ethon 0.11.0 → 0.16.0

data/spec/ethon/easy/informations_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Informations do
@@ -80,6 +81,12 @@ describe Ethon::Easy::Informations do
     end
   end
 
+  describe "#redirect_url" do
+    it "returns nil as there is no redirect" do
+      expect(easy.redirect_url).to be(nil)
+    end
+  end
+
   describe "#request_size" do
     it "returns 53" do
       expect(easy.request_size).to eq(53)
@@ -93,5 +100,27 @@ describe Ethon::Easy::Informations do
     end
   end
 
+  describe "#size_upload" do
+    it "returns float" do
+      expect(easy.size_upload).to be_a(Float)
+    end
+  end
 
+  describe "#size_download" do
+    it "returns float" do
+      expect(easy.size_download).to be_a(Float)
+    end
+  end
+
+  describe "#speed_upload" do
+    it "returns float" do
+      expect(easy.speed_upload).to be_a(Float)
+    end
+  end
+
+  describe "#speed_download" do
+    it "returns float" do
+      expect(easy.speed_download).to be_a(Float)
+    end
+  end
 end

data/spec/ethon/easy/mirror_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Mirror do
@@ -9,7 +10,8 @@ describe Ethon::Easy::Mirror do
       :return_code, :response_code, :response_body, :response_headers,
       :total_time, :starttransfer_time, :appconnect_time,
       :pretransfer_time, :connect_time, :namelookup_time, :redirect_time,
-      :effective_url, :primary_ip, :redirect_count, :debug_info
+      :size_upload, :size_download, :speed_upload, :speed_upload,
+      :effective_url, :primary_ip, :redirect_count, :redirect_url, :debug_info
     ].each do |name|
       it "contains #{name}" do
         expect(described_class::INFORMATIONS_TO_MIRROR).to include(name)

data/spec/ethon/easy/operations_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Operations do
@@ -105,6 +106,7 @@ describe Ethon::Easy::Operations do
 
         it "doesn't follow" do
           expect(easy.response_code).to eq(302)
+          expect(easy.redirect_url).to eq("http://localhost:3001/")
         end
       end
 
@@ -114,6 +116,7 @@ describe Ethon::Easy::Operations do
 
         it "follows" do
           expect(easy.response_code).to eq(200)
+          expect(easy.redirect_url).to eq(nil)
         end
 
         context "when infinite redirect loop" do
@@ -123,6 +126,7 @@ describe Ethon::Easy::Operations do
           context "when max redirect set" do
             it "follows only x times" do
               expect(easy.response_code).to eq(302)
+              expect(easy.redirect_url).to eq("http://localhost:3001/bad_redirect")
             end
           end
         end

data/spec/ethon/easy/options_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Options do
@@ -12,7 +13,7 @@ describe Ethon::Easy::Options do
     :proxyuserpwd, :readdata, :readfunction, :redir_protocols, :ssl_verifyhost,
     :ssl_verifypeer, :sslcert, :sslcerttype, :sslkey, :sslkeytype, :sslversion,
     :timeout, :timeout_ms, :unrestricted_auth, :upload, :url, :useragent,
-    :userpwd, :verbose
+    :userpwd, :verbose, :pipewait, :dns_shuffle_addresses, :path_as_is
   ].each do |name|
     describe "#{name}=" do
       it "responds_to" do

data/spec/ethon/easy/queryable_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Queryable do
@@ -122,6 +123,14 @@ describe Ethon::Easy::Queryable do
           expect(pairs).to include(["b[]", 3])
         end
       end
+
+      context "when params_encoding is :none" do
+        before { params.params_encoding = :none }
+        it "does no transformation" do
+          expect(pairs).to include([:a, 1])
+          expect(pairs).to include([:b, [2, 3]])
+        end
+      end
     end
 
     context "when params contains something nested in an array" do

data/spec/ethon/easy/response_callbacks_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::ResponseCallbacks do

data/spec/ethon/easy/util_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Util do

data/spec/ethon/easy_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy do
@@ -106,8 +107,8 @@ describe Ethon::Easy do
       easy.on_complete { 'on_complete' }
       easy.on_headers { 'on_headers' }
       easy.on_progress { 'on_progress' }
-      easy.response_body = 'test_body'
-      easy.response_headers = 'test_headers'
+      easy.response_body = String.new('test_body')
+      easy.response_headers = String.new('test_headers')
       easy
     end
     let!(:e) { easy.dup }

data/spec/ethon/libc_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Libc do

data/spec/ethon/loggable_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Ethon::Loggable do

data/spec/ethon/multi/operations_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Multi::Operations do

data/spec/ethon/multi/options_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Multi::Options do
@@ -19,6 +20,119 @@ describe Ethon::Multi::Options do
     end
   end
 
+  context "socket_action mode" do
+    let(:multi) { Ethon::Multi.new(execution_mode: :socket_action) }
+
+    describe "#socketfunction callbacks" do
+      it "allows multi_code return values" do
+        calls = []
+        multi.socketfunction = proc do |handle, sock, what, userp, socketp|
+          calls << what
+          :ok
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        expect(calls).to eq([])
+        5.times do
+          multi.socket_action
+          break unless calls.empty?
+          sleep 0.1
+        end
+        expect(calls.last).to eq(:in).or(eq(:out))
+        multi.delete(easy)
+        expect(calls.last).to eq(:remove)
+      end
+
+      it "allows integer return values (compatibility)" do
+        called = false
+        multi.socketfunction = proc do |handle, sock, what, userp, socketp|
+          called = true
+          0
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        5.times do
+          multi.socket_action
+          break if called
+          sleep 0.1
+        end
+        multi.delete(easy)
+
+        expect(called).to be_truthy
+      end
+
+      it "errors on invalid return codes" do
+        called = false
+        multi.socketfunction = proc do |handle, sock, what, userp, socketp|
+          called = true
+          "hi"
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        expect {
+          5.times do
+            multi.socket_action
+            break if called
+            sleep 0.1
+          end
+        }.to raise_error(ArgumentError)
+        expect { multi.delete(easy) }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "#timerfunction callbacks" do
+      it "allows multi_code return values" do
+        calls = []
+        multi.timerfunction = proc do |handle, timeout_ms, userp|
+          calls << timeout_ms
+          :ok
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        expect(calls.last).to be >= 0 # adds an immediate timeout
+
+        multi.delete(easy)
+        expect(calls.last).to eq(-1) # cancels the timer
+      end
+
+      it "allows integer return values (compatibility)" do
+        called = false
+        multi.timerfunction = proc do |handle, timeout_ms, userp|
+          called = true
+          0
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        multi.socket_action
+        multi.delete(easy)
+
+        expect(called).to be_truthy
+      end
+
+      it "errors on invalid return codes" do
+        called = false
+        multi.timerfunction = proc do |handle, timeout_ms, userp|
+          called = true
+          "hi"
+        end
+
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        expect { multi.add(easy) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
   describe "#value_for" do
     context "when option in bool" do
       context "when value true" do

data/spec/ethon/multi/stack_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Multi::Stack do

data/spec/ethon/multi_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Multi do
@@ -7,6 +8,16 @@ describe Ethon::Multi do
       Ethon::Multi.new
     end
 
+    context "with default options" do
+      it "allows running #perform with the default execution_mode" do
+        Ethon::Multi.new.perform
+      end
+
+      it "refuses to run #socket_action" do
+        expect { Ethon::Multi.new.socket_action }.to raise_error(ArgumentError)
+      end
+    end
+
     context "when options not empty" do
       context "when pipelining is set" do
         let(:options) { { :pipelining => true } }
@@ -16,6 +27,126 @@ describe Ethon::Multi do
           Ethon::Multi.new(options)
         end
       end
+
+      context "when execution_mode option is :socket_action" do
+        let(:options) { { :execution_mode => :socket_action } }
+        let(:multi) { Ethon::Multi.new(options) }
+
+        it "refuses to run #perform" do
+          expect { multi.perform }.to raise_error(ArgumentError)
+        end
+
+        it "allows running #socket_action" do
+          multi.socket_action
+        end
+      end
+    end
+  end
+
+  describe "#socket_action" do
+    let(:options) { { :execution_mode => :socket_action } }
+    let(:select_state) { { :readers => [], :writers => [], :timeout => 0 } }
+    let(:multi) {
+      multi = Ethon::Multi.new(options)
+      multi.timerfunction = proc do |handle, timeout_ms, userp|
+        timeout_ms = nil if timeout_ms == -1
+        select_state[:timeout] = timeout_ms
+        :ok
+      end
+      multi.socketfunction = proc do |handle, sock, what, userp, socketp|
+        case what
+        when :remove
+          select_state[:readers].delete(sock)
+          select_state[:writers].delete(sock)
+        when :in
+          select_state[:readers].push(sock) unless select_state[:readers].include? sock
+          select_state[:writers].delete(sock)
+        when :out
+          select_state[:readers].delete(sock)
+          select_state[:writers].push(sock) unless select_state[:writers].include? sock
+        when :inout
+          select_state[:readers].push(sock) unless select_state[:readers].include? sock
+          select_state[:writers].push(sock) unless select_state[:writers].include? sock
+        else
+          raise ArgumentError, "invalid value for 'what' in socketfunction callback"
+        end
+        :ok
+      end
+      multi
+    }
+
+    def fds_to_ios(fds)
+      fds.map do |fd|
+        IO.for_fd(fd).tap { |io| io.autoclose = false }
+      end
+    end
+
+    def perform_socket_action_until_complete
+      multi.socket_action # start things off
+
+      while multi.ongoing?
+        readers, writers, _ = IO.select(
+          fds_to_ios(select_state[:readers]),
+          fds_to_ios(select_state[:writers]),
+          [],
+          select_state[:timeout]
+        )
+
+        to_notify = Hash.new { |hash, key| hash[key] = [] }
+        unless readers.nil?
+          readers.each do |reader|
+            to_notify[reader] << :in
+          end
+        end
+        unless writers.nil?
+          writers.each do |writer|
+            to_notify[writer] << :out
+          end
+        end
+
+        to_notify.each do |io, readiness|
+          multi.socket_action(io, readiness)
+        end
+
+        # if we didn't have anything to notify, then we timed out
+        multi.socket_action if to_notify.empty?
+      end
+    ensure
+      multi.easy_handles.dup.each do |h|
+        multi.delete(h)
+      end
+    end
+
+    it "supports an end-to-end request" do
+      easy = Ethon::Easy.new
+      easy.url = "http://localhost:3001/"
+      multi.add(easy)
+
+      perform_socket_action_until_complete
+
+      expect(multi.ongoing?).to eq(false)
+    end
+
+    it "supports multiple concurrent requests" do
+      handles = []
+      10.times do
+        easy = Ethon::Easy.new
+        easy.url = "http://localhost:3001/?delay=1"
+        multi.add(easy)
+        handles << easy
+      end
+
+      start = Time.now
+      perform_socket_action_until_complete
+      duration = Time.now - start
+      
+      # these should have happened concurrently
+      expect(duration).to be < 2
+      expect(multi.ongoing?).to eq(false)
+
+      handles.each do |handle|
+        expect(handle.response_code).to eq(200)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 

data/spec/support/localhost_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rack'
 require 'rack/handler/webrick'
 require 'net/http'
@@ -43,7 +44,7 @@ class LocalhostServer
     # Use WEBrick since it's part of the ruby standard library and is available on all ruby interpreters.
     options = { :Port => port }
     options.merge!(:AccessLog => [], :Logger => WEBrick::BasicLog.new(StringIO.new)) unless ENV['VERBOSE_SERVER']
-    Rack::Handler::WEBrick.run(Identify.new(@rack_app), options)
+    Rack::Handler::WEBrick.run(Identify.new(@rack_app), **options)
   end
 
   def booted?

data/spec/support/server.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'json'
 require 'zlib'
 require 'sinatra/base'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Hans Hasselberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.15.0
 description: Very lightweight libcurl wrapper.
 email:
 - me@hans.io
@@ -31,9 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -137,7 +137,7 @@ homepage: https://github.com/typhoeus/ethon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,9 +152,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: Libcurl wrapper.
 test_files:

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-
-bundler_args: --without perf
-script: bundle exec rake
-before_install:
-  - gem install bundler
-
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0-p648
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - ruby-head
-  - ree
-  - jruby-18mode
-  - jruby-19mode
-  - jruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ree
-    - rvm: ruby-head
-    - rvm: jruby-head