oembed_provider_engine 0.0.1

data/test/oembed_providable_test.rb

@@ -0,0 +1,215 @@
+require 'test_helper'
+
+class OembedProvidableTest < ActiveSupport::TestCase
+  n = 0
+  context "A model class that includes OembedProvidable" do
+
+    context "when declaring oembed_providable_as" do
+      setup do
+        n += 1
+        @a_class_name = "Klass#{n}"
+
+        Object.const_set(@a_class_name, Class.new(ActiveRecord::Base)).class_eval do
+          include OembedProviderEngine::OembedProvidable
+        end
+
+        @a_class = @a_class_name.constantize
+      end
+
+      should "not be able to be able to declare oembed_providable_as without an argument for type" do
+        assert_raise(ArgumentError) { @a_class.send(:oembed_providable_as) }
+      end
+
+      should "be able to be able to declare oembed_providable_as with a type" do
+        assert_nothing_raised { @a_class.send(:oembed_providable_as, :link) }
+      end
+
+      should "be able to be able to declare oembed_providable_as with a type and a hash for a spec" do
+        assert_nothing_raised { @a_class.send(:oembed_providable_as, :link, { :title => :label }) }
+      end
+
+      should "have the ability to return an oembed_type" do
+        @a_class.send(:oembed_providable_as, :link)
+        assert @a_class.respond_to?(:oembed_type)
+        assert_equal @a_class.oembed_type, :link
+      end
+    end
+
+    context "will have method" do
+      setup do
+        @method_specs = Hash.new
+      end
+
+      context "methods_specs_for that" do
+        should "return an array of hashes that match defaults when there is no hash of overriding specs" do
+          assert_nothing_raised { Photo::OembedResponse.send(:method_specs_for, OembedProviderEngine::OembedProvider.optional_attributes) }
+          OembedProviderEngine::OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          results_for_test = Photo::OembedResponse.send(:method_specs_for, OembedProviderEngine::OembedProvider.optional_attributes)
+          assert_equal results_for_test, @method_specs
+        end
+
+        should "return an array of hashes that take into account overriding specs" do
+          OembedProviderEngine::OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          @method_specs[:title] = :label
+          results_for_test = Item::OembedResponse.send(:method_specs_for, OembedProviderEngine::OembedProvider.optional_attributes)
+          assert_equal results_for_test, @method_specs
+        end
+      end
+
+      context "optional_attributes_specs set and " do
+        should "match the OembedProvider defaults when there is no hash of overriding specs in the oembed_providable_as call" do
+          assert Photo::OembedResponse.respond_to?(:optional_attributes_specs)
+          OembedProviderEngine::OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          assert_equal Photo::OembedResponse.optional_attributes_specs, @method_specs
+        end
+
+        should "match the oembed_providable_as specs if they are specified" do
+          OembedProviderEngine::OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          @method_specs[:title] = :label
+          assert_equal Item::OembedResponse.optional_attributes_specs, @method_specs
+        end
+      end
+
+      context "required_attributes_specs set and " do
+        should "match the OembedProvider defaults when there is no hash of overriding specs in the oembed_providable_as call" do
+          assert Photo::OembedResponse.respond_to?(:required_attributes_specs)
+          OembedProviderEngine::OembedProvider.required_attributes[:photo].each { |attr| @method_specs[attr] = attr }
+          assert_equal Photo::OembedResponse.required_attributes_specs, @method_specs
+        end
+
+        should "match the oembed_providable_as specs if they are specified" do
+          Object.const_set("RichItem", Class.new(ActiveRecord::Base)).class_eval do
+            include OembedProviderEngine::OembedProvidable
+            oembed_providable_as :rich, :html => :description
+            def description
+              "<h1>some html</h1>"
+            end
+          end
+
+          OembedProviderEngine::OembedProvider.required_attributes[:rich].each { |attr| @method_specs[attr] = attr }
+          @method_specs[:html] = :description
+          assert_equal RichItem::OembedResponse.required_attributes_specs, @method_specs
+        end
+      end
+
+      context "providable_all_attributes set and " do
+        should "have all relevant attributes for the type" do
+          assert Item::OembedResponse.respond_to?(:providable_all_attributes)
+          all_attributes = OembedProviderEngine::OembedProvider.optional_attributes +
+            OembedProviderEngine::OembedProvider.required_attributes[:link] +
+            OembedProviderEngine::OembedProvider.base_attributes
+          assert_equal all_attributes, Item::OembedResponse.providable_all_attributes
+        end
+      end
+    end
+  end
+
+  context "A photo that includes OembedProvidable" do
+    setup do
+      @photo = FactoryGirl.create(:photo)
+    end
+
+    should "have an oembed_response object" do
+      assert @photo.oembed_response
+    end
+
+    should "have an oembed_max_dimensions object when maxheight and maxwidth are specified" do
+      maxheight = 400
+      maxwidth = 600
+      assert @photo.oembed_response(:maxheight => maxheight,
+                                    :maxwidth => maxwidth)
+      assert_equal maxheight, @photo.oembed_response.maxheight
+      assert_equal maxwidth, @photo.oembed_response.maxwidth
+
+      assert @photo.respond_to?(:oembed_max_dimensions)
+      assert_equal maxheight, @photo.oembed_max_dimensions[:height]
+      assert_equal maxwidth, @photo.oembed_max_dimensions[:width]
+    end
+
+    context "has an oembed_response and" do
+      setup do
+        @response = @photo.oembed_response
+      end
+
+      context "has required attribute that" do
+        should "be title" do
+          assert @response.title.present?
+        end
+
+        should "be version" do
+          assert @response.version.present?
+        end
+
+        should "be height" do
+          assert @response.height.present?
+        end
+
+        should "be width" do
+          assert @response.width.present?
+        end
+
+        should "be url" do
+          assert @response.url.present?
+        end
+
+        should "be provider_url" do
+          assert @response.provider_url.present?
+        end
+
+        should "be provider_name" do
+          assert @response.provider_name.present?
+        end
+
+        should "be type" do
+          assert @response.type.present?
+        end
+      end
+
+      context "has can have optional attribute that" do
+        should "be author_name" do
+          @photo = FactoryGirl.create(:photo, :author_name => "Snappy")
+          assert @photo.oembed_response.author_name.present?
+          assert_equal "Snappy", @photo.oembed_response.author_name
+        end
+
+        should "be author_url" do
+          @photo = FactoryGirl.create(:photo, :author_url => "http://snapsnap.com")
+          assert @photo.oembed_response.author_url.present?
+          assert_equal "http://snapsnap.com", @photo.oembed_response.author_url
+        end
+
+        should "be thumbnail_url" do
+          @photo = FactoryGirl.create(:photo, :thumbnail_url => "http://snapsnap.com/thumb.jpg")
+          assert @photo.oembed_response.thumbnail_url.present?
+          assert_equal "http://snapsnap.com/thumb.jpg", @photo.oembed_response.thumbnail_url
+        end
+
+        should "be thumbnail_width" do
+          @photo = FactoryGirl.create(:photo, :thumbnail_width => 50)
+          assert @photo.oembed_response.thumbnail_width.present?
+          assert_equal 50, @photo.oembed_response.thumbnail_width
+        end
+
+        should "be thumbnail_height" do
+          @photo = FactoryGirl.create(:photo, :thumbnail_height => 50)
+          assert @photo.oembed_response.thumbnail_height.present?
+          assert_equal 50, @photo.oembed_response.thumbnail_height
+        end
+      end
+
+      context "when returning json" do
+        should "succeed" do
+          assert @response.as_json
+          assert !@response.to_json.to_s.include?(':null')
+        end
+      end
+
+      context "when returning xml" do
+        should "succeed" do
+          assert @response.to_xml
+        end
+      end
+    end
+  end
+end
+

