embedly 1.7.1 → 1.8.0

data/ChangeLog

@@ -1,3 +1,21 @@
+*embedly-1.8.0 (17 Jun 2013)
+
+	17 Jun 2013: Felipe Elias Philipp <felipeelias@gmail.com>
+	Abstracts http client to allow for custom requesters
+
+	17 Jun 2013: Nitesh <me@coffeebite.com>
+	Gets key from Embedly::Configuration
+
+*embedly-1.7.0 (17 Jun 2013)
+
+	17 Jun 2013: Anton Dieterle <antondie@gmail.com>
+	Adds Net::HTTP::Proxy support
+
+*embedly-1.6.0 (2 Apr 2013)
+
+	2 Apr 2013: Bob Corsaro <bob@embed.ly>
+	Adds extract endpoint
+
 *embedly-1.5.6 (23 May 2012)
 
 	23 May 2012: Bob Corsaro <bob@embed.ly>

data/README.rdoc

@@ -67,7 +67,7 @@ You can configure some parameters in the api:
    config.logger = MyAwesomeLogger.new(STDERR)
 
    # disable typhoeus and use Net::HTTP instead
-   config.typhoeus = false
+   config.request_with :net_http
  end
 
 == Testing

data/Rakefile

@@ -22,7 +22,9 @@ Jeweler::Tasks.new do |gem|
                  "Bob Corsaro", 
                  "Felipe Elias Philipp",
                  "Russ Bradberry", 
-                 "Arun Thampi"
+                 "Arun Thampi",
+                 "Anton Dieterle",
+                 "Nitesh"
                 ]
   gem.license = "MIT"
 

data/VERSION

@@ -1 +1 @@
-1.7.1
+1.8.0

data/embedly.gemspec

@@ -5,10 +5,10 @@
 
 Gem::Specification.new do |s|
   s.name = "embedly"
-  s.version = "1.7.1"
+  s.version = "1.8.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"]
+  s.authors = ["Bob Corsaro", "Felipe Elias Philipp", "Russ Bradberry", "Arun Thampi", "Anton Dieterle", "Nitesh"]
   s.date = "2013-06-17"
   s.description = "Ruby Embedly client library"
   s.email = "bob@embed.ly"
@@ -41,6 +41,10 @@ Gem::Specification.new do |s|
     "lib/embedly/configuration.rb",
     "lib/embedly/exceptions.rb",
     "lib/embedly/model.rb",
+    "lib/embedly/request.rb",
+    "lib/embedly/request/base.rb",
+    "lib/embedly/request/net_http.rb",
+    "lib/embedly/request/typhoeus.rb",
     "spec/embedly/api_spec.rb",
     "spec/embedly/command_line_spec.rb",
     "spec/embedly/configuration_spec.rb",

data/lib/embedly/api.rb

@@ -1,16 +1,11 @@
-require 'net/http'
-require 'net/https'
 require 'json'
 require 'ostruct'
 require 'embedly/configuration'
 require 'embedly/model'
 require 'embedly/exceptions'
+require 'embedly/request'
 require 'querystring'
 require 'oauth'
-begin
-  require 'typhoeus'
-rescue LoadError => e
-end
 
 # Performs api calls to embedly.
 #
@@ -55,11 +50,11 @@ class Embedly::API
   # [:+proxy+] Proxy settings in format {:host => '', :port => '', :user => '', :password => ''}
   def initialize opts={}
     @endpoints = [:oembed, :objectify, :preview, :extract]
-    @key = opts[:key]
+    @key = opts[:key] || configuration.key
     @secret = opts[:secret] == "" ? nil : opts[:secret]
     @api_version = Hash.new('1')
     @api_version.merge!({:objectify => '2'})
-    @hostname = opts[:hostname] || 'api.embed.ly'
+    @hostname = opts[:hostname] || 'http://api.embed.ly'
     @timeout = opts[:timeout] || 180
     @headers = {
       'User-Agent' => opts[:user_agent] || "Mozilla/5.0 (compatible; embedly-ruby/#{Embedly::VERSION};)"
@@ -67,31 +62,6 @@ class Embedly::API
     @proxy = opts[:proxy]
   end
 
-  def _do_typhoeus_call path
-    logger.debug { 'using Typhoeus HTTP Client' }
-    scheme, host, port = uri_parse hostname
-    url = "#{scheme}://#{hostname}:#{port}#{path}"
-    logger.debug { "calling #{site}#{path} with headers #{headers} using Typhoeus" }
-    Typhoeus::Request.get(url, {:headers => headers, :timeout => (@timeout*1000) })
-  end
-
-  def _do_basic_call path
-    logger.debug { 'using Net:HTTP client' }
-    scheme, host, port = uri_parse hostname
-    logger.debug { "calling #{site}#{path} with headers #{headers} using Net::HTTP" }
-    http_class = if proxy
-      logger.debug { 'using Net::HTTP::Proxy' }
-      http_class = Net::HTTP::Proxy(proxy[:host], proxy[:port], proxy[:user], proxy[:password])
-    else
-      Net::HTTP
-    end
-    http_class.start(host, port) do |http|
-      http.use_ssl = (scheme == 'https')
-      http.read_timeout = @timeout
-      http.get(path, headers)
-    end
-  end
-
   def _do_oauth_call path
     consumer = OAuth::Consumer.new(key, secret,
       :site => site,
@@ -109,7 +79,9 @@ class Embedly::API
     if key and secret
       _do_oauth_call path
     else
-      configuration.typhoeus ? _do_typhoeus_call(path) : _do_basic_call(path)
+      logger.debug { "calling #{site}#{path} with headers #{headers} using #{request}" }
+      uri = URI.join(hostname, path)
+      request.get(uri, :headers => headers, :timeout => @timeout, :proxy => @proxy)
     end
   end
 
@@ -230,7 +202,12 @@ class Embedly::API
     end
   end
 
+  def request
+    configuration.current_requester.call(self)
+  end
+
   private
+
   def uri_parse uri
     uri =~ %r{^((http(s?))://)?([^:/]+)(:([\d]+))?(/.*)?$}
     scheme = $2 || 'http'

data/lib/embedly/command_line.rb

@@ -1,12 +1,5 @@
 require "optparse"
 
-begin
-  require "typhoeus"
-  Embedly.configuration.typhoeus = true
-rescue LoadError
-  Embedly.configuration.typhoeus = false
-end
-
 module Embedly
   class CommandLine
 
@@ -40,8 +33,7 @@ module Embedly
           :secret => ENV['EMBEDLY_SECRET'],
           :timeout => nil,
           :headers => {},
-          :query => {},
-          :typhoeus => Embedly.configuration.typhoeus
+          :query => {}
         }
       end
 
@@ -99,7 +91,7 @@ Usage [OPTIONS] <url> [url] ..
           end
 
           parser.on("--no-typhoeus", "Don't use typhoeus.") do
-            Embedly.configuration.typhoeus = false
+            Embedly.configuration.request_with :net_http
           end
 
           parser.separator ""

data/lib/embedly/configuration.rb

@@ -6,6 +6,7 @@ require 'logger'
 #
 # * [+debug+] Prints debugging information to logger. Default +false+. Errors still will be logged
 # * [+logger+] Configure the logger; set this if you want to use a custom logger.
+# * [+request_with+] Sets the desired library to perform requests. Default is +Typhoeus+
 #
 # === Usage
 #
@@ -15,10 +16,13 @@ require 'logger'
 #
 #     # customize the logger
 #     config.logger = MyAwesomeLogger.new(STDERR)
+#
+#     # performs requests with net/http
+#     config.request_with :net_http
 #   end
 #
 class Embedly::Configuration
-  attr_accessor :key, :typhoeus # :nodoc:
+  attr_accessor :key, :requester # :nodoc:
 
   def initialize # :nodoc:
     self.reset
@@ -41,10 +45,47 @@ class Embedly::Configuration
     set_logger_level(self.debug?)
   end
 
+  # Configures a new requester
+  #
+  # To add a new requester class, you can do the following:
+  #
+  #    Embedly.configuration.add_requester :custom do |api|
+  #      MyRequester.new(api)
+  #    end
+  #
+  # The requester class should respond to +get+ method, which performs the request
+  # for more details, see +embedly/request/base.rb+
+  def add_requester(name, &block)
+    requesters[name] = block
+  end
+
+  def requesters # :nodoc:
+    @requesters ||= {}
+  end
+
+  # Sets api to use the desired requester class
+  #
+  # When configuring the API, you can do the following:
+  #
+  #    Embedly.configure do |config|
+  #      config.request_with :net_http
+  #    end
+  #
+  # This way, the API will use the +net_http+ class to perform requests
+  def request_with(adapter_name)
+    self.requester = adapter_name
+  end
+
+  # Returns the current configured request block
+  def current_requester
+    requesters[requester]
+  end
+
   # reset configuration
   def reset
-    self.logger = default_logger
-    self.debug  = false
+    self.logger   = default_logger
+    self.debug    = false
+    self.request_with :typhoeus
   end
 
   private
@@ -57,3 +98,11 @@ class Embedly::Configuration
     logger.level = true_or_false ? Logger::DEBUG : Logger::ERROR
   end
 end
+
+# Use typhoeus by default if it is installed
+begin
+  require "typhoeus"
+  Embedly.configuration.request_with :typhoeus
+rescue LoadError
+  Embedly.configuration.request_with :net_http
+end

data/lib/embedly/request.rb

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

data/lib/embedly/request/base.rb

@@ -0,0 +1,50 @@
+module Embedly
+  module Request # :nodoc:
+    # Interface to create custom requesters
+    #
+    # == The class
+    #
+    # If you want to define a custom requester, you should create a class that
+    # inherits from this base class.
+    #
+    # The class should respond to +get+ that receives the uri object and the api
+    # options. The method should perform a get request to Embedly api and return
+    # a response object:
+    #
+    #   class MyRequester < Embedly::Request::Base
+    #     def get(uri, options = {})
+    #       # performs the request
+    #     end
+    #   end
+    #
+    # For more examples, see embedly/requests/*.rb files
+    #
+    # == Adding to configuration
+    #
+    # Make sure to add your class to +embedly+ requesters, like the following:
+    #
+    #  Embedly.configuration.add_requester :my_requester do |api|
+    #    MyRequester.new(api)
+    #  end
+    #
+    # This way you can configure the API to use your custom request object:
+    #
+    #    Embedly.configure do |config|
+    #      config.request_with :my_requester
+    #    end
+    #
+    class Base
+      attr_accessor :api # :nodoc:
+
+      # Receives the current api object
+      def initialize(api)
+        @api = api
+      end
+
+      # Implement this method
+      def get(uri, options = {})
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/embedly/request/net_http.rb

@@ -0,0 +1,27 @@
+require "net/http"
+
+module Embedly
+  module NetHTTP # :nodoc:
+    class Request < Embedly::Request::Base
+      # Perform request using net/http library
+      def get(uri, options = {})
+        proxy = options['proxy']
+        http_class = if proxy
+          logger.debug { 'using Net::HTTP::Proxy' }
+          http_class = Net::HTTP::Proxy(proxy[:host], proxy[:port], proxy[:user], proxy[:password])
+        else
+          Net::HTTP
+        end
+
+        http_class.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+          http.read_timeout = options[:timeout]
+          http.get([uri.path, uri.query].join('?'), options[:headers])
+        end
+      end
+    end
+  end
+end
+
+Embedly.configuration.add_requester :net_http do |api|
+  Embedly::NetHTTP::Request.new(api)
+end

data/lib/embedly/request/typhoeus.rb

@@ -0,0 +1,25 @@
+# TODO: a better solution is to only load the requester if it is in use,
+# rather than loading them all on startup.
+begin
+  require "typhoeus"
+
+  module Embedly
+    module Typhoeus # :nodoc:
+      class Request < Embedly::Request::Base
+        # Perform request using typhoeus
+        def get(uri, options = {})
+          options[:timeout] *= 1000
+          ::Typhoeus::Request.get uri.to_s, :headers => options[:headers], :timeout => options[:timeout]
+        end
+      end
+    end
+  end
+
+  Embedly.configuration.add_requester :typhoeus do |api|
+    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

@@ -1,5 +1,6 @@
 require "spec_helper"
 
+
 module Embedly
   describe API do
     let(:api) { API.new :key => ENV['EMBEDLY_KEY'], :secret => ENV['EMBEDLY_SECRET'] }
@@ -19,5 +20,27 @@ module Embedly
         io.string.should =~ %r{.*DEBUG -- : .*}
       end
     end
+
+    describe "requesters" do
+      describe "net/http" do
+        before do
+          Embedly.configure { |c| c.request_with :net_http }
+        end
+
+        it "sets the correct request adapter" do
+          api.request.should be_a(Embedly::NetHTTP::Request)
+        end
+      end
+
+      describe "typhoeus" do
+        before do
+          Embedly.configure { |c| c.request_with :typhoeus }
+        end
+
+        it "sets the correct request adapter" do
+          api.request.should be_a(Embedly::Typhoeus::Request)
+        end
+      end
+    end
   end
 end

data/spec/embedly/command_line_spec.rb

@@ -13,7 +13,7 @@ module Embedly
       let(:api) { mock(API) }
 
       it "calls api with options" do
-        API.should_receive(:new).with(:key => 'MY_KEY', :headers => {}, :typhoeus => true) { api }
+        API.should_receive(:new).with(:key => 'MY_KEY', :headers => {}) { api }
         api.should_receive(:oembed).with(:urls => ['http://yfrog.com/h7qqespj'], :maxwidth => '10')
         CommandLine.run!(:oembed, arguments)
       end
@@ -87,6 +87,13 @@ module Embedly
         end
       end
 
+      describe "with --no-typhoeus" do
+        it "sets the request with net/http" do
+          command(['--no-typhoeus'])
+          Embedly.configuration.requester.should == :net_http
+        end
+      end
+
       describe "with --option" do
         %w[-o --option].each do |option|
           it "sets custom option with #{option}" do

data/spec/embedly/configuration_spec.rb

@@ -48,6 +48,20 @@ module Embedly
         config.key = 'my_api_key'
         config.key.should == 'my_api_key'
       end
+
+      it "requests typhoeus by default" do
+        config.requester.should == :typhoeus
+      end
+    end
+
+    describe "registering a requester" do
+      it "adds a new requester" do
+        config.add_requester :sample do |api|
+          Embedly::NetHTTP::Request.new(api)
+        end
+        config.request_with :sample
+        config.current_requester.call({}).should be_a(Embedly::NetHTTP::Request)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embedly
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,6 +9,8 @@ authors:
 - Felipe Elias Philipp
 - Russ Bradberry
 - Arun Thampi
+- Anton Dieterle
+- Nitesh
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -209,6 +211,10 @@ files:
 - lib/embedly/configuration.rb
 - lib/embedly/exceptions.rb
 - lib/embedly/model.rb
+- lib/embedly/request.rb
+- lib/embedly/request/base.rb
+- lib/embedly/request/net_http.rb
+- lib/embedly/request/typhoeus.rb
 - spec/embedly/api_spec.rb
 - spec/embedly/command_line_spec.rb
 - spec/embedly/configuration_spec.rb
@@ -228,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1648280040429517220
+      hash: 1864796039289790567
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: