typhoeus 1.3.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 417ef8dd5903c12a896c84db243131ec364aec235a44ac32d2590d95f919c10a
-  data.tar.gz: 62fca0f2cf069282d5c6cdbed018e395b6b40f379cb2d8e45129a156e7aed69a
+  metadata.gz: da76288cb44cae7a0b697d2758d41c736ce8cd35b83cc80dcc36b05a46b71601
+  data.tar.gz: 00675ad1b7cca1fa8a944c03450d1ff78419df4a734913f9297f00fb890bed41
 SHA512:
-  metadata.gz: 9a8e291edbdb7e635f6ffbf085783752e6a0688e342dbec333e2fd85f6d4ac841a4bfca128fe36d4f30d5e0f87a8d124447d77cfd2d15e77c6f29bec4a55f197
-  data.tar.gz: cf6d163bfb31f1cf77c2faf068601b6c65685d5afaf0f582dadd9505882fb8c567583fd1dad7a47f27210018e992ac300a7803f3870250e1f7a1461111bcab80
+  metadata.gz: 931cc5e229d88380754841384cd11aa2e96f851d7ba765420f00e9817d2e05be0b77fbd96d68c21865fd894f34d5708f5c2d306fa0cc9bdbf3c06489103b0b0e
+  data.tar.gz: 8b26b43c59ef011e401f6938ba063fceea42288e755f4762a08b5cf44f6d82dbe8f30959ea65a446a73da35127378d2a2e24f6e920fbe067fcaa37f01320cbe5

data/CHANGELOG.md

@@ -2,7 +2,78 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.1.2...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.6.0...master)
+
+## 1.6.0
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.5.0...v1.6.0)
+
+* Add Ruby 4.0 to CI matrix and update checkout action to v6.
+  ([Geremia Taglialatela](https://github.com/tagliala), [#744](https://github.com/typhoeus/typhoeus/pull/744))
+* Require Ethon >= 0.18.0, removing the upper bound constraint.
+  ([Geremia Taglialatela](https://github.com/tagliala), [#742](https://github.com/typhoeus/typhoeus/pull/742))
+* Update RubyDoc link in gemspec metadata.
+  ([Felipe Mesquita](https://github.com/felipedmesquita), [#737](https://github.com/typhoeus/typhoeus/pull/737))
+* Update gem version badge and remove Code Climate badge.
+  ([Felipe Mesquita](https://github.com/felipedmesquita), [#736](https://github.com/typhoeus/typhoeus/pull/736))
+
+## 1.5.0
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.1...v1.5.0)
+
+* Update gemspec with metadata and remove extra files from the bundled gem.
+  ([Felipe Mesquita](https://github.com/felipedmesquita), [#734](https://github.com/typhoeus/typhoeus/pull/734))
+* Require Ruby 2.6+ and simplify Gemfile.
+  ([Felipe Mesquita](https://github.com/felipedmesquita), [#733](https://github.com/typhoeus/typhoeus/pull/733))
+* Add support for URI objects in `Typhoeus.stub()`.
+  ([Katelyn Schiesser](https://github.com/slowbro), [#732](https://github.com/typhoeus/typhoeus/pull/732))
+* Add explicit require for logger and ostruct gems for Ruby 3.5+ compatibility.
+  ([Felipe Mesquita](https://github.com/felipedmesquita), [#729](https://github.com/typhoeus/typhoeus/pull/729))
+* Add Ruby 3.4 to CI matrix.
+  ([y-yagi](https://github.com/y-yagi), [#728](https://github.com/typhoeus/typhoeus/pull/728))
+* Support curl 8.9 error message changes in tests.
+  ([Mamoru TASAKA](https://github.com/mtasaka), [#724](https://github.com/typhoeus/typhoeus/pull/724))
+* Add Ruby 3.2 and 3.3 to CI, drop Ruby 2.5, lock ethon < 0.16.0.
+  ([y-yagi](https://github.com/y-yagi), [#716](https://github.com/typhoeus/typhoeus/pull/716))
+* Fix typo in comment: "reponse" → "response".
+  ([George Brocklehurst](https://github.com/georgebrock), [#700](https://github.com/typhoeus/typhoeus/pull/700))
+
+## 1.4.1
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...v1.4.1)
+
+* Fix to run CI with Ruby 3.0.
+  ([mishina](https://github.com/mishina2228), [#699](https://github.com/typhoeus/typhoeus/pull/699))
+* Replace CI status badge from Travis to GH Actions.
+  ([mishina](https://github.com/mishina2228), [#698](https://github.com/typhoeus/typhoeus/pull/698))
+* Added getter for `redirect_url` attribute.
+  ([Adrien Rey-Jarthon](https://github.com/jarthod), [#697](https://github.com/typhoeus/typhoeus/pull/697))
+* CI: Adjust ruby versions and MacOS runs.
+  ([Holger Arndt](https://github.com/Kjarrigan), [#696](https://github.com/typhoeus/typhoeus/pull/696))
+* Allow performing `curl --upload-file`.
+  ([Arian Faurtosh](https://github.com/arianf), [#695](https://github.com/typhoeus/typhoeus/pull/695))
+* Add getter for size_upload, size_download, speed_upload, speed_download values.
+  ([Ryo Nakano](https://github.com/ryonkn), [#692](https://github.com/typhoeus/typhoeus/pull/692))
+* Use bundle add instead.
+  ([Glauco Custodio](https://github.com/glaucocustodio), [#691](https://github.com/typhoeus/typhoeus/pull/691))
+* Travis -> Github actions.
+  ([John Mortlock](https://github.com/jmortlock), [#689](https://github.com/typhoeus/typhoeus/pull/689))
+* Add global timeout and connecttimeout to config.
+  ([Teck Wan Wong](https://github.com/teckwan), [#685](https://github.com/typhoeus/typhoeus/pull/685))
+* Update README.md.
+  ([Hussain Akram](https://github.com/hussainakram), [#677](https://github.com/typhoeus/typhoeus/pull/677))
+
+## 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/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 [![Gem Version](https://badge.fury.io/rb/typhoeus.svg)](https://badge.fury.io/rb/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)
 
 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) (GitHub master)
 
 ## Usage
 
@@ -347,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)
 ```
@@ -354,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)
 ```

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) || ((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

@@ -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]
@@ -169,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/expectation.rb

@@ -204,9 +204,11 @@ module Typhoeus
     def url_match?(request_url)
       case base_url
       when String
-        base_url == request_url
+        base_url == request_url.to_s
       when Regexp
-        base_url === request_url
+        base_url === request_url.to_s
+      when defined?(URI) && URI
+        base_url.to_s == request_url.to_s
       when nil
         true
       else

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/cacheable.rb

@@ -11,7 +11,7 @@ module Typhoeus
       end
 
       def run
-        if cacheable? && response = cache.get(self)
+        if response = cached_response
           response.cached = true
           finish(response)
         else
@@ -19,6 +19,10 @@ module Typhoeus
         end
       end
 
+      def cached_response
+        cacheable? && cache.get(self)
+      end
+
       def cache_ttl
         options[:cache_ttl]
       end

data/lib/typhoeus/request/responseable.rb

@@ -1,7 +1,7 @@
 module Typhoeus
   class Request
 
-    # This module contains logic for having a reponse
+    # This module contains logic for having a response
     # getter and setter.
     module Responseable
 

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/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/version.rb

@@ -1,5 +1,5 @@
 module Typhoeus
 
   # The current Typhoeus version.
-  VERSION = '1.3.1'
+  VERSION = '1.6.0'
 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/typhoeus.gemspec

@@ -14,12 +14,22 @@ Gem::Specification.new do |s|
   s.summary      = "Parallel HTTP library on top of libcurl multi."
   s.description  = %q{Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.}
 
-  s.required_rubygems_version = ">= 1.3.6"
+  s.required_ruby_version = ">= 2.6"
   s.license = 'MIT'
+  s.metadata = {
+    'bug_tracker_uri'       => 'https://github.com/typhoeus/typhoeus/issues',
+    'changelog_uri'         => "https://github.com/typhoeus/typhoeus/blob/v#{s.version}/CHANGELOG.md",
+    'documentation_uri'     => "https://www.rubydoc.info/gems/typhoeus/#{s.version}",
+    'rubygems_mfa_required' => 'true',
+    'source_code_uri'       => "https://github.com/typhoeus/typhoeus/tree/v#{s.version}"
+  }
 
-  s.add_dependency('ethon', [">= 0.9.0"])
+  s.add_dependency('ethon', [">= 0.18.0"])
 
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.start_with?(*%w[. Gemfile Guardfile Rakefile perf spec])
+    end
+  end
   s.require_path = 'lib'
 end