oembed_provider_engine 0.0.1

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/oembed_provider.rb

@@ -0,0 +1,2 @@
+OembedProviderEngine::OembedProvider.provider_name = "example.com"
+OembedProviderEngine::OembedProvider.provider_url = "http://www.example.com"

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '30e7535ce5ccce3bcfced25cfbec66ab6e54dcae011de43bf873b2732460f28f6b565587f265798be2dcb28bc0bbdc72ebd4b697889686fe6b52e00ed6a921f7'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+
+  mount OembedProviderEngine::Engine => "/oembed"
+
+  resources :photos
+  resources :items
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/db/migrate/20110212010602_create_items.rb

@@ -0,0 +1,13 @@
+class CreateItems < ActiveRecord::Migration
+  def self.up
+    create_table :items do |t|
+      t.string :label, :null => false
+      t.string :description
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :items
+  end
+end

data/test/dummy/db/migrate/20110212022722_create_photos.rb

@@ -0,0 +1,15 @@
+class CreatePhotos < ActiveRecord::Migration
+  def self.up
+    create_table :photos do |t|
+      t.string :title, :url, :null => false
+      t.string :author_name, :author_url, :thumbnail_url
+      t.integer :width, :height, :null => false
+      t.integer :thumbnail_width, :thumbnail_height
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :photos
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110212022722) do
+
+  create_table "items", :force => true do |t|
+    t.string   "label",       :null => false
+    t.string   "description"
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
+  end
+
+  create_table "photos", :force => true do |t|
+    t.string   "title",            :null => false
+    t.string   "url",              :null => false
+    t.string   "author_name"
+    t.string   "author_url"
+    t.string   "thumbnail_url"
+    t.integer  "width",            :null => false
+    t.integer  "height",           :null => false
+    t.integer  "thumbnail_width"
+    t.integer  "thumbnail_height"
+    t.datetime "created_at",       :null => false
+    t.datetime "updated_at",       :null => false
+  end
+
+end

data/test/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/factories/photos.rb

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

data/test/functional/oembed_provider_controller_test.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class OembedProviderControllerTest < ActionController::TestCase
+
+  tests OembedProviderEngine::OembedProviderController
+
+  context "The oembed provider controller" do
+    setup do
+      @photo = FactoryGirl.create(:photo)
+    end
+
+    should "endpoint" do
+      get :endpoint, :url => "http://example.com/photos/#{@photo.id}", use_route: "root"
+      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', use_route: "root"
+      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', use_route: "root"
+      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', use_route: "root"
+      assert_response :success
+    end
+
+    context "base attributes" do
+      setup do
+        get :endpoint, :url => "http://example.com/photos/#{@photo.id}", :format => 'json', use_route: "root"
+        @json = JSON.parse(response.body)
+      end
+
+      should "have version" do
+        assert @json["version"].present?
+      end
+
+      should "have type" do
+        assert_equal @json["type"], "photo"
+      end
+    end
+  end
+end
+

data/test/integration/navigation_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  fixtures :all
+
+  # test "the truth" do
+  #   assert true
+  # end
+end
+

data/test/integration/oembed_test.rb

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class OembedTest < ActionController::IntegrationTest
+  context "A providable object when its url is request from the oembed endpoint" do
+    setup do
+      @photo = FactoryGirl.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
+      get "/oembed?url=#{@escaped_url}"
+      assert_json_equal_to(response.body)
+    end
+
+    should "return correct json for the providable object when .json" do
+      get "/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
+      get "/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'
+      get "/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'
+      get "/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'
+      get "/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
+      get "/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
+      get "/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
+        get @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