data/test/oembed_provider_test.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+class OembedProviderTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, OembedProviderEngine
+  end
+
+  context "The OembedProvider object" do
+    should "be able to set and return its provider name" do
+      name = "Media Conglomerate International"
+      OembedProviderEngine::OembedProvider.provider_name = name
+      assert_equal OembedProviderEngine::OembedProvider.provider_name, name
+    end
+
+    should "be able to set and return its provider url" do
+      url = "http://example.com"
+      OembedProviderEngine::OembedProvider.provider_url = url
+      assert_equal OembedProviderEngine::OembedProvider.provider_url, url
+    end
+
+    should "be able to set and return its cache age" do
+      age = "1440"
+      OembedProviderEngine::OembedProvider.cache_age = age
+      assert_equal OembedProviderEngine::OembedProvider.cache_age, age
+    end
+
+    should "return version as 1.0 of oEmbed spec" do
+      assert_equal "1.0", OembedProviderEngine::OembedProvider.version
+    end
+
+    should "have an array of base attribute keys" do
+      base_attributes = [:provider_url,
+                         :provider_name,
+                         :cache_age,
+                         :type,
+                         :version]
+
+      assert_equal OembedProviderEngine::OembedProvider.base_attributes, base_attributes
+    end
+
+    should "have an array of optional attribute keys" do
+      optional_attributes = [:title,
+                             :author_name,
+                             :author_url,
+                             :thumbnail_url,
+                             :thumbnail_width,
+                             :thumbnail_height]
+
+      assert_equal OembedProviderEngine::OembedProvider.optional_attributes, optional_attributes
+    end
+
+    should "have a hash of keyed by oembed type with required attribute keys" do
+      required_attributes = {
+        :photo => [:url, :width, :height],
+        :video => [:html, :width, :height],
+        :link => [],
+        :rich => [:html, :width, :height] }
+
+      assert_equal OembedProviderEngine::OembedProvider.required_attributes, required_attributes
+    end
+
+    should "have a hash of keyed by oembed type photo with required attribute keys" do
+      requires = [:url, :width, :height]
+      assert_equal OembedProviderEngine::OembedProvider.required_attributes[:photo], requires
+    end
+
+    should "have a hash of keyed by oembed type video with required attribute keys" do
+      requires = [:html, :width, :height]
+      assert_equal OembedProviderEngine::OembedProvider.required_attributes[:video], requires
+    end
+
+    should "have a hash of keyed by oembed type link with required attribute keys" do
+      requires = []
+      assert_equal OembedProviderEngine::OembedProvider.required_attributes[:link], requires
+    end
+
+    should "have a hash of keyed by oembed type rich with required attribute keys" do
+      requires = [:html, :width, :height]
+      assert_equal OembedProviderEngine::OembedProvider.required_attributes[:rich], requires
+    end
+
+    context "have an cattr accessor for mapping controllers that aren't tableized version of models, to their corresponding models" do
+      should "be able to set and read controller_model_maps" do
+        assert OembedProviderEngine::OembedProvider.respond_to?(:controller_model_maps)
+        assert_equal Hash.new, OembedProviderEngine::OembedProvider.controller_model_maps
+        test_hash = { :images => 'StillImage' }
+        OembedProviderEngine::OembedProvider.controller_model_maps = test_hash
+        assert_equal test_hash, OembedProviderEngine::OembedProvider.controller_model_maps
+        test_hash[:audio] = 'AudioRecording'
+        OembedProviderEngine::OembedProvider.controller_model_maps[:audio] = 'AudioRecording'
+        assert_equal test_hash, OembedProviderEngine::OembedProvider.controller_model_maps
+      end
+    end
+
+    should "be able to answer find_provided_from with provided object based on passed in url" do
+      photo = FactoryGirl.create(:photo)
+      url = "http://example.com/photos/#{photo.id}"
+
+      assert_equal photo, OembedProviderEngine::OembedProvider.find_provided_from(url)
+    end
+
+    should "raise RecordNotFound with non existent photo" do
+      assert_raise ActiveRecord::RecordNotFound do
+        OembedProviderEngine::OembedProvider.find_provided_from("http://example.com/photos/123")
+      end
+    end
+  end
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require 'factory_girl_rails'
+require 'shoulda'
+require 'nokogiri'
+require 'capybara/rails'
+
+module ActionController
+  class IntegrationTest
+    include Capybara::DSL
+  end
+end
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end