typhoeus 0.5.4 → 0.6.0

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.5.4...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.0...master)
+
+## 0.6
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.5.4...v0.6.0)
+
+Enhancements:
+
+* `Request#url` now also contains the url parameters.
+* Use updated ethon version which provides access to protocols and redir_protocols in response to [libcurl SASL buffer overflow vulnerability](http://curl.haxx.se/docs/adv_20130206.html)
+
+Bugfixes:
+
+* Corrected ssl options for the faraday adapter.
+* Benchmark is working again.
 
 ## 0.5.4
 
@@ -18,8 +32,8 @@ Enhancements:
 * Rename parameter `url` to `base_url`. See discussion here: [\#250](https://github.com/typhoeus/typhoeus/issues/250).
   ([bkimble](https://github.com/bkimble), [\#256](https://github.com/typhoeus/typhoeus/pull/256))
 * Provide O(1) header access.
-  * Work around nuby 1.8.7 limitations.
-    ( [](https://github.com/sshingler), [\#176](https://github.com/typhoeus/typhoeus/pull/176) )
+  * Work around ruby 1.8.7 limitations.
+    ([Chris Johnson](https://github.com/findchris), [\#227](https://github.com/typhoeus/typhoeus/pull/227) )
   * Provide symbol access.
 
 ## 0.5.3

data/README.md

@@ -1,4 +1,4 @@
-# Typhoeus [![Build Status](https://secure.travis-ci.org/typhoeus/typhoeus.png)](http://travis-ci.org/typhoeus/typhoeus)
+# Typhoeus [![Build Status](https://secure.travis-ci.org/typhoeus/typhoeus.png)](http://travis-ci.org/typhoeus/typhoeus) [<img src="https://codeclimate.com/github/typhoeus/typhoeus.png" height="13" width="89" />](https://codeclimate.com/github/typhoeus/typhoeus)
 
 Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.
 
@@ -39,9 +39,9 @@ gem "typhoeus"
 
 Copyright © 2009-2010 [Paul Dix](http://www.pauldix.net/)
 
-Copyright © 2011 [David Balatero](https://github.com/dbalatero/)
+Copyright © 2011-2012 [David Balatero](https://github.com/dbalatero/)
 
-Copyright © 2012 [Hans Hasselberg](http://www.hans.io)
+Copyright © 2012-2013 [Hans Hasselberg](http://github.com/i0rek/)
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),

data/lib/typhoeus.rb

@@ -2,9 +2,11 @@ require 'digest/sha2'
 require 'ethon'
 
 require 'typhoeus/config'
+require 'typhoeus/easy_factory'
 require 'typhoeus/errors'
 require 'typhoeus/expectation'
 require 'typhoeus/hydra'
+require 'typhoeus/pool'
 require 'typhoeus/request'
 require 'typhoeus/response'
 require 'typhoeus/version'
@@ -42,7 +44,6 @@ end
 # @since 0.5.0
 module Typhoeus
   extend self
-  extend Hydra::EasyPool
   extend Request::Actions
   extend Request::Callbacks::Types
 

data/lib/typhoeus/adapters/faraday.rb

@@ -98,11 +98,11 @@ module Faraday # :nodoc:
 
         ssl_verifyhost = (ssl && ssl.fetch(:verify, true)) ? 2 : 0
         req.options[:ssl_verifyhost] = ssl_verifyhost
-        req.options[:sslversion] = ssl[:version]          if ssl[:version]
-        req.options[:sslcert]    = ssl[:client_cert_file] if ssl[:client_cert_file]
-        req.options[:sslkey]     = ssl[:client_key_file]  if ssl[:client_key_file]
-        req.options[:cainfo]     = ssl[:ca_file]          if ssl[:ca_file]
-        req.options[:capath]     = ssl[:ca_path]          if ssl[:ca_path]
+        req.options[:sslversion] = ssl[:version]     if ssl[:version]
+        req.options[:sslcert]    = ssl[:client_cert] if ssl[:client_cert]
+        req.options[:sslkey]     = ssl[:client_key]  if ssl[:client_key]
+        req.options[:cainfo]     = ssl[:ca_file]     if ssl[:ca_file]
+        req.options[:capath]     = ssl[:ca_path]     if ssl[:ca_path]
       end
 
       def configure_proxy(req, env)

data/lib/typhoeus/easy_factory.rb

@@ -0,0 +1,115 @@
+module Typhoeus
+
+  # This is a Factory for easies to be used in the hydra.
+  # Before an easy is ready to be added to a multi the
+  # on_complete callback to be set.
+  # This is done by this class.
+  #
+  # @api private
+  class EasyFactory
+
+    # Returns the request provided.
+    #
+    # @return [ Typhoeus::Request ]
+    attr_reader :request
+
+    # Returns the hydra provided.
+    #
+    # @return [ Typhoeus::Hydra ]
+    attr_reader :hydra
+
+    # Create an easy factory.
+    #
+    # @example Create easy factory.
+    #   Typhoeus::Hydra::EasyFactory.new(request, hydra)
+    #
+    # @param [ Request ] request The request to build an easy for.
+    # @param [ Hydra ] hydra The hydra to build an easy for.
+    def initialize(request, hydra = nil)
+      @request = request
+      @hydra = hydra
+    end
+
+    # Return the easy in question.
+    #
+    # @example Return easy.
+    #   easy_factory.easy
+    #
+    # @return [ Ethon::Easy ] The easy.
+    def easy
+      @easy ||= Typhoeus::Pool.get
+    end
+
+    # Fabricated easy.
+    #
+    # @example Prepared easy.
+    #   easy_factory.get
+    #
+    # @return [ Ethon::Easy ] The easy.
+    def get
+      begin
+        easy.http_request(
+          request.base_url,
+          request.options.fetch(:method, :get),
+          request.options.reject{|k,_| k==:method}
+        )
+      rescue Ethon::Errors::InvalidOption => e
+        help = provide_help(e.message.match(/:\s(\w+)/)[1])
+        raise $!, "#{$!}#{help}", $!.backtrace
+      end
+      set_callback
+      easy
+    end
+
+    private
+
+    # Sets on_complete callback on easy in order to be able to
+    # track progress.
+    #
+    # @example Set callback.
+    #   easy_factory.set_callback
+    #
+    # @return [ Ethon::Easy ] The easy.
+    def set_callback
+      easy.on_complete do |easy|
+        request.finish(Response.new(easy.to_hash))
+        Typhoeus::Pool.release(easy)
+        if hydra && !hydra.queued_requests.empty?
+          hydra.add(hydra.queued_requests.shift)
+        end
+      end
+    end
+
+    def provide_help(option)
+      renamed = {
+        :auth_method => :httpauth,
+        :connect_timeout => :connecttimeout,
+        :disable_ssl_host_verification => :ssl_verifyhost,
+        :disable_ssl_peer_verification => :ssl_verifypeer,
+        :encoding => :accept_encoding,
+        :follow_location => :followlocation,
+        :max_redirects => :maxredirs,
+        :password => :userpwd,
+        :proxy_auth_method => :proxyauth,
+        :proxy_password => :proxyuserpwd,
+        :proxy_type => :proxytype,
+        :proxy_username => :proxyuserpwd,
+        :ssl_cacert => :cainfo,
+        :ssl_capath => :capath,
+        :ssl_cert => :sslcert,
+        :ssl_cert_type => :sslcerttype,
+        :ssl_key => :sslkey,
+        :ssl_key_password => :keypasswd,
+        :ssl_key_type => :sslkeytype,
+        :ssl_version => :sslversion,
+        :username => :userpwd
+      }
+      removed = [:cache_key_basis, :cache_timout, :user_agent]
+      if new_option = renamed[option.to_sym]
+        "\nPlease try #{new_option} instead of #{option}." if new_option
+      elsif removed.include?(option.to_sym)
+        "\nThe option #{option} was removed."
+      end
+    end
+  end
+end

data/lib/typhoeus/expectation.rb

@@ -63,12 +63,12 @@ module Typhoeus
       end
     end
 
-    # Creates an expactation.
+    # Creates an expectation.
     #
-    # @example Create expactation.
+    # @example Create expectation.
     #   Typhoeus::Expectation.new(base_url)
     #
-    # @return [ Expectation ] The created expactation.
+    # @return [ Expectation ] The created expectation.
     #
     # @api private
     def initialize(base_url, options = {})
@@ -78,11 +78,11 @@ module Typhoeus
       @from = nil
     end
 
-    # Set from value to mark an expecation. Useful for
+    # Set from value to mark an expectaion. Useful for
     # other libraries, eg. webmock.
     #
-    # @example Mark expecation.
-    #   expecation.from(:webmock)
+    # @example Mark expectation.
+    #   expectation.from(:webmock)
     #
     # @param [ String ] value Value to set.
     #
@@ -95,7 +95,7 @@ module Typhoeus
     end
 
     # Specify what should be returned,
-    # when this expactation is hit.
+    # when this expectation is hit.
     #
     # @example Add response.
     #   expectation.and_return(response)

data/lib/typhoeus/hydra.rb

@@ -1,8 +1,6 @@
 require 'typhoeus/hydra/addable'
 require 'typhoeus/hydra/before'
 require 'typhoeus/hydra/block_connection'
-require 'typhoeus/hydra/easy_factory'
-require 'typhoeus/hydra/easy_pool'
 require 'typhoeus/hydra/memoizable'
 require 'typhoeus/hydra/queueable'
 require 'typhoeus/hydra/runnable'
@@ -40,7 +38,6 @@ module Typhoeus
   # @note Callbacks are going to delay the request
   #   execution.
   class Hydra
-    include Hydra::EasyPool
     include Hydra::Addable
     include Hydra::Runnable
     include Hydra::Memoizable

data/lib/typhoeus/hydra/addable.rb

@@ -16,7 +16,7 @@ module Typhoeus
       #
       # @return [ void ]
       def add(request)
-        multi.add(Hydra::EasyFactory.new(request, self).get)
+        multi.add(EasyFactory.new(request, self).get)
       end
     end
   end

data/lib/typhoeus/pool.rb

@@ -0,0 +1,51 @@
+module Typhoeus
+
+  # The easy pool stores already initialized
+  # easy handles for future use. This is useful
+  # because creating them is quite expensive.
+  #
+  # @api private
+  module Pool
+    extend self
+
+    # Return the easy pool.
+    #
+    # @example Return easy pool.
+    #   hydra.easy_pool
+    #
+    # @return [ Array<Ethon::Easy> ] The easy pool.
+    def easies
+      @easies ||= []
+    end
+
+    # Releases easy into pool. The easy handle is
+    # resetted before it gets back in.
+    #
+    # @example Release easy.
+    #   hydra.release_easy(easy)
+    def release(easy)
+      easy.reset
+      easies << easy
+    end
+
+    # Return an easy from pool.
+    #
+    # @example Return easy.
+    #   hydra.get_easy
+    #
+    # @return [ Ethon::Easy ] The easy.
+    def get
+      easies.pop || Ethon::Easy.new
+    end
+
+    def clear
+      easies.clear
+    end
+
+    def with_easy(&block)
+      easy = get
+      yield easy
+      release easy
+    end
+  end
+end

data/lib/typhoeus/request.rb

@@ -111,9 +111,17 @@ module Typhoeus
 
       set_defaults
     end
-    
+
+    # Return the url.
+    # In contrast to base_url which returns the value you specified, url returns
+    # the full url including the parameters.
+    #
+    # @example Get the url.
+    #   request.url
+    #
+    # @since 0.5.5
     def url
-      base_url
+      EasyFactory.new(self).get.url
     end
 
     # Returns wether other is equal to self.

data/lib/typhoeus/request/before.rb

@@ -20,7 +20,7 @@ module Typhoeus
         Typhoeus.before.each do |callback|
           value = callback.call(self)
           if value.nil? || value == false || value.is_a?(Response)
-            return value
+            return response
           end
         end
         super

data/lib/typhoeus/request/operations.rb

@@ -12,20 +12,8 @@ module Typhoeus
       #
       # @return [ Response ] The response.
       def run
-        easy = Typhoeus.get_easy
-        begin
-          easy.http_request(
-            base_url,
-            options.fetch(:method, :get),
-            options.reject{|k,_| k==:method}
-          )
-        rescue Ethon::Errors::InvalidOption => e
-          help = provide_help(e.message.match(/:\s(\w+)/)[1])
-          raise $!, "#{$!}#{help}", $!.backtrace
-        end
+        easy = EasyFactory.new(self).get
         easy.perform
-        finish(Response.new(easy.to_hash))
-        Typhoeus.release_easy(easy)
         response
       end
 
@@ -47,40 +35,6 @@ module Typhoeus
         execute_callbacks
         response
       end
-
-      private
-
-      def provide_help(option)
-        renamed = {
-          :auth_method => :httpauth,
-          :connect_timeout => :connecttimeout,
-          :disable_ssl_host_verification => :ssl_verifyhost,
-          :disable_ssl_peer_verification => :ssl_verifypeer,
-          :encoding => :accept_encoding,
-          :follow_location => :followlocation,
-          :max_redirects => :maxredirs,
-          :password => :userpwd,
-          :proxy_auth_method => :proxyauth,
-          :proxy_password => :proxyuserpwd,
-          :proxy_type => :proxytype,
-          :proxy_username => :proxyuserpwd,
-          :ssl_cacert => :cainfo,
-          :ssl_capath => :capath,
-          :ssl_cert => :sslcert,
-          :ssl_cert_type => :sslcerttype,
-          :ssl_key => :sslkey,
-          :ssl_key_password => :keypasswd,
-          :ssl_key_type => :sslkeytype,
-          :ssl_version => :sslversion,
-          :username => :userpwd
-        }
-        removed = [:cache_key_basis, :cache_timout, :user_agent]
-        if new_option = renamed[option.to_sym]
-          "\nPlease try #{new_option} instead of #{option}." if new_option
-        elsif removed.include?(option.to_sym)
-          "\nThe option #{option} was removed."
-        end
-      end
     end
   end
 end

data/lib/typhoeus/version.rb

@@ -1,5 +1,5 @@
 module Typhoeus
 
   # The current Typhoeus version.
-  VERSION = '0.5.4'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -20,7 +20,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.5.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.5.8
 description: Like a modern code version of the mythical beast with 100 serpent heads,
   Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.
 email:
@@ -42,6 +42,7 @@ files:
 - lib/rack/typhoeus.rb
 - lib/typhoeus/adapters/faraday.rb
 - lib/typhoeus/config.rb
+- lib/typhoeus/easy_factory.rb
 - lib/typhoeus/errors/no_stub.rb
 - lib/typhoeus/errors/typhoeus_error.rb
 - lib/typhoeus/errors.rb
@@ -49,13 +50,12 @@ files:
 - lib/typhoeus/hydra/addable.rb
 - lib/typhoeus/hydra/before.rb
 - lib/typhoeus/hydra/block_connection.rb
-- lib/typhoeus/hydra/easy_factory.rb
-- lib/typhoeus/hydra/easy_pool.rb
 - lib/typhoeus/hydra/memoizable.rb
 - lib/typhoeus/hydra/queueable.rb
 - lib/typhoeus/hydra/runnable.rb
 - lib/typhoeus/hydra/stubbable.rb
 - lib/typhoeus/hydra.rb
+- lib/typhoeus/pool.rb
 - lib/typhoeus/railtie.rb
 - lib/typhoeus/request/actions.rb
 - lib/typhoeus/request/before.rb
@@ -92,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4558354049498247324
+      hash: -2675130828184465692
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/typhoeus/hydra/easy_factory.rb

@@ -1,78 +0,0 @@
-module Typhoeus
-  class Hydra
-
-    # This is a Factory for easies to be used in the hydra.
-    # Before an easy is ready to be added to a multi the
-    # on_complete callback to be set.
-    # This is done by this class.
-    #
-    # @api private
-    class EasyFactory
-
-      # Returns the request provided.
-      #
-      # @return [ Typhoeus::Request ]
-      attr_reader :request
-
-      # Returns the hydra provided.
-      #
-      # @return [ Typhoeus::Hydra ]
-      attr_reader :hydra
-
-      # Create an easy factory.
-      #
-      # @example Create easy factory.
-      #   Typhoeus::Hydra::EasyFactory.new(request, hydra)
-      #
-      # @param [ Request ] request The request to build an easy for.
-      # @param [ Hydra ] hydra The hydra to build an easy for.
-      def initialize(request, hydra)
-        @request = request
-        @hydra = hydra
-      end
-
-      # Return the easy in question.
-      #
-      # @example Return easy.
-      #   easy_factory.easy
-      #
-      # @return [ Ethon::Easy ] The easy.
-      def easy
-        @easy ||= hydra.get_easy
-      end
-
-      # Fabricated easy.
-      #
-      # @example Prepared easy.
-      #   easy_factory.get
-      #
-      # @return [ Ethon::Easy ] The easy.
-      def get
-        easy.http_request(
-          request.base_url,
-          request.options.fetch(:method, :get),
-          request.options.reject{|k,_| k==:method}
-        )
-        set_callback
-        easy
-      end
-
-      private
-
-      # Sets on_complete callback on easy in order to be able to
-      # track progress.
-      #
-      # @example Set callback.
-      #   easy_factory.set_callback
-      #
-      # @return [ Ethon::Easy ] The easy.
-      def set_callback
-        easy.on_complete do |easy|
-          request.finish(Response.new(easy.to_hash))
-          hydra.release_easy(easy)
-          hydra.add(hydra.queued_requests.shift) unless hydra.queued_requests.empty?
-        end
-      end
-    end
-  end
-end

data/lib/typhoeus/hydra/easy_pool.rb

@@ -1,42 +0,0 @@
-module Typhoeus
-  class Hydra
-
-    # The easy pool stores already initialized
-    # easy handles for future use. This is useful
-    # because creating them is quite expensive.
-    #
-    # @api private
-    module EasyPool
-
-      # Return the easy pool.
-      #
-      # @example Return easy pool.
-      #   hydra.easy_pool
-      #
-      # @return [ Array<Ethon::Easy> ] The easy pool.
-      def easy_pool
-        @easy_pool ||= []
-      end
-
-      # Releases easy into pool. The easy handle is
-      # resetted before it gets back in.
-      #
-      # @example Release easy.
-      #   hydra.release_easy(easy)
-      def release_easy(easy)
-        easy.reset
-        easy_pool << easy
-      end
-
-      # Return an easy from pool.
-      #
-      # @example Return easy.
-      #   hydra.get_easy
-      #
-      # @return [ Ethon::Easy ] The easy.
-      def get_easy
-        easy_pool.pop || Ethon::Easy.new
-      end
-    end
-  end
-end