embedly 0.2.0 → 0.3.0

data/README.rdoc

@@ -27,8 +27,8 @@ You can find rdocs at http://rubydoc.info/github/embedly/embedly-ruby/master/fra
 
   # single url
   obj = embedly_api.oembed :url => 'http://blog.embed.ly'
-  puts obj.marshal_dump
-  json_obj = JSON.pretty_generate(obj.marshal_dump)
+  puts obj[0].marshal_dump
+  json_obj = JSON.pretty_generate(obj[0].marshal_dump)
   puts json_obj
 
   # multiple urls with opts
@@ -45,7 +45,7 @@ You can find rdocs at http://rubydoc.info/github/embedly/embedly-ruby/master/fra
   embedly_pro = Embedly::API.new :key => 'xxxxxxxxxxxxxxxxxxxxxxxxxx'
   url = 'http://www.guardian.co.uk/media/2011/jan/21/andy-coulson-phone-hacking-statement'
   obj = embedly_pro.preview :url => url
-  puts JSON.pretty_generate(obj.marshal_dump)
+  puts JSON.pretty_generate(obj[0].marshal_dump)
 
 == Testing
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/embedly_objectify

@@ -4,7 +4,7 @@ $:.unshift(File.expand_path('../../lib', __FILE__))
 
 options = OpenStruct.new({
   :endpoint => nil,
-  :key => nil,
+  :key => ENV['EMBEDLY_KEY'],
   :verbose => false,
   :args => {}
 })
@@ -26,11 +26,13 @@ Usage #{action} [OPTIONS] <url> [url] ..
     options.endpoint = e
   end
 
-  opts.on("-k", "--key KEY", "Embedly PRO key") do |k|
+  opts.on("-k", "--key KEY", "Embedly PRO key [default: " +
+                             "EMBEDLY_KEY environmental variable]") do |k|
     options.key = k
   end
 
-  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as query param.") do |o|
+  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as " +
+                                       "query param.") do |o|
     k,v = o.split('=')
     options.args[k] = v
   end

data/bin/embedly_oembed

@@ -4,7 +4,7 @@ $:.unshift(File.expand_path('../../lib', __FILE__))
 
 options = OpenStruct.new({
   :endpoint => nil,
-  :key => nil,
+  :key => ENV['EMBEDLY_KEY'],
   :verbose => false,
   :args => {}
 })
@@ -26,11 +26,13 @@ Usage #{action} [OPTIONS] <url> [url] ..
     options.endpoint = e
   end
 
-  opts.on("-k", "--key KEY", "Embedly PRO key") do |k|
+  opts.on("-k", "--key KEY", "Embedly PRO key [default: " +
+                             "EMBEDLY_KEY environmental variable]") do |k|
     options.key = k
   end
 
-  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as query param.") do |o|
+  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as " +
+                                       "query param.") do |o|
     k,v = o.split('=')
     options.args[k] = v
   end

data/bin/embedly_preview

@@ -4,7 +4,7 @@ $:.unshift(File.expand_path('../../lib', __FILE__))
 
 options = OpenStruct.new({
   :endpoint => nil,
-  :key => nil,
+  :key => ENV['EMBEDLY_KEY'],
   :verbose => false,
   :args => {}
 })
@@ -26,11 +26,13 @@ Usage #{action} [OPTIONS] <url> [url] ..
     options.endpoint = e
   end
 
-  opts.on("-k", "--key KEY", "Embedly PRO key") do |k|
+  opts.on("-k", "--key KEY", "Embedly PRO key [default: " +
+                             "EMBEDLY_KEY environmental variable]") do |k|
     options.key = k
   end
 
-  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as query param.") do |o|
+  opts.on("-o", "--option NAME=VALUE", "Set option to be passed as " +
+                                       "query param.") do |o|
     k,v = o.split('=')
     options.args[k] = v
   end

data/features/oembed.feature

@@ -72,8 +72,8 @@ Feature: OEmbed
 
         Examples:
             | url                                                              |
-            | http://www.youtube.com/this/is/a/bad/url                         |
-            | http://blog.embed.ly/lsbsdlfldsf/asdfkljlas/klajsdlfkasdf        |
+            | http://www.youtube.com/watch/is/a/bad/url                        |
+            | http://www.scribd.com/doc/zfldsf/asdfkljlas/klajsdlfkasdf        |
             | http://tweetphoto.com/alsdfldsf/asdfkljlas/klajsdlfkasdf         |
         
 
@@ -85,8 +85,22 @@ Feature: OEmbed
 
         Examples:
             | urls                                                                             | errcode | types       |
