@@ -7,27 +7,31 @@ flickr.name = "Flickr" flickr.url = "http://flickr.com/" # Another one: -# The default format defaults to json +# The default format is json qik = OEmbed::Provider.new("http://qik.com/api/oembed.{format}") qik << "http://qik.com/*" -# Get a raw XML-file from Flickr: +# Get a raw XML-file from Flickr flickr.raw("http://flickr.com/photos/my_user/1231231312") -# Get a raw JSON-file +# Get a raw JSON-file from Flickr flickr.raw("http://flickr.com/photos/my_user/1231231312", :format => :json) -# Returns a OEmbed::Response -flickr.get("http://flickr.com/photos/my_user/1231231312") - -# Register them to +# Register both providers OEmbed::Providers.register(flickr, qik) -OEmbed::Providers.raw("http://qik.com/test", :format => :xml) +# Get a raw XML-file from whichever provider matches +OEmbed::Providers.raw("http://qik.com/video/1", :format => :xml) + +# Returns a OEmbed::Response using XmlSimple library to parse the response +res = flickr.get("http://flickr.com/photos/my_user/1231231312") +# Returns a OEmbed::Response using the JSON library to parse the response +res = flickr.get("http://flickr.com/photos/my_user/1231231312", :format => :json) -res.is_a?(OEmbed::Response) -res.type -res.version -res.author_name -res.author_url -res.provider.url -res.provider.name \ No newline at end of file +res.is_a?(OEmbed::Response) # => true +res.type # => "photo" +res.version # => "1.0" +res.html # => "<img src='http://farm1.static.flickr.com/2312/3123123_123123.jpg' />" +res.author_name # => "my_user" +res.author_url # => "http://flickr.com/photos/my_user" +res.provider.url # => "http://flickr.com/" +res.provider.name # => "Flickr" \ No newline at end of file idea.rb @@ -1,9 +1,16 @@ $:.unshift File.dirname(__FILE__) +%w(json/ext json).each do |lib| + begin + require lib + break + rescue LoadError + end +end + begin - require 'json/ext' + require 'xmlsimple' rescue LoadError - require 'json' end require 'net/http' lib/oembed.rb @@ -11,6 +11,12 @@ module OEmbed end end + class FormatNotSupported < StandardError + def to_s + "This server doesn't have the correct libraries installed to support the '#{super}' format" + end + end + class UnknownResponse < StandardError def to_s "Got unkown response (#{super}) from server" lib/oembed/errors.rb @@ -2,10 +2,28 @@ module OEmbed class Provider attr_accessor :format, :name, :url, :urls, :endpoint - def initialize(endpoint, format = :json) + def initialize(endpoint, format = nil) @endpoint = endpoint @urls = [] + # Try to use the best available format @format = format + case @format + when :json + begin + JSON.respond_to?(:load) + rescue NameError + @format = nil + end + when :xml + begin + XmlSimple.respond_to?(:xml_in) + @format = :xml + rescue NameError + @format = nil + end + else + @format = nil + end end def <<(url) @@ -57,7 +75,8 @@ module OEmbed end def get(url, options = {}) - OEmbed::Response.create_for(raw(url, options.merge(:format => :json)), self) + options[:format] ||= @format if @format + OEmbed::Response.create_for(raw(url, options), self, options[:format]) end def format_in_url? lib/oembed/provider.rb @@ -1,10 +1,19 @@ module OEmbed class Response METHODS = [:define_methods!, :provider, :field, :fields] - attr_reader :fields, :provider + attr_reader :fields, :provider, :format - def self.create_for(json, provider) - fields = JSON.load(json) + def self.create_for(raw, provider, format) + begin + fields = case format + when :xml + XmlSimple.xml_in(raw, {'ForceArray'=>false}) + else + JSON.load(raw) + end + rescue NameError + raise OEmbed::FormatNotSupported, (format || :json).to_s + end resp_type = case fields['type'] when 'photo' : OEmbed::Response::Photo lib/oembed/response.rb @@ -6,10 +6,29 @@ describe OEmbed::Provider do before(:all) do @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 default to nil" do + @flickr.format.should be_nil + 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 + @hulu = OEmbed::Provider.new("http://www.hulu.com/api/oembed.{format}", :yml) + @hulu.format.should be_nil end it "should add URL schemes" do @@ -38,7 +57,7 @@ describe OEmbed::Provider do uri = @flickr.build(url(:flickr)) uri.host.should == "www.flickr.com" uri.path.should == "/services/oembed/" - uri.query.include?("format=json").should be_true + 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(url(:qik)) @@ -111,15 +130,42 @@ describe OEmbed::Provider do end describe "#get" do - it "should set the format to json" do + it "should send the specified format" do @flickr.should_receive(:raw). - with(url(:flickr), :format => :json). - and_return('{}') + with(url(:flickr), {:format=>:json}). + and_return(valid_response(:json)) + @flickr.get(url(:flickr), :format=>:json) + + @flickr.should_receive(:raw). + with(url(:flickr), {:format=>:xml}). + and_return(valid_response(:xml)) + @flickr.get(url(:flickr), :format=>:xml) + + @flickr.should_receive(:raw). + with(url(:flickr), {:format=>:yml}). + and_return(valid_response(:json)) + @flickr.get(url(:flickr), :format=>:yml) + end + + it "should send the provider's format if none is specified" do + @flickr.should_receive(:raw). + with(url(:flickr), {}). + and_return(valid_response(:json)) @flickr.get(url(:flickr)) + + @qik.should_receive(:raw). + with(url(:qik), :format=>:xml). + and_return(valid_response(:xml)) + @qik.get(url(:qik)) + + @viddler.should_receive(:raw). + with(url(:viddler), :format=>:json). + and_return(valid_response(:json)) + @viddler.get(url(:viddler)) end it "should return OEmbed::Response" do - @flickr.stub!(:raw).and_return('{}') + @flickr.stub!(:raw).and_return(valid_response(:json)) @flickr.get(url(:flickr)).is_a?(OEmbed::Response).should be_true end end spec/provider_spec.rb @@ -1,45 +1,76 @@ require File.dirname(__FILE__) + '/spec_helper' describe OEmbed::Response do + include OEmbedSpecHelper + before(:all) do - data = <<-END - { - "type": "photo", - "version": "1.0", - "fields": "hello", - "__id__": 1234 - } - END - @res = OEmbed::Response.new(data, OEmbed::Providers::Flickr) + @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/*" + + @new_res = OEmbed::Response.new(valid_response(:object), OEmbed::Providers::OohEmbed) + + @default_res = OEmbed::Response.create_for(valid_response(:json), @flickr, nil) + @xml_res = OEmbed::Response.create_for(valid_response(:xml), @qik, :xml) + @json_res = OEmbed::Response.create_for(valid_response(:json), @viddler, :json) end it "should set the provider" do - @res.provider.should == OEmbed::Providers::Flickr + @new_res.provider.should == OEmbed::Providers::OohEmbed + + @default_res.provider.should == @flickr + @xml_res.provider.should == @qik + @json_res.provider.should == @viddler end it "should parse the data into #fields" do - @res.fields.should == { - "type" => "photo", - "version" => "1.0", - "fields" => "hello", - "__id__" => 1234 - } + @new_res.fields.keys.should == valid_response(:object).keys + + @default_res.fields.keys.should == valid_response(:object).keys + @xml_res.fields.keys.should == valid_response(:object).keys + @json_res.fields.keys.should == valid_response(:object).keys + end + + it "should not parse the incorrect format" do + lambda do + OEmbed::Response.create_for(valid_response(:xml), @flickr, nil) + end.should raise_error(JSON::ParserError) + + lambda do + OEmbed::Response.create_for(valid_response(:xml), @viddler, :json) + end.should raise_error(JSON::ParserError) + + lambda do + OEmbed::Response.create_for(valid_response(:json), @viddler, :xml) + end.should raise_error(ArgumentError) + end + + it "should access the XML data through #field" do + @xml_res.field(:type).should == "photo" + @xml_res.field(:version).should == "1.0" + @xml_res.field(:fields).should == "hello" + @xml_res.field(:__id__).should == "1234" end - it "should access the data through #field" do - @res.field(:type).should == "photo" - @res.field(:version).should == "1.0" - @res.field(:fields).should == "hello" - @res.field(:__id__).should == 1234 + it "should access the JSON data through #field" do + @json_res.field(:type).should == "photo" + @json_res.field(:version).should == "1.0" + @json_res.field(:fields).should == "hello" + @json_res.field(:__id__).should == 1234 end it "should automagically define helpers" do - @res.type.should == "photo" - @res.version.should == "1.0" + @default_res.type.should == "photo" + @default_res.version.should == "1.0" end it "should protect important methods" do - @res.fields.should_not == @res.field(:fields) - @res.__id__.should_not == @res.field(:__id__) + @default_res.fields.should_not == @default_res.field(:fields) + @default_res.__id__.should_not == @default_res.field(:__id__) end end \ No newline at end of file spec/response_spec.rb @@ -14,4 +14,35 @@ module OEmbedSpecHelper return "http://fake.com/" if site == :fake EXAMPLE[site] end + + def valid_response(format) + case format + when :object + { + "type" => "photo", + "version" => "1.0", + "fields" => "hello", + "__id__" => 1234 + } + when :json + <<-JSON + { + "type": "photo", + "version": "1.0", + "fields": "hello", + "__id__": 1234 + } + JSON + when :xml + <<-XML + <?xml version="1.0" encoding="utf-8" standalone="yes"?> + <oembed> + <type>photo</type> + <version>1.0</version> + <fields>hello</fields> + <__id__>1234</__id__> + </oembed> + XML + end + end end \ No newline at end of file spec/spec_helper.rb 167fab2b0959e9ef25dd613c6596fa0b23e32ee7 Marcos Wright Kuhns webmaster@kuhnsfam.com http://github.com/judofyr/ruby-oembed/commit/93cbe4f4d32ec88bc32116a59fc70c4f52ed109d 93cbe4f4d32ec88bc32116a59fc70c4f52ed109d 2009-01-27T09:09:54-08:00 2009-01-26T18:25:52-08:00 Initial work allowing the use of the XmlSimple library instead of JSON Signed-off-by: Magnus Holm <judofyr@gmail.com> 811395b1d112e61201476daad0a38246001e107f Magnus Holm judofyr@gmail.com