typhoeus 0.6.2 → 0.6.3

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.2...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.3...master)
+
+## 0.6.3
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.2...v0.6.3)
+
+Enhancements:
+
+* Cache hydra per thread.
+* Various documentation improvements.
+  ([craiglittle](https://github.com/craiglittle))
+* Add support for lazy construction of responses from stubbed requests.
+  ([ryankindermann](https://github.com/ryankinderman), [\#275](https://github.com/typhoeus/typhoeus/pull/275))
 
 ## 0.6.2
 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec
 
 gem "rake"

data/README.md

@@ -4,7 +4,7 @@ Like a modern code version of the mythical beast with 100 serpent heads, Typhoeu
 
 ## Example
 
-Single request:
+A single request:
 
 ```ruby
 Typhoeus.get("www.example.com", followlocation: true)
@@ -29,9 +29,9 @@ gem "typhoeus"
 
 ## Project Tracking
 
-* [Documentation](http://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (github master)
+* [Documentation](http://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (GitHub master)
 * [Website](http://typhoeus.github.com/) (v0.4.2)
-* [Mailinglist](http://groups.google.com/group/typhoeus)
+* [Mailing list](http://groups.google.com/group/typhoeus)
 
 ## LICENSE
 

data/lib/typhoeus.rb

@@ -11,27 +11,27 @@ 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 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 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
+# Typhoeus is a HTTP client library based on Ethon which
 # wraps libcurl. Sitting on top of libcurl makes Typhoeus
 # very reliable and fast.
 #
 # There are some gems using Typhoeus like
 # {https://github.com/myronmarston/vcr VCR},
-# {https://github.com/bblimke/webmock Webmock} or
+# {https://github.com/bblimke/webmock WebMock} or
 # {https://github.com/technoweenie/faraday Faraday}. VCR
-# and Webmock are providing their own adapter
-# whereas Faraday relies on {Faraday::Adapter::Typhoeus}
+# and WebMock provide their own adapter whereas
+# Faraday relies on {Faraday::Adapter::Typhoeus}
 # since Typhoeus version 0.5.
 #
 # @example (see Typhoeus::Request)
@@ -47,7 +47,7 @@ module Typhoeus
   extend Request::Actions
   extend Request::Callbacks::Types
 
-  # The default typhoeus user agent.
+  # The default Typhoeus user agent.
   USER_AGENT = "Typhoeus - https://github.com/typhoeus/typhoeus"
 
   # Set the Typhoeus configuration options by passing a block.
@@ -63,7 +63,7 @@ module Typhoeus
     yield Config
   end
 
-  # Stub out specific request.
+  # Stub out a specific request.
   #
   # @example (see Typhoeus::Expectation)
   #
@@ -73,13 +73,15 @@ module Typhoeus
   # @return [ Typhoeus::Expectation ] The expecatation.
   #
   # @see Typhoeus::Expectation
-  def stub(base_url, options = {})
+  def stub(base_url, options = {}, &block)
     expectation = Expectation.all.find{ |e| e.base_url == base_url && e.options == options }
-    return expectation if expectation
-
-    Expectation.new(base_url, options).tap do |new_expectation|
-      Expectation.all << new_expectation
+    if expectation.nil?
+      expectation = Expectation.new(base_url, options)
+      Expectation.all << expectation
     end
+
+    expectation.and_return(&block) unless block.nil?
+    expectation
   end
 
   # Add before callbacks.
@@ -101,7 +103,7 @@ module Typhoeus
   # Execute given block as if block connection is turned off.
   # The old block connection state is restored afterwards.
   #
-  # @example Make a real request, no matter if its blocked.
+  # @example Make a real request, no matter if it's blocked.
   #   Typhoeus::Config.block_connection = true
   #   Typhoeus.get("www.example.com").code
   #   #=> raise Typhoeus::Errors::NoStub
@@ -113,7 +115,7 @@ module Typhoeus
   #
   # @param [ Block ] block The block to execute.
   #
-  # @return [ Object ] Returns the return value of block.
+  # @return [ Object ] Returns the return value of the block.
   #
   # @see Typhoeus::Config#block_connection
   def with_connection

data/lib/typhoeus/adapters/faraday.rb

@@ -18,6 +18,20 @@ module Faraday # :nodoc:
     class Typhoeus < Faraday::Adapter
       self.supports_parallel = true
 
+      (class << self; self; end).instance_eval do
+        remove_method :setup_parallel_manager if method_defined? :setup_parallel_manager
+      end
+
+      remove_method :call              if method_defined? :call
+      remove_method :perform_request   if method_defined? :perform_request
+      remove_method :request           if method_defined? :request
+      remove_method :read_body         if method_defined? :read_body
+      remove_method :configure_ssl     if method_defined? :configure_ssl
+      remove_method :configure_proxy   if method_defined? :configure_proxy
+      remove_method :configure_timeout if method_defined? :configure_timeout
+      remove_method :configure_socket  if method_defined? :configure_socket
+      remove_method :parallel?         if method_defined? :parallel?
+
       # Setup Hydra with provided options.
       #
       # @example Setup Hydra.

data/lib/typhoeus/config.rb

@@ -7,16 +7,16 @@ module Typhoeus
   #     config.verbose = true
   #   end
   #
-  # @example Set the configuration direct.
+  # @example Set the configuration directly.
   #   Typhoeus::Config.verbose = true
   module Config
     extend self
 
-    # Defines wether the connection is blocked.
+    # Defines whether the connection is blocked.
     # Defaults to false. When set to true, only
     # stubbed requests are allowed. A
     # {Typhoeus::Errors::NoStub} error is raised,
-    # when trying to do a real request. Its possible
+    # when trying to do a real request. It's possible
     # to work around inside
     # {Typhoeus#with_connection}.
     #
@@ -28,7 +28,7 @@ module Typhoeus
     # @see Typhoeus::Errors::NoStub
     attr_accessor :block_connection
 
-    # Defines wether GET requests are memoized when using the {Typhoeus::Hydra}.
+    # Defines whether GET requests are memoized when using the {Typhoeus::Hydra}.
     #
     # @return [ Boolean ]
     #
@@ -36,7 +36,7 @@ module Typhoeus
     # @see Typhoeus::Hydra::Memoizable
     attr_accessor :memoize
 
-    # Defines wether curls debug output is shown.
+    # Defines whether curls debug output is shown.
     # Unfortunately it prints to stderr.
     #
     # @return [ Boolean ]
@@ -44,7 +44,7 @@ module Typhoeus
     # @see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTVERBOSE
     attr_accessor :verbose
 
-    # Defines wether requests are cached.
+    # Defines whether requests are cached.
     #
     # @return [ Object ]
     #

data/lib/typhoeus/errors.rb

@@ -3,7 +3,7 @@ require 'typhoeus/errors/no_stub'
 
 module Typhoeus
 
-  # This namespace contains all errors raised by typhoeus.
+  # This namespace contains all errors raised by Typhoeus.
   module Errors
   end
 end

data/lib/typhoeus/expectation.rb

@@ -2,10 +2,10 @@ module Typhoeus
 
   # This class represents an expectation. It is part
   # of the stubbing mechanism. An expectation contains
-  # an url and options, like a request. They were compared
+  # a url and options, like a request. They are compared
   # to the request url and options in order to evaluate
-  # wether they match. If thats the case, the attached
-  # responses were returned one by one.
+  # whether they match. If that's the case, the attached
+  # responses are returned one by one.
   #
   # @example Stub a request and get specified response.
   #   expected = Typhoeus::Response.new
@@ -14,6 +14,30 @@ module Typhoeus
   #   actual = Typhoeus.get("www.example.com")
   #   expected == actual
   #   #=> true
+  #
+  # @example Stub a request and get a lazily-constructed response containing data from actual widgets that exist in the system when the stubbed request is made.
+  #   Typhoeus.stub("www.example.com/widgets") do
+  #     actual_widgets = Widget.all
+  #     Typhoeus::Response.new(
+  #       :body => actual_widgets.inject([]) do |ids, widget|
+  #         ids << widget.id
+  #       end.join(",")
+  #     )
+  #   end
+  #
+  # @example Stub a request and get a lazily-constructed response in the format requested.
+  #   Typhoeus.stub("www.example.com") do |request|
+  #     accept = (request.options[:headers]||{})['Accept'] || "application/json"
+  #     format = accept.split(",").first
+  #     body_obj = { 'things' => [ { 'id' => 'foo' } ] }
+  #
+  #     Typhoeus::Response.new(
+  #       :headers => {
+  #         'Content-Type' => format
+  #       },
+  #       :body => SERIALIZERS[format].serialize(body_obj)
+  #     )
+  #   end
   class Expectation
 
     # @api private
@@ -38,7 +62,7 @@ module Typhoeus
       end
 
       # Clears expectations. This is handy while
-      # testing and you want to make sure, that
+      # testing, and you want to make sure that
       # you don't get canned responses.
       #
       # @example Clear expectations.
@@ -47,14 +71,24 @@ module Typhoeus
         all.clear
       end
 
-      # Returns expecation matching the provided
-      # request.
+      # Returns stubbed response matching the
+      # provided request.
       #
-      # @example Find expectation.
-      #   Typhoeus::Expectation.find_by(request)
+      # @example Find response
+      #   Typhoeus::Expectation.response_for(request)
       #
-      # @return [ Expectation ] The matching expectation.
+      # @return [ Typhoeus::Response ] The stubbed response from a
+      #   matching expectation, or nil if no matching expectation
+      #   is found.
       #
+      # @api private
+      def response_for(request)
+        expectation = find_by(request)
+        return nil if expectation.nil?
+
+        expectation.response(request)
+      end
+
       # @api private
       def find_by(request)
         all.find do |expectation|
@@ -79,7 +113,7 @@ module Typhoeus
     end
 
     # Set from value to mark an expectaion. Useful for
-    # other libraries, eg. webmock.
+    # other libraries, e.g. WebMock.
     #
     # @example Mark expectation.
     #   expectation.from(:webmock)
@@ -101,11 +135,11 @@ module Typhoeus
     #   expectation.and_return(response)
     #
     # @return [ void ]
-    def and_return(response)
-      responses << response
+    def and_return(response=nil, &block)
+      responses << (response.nil? ? block : response)
     end
 
-    # Checks wether this expectation matches
+    # Checks whether this expectation matches
     # the provided request.
     #
     # @example Check if request matches.
@@ -133,7 +167,7 @@ module Typhoeus
     end
 
     # Return the response. When there are
-    # multiple responses, they were returned one
+    # multiple responses, they are returned one
     # by one.
     #
     # @example Return response.
@@ -142,8 +176,11 @@ module Typhoeus
     # @return [ Response ] The response.
     #
     # @api private
-    def response
+    def response(request)
       response = responses.fetch(@response_counter, responses.last)
+      if response.respond_to?(:call)
+        response = response.call(request)
+      end
       @response_counter += 1
       response.mock = @from || true
       response
@@ -151,15 +188,15 @@ module Typhoeus
 
     private
 
-    # Check wether the options matches the request options.
+    # Check whether the options matches the request options.
     # I checks options and original options.
     def options_match?(request)
       (options ? options.all?{ |k,v| request.original_options[k] == v || request.options[k] == v } : true)
     end
 
-    # Check wether the base_url matches the request url.
+    # Check whether 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.
+    # regexp are checked, nil is always true, else false.
     #
     # Nil serves as a placeholder in case you want to match
     # all urls.

data/lib/typhoeus/hydra.rb

@@ -67,7 +67,7 @@ module Typhoeus
       # @deprecated This is only for convenience because so
       #   much external code relies on it.
       def hydra
-        @hydra ||= new
+        Thread.current[:typhoeus_hydra] ||= new
       end
     end
 

data/lib/typhoeus/hydra/stubbable.rb

@@ -15,8 +15,8 @@ module Typhoeus
       # @example Add the request.
       #   hydra.add(request)
       def add(request)
-        if expectation = Expectation.find_by(request)
-          request.finish(expectation.response)
+        if response = Expectation.response_for(request)
+          request.finish(response)
         else
           super
         end

data/lib/typhoeus/pool.rb

@@ -12,8 +12,8 @@ module Typhoeus
 
     @mutex = Mutex.new
 
-    # Releases easy into pool. The easy handle is
-    # resetted before it gets back in.
+    # Releases easy into the pool. The easy handle is
+    # reset before it gets back in.
     #
     # @example Release easy.
     #   hydra.release_easy(easy)
@@ -22,7 +22,7 @@ module Typhoeus
       @mutex.synchronize { easies << easy }
     end
 
-    # Return an easy from pool.
+    # Return an easy from the pool.
     #
     # @example Return easy.
     #   hydra.get_easy

data/lib/typhoeus/request.rb

@@ -42,7 +42,7 @@ module Typhoeus
     # @return [ Hash ]
     attr_accessor :options
 
-    # Returns the hydra the request ran into if any.
+    # Returns the hydra in which the request ran, if any.
     #
     # @return [ Typhoeus::Hydra ]
     #
@@ -61,7 +61,7 @@ module Typhoeus
     # @api private
     attr_accessor :block_connection
 
-    # Create a new request.
+    # Creates a new request.
     #
     # @example Simplest request.
     #   response = Typhoeus::Request.new("www.example.com").run
@@ -126,14 +126,14 @@ module Typhoeus
       EasyFactory.new(self).get.url
     end
 
-    # Returns wether other is equal to self.
+    # Returns whether other is equal to self.
     #
     # @example Are request equal?
     #   request.eql?(other_request)
     #
     # @param [ Object ] other The object to check.
     #
-    # @return [ Boolean ] Returns true if equals, else false.
+    # @return [ Boolean ] Returns true if equal, else false.
     #
     # @api private
     def eql?(other)

data/lib/typhoeus/request/stubbable.rb

@@ -17,8 +17,8 @@ module Typhoeus
       #
       # @return [ Response ] The response.
       def run
-        if expectation = Expectation.find_by(self)
-          finish(expectation.response)
+        if response = Expectation.response_for(self)
+          finish(response)
         else
           super
         end

data/lib/typhoeus/response.rb

@@ -4,7 +4,7 @@ require 'typhoeus/response/status'
 
 module Typhoeus
 
-  # This class respresents the response.
+  # This class represents the response.
   class Response
     include Response::Informations
     include Response::Status
@@ -20,7 +20,7 @@ module Typhoeus
     # @return [ Typhoeus::Request ]
     attr_accessor :request
 
-    # The options provided, contains all the
+    # The provided options, which contain all the
     # informations about the request.
     #
     # @return [ Hash ]
@@ -45,7 +45,7 @@ module Typhoeus
       @headers = Header.new(options[:headers]) if options[:headers]
     end
 
-    # Returns wether this request is mocked
+    # Returns whether this request is mocked
     # or not.
     #
     # @api private
@@ -54,7 +54,7 @@ module Typhoeus
     end
 
     # Returns the handled_response if it has
-    # been defined otherwise returns the response
+    # been defined; otherwise, returns the response
     #
     # @return [ Object ] The result of callbacks
     #   done on the response or the original response.

data/lib/typhoeus/response/informations.rb

@@ -195,7 +195,7 @@ module Typhoeus
       #
       # @return [ Typhoeus::Header ] The response header.
       def headers
-        return nil if response_headers.nil? && @headers.nil?
+        return nil if response_headers.nil? && !defined?(@headers)
         @headers ||= Response::Header.new(response_headers.split("\r\n\r\n").last)
       end
       alias :headers_hash :headers

data/lib/typhoeus/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-04-09 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.10
+        version: 0.5.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.10
+        version: 0.5.11
 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:
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -431775000708918631
+      hash: 3937709754755965055
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: