embedly 1.8.0 → 1.9.0

data/ChangeLog

@@ -1,3 +1,9 @@
+*embedly-1.9.0 (21 Jan 2014)
+	15 Jan 2014: Roman Shterenzon <romanbsd@yahoo.com>
+	Adds a Faraday request adapter
+	Remove Typhoeus as dependency, if it is installed manually, it will be
+		used by default
+
 *embedly-1.8.0 (17 Jun 2013)
 
 	17 Jun 2013: Felipe Elias Philipp <felipeelias@gmail.com>

data/Gemfile

@@ -4,16 +4,13 @@ gem "querystring"
 gem "oauth"
 gem "json"
 
-platforms :mri do
-  gem "typhoeus"
-end
-
 group :development do
+  gem "typhoeus"
   gem "jeweler"
   gem "cucumber"
   gem "rake"
   gem "rspec"
   gem "yard"
   gem "aruba"
+  gem "faraday"
 end
-

data/README.md

@@ -0,0 +1,114 @@
+# embedly
+
+embedly is the Embedly Ruby client library and commandline tool.  It allows
+you to integrate Embedly into your Ruby applications, as well as use
+Embedly's API from the commandline.
+
+To find out what Embedly is all about, please visit http://embed.ly.  To see
+our api documentation, visit http://api.embed.ly/docs.
+
+## Installing
+
+To install the official latest stable version, please use rubygems.
+
+    gem install embedly
+
+If you would like cutting edge, then you can clone and install HEAD.
+
+    git clone git://github.com/embedly/embedly-ruby.git
+    cd embedly-ruby
+    rake install
+
+## Requirements
+
+* querystring <https://github/dokipen/querystring>
+
+## Getting Started
+
+You can find rdocs at http://rubydoc.info/github/embedly/embedly-ruby/master/frames
+
+```ruby
+require 'embedly'
+require 'json'
+
+embedly_api =
+  Embedly::API.new :user_agent => 'Mozilla/5.0 (compatible; mytestapp/1.0; my@email.com)'
+
+# single url
+obj = embedly_api.oembed :url => 'http://www.youtube.com/watch?v=sPbJ4Z5D-n4&feature=topvideos'
+puts obj[0].marshal_dump
+json_obj = JSON.pretty_generate(obj[0].marshal_dump)
+puts json_obj
+
+# multiple urls with opts
+objs = embedly_api.oembed(
+  :urls => ['http://www.youtube.com/watch?v=sPbJ4Z5D-n4&feature=topvideos',
+            'http://twitpic.com/3yr7hk'],
+  :maxwidth => 450,
+  :wmode => 'transparent',
+  :method => 'after'
+)
+json_obj = JSON.pretty_generate(objs.collect{|o| o.marshal_dump})
+puts json_obj
+
+# call api with key (you'll need a real key)
+embedly_api = Embedly::API.new :key => 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
+        :user_agent => 'Mozilla/5.0 (compatible; mytestapp/1.0; my@email.com)'
+url = 'http://www.guardian.co.uk/media/2011/jan/21/andy-coulson-phone-hacking-statement'
+obj = embedly_api.extract :url => url
+puts JSON.pretty_generate(obj[0].marshal_dump)
+```
+
+## Configuration options
+
+You can configure some parameters in the api:
+
+```ruby
+Embedly.configure do |config|
+ # prints debug messages to the logger
+ config.debug = true
+
+ # use a custom logger
+ config.logger = MyAwesomeLogger.new(STDERR)
+
+ # Choose a request adatper (net_http, typhoeus or faraday)
+ config.request_with :faraday
+end
+```
+
+## Testing
+
+    gem install jeweler
+    rake spec
+    rake features # if it complains of missing deps install them
+
+Some tests will fail due to missing api key.  Set the `EMBEDLY_KEY` environmental
+variable with your key to get them to pass.
+
+    EMBEDLY_KEY=xxxxxxxxxxxxx rake features
+
+To turn on debugging, set the `EMBEDLY_VERBOSE` environmental variable.
+
+    EMBEDLY_VERBOSE=1 EMBEDLY_KEY=xxxxxxxxxxx rake features
+
+We have provided some commandline tools to test the Embedly interface.
+
+* embedly_oembed
+* embedly_objectify
+* embedly_preview
+
+Using `--help` with the commands should give you a good idea of how to use them.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Embed.ly, Inc. See MIT-LICENSE for details.

data/Rakefile

@@ -19,12 +19,13 @@ Jeweler::Tasks.new do |gem|
   gem.email = "bob@embed.ly"
   gem.homepage = "http://github.com/embedly/embedly-ruby"
   gem.authors = [
-                 "Bob Corsaro", 
+                 "Bob Corsaro",
                  "Felipe Elias Philipp",
-                 "Russ Bradberry", 
+                 "Russ Bradberry",
                  "Arun Thampi",
                  "Anton Dieterle",
-                 "Nitesh"
+                 "Nitesh",
+                 "Roman Shterenzon",
                 ]
   gem.license = "MIT"
 

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.9.0

data/embedly.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "embedly"
-  s.version = "1.8.0"
+  s.version = "1.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Bob Corsaro", "Felipe Elias Philipp", "Russ Bradberry", "Arun Thampi", "Anton Dieterle", "Nitesh"]
-  s.date = "2013-06-17"
+  s.authors = ["Bob Corsaro", "Felipe Elias Philipp", "Russ Bradberry", "Arun Thampi", "Anton Dieterle", "Nitesh", "Roman Shterenzon"]
+  s.date = "2014-01-21"
   s.description = "Ruby Embedly client library"
   s.email = "bob@embed.ly"
   s.executables = ["embedly_extract", "embedly_objectify", "embedly_oembed", "embedly_preview"]
   s.extra_rdoc_files = [
     "ChangeLog",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     "ChangeLog",
     "Gemfile",
     "MIT-LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/embedly_extract",
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     "lib/embedly/model.rb",
     "lib/embedly/request.rb",
     "lib/embedly/request/base.rb",
+    "lib/embedly/request/faraday.rb",
     "lib/embedly/request/net_http.rb",
     "lib/embedly/request/typhoeus.rb",
     "spec/embedly/api_spec.rb",
@@ -53,7 +54,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/embedly/embedly-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.24"
   s.summary = "Ruby Embedly client library"
 
   if s.respond_to? :specification_version then
@@ -63,13 +64,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<querystring>, [">= 0"])
       s.add_runtime_dependency(%q<oauth>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+      s.add_development_dependency(%q<typhoeus>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<aruba>, [">= 0"])
+      s.add_development_dependency(%q<faraday>, [">= 0"])
     else
       s.add_dependency(%q<querystring>, [">= 0"])
       s.add_dependency(%q<oauth>, [">= 0"])
@@ -81,6 +83,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<aruba>, [">= 0"])
+      s.add_dependency(%q<faraday>, [">= 0"])
     end
   else
     s.add_dependency(%q<querystring>, [">= 0"])
@@ -93,6 +96,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<aruba>, [">= 0"])
+    s.add_dependency(%q<faraday>, [">= 0"])
   end
 end
 

data/features/command_line.feature

@@ -6,7 +6,7 @@ Feature: Command line runner
     When I run `embedly_oembed http://lockerz.com/s/136425091`
     Then the output should contain:
       """
-      "provider_url": "http://lockerz.com"
+      "provider_url": "http://pics.lockerz.com"
       """
 
   Scenario: Run oembed command verbosely

data/features/objectify.feature

@@ -12,4 +12,4 @@ Feature: Objectify
 
         Examples:
             | url                            | metadesc                                  |
-            | http://lockerz.com/s/136425091 | Top finds from friends & celebrities. Get |
+            | http://lockerz.com/s/136425091 | Collect the things you love. Earn         |

data/features/oembed.feature

@@ -16,8 +16,6 @@ Feature: OEmbed
             | http://www.youtube.com/watch?v=Zk7dDekYej0                                       | http://www.youtube.com/    |
             | http://yfrog.com/h7qqespj                                                        | http://yfrog.com           |
             | http://blog.embed.ly/bob                                                         | http://tumblr.com          |
-            | http://blog.doki-pen.org/cassandra-rules                                         | http://blog.doki-pen.org   |
-            | http://www.guardian.co.uk/media/2011/jan/21/andy-coulson-phone-hacking-statement | http://www.guardian.co.uk  |
 
 
     Scenario Outline: Get the types
@@ -65,7 +63,7 @@ Feature: OEmbed
             | url                                                              |
             | http://www.youtube.com/watch/is/a/bad/url                        |
             | http://fav.me/alsfsdf                                            |
-        
+
 
     Scenario Outline: Attempt multi get 404 URLs
         Given an embedly api with key
@@ -77,8 +75,8 @@ Feature: OEmbed
             | urls                                                                             | errcode | types       |
             | http://www.youtube.com/watch/a/bassd/url,http://www.youtube.com/watch/ldf/asdlfj | 404,404 | error,error |
             | http://www.youtube.com/watch/zzzzasdf/kl,http://yfrog.com/h7qqespj               | 404,    | error,photo |
-            | http://yfrog.com/h7qqespj,http://www.youtube.com/watch/asdfasdfasdf              | ,404    | photo,error |
-            
+            | http://yfrog.com/h7qqespj,http://www.youtube.com/watch/asdfasdf/asdf             | ,404    | photo,error |
+
     Scenario Outline: Attempt to get 414 URL
         Given an embedly api with key
         When oembed is called with the <url> URL

data/lib/embedly/configuration.rb

@@ -85,7 +85,7 @@ class Embedly::Configuration
   def reset
     self.logger   = default_logger
     self.debug    = false
-    self.request_with :typhoeus
+    self.request_with :net_http
   end
 
   private

data/lib/embedly/request.rb

@@ -1,3 +1,4 @@
 require "embedly/request/base"
 require "embedly/request/net_http"
 require "embedly/request/typhoeus"
+require "embedly/request/faraday"

data/lib/embedly/request/faraday.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+# Patch Faraday::Response to provide a status code
+module Faraday
+  class Response
+    alias_method :code, :status unless method_defined?(:code)
+  end
+end
+
+module Embedly
+  module Request
+    class Faraday < Base
+      def get(uri, options = {})
+        ::Faraday.get(uri.to_s, nil, options[:headers])
+      end
+    end
+  end
+end
+
+Embedly.configuration.add_requester :faraday do |api|
+  Embedly::Request::Faraday.new(api)
+end

data/lib/embedly/request/typhoeus.rb

@@ -19,7 +19,4 @@ begin
     Embedly::Typhoeus::Request.new(api)
   end
 rescue LoadError
-  require "logger"
-  logger = Logger.new(STDERR)
-  logger.warn { "typhoeus failed to load" }
 end

data/spec/embedly/api_spec.rb

@@ -41,6 +41,23 @@ module Embedly
           api.request.should be_a(Embedly::Typhoeus::Request)
         end
       end
+
+      describe "faraday" do
+        before do
+          Embedly.configure { |c| c.request_with :faraday }
+        end
+
+        it "sets the correct request adapter" do
+          api.request.should be_a(Embedly::Request::Faraday)
+        end
+
+        it "calls faraday" do
+          url = 'http://example.com'
+          headers = {'User-Agent'=>'spec'}
+          Faraday.should_receive(:get).with(url, nil, headers)
+          api.request.get(URI.parse(url), headers: headers)
+        end
+      end
     end
   end
 end

data/spec/embedly/command_line_spec.rb

@@ -10,7 +10,7 @@ module Embedly
 
     describe "::run!" do
       let(:arguments) { ['-k', 'MY_KEY', '--no-secret', 'http://yfrog.com/h7qqespj', '-o', 'maxwidth=10'] }
-      let(:api) { mock(API) }
+      let(:api) { double(API) }
 
       it "calls api with options" do
         API.should_receive(:new).with(:key => 'MY_KEY', :headers => {}) { api }

data/spec/embedly/configuration_spec.rb

@@ -49,8 +49,8 @@ module Embedly
         config.key.should == 'my_api_key'
       end
 
-      it "requests typhoeus by default" do
-        config.requester.should == :typhoeus
+      it "requests using Net::HTTP by default" do
+        config.requester.should == :net_http
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embedly
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,10 +11,11 @@ authors:
 - Arun Thampi
 - Anton Dieterle
 - Nitesh
+- Roman Shterenzon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: querystring
@@ -72,7 +73,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -176,6 +177,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Embedly client library
 email: bob@embed.ly
 executables:
@@ -186,12 +203,12 @@ executables:
 extensions: []
 extra_rdoc_files:
 - ChangeLog
-- README.rdoc
+- README.md
 files:
 - ChangeLog
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/embedly_extract
@@ -213,6 +230,7 @@ files:
 - lib/embedly/model.rb
 - lib/embedly/request.rb
 - lib/embedly/request/base.rb
+- lib/embedly/request/faraday.rb
 - lib/embedly/request/net_http.rb
 - lib/embedly/request/typhoeus.rb
 - spec/embedly/api_spec.rb
@@ -234,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1864796039289790567
+      hash: -3010721165708634299
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -243,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby Embedly client library

data/README.rdoc

@@ -1,108 +0,0 @@
-= embedly
-
-embedly is the Embedly Ruby client library and commandline tool.  It allows
-you to integrate Embedly into your Ruby applications, as well as use
-Embedly's API from the commandline.
-
-To find out what Embedly is all about, please visit http://embed.ly.  To see
-our api documentation, visit http://api.embed.ly/docs.
-
-== Installing
-
-To install the official latest stable version, please use rubygems.
-
-  gem install embedly
-
-If you would like cutting edge, then you can clone and install HEAD.
-
-  git clone git://github.com/embedly/embedly-ruby.git
-  cd embedly-ruby
-  rake install
-
-== Requirements
-
-  * querystring <https://github/dokipen/querystring>
-
-== Getting Started
-
-You can find rdocs at http://rubydoc.info/github/embedly/embedly-ruby/master/frames
-
-  require 'embedly'
-  require 'json'
-
-  embedly_api = Embedly::API.new :user_agent => 'Mozilla/5.0 (compatible; mytestapp/1.0; my@email.com)'
-
-  # single url
-  obj = embedly_api.oembed :url => 'http://www.youtube.com/watch?v=sPbJ4Z5D-n4&feature=topvideos'
-  puts obj[0].marshal_dump
-  json_obj = JSON.pretty_generate(obj[0].marshal_dump)
-  puts json_obj
-
-  # multiple urls with opts
-  objs = embedly_api.oembed(
-    :urls => ['http://www.youtube.com/watch?v=sPbJ4Z5D-n4&feature=topvideos', 'http://twitpic.com/3yr7hk'],
-    :maxwidth => 450,
-    :wmode => 'transparent',
-    :method => 'after'
-  )
-  json_obj = JSON.pretty_generate(objs.collect{|o| o.marshal_dump})
-  puts json_obj
-
-  # call api with key (you'll need a real key)
-  embedly_api = Embedly::API.new :key => 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
-          :user_agent => 'Mozilla/5.0 (compatible; mytestapp/1.0; my@email.com)'
-  url = 'http://www.guardian.co.uk/media/2011/jan/21/andy-coulson-phone-hacking-statement'
-  obj = embedly_api.preview :url => url
-  puts JSON.pretty_generate(obj[0].marshal_dump)
-
-== Configuration options
-
-You can configure some parameters in the api:
-
- Embedly.configure do |config|
-   # prints debug messages to the logger
-   config.debug = true
-
-   # use a custom logger
-   config.logger = MyAwesomeLogger.new(STDERR)
-
-   # disable typhoeus and use Net::HTTP instead
-   config.request_with :net_http
- end
-
-== Testing
-
-  gem install jeweler
-  rake spec
-  rake features # if it complains of missing deps install them
-
-Some tests will fail due to missing api key.  Set the EMBEDLY_KEY environmental
-variable with your key to get them to pass.
-
-  EMBEDLY_KEY=xxxxxxxxxxxxx rake features
-
-To turn on debugging, set the EMBEDLY_VERBOSE environmental variable.
-
-  EMBEDLY_VERBOSE=1 EMBEDLY_KEY=xxxxxxxxxxx rake features
-
-We have provided some commandline tools to test the Embedly interface.
-
-  * embedly_oembed
-  * embedly_objectify
-  * embedly_preview
-
-Using --help with the commands should give you a good idea of how to use them.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2011 Embed.ly, Inc. See MIT-LICENSE for details.