oembed_provider 0.1.0

data/test/full_2_3_5_app_with_tests/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/full_2_3_5_app_with_tests/public/stylesheets/scaffold.css

@@ -0,0 +1,54 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+

data/test/full_2_3_5_app_with_tests/script/about

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
+require 'commands/about'

data/test/full_2_3_5_app_with_tests/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/console'

data/test/full_2_3_5_app_with_tests/script/dbconsole

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/dbconsole'

data/test/full_2_3_5_app_with_tests/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/destroy'

data/test/full_2_3_5_app_with_tests/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/generate'

data/test/full_2_3_5_app_with_tests/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/benchmarker'

data/test/full_2_3_5_app_with_tests/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/profiler'

data/test/full_2_3_5_app_with_tests/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/plugin'

data/test/full_2_3_5_app_with_tests/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/runner'

data/test/full_2_3_5_app_with_tests/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/server'

data/test/full_2_3_5_app_with_tests/test/factories.rb

@@ -0,0 +1,14 @@
+Factory.define :item do |f|
+  f.sequence(:label) { |n| "a label#{n}"}
+  f.sequence(:description) { |n| "a description#{n}"}
+end
+
+Factory.define :photo do |f|
+  f.sequence(:title) { |n| "a title#{n}"}
+  f.sequence(:url) { |n| "http://example.com/photo?id=#{n}"}
+  f.sequence(:width) { |n| "600"}
+  f.sequence(:height) { |n| "400"}
+end
+#   f.sequence(:author_name) { |n| "an author_name#{n}"}
+#   f.sequence(:author_url) { |n| "http://example.com/author?id=#{n}"}
+

data/test/full_2_3_5_app_with_tests/test/functional/oembed_provider_controller_test.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class OembedProviderControllerTest < ActionController::TestCase
+  context "The oembed provider controller" do
+    setup do
+      @photo = Factory.create(:photo)
+    end
+
+    should "endpoint" do
+      get :endpoint, :url => "http://example.com/photos/#{@photo.id}"
+      assert_response :success
+    end
+
+    should "endpoint with format json" do
+      @request.accept = "text/javascript"
+      get :endpoint, :url => "http://example.com/photos/#{@photo.id}", :format => 'json'
+      assert_response :success
+    end
+
+    should "endpoint with format json and callback, return json-p" do
+      @request.accept = "text/javascript"
+      get :endpoint, :url => "http://example.com/photos/#{@photo.id}", :format => 'json', :callback => 'myCallback'
+      assert_response :success
+    end
+
+    should "endpoint with format xml" do
+      @request.accept = "text/xml"
+      get :endpoint, :url => "http://example.com/photos/#{@photo.id}", :format => 'xml'
+      assert_response :success
+    end
+  end
+end
+

data/test/full_2_3_5_app_with_tests/test/integration/oembed_test.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+class OembedTest < ActionController::IntegrationTest
+  context "A providable object when its url is request from the oembed endpoint" do
+    setup do
+      @photo = Factory.create(:photo)
+      @url_without_protocol = "example.com/photos/#{@photo.id}"
+      @escaped_url = "http%3A//#{@url_without_protocol}"
+      @normal_url = "http://#{@url_without_protocol}"
+    end
+    
+    should "return correct json for the providable object" do
+      visit "/oembed?url=#{@escaped_url}"
+      assert_json_equal_to(response.body)
+    end
+
+    should "return correct json for the providable object when .json" do
+      visit "/oembed.json?url=#{@escaped_url}"
+      assert_json_equal_to(response.body)
+    end
+
+    should "return correct json for the providable object when query string specifies format=json" do
+      visit "/oembed?url=#{@escaped_url}&format=json"
+      assert_json_equal_to(response.body)
+    end
+
+    should "return correct json-p for the providable object when .json and callback specified" do
+      callback_name = 'myCallback'
+      visit "/oembed.json?url=#{@escaped_url}&callback=#{callback_name}"
+      assert response.body.include?(callback_name)
+      assert_json_equal_to(response.body.sub("#{callback_name}(", '').chomp(');'))
+    end
+
+    should "return correct json-p for the providable object when .json and variable specified" do
+      variable_name = 'myVar'
+      visit "/oembed.json?url=#{@escaped_url}&variable=#{variable_name}"
+      assert response.body.include?(variable_name)
+      assert_json_equal_to(response.body.sub("var #{variable_name} = ", '').chomp(';'))
+    end
+
+    should "return correct json-p for the providable object when .json and variable and callback specified" do
+      variable_name = 'myVar'
+      callback_name = 'myCallback'
+      visit "/oembed.json?url=#{@escaped_url}&variable=#{variable_name}&callback=#{callback_name}"
+      assert response.body.include?(variable_name)
+      assert response.body.include?(callback_name)
+      stripped_to_json = response.body.sub("var #{variable_name} = ", '').sub("\n#{callback_name}(#{variable_name})", '').chomp(';').chomp(';')
+      assert_json_equal_to(stripped_to_json)
+    end
+
+    should "return correct xml for the providable object when .xml" do
+      visit "/oembed.xml?url=#{@escaped_url}"
+      assert_equal @photo.oembed_response.to_xml, response.body
+    end
+
+    should "return correct xml for the providable object when query string specifies format=xml" do
+      visit "/oembed?url=#{@escaped_url}&format=xml"
+      assert_equal @photo.oembed_response.to_xml, response.body
+    end
+    
+    # test helper here as integration test rather than unit/helpers
+    # only one helper and easier to do and effective in practice
+    context "when visiting providable url, the page" do
+      should "oembed links in the header" do
+        visit @normal_url
+        assert response.body.include?("application/json+oembed")
+        assert response.body.include?("/oembed?url=#{@escaped_url}")
+        assert response.body.include?("application/xml+oembed")
+        assert response.body.include?("/oembed.xml?url=#{@escaped_url}")
+      end
+    end
+
+    # WARNING: maxheight and maxwidth parameter passing
+    # results in correct version of image, etc.
+    # is left to application specific testing by application using the engine
+    # in other words, implement it in YOUR tests
+  end
+  private
+  
+  def assert_json_equal_to(response_body)
+    assert_equal ActiveSupport::JSON.decode(@photo.oembed_response.to_json), ActiveSupport::JSON.decode(response_body)
+  end
+end

data/test/full_2_3_5_app_with_tests/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/full_2_3_5_app_with_tests/test/selenium.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+# This file is not in integration/ because when run with
+# 'rake', it causes segfaults in the test suite
+
+# ATTN: Before runnings these tests, be sure to turn
+# off all extensions and popup blockers in Safari
+
+class ActiveSupport::TestCase
+  self.use_transactional_fixtures = true
+  setup do |session|
+    session.host! "localhost:3001"
+  end
+end
+
+Webrat.configure do |config|
+  config.mode = :selenium
+  config.application_environment = :test
+  config.selenium_browser_key = '*safari'
+end
+
+class SeleniumTest < ActionController::IntegrationTest
+  context "Using Selenium to test javascript functionality" do
+
+    # DEBUG: This works so if the others don't, try just this one
+    # should "be able to visit the homepage" do
+    #   visit "/"
+    #   assert_contain "Welcome aboard"
+    # end
+
+    should "be able to translate an item via AJAX" do
+      item = create_item
+      click_link "Français"
+      assert current_url =~ /\/en\/items\/#{item.id}$/
+      assert_contain "Translate from English to Français"
+      fill_in 'item_translation_label', :with => 'Certains Point'
+      click_button 'Create'
+      assert_contain 'Translation was successfully created.'
+    end
+
+    should "be able to switch translations" do
+      item = create_item
+      click_link "Français"
+      assert current_url =~ /\/en\/items\/#{item.id}$/
+      assert_contain "Translate from English to Français"
+      click_link "Suomi"
+      assert current_url =~ /\/en\/items\/#{item.id}$/
+      assert_contain "Translate from English to Suomi"
+    end
+
+    should "be able to close the translations box" do
+      item = create_item
+      click_link "Français"
+      click_link "[close]"
+      assert_not_contain "Translate from English to Français"
+    end
+
+    should "be able to use the auto translate functionality" do
+      item = create_item
+      visit "/en/items/#{item.id}/translations/new?to_locale=fr"
+      click_link '[auto translate]'
+      sleep 1 # ugly way to wait for google to do it's thing
+      click_button 'Create'
+      assert_contain 'Translation was successfully created.'
+      assert_contain 'Certains Point'
+    end
+
+  end
+
+  private
+
+  def create_item
+    visit "/en/items"
+    click_link "New item"
+    fill_in 'item_label', :with => 'Some Item'
+    fill_in 'item_value', :with => '$3.50'
+    fill_in 'item_locale', :with => 'en'
+    click_button 'Create'
+    assert_contain 'Item was successfully created.'
+    Item.last
+  end
+end

data/test/full_2_3_5_app_with_tests/test/test_helper.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+require 'rubygems'
+require 'shoulda'
+require 'factory_girl'
+require "webrat"
+
+require File.expand_path(File.dirname(__FILE__) + "/factories")
+
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  # self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  # self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  # fixtures :all
+
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method teardown do
+      super
+    end
+  end
+end

data/test/full_2_3_5_app_with_tests/test/unit/oembed_providable_test.rb

@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+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 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, OembedProvider.optional_attributes) }
+          OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          results_for_test = Photo::OembedResponse.send(:method_specs_for, OembedProvider.optional_attributes)
+          assert_equal results_for_test, @method_specs
+        end
+
+        should "return an array of hashes that take into account overriding specs" do
+          OembedProvider.optional_attributes.each { |attr| @method_specs[attr] = attr }
+          @method_specs[:title] = :label
+          results_for_test = Item::OembedResponse.send(:method_specs_for, 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)
+          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
+          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)
+          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 OembedProvidable
+            oembed_providable_as :rich, :html => :description
+            def description
+              "<h1>some html</h1>"
+            end
+          end
+
+          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 = OembedProvider.optional_attributes +
+            OembedProvider.required_attributes[:link] +
+            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 = Factory.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
+      end
+      
+      context "has can have optional attribute that" do
+        should "be author_name" do
+          @photo = Factory.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 = Factory.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 = Factory.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 = Factory.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 = Factory.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