typhoeus 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df7045af2adbad5bf0b5bc883e8bc259a2f63544
-  data.tar.gz: 16d738d8b00c774fe54a78c32becde597ad69569
+SHA256:
+  metadata.gz: b1a6b0485477d252e7eb99852bec27994e9c23aa54e7d376cd24bc07d3639d5c
+  data.tar.gz: d2dbaf34e81e7a906dbf254d0d1aa1d6028c10a08605b6dc6261c282bfc39abd
 SHA512:
-  metadata.gz: c5f8427b91d383cd94bc48c4f944b3bc7dbce619e0eccda0f84d428eb575ff9f7b65530f18789cb1aa99f02e4f03293af9987cffb12686542af13b9fb49bba51
-  data.tar.gz: e01422dc678ff40ac31b695bc1dea8d0c3b843e0ecd2ad61fa386d9b290a0950db93e37289215aedaee3aad60a7cc2acd48efc4baf59ae4fc96f3198d5df460a
+  metadata.gz: 711db47d856f75d5eb730e11161e02a6a6f6c6d9e966aeec3ace577d250d57a790c2d0d5ade86fda425bff6b5f6d5c77079107a3f41a2379d4bff9cd802ca712
+  data.tar.gz: 52cfa55fe418b64ed16e094a497d6fc72092b8d5745d81860aead9e35a6dba403fb2375674ca652ba6bb8e5acac29ed5ce03161c2c68dc0f1de9d44ad65ac277

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    env:
+      BUNDLE_GEMFILE: Gemfile
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', truffleruby]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install libcurl header
+        run: |
+          if ${{ matrix.os == 'macos' }}
+          then
+            brew install curl
+          else
+            sudo apt update && sudo apt install -y --no-install-recommends libcurl4-openssl-dev
+          fi
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rake

data/.github/workflows/experimental.yml

@@ -0,0 +1,33 @@
+name: Experimental
+on: [push, pull_request]
+jobs:
+  build:
+    env:
+      BUNDLE_GEMFILE: Gemfile
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby-version:
+          - ruby-head
+          - jruby-head
+          - truffleruby-head
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install libcurl header
+        run: |
+          if ${{ matrix.os == 'macos' }}
+          then
+            brew install curl
+          else
+            sudo apt update && sudo apt install -y --no-install-recommends libcurl4-openssl-dev
+          fi
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rake

data/CHANGELOG.md

@@ -2,7 +2,23 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.1.2...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.1...master)
+
+## 1.4.1
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...v1.4.1)
+
+## 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
 

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

@@ -15,10 +15,14 @@ group :development, :test do
   gem "sinatra", "~> 1.3"
 
   if Gem.ruby_version >= Gem::Version.new("1.9.0")
-    gem "faraday", ">= 0.9"
+    gem "faraday", ">= 0.9", "< 2.0"
     gem "dalli", "~> 2.0"
   end
 
+  if Gem.ruby_version >= Gem::Version.new("3.0.0")
+    gem 'webrick'
+  end
+
   gem "redis", "~> 3.0"
 
   if RUBY_PLATFORM == "java"

data/README.md

@@ -1,4 +1,4 @@
-# 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 [![CI](https://github.com/typhoeus/typhoeus/actions/workflows/ci.yml/badge.svg)](https://github.com/typhoeus/typhoeus/actions/workflows/ci.yml) [![Experimental](https://github.com/typhoeus/typhoeus/actions/workflows/experimental.yml/badge.svg)](https://github.com/typhoeus/typhoeus/actions/workflows/experimental.yml) [![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.
 
@@ -19,19 +19,20 @@ hydra.run
 ```
 
 ## Installation
-
+Run:
 ```
-gem install typhoeus
+bundle add typhoeus
 ```
 
+Or install it yourself as:
+
 ```
-gem "typhoeus"
+gem install typhoeus
 ```
 
 ## Project Tracking
 
-* [Documentation](http://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (GitHub master)
-* [Mailing list](http://groups.google.com/group/typhoeus)
+* [API Documentation](https://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (GitHub master)
 
 ## Usage
 
@@ -191,6 +192,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:
@@ -242,6 +256,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.
@@ -307,6 +348,8 @@ Typhoeus.get("www.example.com").cached?
 For use with [Dalli](https://github.com/mperham/dalli):
 
 ```ruby
+require "typhoeus/cache/dalli"
+
 dalli = Dalli::Client.new(...)
 Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new(dalli)
 ```
@@ -314,12 +357,16 @@ Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new(dalli)
 For use with Rails:
 
 ```ruby
+require "typhoeus/cache/rails"
+
 Typhoeus::Config.cache = Typhoeus::Cache::Rails.new
 ```
 
 For use with [Redis](https://github.com/redis/redis-rb):
 
 ```ruby
+require "typhoeus/cache/redis"
+
 redis = Redis.new(...)
 Typhoeus::Config.cache = Typhoeus::Cache::Redis.new(redis)
 ```
@@ -327,6 +374,14 @@ Typhoeus::Config.cache = Typhoeus::Cache::Redis.new(redis)
 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.
 
+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
 
 Hydra allows you to stub out specific urls and patterns to avoid hitting

data/lib/typhoeus/adapters/faraday.rb

@@ -97,13 +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
 

data/lib/typhoeus/cache/dalli.rb

@@ -7,7 +7,9 @@ module Typhoeus
       #
       # @param [ Dalli::Client ] client
       #   A connection to the cache server. Defaults to `Dalli::Client.new`
-      # @param [ Integer ] default_ttl
+      # @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

data/lib/typhoeus/cache/rails.rb

@@ -7,7 +7,9 @@ module Typhoeus
       #
       # @param [ ActiveSupport::Cache::Store ] cache
       #   A Rails cache backend. Defaults to Rails.cache.
-      # @param [ Integer ] default_ttl
+      # @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
@@ -19,7 +21,7 @@ module Typhoeus
       end
 
       def set(request, response)
-        @cache.write(request, response, :expires_in => request.cache_ttl || @default_ttl)
+        @cache.write(request.cache_key, response, :expires_in => request.cache_ttl || @default_ttl)
       end
     end
   end

data/lib/typhoeus/cache/redis.rb

@@ -8,7 +8,9 @@ module Typhoeus
       # @param [ Redis ] redis
       #   A connection to Redis. Defaults to `Redis.new`, which uses the
       #   `REDIS_URL` environment variable to connect
-      # @param [ Integer ] default_ttl
+      # @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

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 ]
     #
@@ -44,6 +44,22 @@ module Typhoeus
     # @see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTVERBOSE
     attr_accessor :verbose
 
+    # Defines the default HTTP timeout for the entire request in seconds
+    # See README for more details about timeouts
+    #
+    # @return [ Integer, Float ]
+    #
+    # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt#CURLOPTTIMEOUT
+    attr_accessor :timeout
+
+    # Defines the default HTTP timeout for the connection phase in seconds
+    # See README for more details about timeouts
+    #
+    # @return [ Integer, Float ]
+    #
+    # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT
+    attr_accessor :connecttimeout
+
     # Defines whether requests are cached.
     #
     # @return [ Object ]

data/lib/typhoeus/easy_factory.rb

@@ -35,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.
@@ -78,11 +78,17 @@ module Typhoeus
     # @return [ Ethon::Easy ] The easy.
     def get
       begin
+        read_callback_body = request.options.delete(:set_read_callback)
+
         easy.http_request(
           request.base_url.to_s,
           request.options.fetch(:method, :get),
           sanitize(request.options)
         )
+
+        # this needs to happen after http_request because
+        # ethon will set infilesize to zero if form.empty?
+        set_read_callback(read_callback_body) if !read_callback_body.nil?
       rescue Ethon::Errors::InvalidOption => e
         help = provide_help(e.message.match(/:\s(\w+)/)[1])
         raise $!, "#{$!}#{help}", $!.backtrace
@@ -97,7 +103,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]
@@ -155,6 +161,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)
@@ -164,6 +175,26 @@ module Typhoeus
       end
     end
 
+    # Sets up an easy upload with CURLOPT_READFUNCTION
+    # along with CURLOPT_INFILESIZE_LARGE and CURLOPT_UPLOAD
+    #
+    # @param [ String/File ] body The body read by the readfunction.
+    #
+    # @return [ Ethon::Easy ] The easy.
+    def set_read_callback(body)
+      easy.infilesize_large =
+        if body.respond_to?(:bytesize)
+          body.bytesize
+        elsif body.respond_to?(:size)
+          body.size
+        end
+
+      easy.upload = true
+      easy.set_read_callback(body)
+
+      easy
+    end
+
     def provide_help(option)
       if new_option = CHANGED_OPTIONS[option.to_sym]
         "\nPlease try #{new_option} instead of #{option}." if new_option

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/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 = {})

data/lib/typhoeus/request/cacheable.rb

@@ -2,16 +2,16 @@ module Typhoeus
   class Request
     module Cacheable
       def response=(response)
-        Typhoeus::Config.cache.set(self, response) if cacheable? && !response.cached?
+        cache.set(self, response) if cacheable? && !response.cached?
         super
       end
 
       def cacheable?
-        Typhoeus::Config.cache
+        cache
       end
 
       def run
-        if cacheable? && response = Typhoeus::Config.cache.get(self)
+        if response = cached_response
           response.cached = true
           finish(response)
         else
@@ -19,9 +19,20 @@ module Typhoeus
         end
       end
 
+      def cached_response
+        cacheable? && cache.get(self)
+      end
+
       def cache_ttl
         options[:cache_ttl]
       end
+
+      private
+
+      def cache
+        return nil if options[:cache] === false
+        options[:cache] || Typhoeus::Config.cache
+      end
     end
   end
 end

data/lib/typhoeus/request/callbacks.rb

@@ -89,6 +89,24 @@ module Typhoeus
           @on_headers << block if block_given?
           @on_headers
         end
+
+        # Set on_progress callback.
+        #
+        # @example Set on_progress.
+        #   request.on_progress do |dltotal, dlnow, ultotal, ulnow|
+        #     puts "dltotal (#{dltotal}), dlnow (#{dlnow}), ultotal (#{ultotal}), ulnow (#{ulnow})"
+        #   end
+        #
+        # @param [ Block ] block The block to execute.
+        #
+        # @yield [ Typhoeus::Response ]
+        #
+        # @return [ Array<Block> ] All on_progress blocks.
+        def on_progress(&block)
+          @on_progress ||= []
+          @on_progress << block if block_given?
+          @on_progress
+        end
       end
 
       # Execute the headers callbacks and yields response.
@@ -106,8 +124,8 @@ module Typhoeus
       end
 
       # Execute necessary callback and yields response. This
-      # include in every case on_complete, on_success if
-      # successful and on_failure if not.
+      # include in every case on_complete and on_progress, on_success
+      # if successful and on_failure if not.
       #
       # @example Execute callbacks.
       #   request.execute_callbacks
@@ -116,7 +134,7 @@ module Typhoeus
       #
       # @api private
       def execute_callbacks
-        callbacks = Typhoeus.on_complete + on_complete
+        callbacks = Typhoeus.on_complete + Typhoeus.on_progress + on_complete + on_progress
 
         if response && response.success?
           callbacks += Typhoeus.on_success + on_success

data/lib/typhoeus/request/marshal.rb

@@ -5,9 +5,9 @@ module Typhoeus
     module Marshal
 
       # Return the important data needed to serialize this Request, except the
-      # `on_complete`, `on_success`, `on_failure`, and `hydra`, since they cannot be marshalled.
+      # request callbacks and `hydra`, since they cannot be marshalled.
       def marshal_dump
-        unmarshallable = %w(@on_complete @on_success @on_failure @on_headers @on_body @hydra)
+        unmarshallable = %w(@on_complete @on_success @on_failure @on_progress @on_headers @on_body @hydra)
         (instance_variables - unmarshallable - unmarshallable.map(&:to_sym)).map do |name|
           [name, instance_variable_get(name)]
         end

data/lib/typhoeus/request/streamable.rb

@@ -10,7 +10,7 @@ module Typhoeus
       # Setting an on_body callback will cause the response body to be empty.
       #
       # @example Set on_body.
-      #   request.on_body { |response, body_chunk| puts "Got #{body_chunk.bytesize} bytes" }
+      #   request.on_body { |body_chunk, response| puts "Got #{body_chunk.bytesize} bytes" }
       #
       # @param [ Block ] block The block to execute.
       #

data/lib/typhoeus/request.rb

@@ -214,6 +214,8 @@ module Typhoeus
       options[:headers] = {'User-Agent' => default_user_agent}.merge(options[:headers] || {})
       options[:headers]['Expect'] ||= ''
       options[:verbose] = Typhoeus::Config.verbose if options[:verbose].nil? && !Typhoeus::Config.verbose.nil?
+      options[:timeout] = Typhoeus::Config.timeout if options[:timeout].nil? && !Typhoeus::Config.timeout.nil?
+      options[:connecttimeout] = Typhoeus::Config.connecttimeout if options[:connecttimeout].nil? && !Typhoeus::Config.connecttimeout.nil?
       options[:maxredirs] ||= 50
       options[:proxy] = Typhoeus::Config.proxy unless options.has_key?(:proxy) || Typhoeus::Config.proxy.nil?
     end

data/lib/typhoeus/response/header.rb

@@ -1,3 +1,5 @@
+require 'delegate'
+
 module Typhoeus
   class Response
 

data/lib/typhoeus/response/informations.rb

@@ -210,10 +210,67 @@ module Typhoeus
         options[:redirect_count]
       end
 
+      # Return the URL a redirect would take you to, had you enabled redirects.
+      #
+      # @example Get redirect_url.
+      #   response.redirect_url
+      #
+      # @return [ String ] The redirect_url.
+      def redirect_url
+        options[:redirect_url]
+      end
+
       def request_size
         options[:request_size]
       end
 
+      # Return the bytes, the total amount of bytes that were uploaded
+      #
+      # @example Get size_upload.
+      #   response.size_upload
+      #
+      # @return [ Float ] The size_upload.
+      def size_upload
+        options[:size_upload]
+      end
+
+
+      # Return the bytes, the total amount of bytes that were downloaded.
+      # The amount is only for the latest transfer and will be reset again
+      # for each new transfer. This counts actual payload data, what's
+      # also commonly called body. All meta and header data are excluded
+      # and will not be counted in this number.
+      #
+      # @example Get size_download
+      #   response.size_download
+      #
+      # @return [ Float ] The size_download.
+      def size_download
+        options[:size_download]
+      end
+
+      # Return the bytes/second, the average upload speed that curl
+      # measured for the complete upload
+      #
+      # @example Get speed_upload.
+      #   response.speed_upload
+      #
+      # @return [ Float ] The speed_upload.
+      def speed_upload
+        options[:speed_upload]
+      end
+
+      # Return the bytes/second, the average download speed that curl
+      # measured for the complete download
+      #
+      # @example Get speed_download.
+      #   response.speed_download
+      #
+      # @return [ Float ] The speed_download.
+      def speed_download
+        options[:speed_download]
+      end
+
       def debug_info
         options[:debug_info]
       end

data/lib/typhoeus/response/status.rb

@@ -39,7 +39,7 @@ module Typhoeus
         @http_version ||= first_header_line ? first_header_line[/HTTP\/(\S+)/, 1] : nil
       end
 
-      # Return wether the response is a success.
+      # Return whether the response is a success.
       #
       # @example Return if the response was successful.
       #  response.success?
@@ -49,13 +49,12 @@ module Typhoeus
         (mock || return_code == :ok) && response_code && has_good_response_code?
       end
 
-      # Return wether the response is a failure.
+      # Return whether the response is a failure.
       #
       # @example Return if the response was failed.
       #  response.failure?
       #
       # @return [ Boolean ] Return true if failure, false else.
-
       def failure?
         (mock || return_code == :internal_server_error) && response_code && has_bad_response_code?
       end

data/lib/typhoeus/response.rb

@@ -14,7 +14,7 @@ module Typhoeus
     # Remembers the corresponding request.
     #
     # @example Get request.
-    #   request = Typhoeus::Request.get("www.example.com")
+    #   request = Typhoeus::Request.new("www.example.com")
     #   response = request.run
     #   request == response.request
     #   #=> true

data/lib/typhoeus/version.rb

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

data/lib/typhoeus.rb

@@ -127,11 +127,12 @@ module Typhoeus
   #     #=> :ok
   #   end
   #
-  # @param [ Block ] block The block to execute.
-  #
+  # @yield Yields control to the block after disabling block_connection.
+  #        Afterwards, the block_connection is set to its original
+  #        value.
   # @return [ Object ] Returns the return value of the block.
   #
-  # @see Typhoeus::Config#block_connection
+  # @see Typhoeus::Config.block_connection
   def self.with_connection
     old = Config.block_connection
     Config.block_connection = false

data/spec/typhoeus/adapters/faraday_spec.rb

@@ -163,7 +163,7 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("1.9.0")
 
       context "when not parallel" do
         it "raises an error" do
-          expect { conn.get("/") }.to raise_error(Faraday::Error::ConnectionFailed, "No error")
+          expect { conn.get("/") }.to raise_error(Faraday::ConnectionFailed, "No error")
         end
       end
     end

data/spec/typhoeus/easy_factory_spec.rb

@@ -104,6 +104,12 @@ describe Typhoeus::EasyFactory do
   end
 
   describe "#set_callback" do
+    it "sets easy.on_progress callback when an on_progress callback is provided" do
+      request.on_progress { 1 }
+      expect(easy_factory.easy).to receive(:on_progress)
+      easy_factory.send(:set_callback)
+    end
+
     it "sets easy.on_complete callback" do
       expect(easy_factory.easy).to receive(:on_complete)
       easy_factory.send(:set_callback)

data/spec/typhoeus/hydra/cacheable_spec.rb

@@ -4,6 +4,7 @@ describe Typhoeus::Hydra::Cacheable do
   let(:base_url) { "localhost:3001" }
   let(:hydra) { Typhoeus::Hydra.new() }
   let(:request) { Typhoeus::Request.new(base_url, {:method => :get}) }
+  let(:response) { Typhoeus::Response.new }
   let(:cache) { MemoryCache.new }
 
   describe "add" do
@@ -24,7 +25,6 @@ describe Typhoeus::Hydra::Cacheable do
       end
 
       context "when request in memory" do
-        let(:response) { Typhoeus::Response.new }
         before { cache.memory[request] = response }
 
         it "returns response with cached status" do
@@ -53,6 +53,36 @@ describe Typhoeus::Hydra::Cacheable do
           end
         end
       end
+
+      context "when cache is specified on a request" do
+        before { Typhoeus::Config.cache = false }
+
+        context "when cache is false" do
+          let(:non_cached_request) { Typhoeus::Request.new(base_url, {:method => :get, :cache => false}) }
+
+          it "initiates an HTTP call" do
+            expect(Typhoeus::EasyFactory).to receive(:new).with(non_cached_request, hydra).and_call_original
+
+            hydra.add(non_cached_request)
+          end
+        end
+
+        context "when cache is defined" do
+          let(:cached_request) { Typhoeus::Request.new(base_url, {:method => :get, :cache => cache}) }
+
+          before { cache.memory[cached_request] = response }
+
+          it "uses the cache instead of making a new request" do
+            expect(Typhoeus::EasyFactory).not_to receive(:new)
+
+            hydra.add(cached_request)
+
+            expect(cached_request.response).to be_cached
+            expect(cached_request.response).to eq(response)
+          end
+        end
+      end
+
     end
   end
 end

data/spec/typhoeus/pool_spec.rb

@@ -88,12 +88,14 @@ describe Typhoeus::Pool do
 
       context "when threaded access" do
         it "creates correct number of easies" do
-          array = []
+          queue = Queue.new
           (0..9).map do |n|
             Thread.new do
-              array << Typhoeus::Pool.get
+              queue.enq(Typhoeus::Pool.get)
             end
           end.map(&:join)
+
+          array = Array.new(queue.size) { queue.pop }
           expect(array.uniq.size).to eq(10)
         end
       end

data/spec/typhoeus/request/cacheable_spec.rb

@@ -55,6 +55,30 @@ describe Typhoeus::Request::Cacheable do
           request.run
         end
       end
+
+      context "when cache is specified on a request" do
+        before { Typhoeus::Config.cache = false }
+
+        context "when cache is false" do
+          let(:options) { { :cache => false } }
+
+          it "finishes request" do
+            expect(request.response).to_not be(response)
+            request.run
+          end
+        end
+
+        context "when cache is defined" do
+          let(:options) { { :cache => cache } }
+
+          before { cache.memory[request] = response }
+
+          it "finishes request" do
+            expect(request).to receive(:finish).with(response)
+            request.run
+          end
+        end
+      end
     end
   end
 

data/spec/typhoeus/request/callbacks_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Typhoeus::Request::Callbacks do
   let(:request) { Typhoeus::Request.new("fubar") }
 
-  [:on_complete, :on_success, :on_failure].each do |callback|
+  [:on_complete, :on_success, :on_failure, :on_progress].each do |callback|
     describe "##{callback}" do
       it "responds" do
         expect(request).to respond_to(callback)
@@ -33,7 +33,7 @@ describe Typhoeus::Request::Callbacks do
   end
 
   describe "#execute_callbacks" do
-    [:on_complete, :on_success, :on_failure].each do |callback|
+    [:on_complete, :on_success, :on_failure, :on_progress].each do |callback|
       context "when #{callback}" do
         context "when local callback" do
           before do

data/spec/typhoeus/request/marshal_spec.rb

@@ -5,7 +5,7 @@ describe Typhoeus::Request::Marshal do
   let(:request) { Typhoeus::Request.new(base_url) }
 
   describe "#marshal_dump" do
-    %w(on_complete on_success on_failure).each do |name|
+    %w(on_complete on_success on_failure on_progress).each do |name|
       context "when #{name} handler" do
         before { request.instance_variable_set("@#{name}", Proc.new{}) }
 

data/spec/typhoeus/request_spec.rb

@@ -2,7 +2,13 @@ require 'spec_helper'
 
 describe Typhoeus::Request do
   let(:base_url) { "localhost:3001" }
-  let(:options) { {:verbose => true, :headers => { 'User-Agent' => "Fubar", 'Expect' => "" }, :maxredirs => 50} }
+  let(:options) do
+    {
+      verbose: true,
+      headers: { "User-Agent" => "Fubar", "Expect" => "" },
+      maxredirs: 50
+    }
+  end
   let(:request) { Typhoeus::Request.new(base_url, options) }
 
   describe ".url" do
@@ -95,6 +101,24 @@ describe Typhoeus::Request do
       end
     end
 
+    context "when Config.timeout set" do
+      before { Typhoeus.configure { |config| config.timeout = 10 } }
+      after { Typhoeus.configure { |config| config.timeout = nil } }
+
+      it "respects configuration" do
+        expect(request.options[:timeout]).to eq(10)
+      end
+    end
+
+    context "when Config.connecttimeout set" do
+      before { Typhoeus.configure { |config| config.connecttimeout = 10 } }
+      after { Typhoeus.configure { |config| config.connecttimeout = nil } }
+
+      it "respects configuration" do
+        expect(request.options[:connecttimeout]).to eq(10)
+      end
+    end
+
     context "when maxredirs" do
       context "when not set" do
         it "defaults to 50" do

data/spec/typhoeus/response/informations_spec.rb

@@ -195,6 +195,14 @@ describe Typhoeus::Response::Informations do
     end
   end
 
+  describe "#redirect_url" do
+    let(:options) { { :redirect_url => "http://www.example.com" } }
+
+    it "returns redirect_url from options" do
+      expect(response.redirect_url).to eq("http://www.example.com")
+    end
+  end
+
   describe "#request_size" do
     let(:options) { { :request_size => 2 } }
 
@@ -203,6 +211,38 @@ describe Typhoeus::Response::Informations do
     end
   end
 
+  describe "#size_upload" do
+    let(:options) { { :size_upload => 2.0 } }
+
+    it "returns size_upload from options" do
+      expect(response.size_upload).to eq(2.0)
+    end
+  end
+
+  describe "#size_download" do
+    let(:options) { { :size_download => 2.0 } }
+
+    it "returns size_download from options" do
+      expect(response.size_download).to eq(2.0)
+    end
+  end
+
+  describe "#speed_upload" do
+    let(:options) { { :speed_upload => 2.0 } }
+
+    it "returns speed_upload from options" do
+      expect(response.speed_upload).to eq(2.0)
+    end
+  end
+
+  describe "#speed_download" do
+    let(:options) { { :speed_download => 2.0 } }
+
+    it "returns speed_download from options" do
+      expect(response.speed_download).to eq(2.0)
+    end
+  end
+
   describe "#headers" do
     context "when no response_headers" do
       it "returns nil" do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - David Balatero
 - Paul Dix
 - Hans Hasselberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -34,9 +34,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/experimental.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -134,7 +135,7 @@ homepage: https://github.com/typhoeus/typhoeus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Parallel HTTP library on top of libcurl multi.
 test_files:

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-script: "bundle exec rake"
-sudo: false
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - 2.4.1
-  - ruby-head
-  - jruby-head
-  - jruby-18mode
-  - jruby-19mode
-matrix: 
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: ree