typhoeus 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d43b52d7dfc8cb4542b1670f07f43351906129ba
-  data.tar.gz: 3ff1f2870c76247f16ce94c00e7f534dafe6c879
+  metadata.gz: 79bd3451f6ec67ea973d9dc62dc4645c21e2eba1
+  data.tar.gz: 762e3c44e97fc0f2241d5cbf9d2a9ff2caa8a53a
 SHA512:
-  metadata.gz: fda1a066fe0e0d0a6c078540d85b87739fe7e24907b92e272dc86d473cc9d6a01bc726047f942efc5a7a1a35da62dcfe2bff10c952469c464174ab1592d1c10c
-  data.tar.gz: d407bebd52067ed31b54e4b72a5d5e8ce65f9d43b9fe17e00fd4e7ae024bff905f95ff268e6ca22d2aad90a8fec440c1d69ae9171c83ed68c832831a5699c703
+  metadata.gz: e0a7c0b640b05b4527a4a9a7b3ee7db526fc25e31e001b7287f2423fecebbf6d673adb5c17b7cda32c1206872a3a27d82825b9ee74974607f691e9ee573fb39a
+  data.tar.gz: 444398bc7499402359de7a5534c265bf91c39346903c1b82c4767b1b7f9eb9c72741a979986b905e388301055e6816baa6ef999f9f35bed06a07a4bec37d7b99

data/.travis.yml

@@ -1,21 +1,26 @@
+language: ruby
 script: "bundle exec rake"
-sudo: false
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.7
+  - 2.5.6
+  - 2.6.4
   - ruby-head
   - jruby-head
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
 matrix: 
   fast_finish: true
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-18mode
-    - rvm: rbx-19mode
     - rvm: ree
+  include:
+    - rvm: 1.8.7
+      dist: precise
+    - rvm: 1.9.2
+      dist: trusty

data/CHANGELOG.md

@@ -2,13 +2,49 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.0.0...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...master)
+
+## 1.4.0
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.1.2...v1.4.0)
+
+#### 1 feature
+- Faraday adapter exceptions namespace compatibility with Faraday v1 ([@iMacTia](https://github.com/iMacTia) in [#616](https://github.com/typhoeus/typhoeus/pull/616))
+
+#### 3 Others
+- Yard warning fixes ([@olleolleolle](https://github.com/olleolleolle) in [#622](https://github.com/typhoeus/typhoeus/pull/622))
+- Add more Ruby versions in CI matrix ([@olleolleolle](https://github.com/olleolleolle) in [#623](https://github.com/typhoeus/typhoeus/pull/623))
+- Use of argument passed in function instead of `attr_reader` ([@v-kolesnikov](https://github.com/v-kolesnikov) in [#625](https://github.com/typhoeus/typhoeus/pull/625))
+
+## 1.1.2
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.1.1...v1.1.2)
+
+## 1.1.1
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.1.0...v1.1.1)
+
+## 1.1.0
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.0.2...v1.1.0)
+
+* Unless specified `Expect` header is set to be empty to avoid `100 continue`
+  to be set when using `PUT`
+* Add global config option `Typhoeus::Config.proxy`
+
+## 1.0.2
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.0.1...v1.0.2)
+
+## 1.0.1
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.0.0...v1.0.1)
 
 ## 1.0.0
 
 [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.8.0...v1.0.0)
 
-## O.8.0
+## 0.8.0
 
 [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.7.3...v0.8.0)
 

data/CONTRIBUTING.md

@@ -14,3 +14,7 @@ a test!
 5. Push to your fork and submit a pull request.
 
 And in case we didn't emphasize it enough: we love tests!
+
+## Issue triage [![Open Source Helpers](https://www.codetriage.com/typhoeus/typhoeus/badges/users.svg)](https://www.codetriage.com/typhoeus/typhoeus)
+
+You can contribute by triaging issues which may include reproducing bug reports or asking for vital information, such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to typhoeus on CodeTriage](https://www.codetriage.com/typhoeus/typhoeus).

data/Gemfile

@@ -1,14 +1,25 @@
 source "https://rubygems.org"
 gemspec
 
-gem "rake"
+if Gem.ruby_version < Gem::Version.new("2.0.0")
+  gem "rake", "< 11"
+  gem "json", "< 2"
+else
+  gem "json"
+  gem "rake"
+end
 
 group :development, :test do
   gem "rspec", "~> 3.0"
 
   gem "sinatra", "~> 1.3"
-  gem "json"
-  gem "faraday", ">= 0.9"
+
+  if Gem.ruby_version >= Gem::Version.new("1.9.0")
+    gem "faraday", ">= 0.9"
+    gem "dalli", "~> 2.0"
+  end
+
+  gem "redis", "~> 3.0"
 
   if RUBY_PLATFORM == "java"
     gem "spoon"

data/LICENSE

@@ -1,6 +1,6 @@
 Copyright (c) 2009-2010 Paul Dix
 Copyright (c) 2011 David Balatero
-Copyright (c) 2012-2014 Hans Hasselberg
+Copyright (c) 2012-2016 Hans Hasselberg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,17 +1,7 @@
-# Typhoeus [![Build Status](https://img.shields.io/travis/typhoeus/typhoeus/master.svg)](https://travis-ci.org/typhoeus/typhoeus) [![Code Climate](https://img.shields.io/codeclimate/github/typhoeus/typhoeus.svg)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://img.shields.io/gem/v/typhoeus.svg)](https://rubygems.org/gems/typhoeus)
+# Typhoeus [![Build Status](https://img.shields.io/travis/typhoeus/typhoeus/master.svg)](https://travis-ci.org/typhoeus/typhoeus) [![Code Climate](https://img.shields.io/codeclimate/maintainability/typhoeus/typhoeus.svg)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://img.shields.io/gem/v/typhoeus.svg)](https://rubygems.org/gems/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.
 
-# Typhoeus needs your help!
-
-I don't have enough time, but I think this is a nice project! If you or your company is using Typhoeus you should help keeping it alive! Pick any of:
-
-* add docs
-* respond to issues
-* add features
-
-Or send me an email! I would be more than happy to help getting you up to speed!
-
 ## Example
 
 A single request:
@@ -29,13 +19,16 @@ hydra.run
 ```
 
 ## Installation
-
+Add the following line to your Gemfile:
 ```
-gem install typhoeus
+gem "typhoeus"
 ```
+Then run `bundle install`
+
+Or install it yourself as:
 
 ```
-gem "typhoeus"
+gem install typhoeus
 ```
 
 ## Project Tracking
@@ -201,6 +194,19 @@ end
 request.run
 ```
 
+If you need to interrupt the stream halfway,
+you can return the `:abort` symbol from the `on_body` block, example:
+
+```ruby
+request.on_body do |chunk|
+  buffer << chunk
+  :abort if buffer.size > 1024 * 1024
+end
+```
+
+This will properly stop the stream internally and avoid any memory leak which
+may happen if you interrupt with something like a `return`, `throw` or `raise`.
+
 ### Making Parallel Requests
 
 Generally, you should be running requests through hydra. Here is how that looks:
@@ -252,6 +258,33 @@ end
 hydra.run
 ```
 
+### Making Parallel Requests with Faraday + Typhoeus
+
+```ruby
+require 'faraday'
+
+conn = Faraday.new(:url => 'http://httppage.com') do |builder|
+  builder.request  :url_encoded
+  builder.response :logger
+  builder.adapter  :typhoeus
+end
+
+conn.in_parallel do
+  response1 = conn.get('/first')
+  response2 = conn.get('/second')
+
+  # these will return nil here since the
+  # requests have not been completed
+  response1.body
+  response2.body
+end
+
+# after it has been completed the response information is fully available
+# response1.status, etc
+response1.body
+response2.body
+```
+
 ### Specifying Max Concurrency
 
 Hydra will also handle how many requests you can make in parallel. Things will get flakey if you try to make too many requests at the same time. The built in limit is 200. When more requests than that are queued up, hydra will save them for later and start the requests as others are finished. You can raise or lower the concurrency limit through the Hydra constructor.
@@ -317,37 +350,32 @@ Typhoeus.get("www.example.com").cached?
 For use with [Dalli](https://github.com/mperham/dalli):
 
 ```ruby
-class Cache
-  def initialize
-    @client = Dalli::Client.new
-  end
-
-  def get(request)
-    @client.get(request.cache_key)
-  end
+dalli = Dalli::Client.new(...)
+Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new(dalli)
+```
 
-  def set(request, response)
-    @client.set(request.cache_key, response)
-  end
-end
+For use with Rails:
 
-Typhoeus::Config.cache = Cache.new
+```ruby
+Typhoeus::Config.cache = Typhoeus::Cache::Rails.new
 ```
 
-For use with Rails:
+For use with [Redis](https://github.com/redis/redis-rb):
 
 ```ruby
-class Cache
-  def get(request)
-    Rails.cache.read(request)
-  end
+redis = Redis.new(...)
+Typhoeus::Config.cache = Typhoeus::Cache::Redis.new(redis)
+```
 
-  def set(request, response)
-    Rails.cache.write(request, response)
-  end
-end
+All three of these adapters take an optional keyword argument `default_ttl`, which sets a default
+TTL on cached responses (in seconds), for requests which do not have a cache TTL set.
 
-Typhoeus::Config.cache = Cache.new
+You may also selectively choose not to cache by setting `cache` to `false` on a request or to use
+a different adapter.
+
+```ruby
+cache = Cache.new
+Typhoeus.get("www.example.com", cache: cache)
 ```
 
 ### Direct Stubbing
@@ -407,7 +435,7 @@ and [`connecttimeout`](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLO
 `timeout` is the time limit for the entire request in seconds.
 `connecttimeout` is the time limit for just the connection phase, again in seconds.
 
-There are two additional more fine grained opptions `timeout_ms` and
+There are two additional more fine grained options `timeout_ms` and
 `connecttimeout_ms`. These options offer millisecond precision but are not always available (for instance on linux if `nosignal` is not set to true).
 
 When you pass a floating point `timeout` (or `connecttimeout`) Typhoeus will set `timeout_ms` for you if it has not been defined. The actual timeout values passed to curl will always be rounded up.
@@ -535,7 +563,7 @@ Copyright © 2009-2010 [Paul Dix](http://www.pauldix.net/)
 
 Copyright © 2011-2012 [David Balatero](https://github.com/dbalatero/)
 
-Copyright © 2012-2014 [Hans Hasselberg](http://github.com/i0rek/)
+Copyright © 2012-2016 [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"),
@@ -554,6 +582,3 @@ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/typhoeus/typhoeus/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/lib/typhoeus/adapters/faraday.rb

@@ -12,6 +12,9 @@ module Faraday # :nodoc:
     #
     #   conn = Faraday.new(url: "www.example.com") do |faraday|
     #     faraday.adapter :typhoeus
+    #
+    #     # You can include Typhoeus options to be used for every request
+    #     # faraday.adapter :typhoeus, forbid_reuse: true, maxredirs: 1
     #   end
     #
     #   response = conn.get("/")
@@ -32,6 +35,17 @@ module Faraday # :nodoc:
       remove_method :configure_socket  if method_defined? :configure_socket
       remove_method :parallel?         if method_defined? :parallel?
 
+      # Initialize the Typhoeus adapter
+      #
+      # @param [ App ] app Farday app
+      # @option [ Hash ] adapter_options Typhoeus options
+      #
+      # @return [ void ]
+      def initialize(app, adapter_options = {})
+        super(app)
+        @adapter_options = adapter_options
+      end
+
       # Setup Hydra with provided options.
       #
       # @example Setup Hydra.
@@ -72,12 +86,7 @@ module Faraday # :nodoc:
       def request(env)
         read_body env
 
-        req = ::Typhoeus::Request.new(
-          env[:url].to_s,
-          :method  => env[:method],
-          :body    => env[:body],
-          :headers => env[:request_headers]
-        )
+        req = typhoeus_request(env)
 
         configure_ssl     req, env
         configure_proxy   req, env
@@ -88,12 +97,13 @@ module Faraday # :nodoc:
           if resp.timed_out?
             env[:typhoeus_timed_out] = true
             unless parallel?(env)
-              raise Faraday::Error::TimeoutError, "request timed out"
+              raise Faraday::TimeoutError, "request timed out"
             end
-          elsif resp.response_code == 0
+          elsif (resp.response_code == 0) || ((resp.return_code != :ok) && !resp.mock?)
             env[:typhoeus_connection_failed] = true
+            env[:typhoeus_return_message] = resp.return_message
             unless parallel?(env)
-              raise Faraday::Error::ConnectionFailed, resp.return_message
+              raise Faraday::ConnectionFailed, resp.return_message
             end
           end
 
@@ -107,6 +117,16 @@ module Faraday # :nodoc:
         req
       end
 
+      def typhoeus_request(env)
+        opts = {
+          :method => env[:method],
+          :body => env[:body],
+          :headers => env[:request_headers]
+        }.merge(@adapter_options)
+
+        ::Typhoeus::Request.new(env[:url].to_s, opts)
+      end
+
       def read_body(env)
         env[:body] = env[:body].read if env[:body].respond_to? :read
       end
@@ -135,6 +155,7 @@ module Faraday # :nodoc:
         req.options[:proxy] = "#{proxy[:uri].scheme}://#{proxy[:uri].host}:#{proxy[:uri].port}"
 
         if proxy[:user] && proxy[:password]
+          req.options[:proxyauth] = :any
           req.options[:proxyuserpwd] = "#{proxy[:user]}:#{proxy[:password]}"
         end
       end

data/lib/typhoeus/cache/dalli.rb

@@ -0,0 +1,28 @@
+module Typhoeus
+  module Cache
+    # This module provides a simple way to cache HTTP responses using Dalli.
+    class Dalli
+      # @example Set Dalli as the Typhoeus cache backend
+      #   Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new
+      #
+      # @param [ Dalli::Client ] client
+      #   A connection to the cache server. Defaults to `Dalli::Client.new`
+      # @param [ Hash ] options
+      #   Options
+      # @option options [ Integer ] :default_ttl
+      #   The default TTL of cached responses in seconds, for requests which do not set a cache_ttl.
+      def initialize(client = ::Dalli::Client.new, options = {})
+        @client = client
+        @default_ttl = options[:default_ttl]
+      end
+
+      def get(request)
+        @client.get(request.cache_key)
+      end
+
+      def set(request, response)
+        @client.set(request.cache_key, response, request.cache_ttl || @default_ttl)
+      end
+    end
+  end
+end

data/lib/typhoeus/cache/rails.rb

@@ -0,0 +1,28 @@
+module Typhoeus
+  module Cache
+    # This module provides a simple way to cache HTTP responses in using the Rails cache.
+    class Rails
+      # @example Use the Rails cache setup to cache Typhoeus responses.
+      #   Typhoeus::Config.cache = Typhoeus::Cache::Rails.new
+      #
+      # @param [ ActiveSupport::Cache::Store ] cache
+      #   A Rails cache backend. Defaults to Rails.cache.
+      # @param [ Hash ] options
+      #   Options
+      # @option options [ Integer ] :default_ttl
+      #   The default TTL of cached responses in seconds, for requests which do not set a cache_ttl.
+      def initialize(cache = ::Rails.cache, options = {})
+        @cache = cache
+        @default_ttl = options[:default_ttl]
+      end
+
+      def get(request)
+        @cache.read(request)
+      end
+
+      def set(request, response)
+        @cache.write(request.cache_key, response, :expires_in => request.cache_ttl || @default_ttl)
+      end
+    end
+  end
+end

data/lib/typhoeus/cache/redis.rb

@@ -0,0 +1,35 @@
+module Typhoeus
+  module Cache
+    # This module provides a simple way to cache HTTP responses in Redis.
+    class Redis
+      # @example Set Redis as the Typhoeus cache backend
+      #   Typhoeus::Config.cache = Typhoeus::Cache::Redis.new
+      #
+      # @param [ Redis ] redis
+      #   A connection to Redis. Defaults to `Redis.new`, which uses the
+      #   `REDIS_URL` environment variable to connect
+      # @param [ Hash ] options
+      #   Options
+      # @option options [ Integer ] :default_ttl
+      #   The default TTL of cached responses in seconds, for requests which do not set a cache_ttl.
+      def initialize(redis = ::Redis.new, options = {})
+        @redis = redis
+        @default_ttl = options[:default_ttl]
+      end
+
+      def get(request)
+        serialized_response = @redis.get(request.cache_key)
+        return unless serialized_response
+        Marshal.load(serialized_response)
+      end
+
+      def set(request, response)
+        ttl = request.cache_ttl || @default_ttl
+        key = request.cache_key
+        serialized_response = Marshal.dump(response)
+        @redis.set(key, serialized_response)
+        @redis.expire(key, ttl) if ttl
+      end
+    end
+  end
+end

data/lib/typhoeus/config.rb

@@ -18,7 +18,7 @@ module Typhoeus
     # {Typhoeus::Errors::NoStub} error is raised,
     # when trying to do a real request. It's possible
     # to work around inside
-    # {Typhoeus#with_connection}.
+    # {Typhoeus.with_connection}.
     #
     # @return [ Boolean ]
     #
@@ -58,5 +58,12 @@ module Typhoeus
     #
     # @see Typhoeus::Request#set_defaults
     attr_accessor :user_agent
+
+    # Defines wether to use a proxy server for every request.
+    #
+    # @return [ String ]
+    #
+    # @see Typhoeus::Request#set_defaults
+    attr_accessor :proxy
   end
 end

data/lib/typhoeus/easy_factory.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Typhoeus
 
   # This is a Factory for easies to be used in the hydra.
@@ -33,7 +35,7 @@ module Typhoeus
 
     REMOVED_OPTIONS =  Set.new([:cache_key_basis, :cache_timeout, :user_agent])
 
-    SANITIZE_IGNORE  = Set.new([:method, :cache_ttl])
+    SANITIZE_IGNORE  = Set.new([:method, :cache_ttl, :cache])
     SANITIZE_TIMEOUT = Set.new([:timeout_ms, :connecttimeout_ms])
 
     # Returns the request provided.
@@ -95,7 +97,7 @@ module Typhoeus
       # set nosignal to true by default
       # this improves thread safety and timeout behavior
       sanitized = {:nosignal => true}
-      request.options.each do |k,v|
+      options.each do |k,v|
         s = k.to_sym
         next if SANITIZE_IGNORE.include?(s)
         if new_option = RENAMED_OPTIONS[k.to_sym]
@@ -119,7 +121,7 @@ module Typhoeus
     end
 
     def sanitize_timeout!(options, timeout)
-      timeout_ms = (timeout.to_s + '_ms').to_sym
+      timeout_ms = :"#{timeout}_ms"
       if options[timeout] && options[timeout].round != options[timeout]
         if !options[timeout_ms]
           options[timeout_ms] = (options[timeout]*1000).ceil
@@ -153,6 +155,11 @@ module Typhoeus
           request.execute_headers_callbacks(Response.new(Ethon::Easy::Mirror.from_easy(easy).options))
         end
       end
+      request.on_progress.each do |callback|
+        easy.on_progress do |dltotal, dlnow, ultotal, ulnow, easy|
+          callback.call(dltotal, dlnow, ultotal, ulnow, response)
+        end
+      end
       easy.on_complete do |easy|
         request.finish(Response.new(easy.mirror.options))
         Typhoeus::Pool.release(easy)

data/lib/typhoeus/hydra/cacheable.rb

@@ -2,7 +2,7 @@ module Typhoeus
   class Hydra
     module Cacheable
       def add(request)
-        if request.cacheable? && response = Typhoeus::Config.cache.get(request)
+        if request.cacheable? && response = request.cached_response
           response.cached = true
           request.finish(response)
           dequeue

data/lib/typhoeus/pool.rb

@@ -17,6 +17,8 @@ module Typhoeus
     # @example Release easy.
     #   Typhoeus::Pool.release(easy)
     def self.release(easy)
+      easy.cookielist = "flush" # dump all known cookies to 'cookiejar'
+      easy.cookielist = "all" # remove all cookies from memory for this handle
       easy.reset
       @mutex.synchronize { easies << easy }
     end

data/lib/typhoeus/request/actions.rb

@@ -15,7 +15,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def get(base_url, options = {})
@@ -31,7 +31,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def post(base_url, options = {})
@@ -50,7 +50,7 @@ module Typhoeus
       # @option options :body [ Hash ] Body hash which
       #   becomes a PUT request body.
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def put(base_url, options = {})
@@ -66,7 +66,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def delete(base_url, options = {})
@@ -82,7 +82,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def head(base_url, options = {})
@@ -98,7 +98,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def patch(base_url, options = {})
@@ -114,7 +114,7 @@ module Typhoeus
       #
       # @option (see Typhoeus::Request#initialize)
       #
-      # @return (see Typhoeus::Request#initialize)
+      # @return (see Typhoeus::Response#initialize)
       #
       # @note (see Typhoeus::Request#initialize)
       def options(base_url, options = {})