typhoeus 0.5.3 → 0.5.4

data/CHANGELOG.md

@@ -2,7 +2,25 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.5.3...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.5.4...master)
+
+## 0.5.4
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.5.3...v0.5.4)
+
+Enhancements:
+
+* Make sure response_code is an integer.
+* When setting an header through vcr or webmock it becomes a `Typhoeus::Response::Header`.
+* Provide a Rack middleware to decode nested Typhoeus arrays properly.
+  ([Dwayne Macgowan](https://github.com/dwaynemac), [\#224](https://github.com/typhoeus/typhoeus/issues/224))
+* Handled response is available again.
+* 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) )
+  * Provide symbol access.
 
 ## 0.5.3
 

data/lib/rack/typhoeus.rb

@@ -0,0 +1 @@
+require "rack/typhoeus/middleware/params_decoder"

data/lib/rack/typhoeus/middleware/params_decoder.rb

@@ -0,0 +1,57 @@
+require 'rack/typhoeus/middleware/params_decoder/helper'
+
+module Rack
+  module Typhoeus
+    module Middleware
+
+      # This Rack middleware takes care of the proper deserialization of
+      # the nested params encoded by Typhoeus.
+      #
+      # @example Require the railtie when using Rails.
+      #   require 'typhoeus/railtie'
+      #
+      # @example Include the middleware for Rack based applications.
+      #   use Rack::Typhoeus::Middleware::ParamsDecoder
+      #
+      # @example Use the helper directly. Not recommended as b/c the interface might change.
+      #   require 'rack/typhoeus/middleware/params_decoder/helper'
+      #   include Rack::Typhoeus::Middleware::ParamsDecoder::Helper
+      #   decode!(params)
+      #
+      # @author Dwayne Macgowan
+      # @since 0.5.4
+      class ParamsDecoder
+        include ParamsDecoder::Helper
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          req = Rack::Request.new(env)
+          decode(req.params).each_pair { |k, v| update_params req, k, v }
+          @app.call(env)
+        end
+
+        private
+
+        # Persist params change in environment. Extracted from:
+        # https://github.com/rack/rack/blob/master/lib/rack/request.rb#L233
+        def update_params(req, k, v)
+          found = false
+          if req.GET.has_key?(k)
+            found = true
+            req.GET[k] = v
+          end
+          if req.POST.has_key?(k)
+            found = true
+            req.POST[k] = v
+          end
+          unless found
+            req.GET[k] = v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/typhoeus/middleware/params_decoder/helper.rb

@@ -0,0 +1,72 @@
+module Rack
+  module Typhoeus
+    module Middleware
+      class ParamsDecoder
+        module Helper
+
+          # Recursively decodes Typhoeus encoded arrays in given Hash.
+          #
+          # @example Use directly in a Rails controller.
+          #    class ApplicationController
+          #       before_filter :decode_typhoeus_arrays
+          #    end
+          #
+          # @author Dwayne Macgowan
+          #
+          def decode_typhoeus_arrays
+            decode!(params)
+          end
+
+          # Recursively decodes Typhoeus encoded arrays in given Hash.
+          #
+          # @param hash [Hash]. This Hash will be modified!
+          #
+          # @return [Hash] Hash with properly decoded nested arrays.
+          def decode!(hash)
+            return hash unless hash.is_a?(Hash)
+            hash.each_pair do |key,value|
+              if value.is_a?(Hash)
+                decode!(value)
+                hash[key] = convert(value)
+              end
+            end
+            hash
+          end
+
+          def decode(hash)
+            decode!(hash.dup)
+          end
+
+          private
+
+          # Checks if Hash is an Array encoded as a Hash.
+          # Specifically will check for the Hash to have this
+          # form: {'0' => v0, '1' => v1, .., 'n' => vN }
+          #
+          # @param hash [Hash]
+          #
+          # @return [Boolean] True if its a encoded Array, else false.
+          def encoded?(hash)
+            return false if hash.empty?
+            keys = hash.keys.map{|i| i.to_i if i.respond_to?(:to_i)}.sort
+            keys == hash.keys.size.times.to_a
+          end
+
+          # If the Hash is an array encoded by typhoeus an array is returned
+          # else the self is returned
+          #
+          # @param hash [Hash] The Hash to convert into an Array.
+          #
+          # @return [Arraya/Hash]
+          def convert(hash)
+            if encoded?(hash)
+              Hash[hash.sort].values
+            else
+              hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/typhoeus.rb

@@ -9,8 +9,19 @@ require 'typhoeus/request'
 require 'typhoeus/response'
 require 'typhoeus/version'
 
