ethon 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cc64826630c9f25f87d4a4140a9cecc43575994
-  data.tar.gz: 01f6e1dc05161204a18eabe86e64c941fcb5bda1
+  metadata.gz: ac54c9df1c6dfd22a65124a64c7bb93b2792dc55
+  data.tar.gz: 5fedd427db76181d6bde8c7c4af4116bdf1cc272
 SHA512:
-  metadata.gz: d98725e35b6e1d81fcd4f2b1207d54f178e058230b2bbf49249e94e4ff05067d8e7a5e6cdfb7be2465ac7a2c6f8b4a7145e5bf9e291817dd0e1661c87816f595
-  data.tar.gz: a60d5cd6436990a8f58d3ef5c2eb47167998b6ade221fdaa66e6464b2119d3a6e395e660ef17031dc72eec059f9b92dc0f4187e57b3d032dd30a5c29cd74f20b
+  metadata.gz: 538f6d8f6af52a294d72ecc3f63f8a2a7ed97f90154382979edfbdc6085f38e16ea4e336f1cdff3d107551402ba2408b87f8632added41b2915744b97da47c3c
+  data.tar.gz: 54695f47f42ea0838c8da9531d136b52d6d77a8e5cd10374929c878b6ff55f572727d1e8afa3b854672ba6bbbcb5eff1d0d25091bc6d5f1ad6df0d757eeecb6e

data/.travis.yml

@@ -4,6 +4,8 @@ sudo: false
 
 bundler_args: --without perf
 script: bundle exec rake
+before_install:
+  - gem install bundler
 
 rvm:
   - 1.8.7

data/Gemfile

@@ -18,11 +18,16 @@ group :development, :test do
     gem "json"
   end
 
-  gem "mime-types", "~> 1.18"
+  if Gem.ruby_version >= Gem::Version.new("2.0.0")
+    gem "mime-types", "~> 1.18"
+  end
 
-  unless ENV["CI"]
-    gem "guard-rspec", "~> 0.7"
-    gem "rb-fsevent", "~> 0.9.1"
+  if Gem.ruby_version >= Gem::Version.new("2.2.0")
+    gem "mustermann"
+  elsif Gem.ruby_version >= Gem::Version.new("2.1.0")
+    gem "mustermann", "0.4.0"
+  elsif Gem.ruby_version >= Gem::Version.new("2.0.0")
+    gem "mustermann", "0.3.1"
   end
 end
 

data/README.md

@@ -1,4 +1,7 @@
-#  Ethon [![Build Status](https://secure.travis-ci.org/typhoeus/ethon.png?branch=master)](http://travis-ci.org/typhoeus/ethon) [![Gem Version](https://badge.fury.io/rb/ethon.png)](http://badge.fury.io/rb/ethon)
+[![Gem Version](https://badge.fury.io/rb/ethon.svg)](https://badge.fury.io/rb/ethon)
+[![Build Status](https://travis-ci.org/typhoeus/ethon.svg?branch=master)](https://travis-ci.org/typhoeus/ethon)
+
+#  Ethon
 
 In Greek mythology, Ethon, the son of Typhoeus and Echidna, is a gigantic eagle. So much for the history.
 In the modern world, Ethon is a very basic libcurl wrapper using ffi.

data/lib/ethon/curls/functions.rb

@@ -19,6 +19,7 @@ module Ethon
         base.attach_function :easy_setopt_long,           :curl_easy_setopt,         [:pointer, :easy_option, :long],     :easy_code
         base.attach_function :easy_setopt_callback,       :curl_easy_setopt,         [:pointer, :easy_option, :callback], :easy_code
         base.attach_function :easy_setopt_debug_callback, :curl_easy_setopt,         [:pointer, :easy_option, :debug_callback], :easy_code
+        base.attach_function :easy_setopt_progress_callback, :curl_easy_setopt,      [:pointer, :easy_option, :progress_callback], :easy_code
         base.attach_function :easy_setopt_off_t,          :curl_easy_setopt,         [:pointer, :easy_option, :int64],    :easy_code
         base.instance_variable_set(:@blocking, true)
         base.attach_function :easy_perform,               :curl_easy_perform,        [:pointer],                     :easy_code

data/lib/ethon/curls/options.rb

@@ -7,7 +7,7 @@ module Ethon
 
       OPTION_STRINGS = { :easy => 'easy_options', :multi => 'multi_options' }.freeze
       FOPTION_STRINGS = { :easy => 'EASY_OPTIONS', :multi => 'MULTI_OPTIONS' }.freeze
-      FTYPES = [:long, :string, :ffipointer, :callback, :debug_callback, :off_t]
+      FTYPES = [:long, :string, :ffipointer, :callback, :debug_callback, :progress_callback, :off_t]
       FUNCS = Hash[*[:easy, :multi].zip([:easy, :multi].map { |t| Hash[*FTYPES.zip(FTYPES.map { |ft| "#{t}_setopt_#{ft}" }).flatten] }).flatten]
       # Sets appropriate option for easy, depending on value type.
       def set_option(option, value, handle, type = :easy)
@@ -85,6 +85,9 @@ module Ethon
         when :debug_callback
           func=:debug_callback
           raise Errors::InvalidValue.new(option,value) unless value.nil? or value.is_a? Proc
+        when :progress_callback
+          func=:progress_callback
+          raise Errors::InvalidValue.new(option,value) unless value.nil? or value.is_a? Proc
         when :off_t
           return if value.nil?
           func=:off_t
@@ -136,6 +139,7 @@ module Ethon
         :cbdata => :objectpoint,
         :callback => :functionpoint,
         :debug_callback => :functionpoint,
+        :progress_callback => :functionpoint,
         :off_t => :off_t,
       }
 
@@ -247,7 +251,7 @@ module Ethon
       option :easy, :opensocketdata, :cbdata, 164
       option :easy, :closesocketfunction, :callback, 208
       option :easy, :closesocketdata, :cbdata, 209
-      option :easy, :progressfunction, :callback, 56
+      option :easy, :progressfunction, :progress_callback, 56
       option :easy, :progressdata, :cbdata, 57
       option :easy, :headerfunction, :callback, 79
       option :easy, :writeheader, :cbdata, 29
@@ -266,6 +270,8 @@ module Ethon
       option :easy, :chunk_data, :cbdata, 201
       option :easy, :fnmatch_function, :callback, 200
       option :easy, :fnmatch_data, :cbdata, 202
+      option :easy, :xferinfofunction, :progress_callback, 219
+      option :easy, :xferinfodata, :cbdata, 57
       ## ERROR OPTIONS
       option :easy, :errorbuffer, :buffer, 10, 256
       option :easy, :stderr, :dontuse_object, 37

data/lib/ethon/curls/settings.rb

@@ -2,6 +2,7 @@ module Ethon
   module Curl
     callback :callback, [:pointer, :size_t, :size_t, :pointer], :size_t
     callback :debug_callback, [:pointer, :debug_info_type, :pointer, :size_t, :pointer], :int
+    callback :progress_callback, [:pointer, :long_long, :long_long, :long_long, :long_long], :int
     ffi_lib_flags :now, :global
     ffi_lib ['libcurl', 'libcurl.so.4']
   end

data/lib/ethon/easy.rb

@@ -253,6 +253,7 @@ module Ethon
       @on_complete = nil
       @on_headers = nil
       @on_body = nil
+      @on_progress = nil
       @procs = nil
       @mirror = nil
       Curl.easy_reset(handle)
@@ -267,6 +268,7 @@ module Ethon
       e.instance_variable_set(:@body_write_callback, nil)
       e.instance_variable_set(:@header_write_callback, nil)
       e.instance_variable_set(:@debug_callback, nil)
+      e.instance_variable_set(:@progress_callback, nil)
       e.set_callbacks
       e
     end

data/lib/ethon/easy/callbacks.rb

@@ -72,6 +72,27 @@ module Ethon
         }
       end
 
+      def set_progress_callback
+        if Curl.version_info[:version] >= "7.32.0"
+          Curl.set_option(:xferinfofunction, progress_callback, handle)
+        else
+          Curl.set_option(:progressfunction, progress_callback, handle)
+        end
+      end
+
+      # Returns the progress callback.
+      #
+      # @example Return the callback.
+      #   easy.progress_callback
+      #
+      # @return [ Proc ] The callback.
+      def progress_callback
+        @progress_callback ||= proc { |_, dltotal, dlnow, ultotal, ulnow|
+          progress(dltotal, dlnow, ultotal, ulnow)
+          0
+        }
+      end
+
       # Set the read callback. This callback is used by libcurl to
       # read data when performing a PUT request.
       #

data/lib/ethon/easy/form.rb

@@ -21,9 +21,10 @@ module Ethon
       # @param [ Hash ] params The parameter with which to initialize the form.
       #
       # @return [ Form ] A new Form.
-      def initialize(easy, params)
+      def initialize(easy, params, multipart = nil)
         @easy = easy
         @params = params || {}
+        @multipart = multipart
       end
 
       # Return a pointer to the first form element in libcurl.
@@ -47,13 +48,14 @@ module Ethon
       end
 
       # Return if form is multipart. The form is multipart
-      # when it contains a file.
+      # when it contains a file or multipart option is set on the form during creation.
       #
       # @example Return if form is multipart.
       #   form.multipart?
       #
       # @return [ Boolean ] True if form is multipart, else false.
       def multipart?
+        return true if @multipart
         query_pairs.any?{|pair| pair.respond_to?(:last) && pair.last.is_a?(Array)}
       end
 

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

@@ -71,7 +71,7 @@ module Ethon
         #
         # @return [ Form ] The form.
         def form
-          @form ||= Form.new(@easy, query_options.fetch(:body, nil))
+          @form ||= Form.new(@easy, query_options.fetch(:body, nil), options.fetch(:multipart, nil))
         end
 
         # Get the requested array encoding. By default it's

data/lib/ethon/easy/options.rb

@@ -16,8 +16,16 @@ module Ethon
       end
 
       def escape?
-        return true if @escape
-        @escape.nil? ? true : false
+        return true if !defined?(@escape) || @escape.nil?
+        @escape
+      end
+
+      def multipart=(b)
+        @multipart = b
+      end
+
+      def multipart?
+        !!@multipart
       end
 
       Curl.easy_options(nil).each do |opt, props|

data/lib/ethon/easy/response_callbacks.rb

@@ -69,6 +69,32 @@ module Ethon
         end
       end
 
+      # Set on_progress callback.
+      #
+      # @example Set on_progress.
+      #   request.on_progress {|dltotal, dlnow, ultotal, ulnow| p "#{dltotal} #{dlnow} #{ultotal} #{ulnow}" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_progress(&block)
+        @on_progress ||= []
+        if block_given?
+          @on_progress << block
+          set_progress_callback
+          self.noprogress = 0
+        end
+        @on_progress
+      end
+
+      # Execute on_progress callbacks.
+      #
+      # @example Execute on_progress.
+      #   request.body(1, 1, 1, 1)
+      def progress(dltotal, dlnow, ultotal, ulnow)
+        if defined?(@on_progress) and not @on_progress.nil?
+          @on_progress.each{ |callback| callback.call(dltotal, dlnow, ultotal, ulnow) }
+        end
+      end
+
       # Set on_body callback.
       #
       # @example Set on_body.

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
 end

data/spec/ethon/easy/callbacks_spec.rb

@@ -8,7 +8,7 @@ describe Ethon::Easy::Callbacks do
       expect(Ethon::Curl).to receive(:set_option).exactly(3).times
     end
 
-    it "sets write- and headerfunction" do
+    it "sets write-, debug-, and headerfunction" do
       easy.set_callbacks
     end
 
@@ -28,6 +28,12 @@ describe Ethon::Easy::Callbacks do
     end
   end
 
+  describe "#progress_callback" do
+    it "returns 0" do
+      expect(easy.progress_callback.call(0,1,1,1,1)).to be(0)
+    end
+  end
+
   describe "#body_write_callback" do
     let(:body_write_callback) { easy.instance_variable_get(:@body_write_callback) }
     let(:stream) { double(:read_string => "") }

data/spec/ethon/easy/debug_info_spec.rb

@@ -23,6 +23,7 @@ describe Ethon::Easy::DebugInfo do
       end
 
       after do
+        easy.verbose = false
         easy.reset
       end
 

data/spec/ethon/easy/form_spec.rb

@@ -41,6 +41,15 @@ describe Ethon::Easy::Form do
         expect(form.multipart?).to be_truthy
       end
     end
+
+    context "when options contains multipart=true" do
+      before { form.instance_variable_set(:@multipart, true) }
+      let(:pairs) { [['a', '1'], ['b', '2']] }
+
+      it "returns true" do
+        expect(form.multipart?).to be_truthy
+      end
+    end
   end
 
   describe "#materialize" do

data/spec/ethon/easy/options_spec.rb

@@ -74,6 +74,35 @@ describe Ethon::Easy::Options do
     end
   end
 
+  describe '#multipart?' do
+    context 'by default' do
+      it 'returns false' do
+        expect(easy.multipart?).to be_falsey
+      end
+    end
+
+    context 'when #multipart=nil' do
+      it 'returns false' do
+        easy.multipart = nil
+        expect(easy.multipart?).to be_falsey
+      end
+    end
+
+    context 'when #multipart=true' do
+      it 'returns true' do
+        easy.multipart = true
+        expect(easy.multipart?).to be_truthy
+      end
+    end
+
+    context 'when #multipart=false' do
+      it 'returns false' do
+        easy.multipart = false
+        expect(easy.multipart?).to be_falsey
+      end
+    end
+  end
+
   describe "#httppost=" do
     it "raises unless given a FFI::Pointer" do
       expect{ easy.httppost = 1 }.to raise_error(Ethon::Errors::InvalidValue)

data/spec/ethon/easy/queryable_spec.rb

@@ -152,9 +152,11 @@ describe Ethon::Easy::Queryable do
         end
 
         context "when MIME" do
-          context "when mime type" do
-            it "sets mime type to text" do
-              expect(mime_type).to eq("application/x-ruby")
+          if defined?(MIME)
+            context "when mime type" do
+              it "sets mime type to text" do
+                expect(mime_type).to eq("application/x-ruby")
+              end
             end
           end
 

data/spec/ethon/easy/response_callbacks_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Ethon::Easy::ResponseCallbacks do
   let(:easy) { Ethon::Easy.new }
 
-  [:on_complete, :on_headers, :on_body].each do |callback_type|
+  [:on_complete, :on_headers, :on_body, :on_progress].each do |callback_type|
     describe "##{callback_type}" do
       it "responds" do
         expect(easy).to respond_to("#{callback_type}")
@@ -68,6 +68,62 @@ describe Ethon::Easy::ResponseCallbacks do
     end
   end
 
+  describe "#progress" do
+    context "when requesting for realz" do
+      it "executes callback" do
+        post = Ethon::Easy::Http::Post.new("http://localhost:3001", {:body => "bar=fu"})
+        post.setup(easy)
+        @called = false
+        @has_dltotal = false
+        @has_ultotal = false
+        easy.on_progress { @called = true }
+        easy.on_progress { |dltotal, _, _, _| @has_dltotal ||= true }
+        easy.on_progress { |_, _, ultotal, _| @has_ultotal ||= true }
+        easy.perform
+        expect(@called).to be true
+        expect(@has_dltotal).to be true
+        expect(@has_ultotal).to be true
+      end
+    end
+
+    context "when pretending" do
+      before do
+        @dltotal = nil
+        @dlnow = nil
+        @ultotal = nil
+        @ulnow = nil
+        easy.on_progress { |dltotal, dlnow, ultotal, ulnow| @dltotal = dltotal ; @dlnow = dlnow; @ultotal = ultotal; @ulnow = ulnow }
+      end
+
+      it "executes blocks and passes dltotal" do
+        easy.progress(1, 2, 3, 4)
+        expect(@dltotal).to eq(1)
+      end
+
+      it "executes blocks and passes dlnow" do
+        easy.progress(1, 2, 3, 4)
+        expect(@dlnow).to eq(2)
+      end
+
+      it "executes blocks and passes ultotal" do
+        easy.progress(1, 2, 3, 4)
+        expect(@ultotal).to eq(3)
+      end
+
+      it "executes blocks and passes ulnow" do
+        easy.progress(1, 2, 3, 4)
+        expect(@ulnow).to eq(4)
+      end
+
+      context "when @on_progress nil" do
+        it "doesn't raise" do
+          easy.instance_variable_set(:@on_progress, nil)
+          expect{ easy.progress(1, 2, 3, 4) }.to_not raise_error
+        end
+      end
+    end
+  end
+
   describe "#body" do
     before do
       @chunk = nil

data/spec/ethon/easy_spec.rb

@@ -105,6 +105,7 @@ describe Ethon::Easy do
       easy.url = "http://localhost:3001/"
       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
@@ -132,6 +133,10 @@ describe Ethon::Easy do
       expect { easy.perform }.not_to change { e.response_body }
     end
 
+    it "preserves on_progress callback" do
+      expect(e.on_progress).to be(easy.on_progress)
+    end
+
     it 'sets new body_write_callback of duplicated handle' do
       expect { e.perform }.to change { e.response_body }
       expect { e.perform }.not_to change { easy.response_body }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Hans Hasselberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi