oembed_links 0.1.9

data/oembed_links_example.yml

@@ -0,0 +1,46 @@
+:config:
+  :method: "NetHTTP"
+
+:providers:
+  :oohembed: "http://oohembed.com/oohembed/"
+  :vimeo: "http://www.vimeo.com/api/oembed.{format}"
+  :hulu: "http://www.hulu.com/api/oembed.{format}"
+  :flickr: "http://www.flickr.com/services/oembed"
+  :viddler: "http://lab.viddler.com/services/oembed/"
+
+:oohembed:
+  :format: "json"
+  :schemes:
+    - "http://*.amazon.(com|co.uk|de|ca|jp)/*/(gp/product|o/ASIN|obidos/ASIN|dp)/*"
+    - "http://*.amazon.(com|co.uk|de|ca|jp)/(gp/product|o/ASIN|obidos/ASIN|dp)/*"        
+    - "http://*.collegehumor.com/video:*"
+    - "http://*.funnyordie.com/videos/*"
+    - "http://video.google.com/videoplay?*"
+    - "http://*.imdb.com/title/tt*/"
+    - "http://*.metacafe.com/watch/*"
+    - "http://*.slideshare.net/*"
+    - "http://twitter.com/*/statuses/*"
+    - "http://*.wikipedia.org/wiki/*"
+    - "http://*.wordpress.com/[0-9]{4}/[0-9]{2}/[0-9]{2}/*"
+    - "http://*.youtube.com/watch*"
+
+:vimeo:
+  :format: "json"
+  :schemes:
+    - "http://www.vimeo.com/groups/*/*"
+    - "http://www.vimeo.com/*"
+
+:hulu:
+  :format: "xml"
+  :schemes:
+    - "http://www.hulu.com/watch/*"
+
+:flickr:
+  :format: "xml"
+  :schemes:
+    - "http://*.flickr.com/*"
+    
+:viddler:
+  :format: "xml"
+  :schemes:
+    - "http://*.viddler.com/*"

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'oembed_links'
+
+yaml_file = File.join(RAILS_ROOT, "config", "oembed_links.yml")
+if File.exists?(yaml_file)
+  OEmbed::register_yaml_file(yaml_file)
+end
+

data/spec/oembed_links_spec.rb

@@ -0,0 +1,286 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe OEmbed, "registration tasks" do
+  include SpecHelper
+  
+  before(:each) do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs
+    clear_urls
+  end
+
+  it "should default to NetHTTP if no method is specified in configuration" do
+    OEmbed.register()
+    OEmbed.instance_variable_get("@fetch_method").should == "NetHTTP"
+  end
+  
+  it "should throw an error if you provide provider URLs but no scheme or format information" do
+    lambda { OEmbed.register({ }, { :fake => "http://fake" })}.should raise_error
+  end
+
+  it "should throw an error if you don't provide any scheme urls for registration" do
+    lambda { OEmbed.register({ }, { :fake => "http://fake" }, { :fake => { :format => "json", :schemes => []}})}.should raise_error
+  end
+
+  it "should default to json format if none is specified" do
+    OEmbed.register({ }, { :fake => "http://fake" }, { :fake => { :schemes => ["http://fake/*"]}})
+    OEmbed.instance_variable_get("@formats")[:fake].should == "json"
+  end
+
+  it "should support loading a configuration via YAML" do
+    OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    OEmbed.instance_variable_get("@urls").size.should == 3
+  end
+
+  it "should support ad hoc addition of providers" do
+    OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    OEmbed.instance_variable_get("@urls").size.should == 3
+    OEmbed.register_provider(:test4, "http://test4/oembed.{format}", "xml", "http://test4.*/*", "http://test4.*/foo/*")
+    OEmbed.instance_variable_get("@urls").size.should == 4
+  end
+
+  it "should support adding new fetchers" do
+    
+    OEmbed.register_fetcher(FakeFetcher)
+    OEmbed.register({ :method => "fake_fetcher"},
+                    { :fake => "http://fake" },
+                    { :fake => {
+                        :format => "json",
+                        :schemes => "http://fake/*"
+                      }})
+    OEmbed.transform("http://fake/bar/baz").should == "fakecontent"
+  end
+  
+  it "should support adding new formatters" do
+    OEmbed.register_formatter(FakeFormatter)
+    OEmbed.register({ :method => "fake_fetcher"},
+                    { :fake => "http://fake" },
+                    { :fake => {
+                        :format => "fake_formatter",
+                        :schemes => "http://fake/*"
+                      }})
+    url_provides("")    
+    OEmbed.transform("http://fake/bar/baz").should == "http://fakesville"
+  end
+
+  it "should allow selective loading of formatters through the load_default_libs function" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::LibXML
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml")
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::HpricotXML
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml", "hpricot")
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::RubyXML    
+  end
+
+  it "should support the hpricot formatter" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml")
+    url_provides(<<-EOXML)
+<?xml version="1.0"?>
+<oembed>
+  <html>bar</html>
+</oembed>
+    EOXML
+    OEmbed.register_provider(:test, "http://test4/oembed.{format}", "xml", "http://test.*/*")
+    OEmbed.transform("http://test.com/bar/baz").should == "bar"
+  end
+
+  it "should support the rexml formatter" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml", "hpricot")
+    url_provides(<<-EOXML)
+<?xml version="1.0"?>
+<oembed>
+  <html>barxml</html>
+</oembed>
+    EOXML
+    OEmbed.register_provider(:test, "http://test4/oembed.{format}", "xml", "http://test.*/*")
+    OEmbed.transform("http://test.com/bar/baz").should == "barxml"
+  end  
+
+  
+
+end
+
+describe OEmbed, "transforming functions" do
+  include SpecHelper
+  before(:each) do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs
+    clear_urls
+    url_provides({
+     "html" => "foo",
+     "type" => "video"
+    }.to_json)
+    OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    @current_path = File.dirname(__FILE__)
+    @template_path = File.join(@current_path, "templates")
+  end
+
+  it "should always give priority to provider conditional blocks" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.none? { "none" }
+      r.any? { |a| "any" }
+      r.video? { |v| "video" }
+      r.from?(:test1) { |t| "test1" }
+      r.matches?(/./) { |m| "regex" }
+    end.should == "test1"
+  end
+
+  it "should always give priority regex conditional blocks over all others except provider" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.none? { "none" }      
+      r.any? { |a| "any" }
+      r.video? { |v| "video" }
+      r.matches?(/./) { |m| "regex" }
+    end.should == "regex"
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.matches?(/./) { |m| "regex" }
+      r.any? { |a| "any" }
+      r.video? { |v| "video" }      
+    end.should == "regex"
+  end
+
+  it "should recognize the type of content and handle the conditional block appropriately" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.none? { "none" }      
+      r.any? { |a| "any" }
+      r.video? { |v| "video" }
+    end.should == "video"
+    url_provides({
+     "html" => "bar",
+     "type" => "hedgehog"
+    }.to_json)
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.video? { |v| "video" }
+      r.hedgehog? { |v| "hedgey"}
+    end.should == "hedgey"    
+  end
+
+  it "should still output the content of a url if no transforming blocks match it" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.audio? { |a| "audio" }
+      r.hedgehog? { |v| "hedgey"}
+      r.from?(:test2) { |t| "test2" }
+      r.matches?(/baz/) { |m| "regex" }
+    end.should == "http://test1.net/foo" 
+  end
+
+  it "should transform only urls which have registered providers" do
+    OEmbed.transform("http://test1.net/foo and http://not.a.valid.url.host/fake are urls") do |r, url|
+      r.video? { |v| "video" }
+    end.should == "video and http://not.a.valid.url.host/fake are urls"    
+  end
+
+  it "should pass control to the .none? block if no scheme matched" do
+    OEmbed.transform("http://not.a.valid.url.host/fake") do |r, url|
+      r.none? { "nomatch" }
+      r.audio? { |a| "audio" }
+      r.hedgehog? { |v| "hedgey"}
+      r.from?(:test2) { |t| "test2" }
+      r.matches?(/baz/) { |m| "regex" }
+    end.should == "nomatch" 
+  end
+
+  it "should allow templates to be used to process the output" do
+    url_provides({
+     "url" => "template!"
+                 }.to_json)
+    
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => File.join(@template_path, "test.rhtml"))
+    end.should == "template! rhtml"
+  end
+
+
+  it "should allow a template root to be set programmatically to process the output" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    OEmbed::TemplateResolver.template_root = @template_path
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.html.erb")
+    end.should == "template! erb"
+  end
+
+  it "should allow for selection of different template renderers" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    defined?(Erubis).should_not == true
+    defined?(Haml).should_not == true
+    OEmbed::TemplateResolver.template_root = @template_path    
+    OEmbed::TemplateResolver.template_processor = :erubis
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.html.erb")
+    end.should == "template! erb"    
+    defined?(Erubis).should == "constant"
+    OEmbed::TemplateResolver.template_processor = :haml
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "test.haml")
+    end.should == "template! haml"
+    defined?(Haml).should == "constant"
+  end
+
+  it "should throw an exception if a path to a template specified does not exist" do
+    url_provides({
+                   "url" => "template!"
+                 }.to_json)
+    lambda { OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "does.not.exist")
+      end }.should raise_error
+  end
+  
+  
+end
+
+
+describe OEmbed, "Rails template resolving functions" do
+  include SpecHelper
+  before(:each) do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs    
+    clear_urls
+    url_provides({
+     "html" => "foo",
+                   "type" => "video",
+                   "url" => "rails"
+    }.to_json)
+    OEmbed.register_yaml_file(File.join(File.dirname(__FILE__), "oembed_links_test.yml"))
+    OEmbed::TemplateResolver.template_processor = nil
+    @current_path = File.dirname(__FILE__)
+    @template_path = File.join(@current_path, "templates")
+
+    require 'actionpack'
+    require 'action_controller'
+    require 'action_controller/test_process'
+
+    class ::ApplicationController < ActionController::Base
+      
+    end
+    ApplicationController.view_paths += [File.dirname(__FILE__)]
+    ActiveSupport::Dependencies.mark_for_unload(ApplicationController)
+  end
+
+  it "should support Rails-like template paths for template selection" do
+
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => ("templates/test"))
+    end.should == "rails erb"
+  end
+
+  it "should support Rails-like template paths with extension specified" do
+    OEmbed.transform("http://test1.net/foo") do |r, url|
+      r.any?(:template => "templates/test.rhtml")
+    end.should == "rails rhtml"
+  end
+  
+end
+
+
+
+
+