+# If we are using any Rack based application then we need the Typhoeus rack
+# # middleware to ensure our app is running properly.
+if defined?(Rack)
+  require "rack/typhoeus"
+end
+
+# If we are using Rails then we will include the Typhoeus railtie.
+# if defined?(Rails)
+#   require "typhoeus/railtie"
+# end
+
 # Typhoeus is a http client library based on Ethon which
-# wraps libcurl. Sitting on top of libcurl make Typhoeus
+# wraps libcurl. Sitting on top of libcurl makes Typhoeus
 # very reliable and fast.
 #
 # There are some gems using Typhoeus like
@@ -55,17 +66,17 @@ module Typhoeus
   #
   # @example (see Typhoeus::Expectation)
   #
-  # @param [ String ] url The url to stub out.
+  # @param [ String ] base_url The url to stub out.
   # @param [ Hash ] options The options to stub out.
   #
   # @return [ Typhoeus::Expectation ] The expecatation.
   #
   # @see Typhoeus::Expectation
-  def stub(url, options = {})
-    expectation = Expectation.all.find{ |e| e.url == url && e.options == options }
+  def stub(base_url, options = {})
+    expectation = Expectation.all.find{ |e| e.base_url == base_url && e.options == options }
     return expectation if expectation
 
-    Expectation.new(url, options).tap do |new_expectation|
+    Expectation.new(base_url, options).tap do |new_expectation|
       Expectation.all << new_expectation
     end
   end
@@ -73,7 +84,7 @@ module Typhoeus
   # Add before callbacks.
   #
   # @example Add before callback.
-  #   Typhoeus.before { |request| p request.url }
+  #   Typhoeus.before { |request| p request.base_url }
   #
   # @param [ Block ] block The callback.
   #

data/lib/typhoeus/expectation.rb

@@ -17,7 +17,7 @@ module Typhoeus
   class Expectation
 
     # @api private
-    attr_reader :url
+    attr_reader :base_url
 
     # @api private
     attr_reader :options
@@ -66,13 +66,13 @@ module Typhoeus
     # Creates an expactation.
     #
     # @example Create expactation.
-    #   Typhoeus::Expectation.new(url)
+    #   Typhoeus::Expectation.new(base_url)
     #
     # @return [ Expectation ] The created expactation.
     #
     # @api private
-    def initialize(url, options = {})
-      @url = url
+    def initialize(base_url, options = {})
+      @base_url = base_url
       @options = options
       @response_counter = 0
       @from = nil
@@ -117,7 +117,7 @@ module Typhoeus
     #
     # @api private
     def matches?(request)
-      url_match?(request.url) && options_match?(request)
+      url_match?(request.base_url) && options_match?(request)
     end
 
     # Return canned responses.
@@ -157,18 +157,18 @@ module Typhoeus
       (options ? options.all?{ |k,v| request.original_options[k] == v || request.options[k] == v } : true)
     end
 
-    # Check wether the url matches the request url.
-    # The url can be a string, regex or nil. String and
+    # Check wether the base_url matches the request url.
+    # The base_url can be a string, regex or nil. String and
     # regexp were checked, nil is always true. Else false.
     #
     # Nil serves as a placeholder in case you want to match
     # all urls.
     def url_match?(request_url)
-      case url
+      case base_url
       when String
-        url == request_url
+        base_url == request_url
       when Regexp
-        !!request_url.match(url)
+        !!request_url.match(base_url)
       when nil
         true
       else

data/lib/typhoeus/hydra/easy_factory.rb

@@ -49,7 +49,7 @@ module Typhoeus
       # @return [ Ethon::Easy ] The easy.
       def get
         easy.http_request(
-          request.url,
+          request.base_url,
           request.options.fetch(:method, :get),
           request.options.reject{|k,_| k==:method}
         )

data/lib/typhoeus/railtie.rb

@@ -0,0 +1,12 @@
+require "typhoeus"
+
+module Rails
+  module Typhoeus
+    class Railtie < Rails::Railtie
+      # Need to include the Typhoeus middleware.
+      initializer "include the identity map" do |app|
+        app.config.middleware.use "Rack::Typhoeus::Middleware::ParamsDecoder"
+      end
+    end
+  end
+end

data/lib/typhoeus/request.rb

@@ -30,10 +30,10 @@ module Typhoeus
     include Request::Stubbable
     include Request::Before
 
-    # Returns the provided url.
+    # Returns the provided base url.
     #
     # @return [ String ]
-    attr_accessor :url
+    attr_accessor :base_url
 
     # Returns options, which includes default parameters.
     #
@@ -89,7 +89,7 @@ module Typhoeus
     #     followlocation: true
     #   ).run
     #
-    # @param [ String ] url The url to request.
+    # @param [ String ] base_url The url to request.
     # @param [ options ] options The options.
     #
     # @option options [ Hash ] :params Translated
@@ -99,18 +99,22 @@ module Typhoeus
     #
     # @return [ Typhoeus::Request ] The request.
     #
-    # @note See {http://rubydoc.info/github/typhoeus/ethon/Ethon/Easy#initialize-instance_method Ethon::Easy#initialize} for more options.
+    # @note See {http://rubydoc.info/github/typhoeus/ethon/Ethon/Easy/Options Ethon::Easy::Options} for more options.
     #
     # @see Typhoeus::Hydra
     # @see Typhoeus::Response
     # @see Typhoeus::Request::Actions
-    def initialize(url, options = {})
-      @url = url
+    def initialize(base_url, options = {})
+      @base_url = base_url
       @original_options = options
       @options = options.dup
 
       set_defaults
     end
+    
+    def url
+      base_url
+    end
 
     # Returns wether other is equal to self.
     #
@@ -124,7 +128,7 @@ module Typhoeus
     # @api private
     def eql?(other)
       self.class == other.class &&
-        self.url == other.url &&
+        self.base_url == other.base_url &&
         fuzzy_hash_eql?(self.options, other.options)
     end
 
@@ -134,7 +138,7 @@ module Typhoeus
     #
     # @api private
     def hash
-      [ self.class, self.url, self.options ].hash
+      [ self.class, self.base_url, self.options ].hash
     end
 
     private

data/lib/typhoeus/request/actions.rb

@@ -18,8 +18,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def get(url, options = {})
-        Request.new(url, options.merge(:method => :get)).run
+      def get(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :get)).run
       end
 
       # Make a post request.
@@ -34,8 +34,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def post(url, options = {})
-        Request.new(url, options.merge(:method => :post)).run
+      def post(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :post)).run
       end
 
       # Make a put request.
@@ -46,15 +46,15 @@ module Typhoeus
       # @param (see Typhoeus::Request#initialize)
       #
       # @option options :params [ Hash ] Params hash which
-      #   is attached to the url.
+      #   is attached to the base_url.
       # @option options :body [ Hash ] Body hash which
       #   becomes a PUT request body.
       #
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def put(url, options = {})
-        Request.new(url, options.merge(:method => :put)).run
+      def put(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :put)).run
       end
 
       # Make a delete request.
@@ -69,8 +69,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def delete(url, options = {})
-        Request.new(url, options.merge(:method => :delete)).run
+      def delete(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :delete)).run
       end
 
       # Make a head request.
@@ -85,8 +85,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def head(url, options = {})
-        Request.new(url, options.merge(:method => :head)).run
+      def head(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :head)).run
       end
 
       # Make a patch request.
@@ -101,8 +101,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def patch(url, options = {})
-        Request.new(url, options.merge(:method => :patch)).run
+      def patch(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :patch)).run
       end
 
       # Make a options request.
@@ -117,8 +117,8 @@ module Typhoeus
       # @return (see Typhoeus::Request#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
-      def options(url, options = {})
-        Request.new(url, options.merge(:method => :options)).run
+      def options(base_url, options = {})
+        Request.new(base_url, options.merge(:method => :options)).run
       end
     end
   end

data/lib/typhoeus/request/callbacks.rb

@@ -95,7 +95,9 @@ module Typhoeus
           callbacks += Typhoeus.on_failure + on_failure
         end
 
-        callbacks.map{ |callback| callback.call(self.response) }
+        callbacks.map do |callback|
+          self.response.handled_response = callback.call(self.response)
+        end
       end
     end
   end

data/lib/typhoeus/request/operations.rb

@@ -15,7 +15,7 @@ module Typhoeus
         easy = Typhoeus.get_easy
         begin
           easy.http_request(
-            url,
+            base_url,
             options.fetch(:method, :get),
             options.reject{|k,_| k==:method}
           )
@@ -52,26 +52,27 @@ module Typhoeus
 
       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,
-          :proxy_username => :proxyuserpwd,
+          :password => :userpwd,
+          :proxy_auth_method => :proxyauth,
           :proxy_password => :proxyuserpwd,
-          :disable_ssl_peer_verification => :ssl_verifypeer,
-          :disable_ssl_host_verification => :ssl_verifyhost,
+          :proxy_type => :proxytype,
+          :proxy_username => :proxyuserpwd,
+          :ssl_cacert => :cainfo,
+          :ssl_capath => :capath,
           :ssl_cert => :sslcert,
           :ssl_cert_type => :sslcerttype,
           :ssl_key => :sslkey,
-          :ssl_key_type => :sslkeytype,
           :ssl_key_password => :keypasswd,
-          :ssl_cacert => :cainfo,
-          :ssl_capath => :capath,
+          :ssl_key_type => :sslkeytype,
           :ssl_version => :sslversion,
-          :username => :userpwd,
-          :password => :userpwd,
-          :auth_method => :httpauth,
-          :proxy_auth_method => :proxyauth,
-          :proxy_type => :proxytype
+          :username => :userpwd
         }
         removed = [:cache_key_basis, :cache_timout, :user_agent]
         if new_option = renamed[option.to_sym]

data/lib/typhoeus/response.rb

@@ -26,6 +26,11 @@ module Typhoeus
     # @return [ Hash ]
     attr_accessor :options
 
+    # The handled response.
+    #
+    # @return [ String ]
+    attr_accessor :handled_response
+
     # @api private
     attr_writer :mock
 
@@ -39,7 +44,7 @@ module Typhoeus
     # @return [ Response ] The new response.
     def initialize(options = {})
       @options = options
-      @headers = options[:headers]
+      @headers = Header.new(options[:headers]) if options[:headers]
     end
 
     # Returns wether this request is mocked

data/lib/typhoeus/response/header.rb

@@ -6,6 +6,7 @@ module Typhoeus
     #
     # @api private
     class Header < Hash
+
       # Create a new header.
       #
       # @example Create new header.
@@ -14,7 +15,9 @@ module Typhoeus
       # @param [ String ] raw The raw header.
       def initialize(raw)
         @raw = raw
+        @sanitized = {}
         parse
+        set_default_proc_on(self, lambda { |h, k| @sanitized[k.to_s.downcase] })
       end
 
       # Parses the raw header.
@@ -22,15 +25,16 @@ module Typhoeus
       # @example Parse header.
       #   header.parse
       def parse
-        raw.lines.each do |header|
-          next if header.empty? || header =~ /^HTTP\/1.[01]/
-          process_line(header)
-        end
-      end
-
-      def [](key)
-        self.each do |k, v|
-          return v if k.downcase == key.downcase
+        case @raw
+        when Hash
+          raw.each do |k, v|
+            process_pair(k, v)
+          end
+        when String
+          raw.lines.each do |header|
+            next if header.empty? || header =~ /^HTTP\/1.[01]/
+            process_line(header)
+          end
         end
       end
 
@@ -41,11 +45,26 @@ module Typhoeus
       # @return [ void ]
       def process_line(header)
         key, value = header.split(':', 2).map(&:strip)
-        if self.has_key?(key)
-          self[key] = [self[key]] unless self[key].is_a? Array
-          self[key].push(value)
+        process_pair(key, value)
+      end
+
+      # Sets key value pair for self and @sanitized.
+      #
+      # @return [ void ]
+      def process_pair(key, value)
+        set_value(key, value, self)
+        set_value(key.downcase, value, @sanitized)
+      end
+
+      # Sets value for key in specified hash
+      #
+      # @return [ void ]
+      def set_value(key, value, hash)
+        if hash.has_key?(key)
+          hash[key] = [hash[key]] unless hash[key].is_a? Array
+          hash[key].push(value)
         else
-          self[key] = value
+          hash[key] = value
         end
       end
 
@@ -56,7 +75,18 @@ module Typhoeus
       #
       # @return [ String ] The raw header.
       def raw
-        @raw ||= ''
+        @raw || ''
+      end
+
+      # Sets the default proc for the specified hash independent of the Ruby version.
+      #
+      # @return [ void ]
+      def set_default_proc_on(hash, default_proc)
+        if hash.respond_to?(:default_proc=)
+          hash.default_proc = default_proc
+        else
+          hash.replace(Hash.new(&default_proc).merge(hash))
+        end
       end
     end
   end

data/lib/typhoeus/response/informations.rb

@@ -46,7 +46,7 @@ module Typhoeus
       #
       # @return [ Integer ] The response_code.
       def response_code
-        options[:response_code] || options[:code]
+        (options[:response_code] || options[:code]).to_i
       end
       alias :code :response_code
 

data/lib/typhoeus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2013-01-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.3
+        version: 0.5.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.5.7
 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:
@@ -37,6 +37,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rack/typhoeus/middleware/params_decoder/helper.rb
+- lib/rack/typhoeus/middleware/params_decoder.rb
+- lib/rack/typhoeus.rb
 - lib/typhoeus/adapters/faraday.rb
 - lib/typhoeus/config.rb
 - lib/typhoeus/errors/no_stub.rb
@@ -53,6 +56,7 @@ files:
 - lib/typhoeus/hydra/runnable.rb
 - lib/typhoeus/hydra/stubbable.rb
 - lib/typhoeus/hydra.rb
+- lib/typhoeus/railtie.rb
 - lib/typhoeus/request/actions.rb
 - lib/typhoeus/request/before.rb
 - lib/typhoeus/request/block_connection.rb
@@ -88,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 419611758295813081
+      hash: -4558354049498247324
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: