typhoeus 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79bd3451f6ec67ea973d9dc62dc4645c21e2eba1
-  data.tar.gz: 762e3c44e97fc0f2241d5cbf9d2a9ff2caa8a53a
+SHA256:
+  metadata.gz: b1a6b0485477d252e7eb99852bec27994e9c23aa54e7d376cd24bc07d3639d5c
+  data.tar.gz: d2dbaf34e81e7a906dbf254d0d1aa1d6028c10a08605b6dc6261c282bfc39abd
 SHA512:
-  metadata.gz: e0a7c0b640b05b4527a4a9a7b3ee7db526fc25e31e001b7287f2423fecebbf6d673adb5c17b7cda32c1206872a3a27d82825b9ee74974607f691e9ee573fb39a
-  data.tar.gz: 444398bc7499402359de7a5534c265bf91c39346903c1b82c4767b1b7f9eb9c72741a979986b905e388301055e6816baa6ef999f9f35bed06a07a4bec37d7b99
+  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,11 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...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
 

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/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)
+# 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,11 +19,10 @@ hydra.run
 ```
 
 ## Installation
-Add the following line to your Gemfile:
+Run:
 ```
-gem "typhoeus"
+bundle add typhoeus
 ```
-Then run `bundle install`
 
 Or install it yourself as:
 
@@ -33,8 +32,7 @@ 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
 
@@ -350,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)
 ```
@@ -357,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/config.rb

@@ -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
@@ -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/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.4.0'
+  VERSION = '1.4.1'
 end

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.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - David Balatero
 - Paul Dix
 - Hans Hasselberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-08 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.5.2.3
-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,26 +0,0 @@
-language: ruby
-script: "bundle exec rake"
-rvm:
-  - 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
-matrix: 
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: ree
-  include:
-    - rvm: 1.8.7
-      dist: precise
-    - rvm: 1.9.2
-      dist: trusty