-            | http://www.youtube.com/this/is/a/bad/url,http://blog.embed.ly/alsd/slsdlf/asdlfj | 404,404 | error,error |
-            | http://blog.embed.ly/lsbsdlfldsf/asdf/kl,http://tweetphoto.com/asdf/asdf/asdfl   | 404,404 | error,error |
-            | http://blog.embed.ly/lsbsdlfldsf/asdf/kl,http://tweetphoto.com/14784358          | 404,    | error,photo |
-            | http://tweetphoto.com/14784358,http://www.scribd.com/asdf/asdf/asdfasdf          | ,404    | photo,error |
+            | http://www.youtube.com/watch/a/bassd/url,http://www.youtube.com/watch/ldf/asdlfj | 404,404 | error,error |
+            | http://www.scribd.com/doc/lsbsdlfldsf/kl,http://www.scribd.com/doc/zasdf/asdfl   | 404,404 | error,error |
+            | http://www.youtube.com/watch/zzzzasdf/kl,http://tweetphoto.com/14784358          | 404,    | error,photo |
+            | http://tweetphoto.com/14784358,http://www.scribd.com/doc/asdfasdfasdf            | ,404    | photo,error |
         
+    Scenario Outline: Attempt at non-api service without key
+        Given an embedly endpoint
+        When oembed is called with the <url> URL
+        Then error_code should be 401
+        And error_message should be This service requires an Embedly Pro account
+        And type should be error
+
+        Examples:
+            | urls                                                                             | 
+            | http://hn.embed.ly/                                                              | 
+            | http://bit.ly/enZRxO                                                             | 
+            | http://techcrunch.com/2011/02/03/linkedins-next-data-dive-professional-skills/   | 
+            | http://teachertube.com/rssPhoto.php                                              | 
+            | http://goo.gl/y1i9p                                                              | 

data/features/steps/api_steps.rb

@@ -1,6 +1,9 @@
 $:.unshift(File.expand_path('../../../lib',__FILE__))
 require 'embedly'
 
+# cache for endpoints
+ENDPOINTS = {}
+
 Given /an embedly endpoint( [^\s]+)?( with key)?$/ do |endpoint, key_enabled|
   opts = {}
   opts[:endpoint] = endpoint
@@ -8,38 +11,47 @@ Given /an embedly endpoint( [^\s]+)?( with key)?$/ do |endpoint, key_enabled|
     raise 'Please set env variable $EMBEDLY_KEY' unless ENV['EMBEDLY_KEY']
     opts[:key] = ENV["EMBEDLY_KEY"] 
   end
-  @api = Embedly::API.new opts
+  if not ENDPOINTS[opts]
+    ENDPOINTS[opts] = Embedly::API.new opts
+  end
+  @api = ENDPOINTS[opts]
 end
 
 When /(\w+) is called with the (.*) URLs?( and ([^\s]+) flag)?$/ do |method, urls, _, flag|
-  urls = urls.split(',')
-  opts = {}
-  if urls.size == 1
-    opts[:url] = urls.first
-  else
-    opts[:urls] = urls
+  @result = nil
+  begin
+    urls = urls.split(',')
+    opts = {}
+    if urls.size == 1
+      opts[:url] = urls.first
+    else
+      opts[:urls] = urls
+    end
+    opts[flag.to_sym] = true if flag
+    @result = @api.send(method, opts)
+  rescue
+    @error = $!
   end
-  opts[flag.to_sym] = true if flag
-  @result = @api.send(method, opts)
 end
 
-Then /([^\s]+) should be ([^\s]+)/ do |key, value|
+Then /an? (\w+) error should get thrown/ do |error|
+  @error.class.to_s.should == error
+end
+
+Then /([^\s]+) should be (.+)$/ do |key, value|
+  raise @error if @error
   logger = Embedly.logger('api_steps')
-  if @result.is_a?Array
-    @result.collect do |o|  
-      logger.debug { "result: #{o.marshal_dump}"}
-      o.send(key).to_s
-    end.join(',').should == value
-  else
-    logger.debug { "result: #{@result.marshal_dump}"}
-    @result.send(key).to_s.should == value
-  end
+  @result.collect do |o|  
+    logger.debug { "result: #{o.marshal_dump}"}
+    o.send(key).to_s
+  end.join(',').should == value
 end
 
 Then /([^\s]+) should start with ([^\s]+)/ do |key, value|
+  raise @error if @error
   logger = Embedly.logger('api_steps')
-  logger.debug { "result: #{@result.marshal_dump}"}
-  v = key.split('.').inject(@result){|o,c| o.send(c)}.to_s
+  logger.debug { "result: #{@result[0].marshal_dump}"}
+  v = key.split('.').inject(@result[0]){|o,c| o.send(c)}.to_s
   v.to_s.should match(/^#{value}/)
 end
 

data/lib/embedly/api.rb

@@ -20,7 +20,7 @@ include ::Embedly
 #
 #   api = Embedly::API.new
 #   obj = api.oembed :url => 'http://blog.doki-pen.org/'
-#   puts obj.title, obj.description, obj.thumbnail_url
+#   puts obj[0].title, obj[0].description, obj[0].thumbnail_url
 #
 # Call parameters should be passed as the opts parameter.  If set, key will
 # automatically be added to the query string of the call, so no need to set it.
@@ -49,7 +49,7 @@ class Embedly::API
     else
       @endpoint = opts[:endpoint] || 'api.embed.ly'
     end
-    @api_versions = Hash.new('1').merge!({'objectify' => '2'})
+    @api_version = Hash.new('1').merge!({'objectify' => '2'})
     @user_agent = opts[:user_agent] || "Mozilla/5.0 (compatible; embedly-ruby/#{Embedly::VERSION};)"
   end
 
@@ -71,46 +71,82 @@ class Embedly::API
 
     raise 'must pass urls' if opts[:urls].size == 0
 
-    if opts[:urls].size == 1
-      params = {:url => opts[:urls].first}
-    else
-      params = {:urls => opts[:urls]}
+    params = {:urls => opts[:urls]}
+
+    # store unsupported services as errors and don't send them to embedly
+    rejects = []
+    if not key
+      params[:urls].reject!.with_index do |url, i| 
+        if url !~ services_regex
+          rejects << [i, 
+            EmbedlyObject.new(
+              :type => 'error', 
+              :error_code => 401, 
+              :error_message => 'This service requires an Embedly Pro account'
+            )
+          ]
+        end
+      end
     end
 
-    params[:key] = key if key
-    params.merge!Hash[
-      opts.select{|k,_| not [:url, :urls, :action, :version].index k}
-    ]
+    if params[:urls].size > 0
+      params[:key] = key if key
+      params.merge!Hash[
+        opts.select{|k,_| not [:url, :urls, :action, :version].index k}
+      ]
 
-    path = "/#{opts[:version]}/#{opts[:action]}?#{q params}"
+      path = "/#{opts[:version]}/#{opts[:action]}?#{q params}"
 
-    ep = endpoint
-    ep = "http://#{ep}" if endpoint !~ %r{^https?://.*}
-    logger.debug { "calling #{ep}#{path}" }
+      logger.debug { "calling #{endpoint}#{path}" }
 
-    url = URI.parse(ep)
-    response = Net::HTTP.start(url.host, url.port) do |http|
-      http.get(path, {'User-Agent' => user_agent})
-    end
+      url = URI.parse(absurl(endpoint))
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.get(path, {'User-Agent' => user_agent})
+      end
+
+      if response.code.to_i == 200
+        logger.debug { response.body }
+        # [].flatten is to be sure we have an array
+        objs = [JSON.parse(response.body)].flatten.collect {|o| EmbedlyObject.new(o)}
+      else
+        logger.error { response.inspect }
+        raise 'An unexpected error occurred'
+      end
 
-    # passing url vs. urls causes different things to happen on errors (like a
-    # 404 for the URL).  using the url parameter returns a non 200 error code
-    # in the response.  Using urls causes an error json object to be returned,
-    # but the main call will still be status 200.  Below, we try to canonize as
-    # best we can but it should really be changed server side.
-    if response.code.to_i == 200
-      logger.debug { response.body }
-      # [].flatten is to be sure we have an array
-      objs = [JSON.parse(response.body)].flatten.collect {|o| EmbedlyObject.new(o)}
+      # re-insert rejects into response
+      rejects.each do |i, obj|
+        objs.insert i, obj
+      end
+
+      objs
     else
-      objs = EmbedlyObject.new :type => 'error', :error_code => response.code.to_i
+      # we only have rejects, return them without calling embedly
+      rejects.collect{|i, obj| obj}
     end
+  end
 
-    if objs.size == 1
-      objs.first
-    else
-      objs
+  # Returns structured data from the services API method.
+  #
+  # Response is cached per API object.  
+  #
+  # see http://api.embed.ly/docs/service for a description of the response.
+  def services
+    logger.warn { "services isn't availble on the pro endpoint" } if key
+    if not @services
+      url = URI.parse(absurl(endpoint))
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.get('/1/services/ruby', {'User-Agent' => user_agent})
+      end
+      raise 'services call failed', response if response.code.to_i != 200
+      @services = JSON.parse(response.body)
     end
+    @services
+  end
+
+  # Returns a regex suitable for checking urls against for non-Pro usage
+  def services_regex
+    r = services.collect {|p| p["regex"].join("|")}.join("|")
+    Regexp.new r
   end
 
   # Performs api call based on method name
@@ -124,11 +160,15 @@ class Embedly::API
   def method_missing(name, *args, &block)
     opts = args[0]
     opts[:action] = name
-    opts[:version] = @api_versions[name]
+    opts[:version] = @api_version[name]
     apicall opts
   end
 
   private
+  def absurl uri
+    uri !~ %r{^https?://.*} ? "http://#{uri}" : uri
+  end
+  
   # Escapes url parameters
   # TODO: move to utils
   def escape s

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bob Corsaro
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -05:00
+date: 2011-02-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency