ethon 0.11.0 → 0.16.0

data/lib/ethon/easy/http/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http/patch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http/post.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http/postable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http/put.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http/putable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     module Http

data/lib/ethon/easy/http.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon/easy/http/actionable'
 require 'ethon/easy/http/post'
 require 'ethon/easy/http/get'

data/lib/ethon/easy/informations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
 
@@ -70,7 +71,28 @@ module Ethon
 
         # Return the total number of redirections that were
         # actually followed.
-        :redirect_count => :long
+        :redirect_count => :long,
+
+        # URL a redirect would take you to, had you enabled redirects (Added in 7.18.2)
+        :redirect_url => :string,
+
+        # Return the bytes, the total amount of bytes that were uploaded
+        :size_upload => :double,
+
+        # 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.
+        :size_download => :double,
+
+        # Return the bytes/second, the average upload speed that curl
+        # measured for the complete upload
+        :speed_upload => :double,
+
+        # Return the bytes/second, the average download speed that curl
+        # measured for the complete download
+        :speed_download => :double
       }
 
       AVAILABLE_INFORMATIONS.each do |name, type|

data/lib/ethon/easy/mirror.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     class Mirror

data/lib/ethon/easy/operations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
     # This module contains the logic to prepare and perform

data/lib/ethon/easy/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
 

data/lib/ethon/easy/params.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon/easy/util'
 require 'ethon/easy/queryable'
 

data/lib/ethon/easy/queryable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
 
@@ -102,6 +103,8 @@ module Ethon
             encode_rack_array_pairs(h, prefix, pairs)
           elsif params_encoding == :multi
             encode_multi_array_pairs(h, prefix, pairs)
+          elsif params_encoding == :none
+            pairs << [prefix, h]
           else
             encode_indexed_array_pairs(h, prefix, pairs)
           end
@@ -128,7 +131,7 @@ module Ethon
           pairs_for(v, key, pairs)
         end
       end
-      
+
     def encode_multi_array_pairs(h, prefix, pairs)
       h.each_with_index do |v, i|
         key = prefix

data/lib/ethon/easy/response_callbacks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy
 
@@ -42,7 +43,12 @@ module Ethon
         return if @headers_called
         @headers_called = true
         if defined?(@on_headers) and not @on_headers.nil?
-          @on_headers.each{ |callback| callback.call(self) }
+          result = nil
+          @on_headers.each do |callback|
+            result = callback.call(self)
+            break if result == :abort
+          end
+          result
         end
       end
 

data/lib/ethon/easy/util.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Easy # :nodoc:
 

data/lib/ethon/easy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon/easy/informations'
 require 'ethon/easy/features'
 require 'ethon/easy/callbacks'
@@ -159,7 +160,6 @@ module Ethon
     #   * :recv_error: Failure with receiving network data.
     #   * :ssl_certproblem: problem with the local client certificate.
     #   * :ssl_cipher: Couldn't use specified cipher.
-    #   * :ssl_cacert: Peer certificate cannot be authenticated with known CA certificates.
     #   * :bad_content_encoding: Unrecognized transfer encoding.
     #   * :ldap_invalid_url: Invalid LDAP URL.
     #   * :filesize_exceeded: Maximum file size exceeded.

data/lib/ethon/errors/ethon_error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/global_init.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/invalid_option.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/invalid_value.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/multi_add.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/multi_fdset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/multi_remove.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/multi_timeout.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors/select.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   module Errors
 

data/lib/ethon/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon/errors/ethon_error'
 require 'ethon/errors/global_init'
 require 'ethon/errors/multi_timeout'

data/lib/ethon/libc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
 
   # FFI Wrapper module for Libc.

data/lib/ethon/loggable.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Ethon
 
   # Contains logging behaviour.

data/lib/ethon/multi/operations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Multi # :nodoc
     # This module contains logic to run a multi.
@@ -23,12 +24,16 @@ module Ethon
       #
       # @return [ void ]
       def init_vars
-        @timeout = ::FFI::MemoryPointer.new(:long)
-        @timeval = Curl::Timeval.new
-        @fd_read = Curl::FDSet.new
-        @fd_write = Curl::FDSet.new
-        @fd_excep = Curl::FDSet.new
-        @max_fd = ::FFI::MemoryPointer.new(:int)
+        if @execution_mode == :perform
+          @timeout = ::FFI::MemoryPointer.new(:long)
+          @timeval = Curl::Timeval.new
+          @fd_read = Curl::FDSet.new
+          @fd_write = Curl::FDSet.new
+          @fd_excep = Curl::FDSet.new
+          @max_fd = ::FFI::MemoryPointer.new(:int)
+        elsif @execution_mode == :socket_action
+          @running_count_pointer = FFI::MemoryPointer.new(:int)
+        end
       end
 
       # Perform multi.
@@ -38,6 +43,8 @@ module Ethon
       # @example Perform multi.
       #   multi.perform
       def perform
+        ensure_execution_mode(:perform)
+
         Ethon.logger.debug(STARTED_MULTI)
         while ongoing?
           run
@@ -66,9 +73,38 @@ module Ethon
         )
       end
 
-      private
+      # Continue execution with an external IO loop.
+      #
+      # @example When no sockets are ready yet, or to begin.
+      #   multi.socket_action
+      #
+      # @example When a socket is readable
+      #   multi.socket_action(io_object, [:in])
+      #
+      # @example When a socket is readable and writable
+      #   multi.socket_action(io_object, [:in, :out])
+      #
+      # @return [ Symbol ] The Curl.multi_socket_action return code.
+      def socket_action(io = nil, readiness = 0)
+        ensure_execution_mode(:socket_action)
+
+        fd = if io.nil?
+          ::Ethon::Curl::SOCKET_TIMEOUT
+        elsif io.is_a?(Integer)
+          io
+        else
+          io.fileno
+        end
+
+        code = Curl.multi_socket_action(handle, fd, readiness, @running_count_pointer)
+        @running_count = @running_count_pointer.read_int
 
-      # Return wether the multi still requests or not.
+        check
+
+        code
+      end
+
+      # Return whether the multi still contains requests or not.
       #
       # @example Return if ongoing.
       #   multi.ongoing?
@@ -78,6 +114,8 @@ module Ethon
         easy_handles.size > 0 || (!defined?(@running_count) || running_count > 0)
       end
 
+      private
+
       # Get timeout.
       #
       # @example Get timeout.

data/lib/ethon/multi/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Multi
 
@@ -8,7 +9,7 @@ module Ethon
       # Sets max_total_connections option.
       #
       # @example Set max_total_connections option.
-      #   easy.max_total_conections = $value
+      #   multi.max_total_conections = $value
       #
       # @param [ String ] value The value to set.
       #
@@ -20,7 +21,7 @@ module Ethon
       # Sets maxconnects option.
       #
       # @example Set maxconnects option.
-      #   easy.maxconnects = $value
+      #   multi.maxconnects = $value
       #
       # @param [ String ] value The value to set.
       #
@@ -32,19 +33,19 @@ module Ethon
       # Sets pipelining option.
       #
       # @example Set pipelining option.
-      #   easy.pipelining = $value
+      #   multi.pipelining = $value
       #
       # @param [ String ] value The value to set.
       #
       # @return [ void ]
       def pipelining=(value)
-        Curl.set_option(:pipelining, value_for(value, :bool), handle, :multi)
+        Curl.set_option(:pipelining, value_for(value, :int), handle, :multi)
       end
 
       # Sets socketdata option.
       #
       # @example Set socketdata option.
-      #   easy.socketdata = $value
+      #   multi.socketdata = $value
       #
       # @param [ String ] value The value to set.
       #
@@ -56,7 +57,7 @@ module Ethon
       # Sets socketfunction option.
       #
       # @example Set socketfunction option.
-      #   easy.socketfunction = $value
+      #   multi.socketfunction = $value
       #
       # @param [ String ] value The value to set.
       #
@@ -68,7 +69,7 @@ module Ethon
       # Sets timerdata option.
       #
       # @example Set timerdata option.
-      #   easy.timerdata = $value
+      #   multi.timerdata = $value
       #
       # @param [ String ] value The value to set.
       #
@@ -80,7 +81,7 @@ module Ethon
       # Sets timerfunction option.
       #
       # @example Set timerfunction option.
-      #   easy.timerfunction = $value
+      #   multi.timerfunction = $value
       #
       # @param [ String ] value The value to set.
       #

data/lib/ethon/multi/stack.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ethon
   class Multi
 

data/lib/ethon/multi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon/easy/util'
 require 'ethon/multi/stack'
 require 'ethon/multi/operations'
@@ -73,10 +74,21 @@ module Ethon
     # is 1 will not be treated as unlimited. Instead it will open only 1 
     # connection and try to pipeline on it.
     # (Added in 7.30.0)
+    # @option options :execution_mode [Boolean]
+    #  Either :perform (default) or :socket_action, specifies the usage
+    #  method that will be used on this multi object. The default :perform
+    #  mode provides a #perform function that uses curl_multi_perform
+    #  behind the scenes to automatically continue execution until all
+    #  requests have completed. The :socket_action mode provides an API
+    #  that allows the {Multi} object to be integrated into an external
+    #  IO loop, by calling #socket_action and responding to the 
+    #  socketfunction and timerfunction callbacks, using the underlying
+    #  curl_multi_socket_action semantics.
     #
     # @return [ Multi ] The new multi.
     def initialize(options = {})
       Curl.init
+      @execution_mode = options.delete(:execution_mode) || :perform
       set_attributes(options)
       init_vars
     end
@@ -99,5 +111,16 @@ module Ethon
         method("#{key}=").call(value)
       end
     end
+
+    private
+
+    # Internal function to gate functions to a specific execution mode
+    #
+    # @raise ArgumentError
+    #
+    # @api private
+    def ensure_execution_mode(expected_mode)
+      raise ArgumentError, "Expected the Multi to be in #{expected_mode} but it was in #{@execution_mode}" if expected_mode != @execution_mode
+    end
   end
 end

data/lib/ethon/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Ethon
 
   # Ethon version.
-  VERSION = '0.11.0'
+  VERSION = '0.16.0'
 end

data/lib/ethon.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'logger'
 require 'ffi'
 require 'thread'

data/profile/benchmarks.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'ethon'
 require 'open-uri'
 require 'patron'

data/profile/memory_leaks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ethon'
 require 'ethon/easy'
 

data/profile/perf_spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #### SETUP
 require 'bundler'
 Bundler.setup

data/profile/support/memory_test_helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ruby_object_leak_tracker'
 require_relative 'os_memory_leak_tracker'
 

data/profile/support/os_memory_leak_tracker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class OSMemoryLeakTracker
   attr_reader :current_run
 

data/profile/support/ruby_object_leak_tracker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class RubyObjectLeakTracker
   attr_reader :previous_count_hash, :current_count_hash
 

data/spec/ethon/curl_spec.rb

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

data/spec/ethon/easy/callbacks_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Ethon::Easy::Callbacks do
@@ -55,4 +56,26 @@ describe Ethon::Easy::Callbacks do
       end
     end
   end
+
+  describe "#header_write_callback" do
+    let(:header_write_callback) { easy.instance_variable_get(:@header_write_callback) }
+    let(:stream) { double(:read_string => "") }
+    context "when header returns not :abort" do
+      it "returns number bigger than 0" do
+        expect(header_write_callback.call(stream, 1, 1, nil) > 0).to be(true)
+      end
+    end
+
+    context "when header returns :abort" do
+      before do
+        easy.on_headers.clear
+        easy.on_headers { :abort }
+      end
+      let(:header_write_callback) { easy.instance_variable_get(:@header_write_callback) }
+
+      it "returns -1 to indicate abort to libcurl" do
+        expect(header_write_callback.call(stream, 1, 1, nil)).to eq(-1)
+      end
+    end
+  end
 end

data/spec/ethon/easy/debug_info_spec.rb

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

data/spec/ethon/easy/features_spec.rb

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

data/spec/ethon/easy/form_spec.rb

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

data/spec/ethon/easy/header_spec.rb

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

data/spec/ethon/easy/http/custom_spec.rb

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

data/spec/ethon/easy/http/delete_spec.rb

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

data/spec/ethon/easy/http/get_spec.rb

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

data/spec/ethon/easy/http/head_spec.rb

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

data/spec/ethon/easy/http/options_spec.rb

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

data/spec/ethon/easy/http/patch_spec.rb

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

data/spec/ethon/easy/http/post_spec.rb

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

data/spec/ethon/easy/http/put_spec.rb

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

data/spec/ethon/easy/http_spec.rb

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