ruby-oembed 0.7.0

data/lib/oembed/response.rb

@@ -0,0 +1,59 @@
+module OEmbed
+  class Response
+    METHODS = [:define_methods!, :provider, :field, :fields]
+    attr_reader :fields, :provider, :format
+
+    def self.create_for(raw, provider, format = :json)
+      fields = OEmbed::Formatters.convert(format, raw)
+
+      resp_type = case fields['type']
+        when 'photo' then OEmbed::Response::Photo
+        when 'video' then OEmbed::Response::Video
+        when 'link'  then OEmbed::Response::Link
+        when 'rich'  then OEmbed::Response::Rich
+        else              self
+      end
+
+      resp_type.new(fields, provider)
+    end
+
+    def initialize(fields, provider)
+      @fields = fields
+      @provider = provider
+      define_methods!
+    end
+
+    def field(m)
+      @fields[m.to_s]
+    end
+
+    def video?
+      is_a?(OEmbed::Response::Video)
+    end
+
+    def photo?
+      is_a?(OEmbed::Response::Photo)
+    end
+
+    def link?
+      is_a?(OEmbed::Response::Link)
+    end
+
+    def rich?
+      is_a?(OEmbed::Response::Rich)
+    end
+
+    private
+
+    def define_methods!
+      @fields.keys.each do |key|
+        next if METHODS.include?(key.to_sym) || key[0,2]=="__" || key[-1]==??
+        class << self
+          self
+        end.send(:define_method, key) do
+          @fields[key]
+        end
+      end
+    end
+  end
+end

data/lib/oembed/response/link.rb

@@ -0,0 +1,6 @@
+module OEmbed
+  class Response
+    class Link < self
+    end
+  end
+end

data/lib/oembed/response/photo.rb

@@ -0,0 +1,9 @@
+module OEmbed
+  class Response
+    class Photo < self
+      def html
+        "<img src='" + self.url + "' />"
+      end
+    end
+  end
+end

data/lib/oembed/response/rich.rb

@@ -0,0 +1,6 @@
+module OEmbed
+  class Response
+    class Rich < self
+    end
+  end
+end

data/lib/oembed/response/video.rb

@@ -0,0 +1,6 @@
+module OEmbed
+  class Response
+    class Video < self
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'oembed'
+OEmbed::Providers.register_all()
+OEmbed::Providers.register_fallback(OEmbed::ProviderDiscovery, OEmbed::Providers::Embedly, OEmbed::Providers::OohEmbed)

data/ruby-oembed.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-oembed}
+  s.version = "0.7.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Magnus Holm", "Alex Kessinger", "Aris Bartee"]
+  s.date = %q{2010-08-19}
+  s.description = %q{A fork of a fork. @github[voidfiles,judofyr].  judufyr created the project and voidfiles added support for Embedly.  This is just the gem}
+  s.email = %q{arisbartee@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION",
+     "idea.rb",
+     "integration_test/test.rb",
+     "integration_test/test_urls.csv",
+     "lib/oembed.rb",
+     "lib/oembed/embedly_urls.json",
+     "lib/oembed/errors.rb",
+     "lib/oembed/formatters.rb",
+     "lib/oembed/provider.rb",
+     "lib/oembed/provider_discovery.rb",
+     "lib/oembed/providers.rb",
+     "lib/oembed/response.rb",
+     "lib/oembed/response/link.rb",
+     "lib/oembed/response/photo.rb",
+     "lib/oembed/response/rich.rb",
+     "lib/oembed/response/video.rb",
+     "rails/init.rb",
+     "ruby-oembed.gemspec",
+     "spec/provider_spec.rb",
+     "spec/providers_spec.rb",
+     "spec/response_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/arisbartee/ruby-oembed}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{oEmbed for Ruby}
+  s.test_files = [
+    "spec/provider_spec.rb",
+     "spec/providers_spec.rb",
+     "spec/response_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/provider_spec.rb

@@ -0,0 +1,175 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe OEmbed::Provider do
+  include OEmbedSpecHelper
+
+  before(:all) do
+    @default = OEmbed::Formatters::DEFAULT
+    @flickr = OEmbed::Provider.new("http://www.flickr.com/services/oembed/")
+    @qik = OEmbed::Provider.new("http://qik.com/api/oembed.{format}", :xml)
+    @viddler = OEmbed::Provider.new("http://lab.viddler.com/services/oembed/", :json)
+
+    @flickr << "http://*.flickr.com/*"
+    @qik << "http://qik.com/video/*"
+    @qik << "http://qik.com/*"
+    @viddler << "http://*.viddler.com/*"
+  end
+
+  it "should by default use OEmbed::Formatters::DEFAULT" do
+    @flickr.format.should == @default
+  end
+
+  it "should allow xml" do
+    @qik.format.should == :xml
+  end
+
+  it "should allow json" do
+    @viddler.format.should == :json
+  end
+
+  it "should not allow random formats" do
+    proc { OEmbed::Provider.new("http://www.hulu.com/api/oembed.{format}", :yml) }.
+    should raise_error(OEmbed::FormatNotSupported)
+  end
+
+  it "should add URL schemes" do
+    @flickr.urls.should == [%r{^http://([^\.]+\.)?flickr\.com/(.*?)}]
+    @qik.urls.should == [%r{^http://qik\.com/video/(.*?)},
+                         %r{^http://qik\.com/(.*?)}]
+  end
+
+  it "should match URLs" do
+    @flickr.include?(example_url(:flickr)).should be_true
+    @qik.include?(example_url(:qik)).should be_true
+  end
+
+  it "should detect if the format is in the URL" do
+    @flickr.format_in_url?.should be_false
+    @qik.format_in_url?.should be_true
+  end
+
+  it "should raise error if the URL is invalid" do
+    proc{ @flickr.build(example_url(:fake)) }.should raise_error(OEmbed::NotFound)
+    proc{ @qik.build(example_url(:fake)) }.should raise_error(OEmbed::NotFound)
+  end
+
+  describe "#build" do
+    it "should return a proper URL" do
+      uri = @flickr.build(example_url(:flickr))
+      uri.host.should == "www.flickr.com"
+      uri.path.should == "/services/oembed/"
+      uri.query.include?("format=#{@flickr.format}").should be_true
+      uri.query.include?("url=http://flickr.com/photos/bees/2362225867/").should be_true
+
+      uri = @qik.build(example_url(:qik))
+      uri.host.should == "qik.com"
+      uri.path.should == "/api/oembed.xml"
+      uri.query.should == "url=http://qik.com/video/49565"
+    end
+
+    it "should accept parameters" do
+      uri = @flickr.build(example_url(:flickr),
+        :maxwidth => 600,
+        :maxheight => 200,
+        :format => :xml,
+        :another => "test")
+
+      uri.query.include?("maxwidth=600").should be_true
+      uri.query.include?("maxheight=200").should be_true
+      uri.query.include?("format=xml").should be_true
+      uri.query.include?("another=test").should be_true
+    end
+
+    it "should build correctly when format is in the endpoint URL" do
+      uri = @qik.build(example_url(:qik), :format => :json)
+      uri.path.should == "/api/oembed.json"
+    end
+  end
+
+  describe "#raw" do
+    it "should return the body on 200" do
+      res = Net::HTTPOK.new("1.1", 200, "OK").instance_eval do
+        @body = "raw content"
+        @read = true
+        self
+      end
+      Net::HTTP.stub!(:start).and_return(res)
+
+      @flickr.raw(example_url(:flickr)).should == "raw content"
+    end
+
+    it "should raise error on 501" do
+      res = Net::HTTPNotImplemented.new("1.1", 501, "Not Implemented")
+      Net::HTTP.stub!(:start).and_return(res)
+
+      proc do
+        @flickr.raw(example_url(:flickr))
+      end.should raise_error(OEmbed::UnknownFormat)
+    end
+
+    it "should raise error on 404" do
+      res = Net::HTTPNotFound.new("1.1", 404, "Not Found")
+      Net::HTTP.stub!(:start).and_return(res)
+
+      proc do
+        @flickr.raw(example_url(:flickr))
+      end.should raise_error(OEmbed::NotFound)
+    end
+
+    it "should raise error on all other responses" do
+      Net::HTTPResponse::CODE_TO_OBJ.delete_if do |code, res|
+        ["200", "404", "501"].include?(code)
+      end.each do |code, res|
+        r = res.new("1.1", code, "Message")
+        Net::HTTP.stub!(:start).and_return(r)
+
+        proc do
+          @flickr.raw(example_url(:flickr))
+        end.should raise_error(OEmbed::UnknownResponse)
+      end
+    end
+  end
+
+  describe "#get" do
+    it "should send the specified format" do
+      @flickr.should_receive(:raw).
+        with(example_url(:flickr), {:format=>:json}).
+        and_return(valid_response(:json))
+      @flickr.get(example_url(:flickr), :format=>:json)
+
+      @flickr.should_receive(:raw).
+        with(example_url(:flickr), {:format=>:xml}).
+        and_return(valid_response(:xml))
+      @flickr.get(example_url(:flickr), :format=>:xml)
+
+      lambda do
+        @flickr.should_receive(:raw).
+          with(example_url(:flickr), {:format=>:yml}).
+          and_return(valid_response(:json))
+        @flickr.get(example_url(:flickr), :format=>:yml)
+      end.should raise_error(OEmbed::FormatNotSupported)
+    end
+
+    it "should send the provider's format if none is specified" do
+      @flickr.should_receive(:raw).
+        with(example_url(:flickr), :format => @default).
+        and_return(valid_response(@default))
+      @flickr.get(example_url(:flickr))
+
+      @qik.should_receive(:raw).
+        with(example_url(:qik), :format=>:xml).
+        and_return(valid_response(:xml))
+      @qik.get(example_url(:qik))
+
+      @viddler.should_receive(:raw).
+        with(example_url(:viddler), :format=>:json).
+        and_return(valid_response(:json))
+      @viddler.get(example_url(:viddler))
+    end
+
+    it "should return OEmbed::Response" do
+      @flickr.stub!(:raw).and_return(valid_response(@default))
+      @flickr.get(example_url(:flickr)).is_a?(OEmbed::Response).should be_true
+    end
+  end
+end

data/spec/providers_spec.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe OEmbed::Providers do
+  include OEmbedSpecHelper
+
+  before(:all) do
+    @flickr = OEmbed::Provider.new("http://www.flickr.com/services/oembed/")
+    @qik = OEmbed::Provider.new("http://qik.com/api/oembed.{format}")
+
+    @flickr << "http://*.flickr.com/*"
+    @qik << "http://qik.com/video/*"
+    @qik << "http://qik.com/*"
+  end
+
+  it "should register providers" do
+    OEmbed::Providers.register(@flickr, @qik)
+    urls = OEmbed::Providers.urls.dup
+
+    @flickr.urls.each do |regexp|
+      urls.delete(regexp).should == @flickr
+    end
+
+     @qik.urls.each do |regexp|
+      urls.delete(regexp).should == @qik
+    end
+
+    urls.length.should == 0
+  end
+
+  it "should find by URLs" do
+    OEmbed::Providers.find(example_url(:flickr)).should == @flickr
+    OEmbed::Providers.find(example_url(:qik)).should == @qik
+  end
+
+  it "should unregister providers" do
+    OEmbed::Providers.unregister(@flickr)
+    urls = OEmbed::Providers.urls.dup
+
+    @qik.urls.each do |regexp|
+      urls.delete(regexp).should == @qik
+    end
+
+    urls.length.should == 0
+  end
+
+  it "should use the OEmbed::ProviderDiscovery fallback provider correctly" do
+  
+
+    # None of the registered providers should match
+  #  all_example_urls.each do |url|
+      provider = OEmbed::Providers.find('http://www.mobypicture.com/user/IadoreChrisette/view/7275748')
+      provider.should_not_receive(:raw)
+      provider.should_not_receive(:get)
+  #  end
+
+    # Register the fallback
+  #  OEmbed::Providers.register_fallback(OEmbed::ProviderDiscovery)
+
+ #   provider = OEmbed::ProviderDiscovery
+  #  provider.should_receive(:raw).
+ #     with(url, {}).
+ #     and_return(valid_response(:raw))
+ #   provider.should_receive(:get).
+ #     with(url, {}).
+#      and_return(valid_response(:object))
+    #asdf
+
+
+  end
+
+  it "should bridge #get and #raw to the right provider" do
+    OEmbed::Providers.register_all
+    all_example_urls.each do |url|
+      provider = OEmbed::Providers.find(url)
+      provider.should_receive(:raw).
+        with(url, {})
+      provider.should_receive(:get).
+        with(url, {})
+      OEmbed::Providers.raw(url)
+      OEmbed::Providers.get(url)
+    end
+  end
+
+  it "should raise an error if no embeddable content is found" do
+    ["http://fake.com/", example_url(:google_video)].each do |url|
+      proc { OEmbed::Providers.get(url) }.should raise_error(OEmbed::NotFound)
+      proc { OEmbed::Providers.raw(url) }.should raise_error(OEmbed::NotFound)
+    end
+  end
+
+  it "should register fallback providers" do
+    OEmbed::Providers.register_fallback(OEmbed::Providers::Hulu)
+    OEmbed::Providers.register_fallback(OEmbed::Providers::OohEmbed)
+
+    OEmbed::Providers.fallback.should == [ OEmbed::Providers::Hulu, OEmbed::Providers::OohEmbed]
+  end
+
+  it "should fallback to the appropriate provider when URL isn't found" do
+    url = example_url(:google_video)
+
+    provider = OEmbed::Providers.fallback.last
+    provider.should_receive(:raw).
+      with(url, {}).
+      and_return(valid_response(:raw))
+    provider.should_receive(:get).
+      with(url, {}).
+      and_return(valid_response(:object))
+
+    OEmbed::Providers.fallback.each do |p|
+      next if p == provider
+      p.should_receive(:raw).and_raise(OEmbed::NotFound)
+      p.should_receive(:get).and_raise(OEmbed::NotFound)
+    end
+
+    OEmbed::Providers.raw(url)
+    OEmbed::Providers.get(url)
+  end
+
+  it "should still raise an error if no embeddable content is found" do
+    ["http://fake.com/"].each do |url|
+      proc { OEmbed::Providers.get(url) }.should raise_error(OEmbed::NotFound)
+      proc { OEmbed::Providers.raw(url) }.should raise_error(OEmbed::NotFound)
+    end
+  end
+end