ruby-oembed 0.8.1 → 0.8.3

data/.yardopts

@@ -0,0 +1,4 @@
+--readme README.rdoc
+--markup rdoc
+--exclude tasks
+lib/**/*.rb - CHANGELOG.rdoc LICENSE

data/CHANGELOG.rdoc

@@ -1,5 +1,17 @@
 = CHANGELOG
 
+== 0.8.3 - 26 June 2011
+
+* Fixing a circular dependency introduced during my recent Jeweler upgrade. (Marcos Wright Kuhns)
+
+== 0.8.2 - 25 June 2011
+
+* Added built-in providers for Instagram, Slideshare and Yfrog
+* Improved support (and error detection) for custom OEmbed::Formatter backends. (Marcos Wright Kuhns)
+* DRYed up OEmbed::Formatter::JSON and XML methods into OEmbed::Formatter::Base (Marcos Wright Kuhns)
+* More consistently raise an OEmbed::Parse error if there is any sort of problem parsing the server response, whether it's an expected error type or not. (Marcos Wright Kuhns)
+* Added in-code comments about the oohEmbed service becoming part of Embed.ly
+
 == 0.8.1 - 27 February 2011
 
 * Removed all dependencies on external gems. XML is parsed using REXML and JSON can be parsed using YAML thanks to the convert_json_to_yaml method borrowed from Rails! (Marcos Wright Kuhns)
@@ -17,7 +29,7 @@
 * Provider#url and Provider#name will be removed at some point in the future.
 * All direct raw calls will be made private at some point in the future (i.e. Provider#raw, Providers#raw, and ProviderDiscovery#raw)
 
-== 0.8.0 - Unreleased
+== 0.8.0 - Not Publicly Released
 
 * Added OEmbed::Formatter Backends, to remove the dependency on the json gem and make adding support for other parsing libraries easier. This also fixes GitHub Issue =1. (Marcos Wright Kuhns)
 * Catch invalid endpoint URLs on OEmbed::Provider instantiation. (Marcos Wright Kuhns)

data/Gemfile

@@ -1,4 +1,9 @@
-# A sample Gemfile
-source "http://rubygems.org"
-gem 'jeweler'
-gemspec
+source :rubygems
+
+group :development, :test do
+  gem 'jeweler'
+  gem 'rake'
+  gem 'json'
+  gem 'xml-simple'
+  gem 'rspec', '>=2.0'
+end

data/Gemfile.lock

@@ -1,31 +1,23 @@
-PATH
-  remote: .
-  specs:
-    ruby-oembed (0.8.0)
-
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    gemcutter (0.6.1)
     git (1.2.5)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
       git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json (1.5.1)
-    json_pure (1.4.6)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+      rake
+    json (1.5.3)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    xml-simple (1.0.14)
+    rspec-mocks (2.6.0)
+    xml-simple (1.1.0)
 
 PLATFORMS
   ruby
@@ -33,5 +25,6 @@ PLATFORMS
 DEPENDENCIES
   jeweler
   json
+  rake
   rspec (>= 2.0)
-  ruby-oembed!
+  xml-simple

data/README.rdoc

@@ -43,7 +43,7 @@ Last but not least, ruby-oembed supports both {oohEmbed}[http://oohembed.com] an
 
 == Formatters
 
-This library works wonderfully on it's on, but can get a speed boost by using 3rd party libraries to parse oEmbed data. To use a 3rd party Formatter, just be sure to require the library _before_ ruby-oembed.
+This library works wonderfully on its own, but can get a speed boost by using 3rd party libraries to parse oEmbed data. To use a 3rd party Formatter, just be sure to require the library _before_ ruby-oembed.
 
   require 'json'
   require 'xmlsimple'
@@ -59,7 +59,7 @@ The following, optional, backends are currently supported:
 
 = Lend a Hand
 
-Code for the ruby-oembed library is {hosted on GitHub}[http://github.com/judofyr/ruby-oembed].
+Code for the ruby-oembed library is {hosted on GitHub}[https://github.com/judofyr/ruby-oembed].
 
   # Get the code.
   git clone git://github.com/judofyr/ruby-oembed.git
@@ -70,9 +70,25 @@ Code for the ruby-oembed library is {hosted on GitHub}[http://github.com/judofyr
   # Run the tests.
   rake specs
 
-If you encounter any bug, feel free to {create an Issue}[http://github.com/judofyr/ruby-oembed/issues].
+If you encounter any bug, feel free to {create an Issue}[https://github.com/judofyr/ruby-oembed/issues].
 
-To submit a patch, please {fork}[http://help.github.com/forking/] the library and commit your changes along with relevant tests. Once you're happy with the changes, {send a pull request}[http://help.github.com/pull-requests/].
+We gladly accept pull requests! Just {fork}[http://help.github.com/forking/] the library and commit your changes along with relevant tests. Once you're happy with the changes, {send a pull request}[http://help.github.com/pull-requests/].
+
+We do our best to {keep our tests green}[http://travis-ci.org/metavida/ruby-oembed] https://secure.travis-ci.org/metavida/ruby-oembed.png
+
+= Contributors
+
+Thanks to the following people for their contributions to this gem, both large and small:
+
+* {Aris Bartee}[https://github.com/arisbartee]
+* {Todd Fisher}[https://github.com/taf2]
+* {Hans de Graff}[https://github.com/graaff]
+* {Magnus Holm}[https://github.com/judofyr] (original author of this library)
+* {Alex Kessinger}[https://github.com/voidfiles]
+* {Ryan Richards}[https://github.com/rrichards]
+* {Colin Shea}[https://github.com/evaryont]
+* {Kyle Slattery}[https://github.com/kyleslattery]
+* {Marcos Wright-Kuhns}[https://github.com/metavida] (current maintainer)
 
 = License
 

data/Rakefile

@@ -14,9 +14,6 @@ begin
     gemspec.license = "MIT"
     gemspec.email = "arisbartee@gmail.com"
     gemspec.authors = ["Magnus Holm","Alex Kessinger","Aris Bartee","Marcos Wright Kuhns"]
-    gemspec.add_development_dependency("json")
-    gemspec.add_development_dependency("xml-simple")
-    gemspec.add_development_dependency("rspec", ">=2.0")
     
     gemspec.rdoc_options = %W(
       --main README.rdoc
@@ -26,7 +23,7 @@ begin
       CHANGELOG.rdoc
     )
   end
-  Jeweler::GemcutterTasks.new
+  Jeweler::RubygemsDotOrgTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end

data/lib/oembed/formatter.rb

@@ -1,3 +1,4 @@
+require 'oembed/formatter/base'
 require 'oembed/formatter/json'
 require 'oembed/formatter/xml'
 
@@ -37,19 +38,23 @@ module OEmbed
       def decode(format, value)
         supported?(format)
         
-        case format.to_s
-        when 'json'
-          begin
-            JSON.decode(value)
-          rescue JSON.backend::ParseError
-            raise OEmbed::ParseError, $!.message
-          end
-        when 'xml'
-          begin
-            XML.decode(value)
-          rescue XML.backend::ParseError
-            raise OEmbed::ParseError, $!.message
+        begin
+          case format.to_s
+          when 'json'
+            begin
+              JSON.decode(value)
+            rescue JSON.backend.parse_error
+              raise OEmbed::ParseError, $!.message
+            end
+          when 'xml'
+            begin
+              XML.decode(value)
+            rescue XML.backend.parse_error
+              raise OEmbed::ParseError, $!.message
+            end
           end
+        rescue
+          raise OEmbed::ParseError, "#{$!.class}: #{$!.message}"
         end
       end
       
@@ -91,7 +96,7 @@ module OEmbed
           !actual.detect { |key, value| value.to_s != expected[key].to_s }
       end
       
-    end
+    end # self
     
   end
 end

data/lib/oembed/formatter/base.rb

@@ -0,0 +1,108 @@
+module OEmbed
+  module Formatter
+    # These are methods that are shared by the OEmbed::Formatter sub-classes
+    # (i.e. OEmbed::Formatter:JSON and OEmbed::Formatter::XML).
+    module Base
+      
+      # Returns true if there is a valid backend. Otherwise, raises OEmbed::FormatNotSupported
+      def supported?
+        !!backend
+      end
+      
+      # Parses a String or IO and convert it into an Object
+      def decode(value)
+        backend.decode(value)
+      end
+      
+      # Given either a String (the name of the backend to use) or an Object (which
+      # must respond to the decode method), sets the current backend. Raises a LoadError
+      # if the given backend cannot be loaded (e.g. an invalid String name, or the
+      # decode method doesn't work properly).
+      #   OEmbed::Formatter::XML.backend = 'REXML'
+      #   OEmbed::Formatter::JSON.backend = MyCustomJsonDecoder.new
+      def backend=(new_backend)
+        new_backend_obj = case new_backend
+        when String
+          already_required = false
+          begin 
+            already_required = self::Backends.const_defined?(new_backend, false)
+          rescue ArgumentError # we're dealing with ruby < 1.9 where const_defined? only takes 1 argument, but behaves the way we want it to.
+            already_required = self::Backends.const_defined?(new_backend)
+          rescue NameError # no backends have been loaded yet
+            already_required = false
+          end
+      
+          require "oembed/formatter/#{backend_path}/#{new_backend.downcase}" unless already_required
+          self::Backends.const_get(new_backend)
+        else
+          new_backend
+        end
+        
+        test_backend(new_backend_obj)
+        
+        @backend = new_backend_obj
+        
+      rescue
+        raise LoadError, "There was an error setting the backend: #{new_backend.inspect} - #{$!.message}"
+      end
+      
+      # Perform a set of operations using a backend other than the current one.
+      #   OEmbed::Formatter::XML.with_backend('XmlSimple') do
+      #     OEmbed::Formatter::XML.decode(xml_value)
+      #   end
+      def with_backend(new_backend)
+        old_backend, self.backend = backend, new_backend
+        yield
+      ensure
+        self.backend = old_backend
+      end
+      
+      private
+      
+      # Makes sure the given backend can correctly parse values using the decode
+      # method.
+      def test_backend(new_backend)
+        raise LoadError, "The given backend must respond to the decode method: #{new_backend.inspect}" unless new_backend.respond_to?(:decode)
+        
+        expected = {
+          "version"=>1.0,
+          "string"=>"test",
+          "int"=>42,
+          "html"=>"<i>Cool's</i>\n the \"word\"!",
+        }
+        
+        actual = new_backend.decode(test_value)
+        
+        # For the test to be true the actual output Hash should have the
+        # exact same list of keys _and_ the values should be the same
+        # if we ignoring typecasting.
+        if(
+          actual.keys.sort != expected.keys.sort ||
+          actual.detect { |key, value| value.to_s != expected[key].to_s }
+        )
+          msg = new_backend.decode_fail_msg rescue nil
+          msg ||= "The given backend failed to decode the test string correctly"
+          raise LoadError, "#{msg}: #{new_backend.inspect}"
+        end
+      end
+      
+      # Must return a String representing the sub-directory where in-library
+      # backend rb files live (e.g. 'json/backends')
+      def backend_path
+        raise "This method must be defined by a format-specific OEmbed::Formatter sub-class."
+      end
+      
+      # Must return a String that when parsed by a backend returns the following ruby Hash
+      #   {
+      #     "version"=>1.0,
+      #     "string"=>"test",
+      #     "int"=>42,
+      #     "html"=>"<i>Cool's</i>\n the \"word\"!",
+      #   }
+      def test_value
+        raise "This method must be defined by a format-specific OEmbed::Formatter sub-class."
+      end
+  
+    end # SharedMethods
+  end
+end

data/lib/oembed/formatter/json.rb

@@ -6,16 +6,7 @@ module OEmbed
       DECODERS = %w(ActiveSupportJSON JSONGem Yaml)
       
       class << self
-        
-        # Returns true if there is a valid JSON backend. Otherwise, raises OEmbed::FormatNotSupported
-        def supported?
-          !!backend
-        end
-        
-        # Parses a JSON string or IO and convert it into an object
-        def decode(json)
-          backend.decode(json)
-        end
+        include ::OEmbed::Formatter::Base
         
         # Returns the current JSON backend.
         def backend
@@ -24,32 +15,6 @@ module OEmbed
           @backend
         end
 
-        def backend=(name)
-          if name.is_a?(Module)
-            @backend = name
-          else
-            already_required = false
-            begin 
-              already_required = OEmbed::Formatter::JSON::Backends.const_defined?(name, false)
-            rescue ArgumentError # we're dealing with ruby < 1.9 where const_defined? only takes 1 argument, but behaves the way we want it to.
-              already_required = OEmbed::Formatter::JSON::Backends.const_defined?(name)
-            rescue NameError # no backends have been loaded yet
-              already_required = false
-            end
-            
-            require "oembed/formatter/json/backends/#{name.to_s.downcase}" unless already_required
-            @backend = OEmbed::Formatter::JSON::Backends::const_get(name)
-          end
-          @parse_error = @backend::ParseError
-        end
-        
-        def with_backend(name)
-          old_backend, self.backend = backend, name
-          yield
-        ensure
-          self.backend = old_backend
-        end
-
         def set_default_backend
           DECODERS.find do |name|
             begin
@@ -62,7 +27,19 @@ module OEmbed
           end
         end
         
-      end
+        private
+        
+        def backend_path
+          'json/backends'
+        end
+        
+        def test_value
+          <<-JSON
+{"version":"1.0", "string":"test", "int":42,"html":"<i>Cool's</i>\\n the \\"word\\"\\u0021"}
+          JSON
+        end
+        
+      end # self
       
     end # JSON
   end

data/lib/oembed/formatter/json/backends/activesupportjson.rb

@@ -6,23 +6,23 @@ module OEmbed
     module JSON
       module Backends
         module ActiveSupportJSON
-          ParseError = ::ActiveSupport::JSON.parse_error
           extend self
 
           # Parses a JSON string or IO and convert it into an object.
           def decode(json)
             ::ActiveSupport::JSON.decode(json)
           end
+          
+          def decode_fail_msg
+            "The version of ActiveSupport::JSON you have installed isn't parsing JSON like ruby-oembed expected."
+          end
+          
+          def parse_error
+            ::ActiveSupport::JSON.parse_error
+          end
         
         end
       end
     end
   end
 end
-
-# Only allow this backend if it parses JSON strings the way we expect it to
-begin
-  raise unless OEmbed::Formatter.test_backend(OEmbed::Formatter::JSON::Backends::ActiveSupportJSON)
-rescue
-  raise LoadError, "The version of ActiveSupport::JSON you have installed isn't parsing JSON like ruby-oembed expected."
-end

data/lib/oembed/formatter/json/backends/jsongem.rb

@@ -6,7 +6,6 @@ module OEmbed
     module JSON
       module Backends
         module JSONGem
-          ParseError = ::JSON::ParserError
           extend self
 
           # Parses a JSON string or IO and convert it into an object.
@@ -16,16 +15,17 @@ module OEmbed
             end
             ::JSON.parse(json)
           end
+          
+          def decode_fail_msg
+            "The version of the json library you have installed isn't parsing JSON like ruby-oembed expected."
+          end
+          
+          def parse_error
+            ::JSON::ParserError
+          end
         
         end
       end
     end
   end
 end
-
-# Only allow this backend if it parses JSON strings the way we expect it to
-begin
-  raise unless OEmbed::Formatter.test_backend(OEmbed::Formatter::JSON::Backends::JSONGem)
-rescue
-  raise LoadError, "The version of the json library you have installed isn't parsing JSON like ruby-oembed expected."
-end