data/spec/oembed_links_test.yml

@@ -0,0 +1,26 @@
+:config:
+  :method: "NetHTTP"
+
+:providers:
+  :test1: "http://test1/dude/{format}/"
+  :test2: "http://test2.{format}"
+  :test3: "http://test3"
+
+
+:test1:
+  :format: "json"
+  :schemes:
+    - "http://test1.*/*"
+    - "http://test1/*/test/*"
+
+:test2:
+  :format: "xml"
+  :schemes:
+    - "http://test2.*/*/stuff/*"
+    - "http://test2/foo/bar/*"
+
+:test3:
+  :format: "json"
+  :schemes:
+    - "http://test3/foo/*"
+

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'oembed_links'
+
+module SpecHelper
+  
+  def url_provides(content)
+    Net::HTTP.fake_content(content)
+  end
+
+  def clear_urls
+    Net::HTTP.clear_fakes
+  end
+  
+end
+
+require 'net/http'
+module Net
+  class HTTP
+    
+    def self.fake_content(content)
+      @content = content
+    end
+    
+
+    def self.clear_fakes
+      @content = nil
+    end
+    
+    def self.get(uri)
+      return @content
+    end
+    
+  end
+end
+
+
+require 'json'
+class FakeFetcher
+  def name
+    "fake_fetcher"
+  end
+
+  def fetch(url)
+    {
+      "url" => "fakecontent"
+    }.to_json
+  end
+end
+
+class FakeFormatter
+  def name
+    "fake_formatter"
+  end
+
+  def format(txt)
+    {
+      "url" => "http://fakesville"
+    }
+  end
+end
+
+

data/spec/templates/test.haml

@@ -0,0 +1 @@
+= data['url'] + ' haml'

data/spec/templates/test.html.erb

@@ -0,0 +1 @@
+<%= data['url'] %> erb

data/spec/templates/test.rhtml

@@ -0,0 +1 @@
+<%= data['url'] %> rhtml

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: oembed_links
+version: !ruby/object:Gem::Version 
+  version: 0.1.9
+platform: ruby
+authors: 
+- Indianapolis Star MD&D
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easy OEmbed integration for Ruby (and Rails).
+email: 
+- bugs@indy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- CREDIT
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/oembed_links.rb
+- lib/oembed_links/fetchers/net_http.rb
+- lib/oembed_links/fetchers/ruby_tubesday.rb
+- lib/oembed_links/fetchers/curb.rb
+- lib/oembed_links/formatters/hpricot_xml.rb
+- lib/oembed_links/formatters/json.rb
+- lib/oembed_links/formatters/lib_xml.rb
+- lib/oembed_links/formatters/ruby_xml.rb
+- lib/oembed_links/response.rb
+- lib/oembed_links/template_resolver.rb
+- oembed_links.gemspec
+- oembed_links_example.yml
+- rails/init.rb
+- spec/oembed_links_spec.rb
+- spec/oembed_links_test.yml
+- spec/spec_helper.rb
+- spec/templates/test.haml
+- spec/templates/test.html.erb
+- spec/templates/test.rhtml
+has_rdoc: true
+homepage: http://indystar.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: oembed_links
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+