ethon 0.7.3 → 0.7.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzIwZTI3ZDU0NzcyNGIwYTcyNDQwMzBhMTE3YWVjOTk4M2NmODg3Yg==
+    N2ZmZmIxYjlmYzhiMDJmODM5YjczNWE5NGQwYTA1OTIzMTU2YTQ5YQ==
   data.tar.gz: !binary |-
-    ODA0NWYyYWJmMWJiZTExN2JlNmY4YmI4ZDM4YTEzOTkwNzNhODM5MA==
+    YThkNDc2ZmViYTdlZDkxNWUxMjRiNmE5NzIyNDUyN2QxMDlkNDc2MA==
 SHA512:
   metadata.gz: !binary |-
-    NTk5ZjIxNjQ4NDVmYTkzMGE2NDBjNTA2MTI5MzA3ODE4NjA2Mzg2MjkzNzk5
-    NGNhMmEzNjBiODc3OGQ2OTZmNzUwNmI2ZTVmZjVjYjk2YjA5OThjYzM0MzA2
-    YWE2OTBiODZiZGJjOTA3YjdjMWY5YTVmNGRjOTgwYTBjMDQwYjc=
+    ZjZjYTk3OGM3MGNlMmU3YmJiMGNkM2ZhMGE3MGRlNWUyYmYzMjFkOTRjNmVj
+    YWY1NzBmZTIyYTFlY2I2M2ZlMzhmMDk1ZWJiNDk2MDlhODJhMTg1ZWVhM2Yy
+    MjM5ODJjNWI0MTY3MWU0NzkxZTFkNWQ0YTdkZGJhMmY1YzdmYzc=
   data.tar.gz: !binary |-
-    NTgzMzlkN2Q3YTY5YWIyMWRmNzdlMDFjZGFkZTdkOTYyNjZkMWI3ZTEyMGRi
-    NTA2ODhhMjdjYmYwOTg2MDNlMjVlZmUzZWIzNGExODg1YzNmN2MwNGQ5ZGJi
-    ZTIzNjllMmQzYzczMGI3MTIxYzA2NWViNmU4ZWI0MDJkMTU3ODg=
+    MmZiN2MxYmQyYmM4YWExOTIxYzU4NDlkYWRhYmE0M2RlZWIzOGJlY2IwOThm
+    MzkyZGQ0OGMzOTQyZWE0ZjZhODU5ZTlkMjk3ZWFjZGI2Y2E0NzZiOTM3ZjFl
+    NTkyMzYzNDQ2NWRjY2FkOWJjMDVjZGFkZmRmZDE3ZmI3ZjRmYTg=

data/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 ## Master
 
-[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.3...master)
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.4...master)
+
+## 0.7.4
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.3...v0.7.4)
+
+* Support different array encodings for params.
+  ([Marcello Barnaba](https://github.com/ifad), [\#104](https://github.com/typhoeus/ethon/pull/104))
+* Programtic access to version infos.
+  ([Jonas Wagner](https://github.com/jwagner), [\#90](https://github.com/typhoeus/ethon/pull/90))
+
 
 ## 0.7.3
 

data/lib/ethon/curls/classes.rb

@@ -10,6 +10,18 @@ module Ethon
       layout :code, :msg_code, :easy_handle, :pointer, :data, MsgData
     end
 
+    class VersionInfoData < ::FFI::Struct
+      layout :curl_version, :uint8,
+        :version, :string,
+        :version_num, :int,
+        :host, :string,
+        :features, :int,
+        :ssl_version, :string,
+        :ssl_version_num, :long,
+        :libz_version, :string,
+        :protocols, :pointer
+    end
+
     # :nodoc:
     class FDSet < ::FFI::Struct
       if Curl.windows?

data/lib/ethon/curls/constants.rb

@@ -39,5 +39,24 @@ module Ethon
 
     # :nodoc:
     MsgCode = enum(:msg_code, msg_codes)
+
+    VERSION_IPV6 = (1<<0)  # IPv6-enabled
+    VERSION_KERBEROS4 = (1<<1)  # kerberos auth is supported
+    VERSION_SSL = (1<<2)  # SSL options are present
+    VERSION_LIBZ = (1<<3)  # libz features are present
+    VERSION_NTLM = (1<<4)  # NTLM auth is supported
+    VERSION_GSSNEGOTIATE = (1<<5) # Negotiate auth supp
+    VERSION_DEBUG = (1<<6)  # built with debug capabilities
+    VERSION_ASYNCHDNS = (1<<7)  # asynchronous dns resolves
+    VERSION_SPNEGO = (1<<8)  # SPNEGO auth is supported
+    VERSION_LARGEFILE = (1<<9)  # supports files bigger than 2GB
+    VERSION_IDN = (1<<10) # International Domain Names support
+    VERSION_SSPI = (1<<11) # SSPI is supported
+    VERSION_CONV = (1<<12) # character conversions supported
+    VERSION_CURLDEBUG = (1<<13) # debug memory tracking supported
+    VERSION_TLSAUTH_SRP = (1<<14) # TLS-SRP auth is supported
+    VERSION_NTLM_WB = (1<<15) # NTLM delegating to winbind helper
+    VERSION_HTTP2 = (1<<16) # HTTP2 support built
+    VERSION_GSSAPI = (1<<17) # GSS-API is supported
   end
 end

data/lib/ethon/curls/functions.rb

@@ -44,6 +44,8 @@ module Ethon
         base.attach_function :multi_setopt_off_t,         :curl_multi_setopt,        [:pointer, :multi_option, :int64],    :multi_code
 
         base.attach_function :version,                    :curl_version,             [],                             :string
+        base.attach_function :version_info,               :curl_version_info,        [],                             Curl::VersionInfoData.ptr
+
         base.attach_function :slist_append,               :curl_slist_append,        [:pointer, :string],            :pointer
         base.attach_function :slist_free_all,             :curl_slist_free_all,      [:pointer],                     :void
         base.instance_variable_set(:@blocking, true)

data/lib/ethon/easy.rb

@@ -1,4 +1,5 @@
 require 'ethon/easy/informations'
+require 'ethon/easy/features'
 require 'ethon/easy/callbacks'
 require 'ethon/easy/options'
 require 'ethon/easy/header'
@@ -39,6 +40,7 @@ module Ethon
     include Ethon::Easy::Http
     include Ethon::Easy::Operations
     include Ethon::Easy::ResponseCallbacks
+    extend Ethon::Easy::Features
 
     # Returns the curl return code.
     #

data/lib/ethon/easy/features.rb

@@ -0,0 +1,30 @@
+module Ethon
+  class Easy
+
+    # This module contains class methods for feature checks
+    module Features
+      # Returns true if this curl version supports zlib.
+      #
+      # @example Return wether zlib is supported.
+      #   Ethon::Easy.supports_zlib?
+      #
+      # @return [ Boolean ] True if supported, else false.
+      def supports_zlib?
+        !!(Curl.version_info[:features] & Curl::VERSION_LIBZ)
+      end
+
+      # Returns true if this curl version supports AsynchDNS.
+      #
+      # @example
+      #   Ethon::Easy.supports_asynch_dns?
+      #
+      # @return [ Boolean ] True if supported, else false.
+      def supports_asynch_dns?
+        !!(Curl.version_info[:features] & Curl::VERSION_ASYNCHDNS)
+      end
+
+      alias :supports_timeout_ms? :supports_asynch_dns?
+
+    end
+  end
+end

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

@@ -8,6 +8,8 @@ module Ethon
       # for more real actions like GET, HEAD, POST and PUT.
       module Actionable
 
+        QUERY_OPTIONS = [ :params, :body, :params_encoding ]
+
         # Create a new action.
         #
         # @example Create a new action.
@@ -19,7 +21,7 @@ module Ethon
         # @return [ Action ] A new action.
         def initialize(url, options)
           @url = url
-          @options = options.dup
+          @options, @query_options = parse_options(options)
         end
 
         # Return the url.
@@ -42,6 +44,16 @@ module Ethon
           @options
         end
 
+        # Returns the query options hash.
+        #
+        # @example Return query options.
+        #   action.query_options
+        #
+        # @return [ Hash ] The query options.
+        def query_options
+          @query_options
+        end
+
         # Return the params.
         #
         # @example Return params.
@@ -49,7 +61,7 @@ module Ethon
         #
         # @return [ Params ] The params.
         def params
-          @params ||= Params.new(@easy, options.delete(:params))
+          @params ||= Params.new(@easy, query_options.fetch(:params, nil))
         end
 
         # Return the form.
@@ -59,7 +71,17 @@ module Ethon
         #
         # @return [ Form ] The form.
         def form
-          @form ||= Form.new(@easy, options.delete(:body))
+          @form ||= Form.new(@easy, query_options.fetch(:body, nil))
+        end
+
+        # Get the requested array encoding. By default it's
+        # :typhoeus, but it can also be set to :rack.
+        #
+        # @example Get encoding from options
+        #   action.params_encoding
+        #
+        def params_encoding
+          @params_encoding ||= query_options.fetch(:params_encoding, :typhoeus)
         end
 
         # Setup everything necessary for a proper request.
@@ -70,6 +92,7 @@ module Ethon
         # @param [ easy ] easy the easy to setup.
         def setup(easy)
           @easy = easy
+
           if params.empty?
             easy.url = url
           else
@@ -87,6 +110,8 @@ module Ethon
         # @param [ Easy ] easy The easy to setup.
         def set_params(easy)
           params.escape = true
+          params.params_encoding = params_encoding
+
           base_url, base_params = url.split("?")
           base_params += "&" if base_params
           easy.url = "#{base_url}?#{base_params}#{params.to_s}"
@@ -100,6 +125,21 @@ module Ethon
         # @param [ Easy ] easy The easy to setup.
         def set_form(easy)
         end
+
+        private
+
+        def parse_options(options)
+          query_options = {}
+          options = options.dup
+
+          QUERY_OPTIONS.each do |query_option|
+            if options.key?(query_option)
+              query_options[query_option] = options.delete(query_option)
+            end
+          end
+
+          return options, query_options
+        end
       end
     end
   end

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

@@ -14,6 +14,7 @@ module Ethon
         # @param [ Easy ] easy The easy to setup.
         def set_form(easy)
           easy.url ||= url
+          form.params_encoding = params_encoding
           if form.multipart?
             form.escape = false
             form.materialize

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

@@ -14,6 +14,7 @@ module Ethon
         def set_form(easy)
           easy.upload = true
           form.escape = true
+          form.params_encoding = params_encoding
           easy.infilesize = form.to_s.bytesize
           easy.set_read_callback(form.to_s)
         end

data/lib/ethon/easy/informations.rb

@@ -77,15 +77,18 @@ module Ethon
         eval %Q|def #{name}; Curl.send(:get_info_#{type}, :#{name}, handle); end|
       end
 
-      # Returns this curl version supports zlib.
+      # Returns true if this curl version supports zlib.
       #
       # @example Return wether zlib is supported.
       #   easy.supports_zlib?
       #
       # @return [ Boolean ] True if supported, else false.
+      # @deprecated Please use the static version instead
       def supports_zlib?
-        !!(Curl.version.match(/zlib/))
+        Kernel.warn("Ethon: Easy#supports_zlib? is deprecated and will be removed, please use Easy#.")
+        Easy.supports_zlib?
       end
+
     end
   end
 end

data/lib/ethon/easy/queryable.rb

@@ -8,6 +8,7 @@ module Ethon
       # :nodoc:
       def self.included(base)
         base.send(:attr_accessor, :escape)
+        base.send(:attr_accessor, :params_encoding)
       end
 
       # Return wether there are elements in params or not.
@@ -95,18 +96,37 @@ module Ethon
       def recursively_generate_pairs(h, prefix, pairs)
         case h
         when Hash
-          h.each_pair do |k,v|
-            key = prefix.nil? ? k : "#{prefix}[#{k}]"
-            pairs_for(v, key, pairs)
-          end
+          encode_hash_pairs(h, prefix, pairs)
         when Array
-          h.each_with_index do |v, i|
-            key = "#{prefix}[#{i}]"
-            pairs_for(v, key, pairs)
+          if params_encoding == :rack
+            encode_rack_array_pairs(h, prefix, pairs)
+          else
+            encode_indexed_array_pairs(h, prefix, pairs)
           end
         end
       end
 
+      def encode_hash_pairs(h, prefix, pairs)
+        h.each_pair do |k,v|
+          key = prefix.nil? ? k : "#{prefix}[#{k}]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
+      def encode_indexed_array_pairs(h, prefix, pairs)
+        h.each_with_index do |v, i|
+          key = "#{prefix}[#{i}]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
+      def encode_rack_array_pairs(h, prefix, pairs)
+        h.each do |v|
+          key = "#{prefix}[]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
       def pairs_for(v, key, pairs)
         case v
         when Hash, Array

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.7.3'
+  VERSION = '0.7.4'
 end

data/spec/ethon/easy/features_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Ethon::Easy::Informations do
+
+  describe "#supports_asynch_dns?" do
+    it "returns boolean" do
+      expect([true, false].include? Ethon::Easy.supports_asynch_dns?).to be_truthy
+    end
+  end
+
+  describe "#supports_zlib?" do
+    it "returns boolean" do
+      expect([true, false].include? Ethon::Easy.supports_zlib?).to be_truthy
+    end
+  end
+
+  describe "#supports_timeout_ms?" do
+    it "returns boolean" do
+      expect([true, false].include? Ethon::Easy.supports_timeout_ms?).to be_truthy
+    end
+  end
+
+end

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

@@ -5,7 +5,8 @@ describe Ethon::Easy::Http::Post do
   let(:url) { "http://localhost:3001/" }
   let(:params) { nil }
   let(:form) { nil }
-  let(:post) { described_class.new(url, {:params => params, :body => form}) }
+  let(:options) { Hash.new }
+  let(:post) { described_class.new(url, options.merge({:params => params, :body => form})) }
 
   describe "#setup" do
     context "when nothing" do
@@ -39,6 +40,25 @@ describe Ethon::Easy::Http::Post do
         expect(easy.url).to eq("#{url}?a=1%26")
       end
 
+      context "with arrays" do
+        let(:params) { {:a => %w( foo bar )} }
+
+        context "by default" do
+          it "encodes them with indexes" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a%5B0%5D=foo&a%5B1%5D=bar")
+          end
+        end
+
+        context "when params_encoding is :rack" do
+          let(:options) { {:params_encoding => :rack} }
+          it "encodes them without indexes" do
+            post.setup(easy)
+            expect(easy.url).to eq("#{url}?a%5B%5D=foo&a%5B%5D=bar")
+          end
+        end
+      end
+
       it "sets postfieldsize" do
         expect(easy).to receive(:postfieldsize=).with(0)
         post.setup(easy)
@@ -214,6 +234,26 @@ describe Ethon::Easy::Http::Post do
           end
         end
       end
+
+      context "when arrays" do
+        let(:form) { {:a => %w( foo bar )} }
+
+        context "by default" do
+          it "sets copypostfields with indexed, escaped representation" do
+            expect(easy).to receive(:copypostfields=).with('a%5B0%5D=foo&a%5B1%5D=bar')
+            post.setup(easy)
+          end
+        end
+
+        context "when params_encoding is :rack" do
+          let(:options) { {:params_encoding => :rack} }
+
+          it "sets copypostfields with non-indexed, escaped representation" do
+            expect(easy).to receive(:copypostfields=).with('a%5B%5D=foo&a%5B%5D=bar')
+            post.setup(easy)
+          end
+        end
+      end
     end
 
     context "when params and body" do

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

@@ -5,7 +5,8 @@ describe Ethon::Easy::Http::Put do
   let(:url) { "http://localhost:3001/" }
   let(:params) { nil }
   let(:form) { nil }
-  let(:put) { described_class.new(url, {:params => params, :body => form}) }
+  let(:options) { Hash.new }
+  let(:put) { described_class.new(url, options.merge({:params => params, :body => form})) }
 
   describe "#setup" do
     context "when nothing" do
@@ -41,6 +42,25 @@ describe Ethon::Easy::Http::Put do
         expect(easy.url).to eq("#{url}?a=1%26")
       end
 
+      context "with arrays" do
+        let(:params) { {:a => %w( foo bar )} }
+
+        context "by default" do
+          it "encodes them with indexes" do
+            put.setup(easy)
+            expect(easy.url).to eq("#{url}?a%5B0%5D=foo&a%5B1%5D=bar")
+          end
+        end
+
+        context "when params_encoding is :rack" do
+          let(:options) { {:params_encoding => :rack} }
+          it "encodes them without indexes" do
+            put.setup(easy)
+            expect(easy.url).to eq("#{url}?a%5B%5D=foo&a%5B%5D=bar")
+          end
+        end
+      end
+
       it "sets upload" do
         expect(easy).to receive(:upload=).with(true)
         put.setup(easy)
@@ -117,6 +137,29 @@ describe Ethon::Easy::Http::Put do
           end
         end
       end
+
+      context "when arrays" do
+        let(:form) { {:a => %w( foo bar )} }
+
+        before do
+          put.setup(easy)
+          easy.perform
+        end
+
+        context "by default" do
+          it "submits an indexed, escaped representation" do
+            expect(easy.response_body).to include('"body":"a%5B0%5D=foo&a%5B1%5D=bar"')
+          end
+        end
+
+        context "when params_encoding is :rack" do
+          let(:options) { {:params_encoding => :rack} }
+
+          it "submits an non-indexed, escaped representation" do
+            expect(easy.response_body).to include('"body":"a%5B%5D=foo&a%5B%5D=bar"')
+          end
+        end
+      end
     end
 
     context "when params and body"

data/spec/ethon/easy/informations_spec.rb

@@ -88,7 +88,10 @@ describe Ethon::Easy::Informations do
 
   describe "#supports_zlib?" do
     it "returns true" do
+      Kernel.should_receive(:warn) #deprecation warning
       expect(easy.supports_zlib?).to be_truthy
     end
   end
+
+
 end

data/spec/ethon/easy/options_spec.rb

@@ -104,9 +104,9 @@ describe Ethon::Easy::Options do
       end
     end
 
-    if Ethon::Curl.version.match("c-ares")
+    if Ethon::Easy.supports_timeout_ms?
       context "when timeout_ms" do
-        let(:timeout_ms) { 900 }
+        let(:timeout_ms) { 100 }
 
         context "when request takes longer" do
           let(:url) { "localhost:3001?delay=1" }
@@ -118,13 +118,14 @@ describe Ethon::Easy::Options do
       end
 
       context "when connecttimeout_ms" do
-        let(:connecttimeout_ms) { 1 }
+        let(:connecttimeout_ms) { 100 }
 
         context "when cannot connect" do
           let(:url) { "localhost:3002" }
 
           it "times out" do
-            expect(easy.return_code).to eq(:couldnt_connect)
+            # this can either lead to a timeout or couldnt connect depending on which happens first
+            expect([:couldnt_connect, :operation_timedout]).to include(easy.return_code)
           end
         end
       end

data/spec/ethon/easy/queryable_spec.rb

@@ -106,10 +106,21 @@ describe Ethon::Easy::Queryable do
     context "when params contains an array" do
       let(:hash) { {:a => 1, :b => [2, 3]} }
 
-      it "transforms" do
-        expect(pairs).to include([:a, 1])
-        expect(pairs).to include(["b[0]", 2])
-        expect(pairs).to include(["b[1]", 3])
+      context "by default" do
+        it "transforms" do
+          expect(pairs).to include([:a, 1])
+          expect(pairs).to include(["b[0]", 2])
+          expect(pairs).to include(["b[1]", 3])
+        end
+      end
+
+      context "when params_encoding is :rack" do
+        before { params.params_encoding = :rack }
+        it "transforms without indexes" do
+          expect(pairs).to include([:a, 1])
+          expect(pairs).to include(["b[]", 2])
+          expect(pairs).to include(["b[]", 3])
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Hans Hasselberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -55,6 +55,7 @@ files:
 - lib/ethon/easy.rb
 - lib/ethon/easy/callbacks.rb
 - lib/ethon/easy/debug_info.rb
+- lib/ethon/easy/features.rb
 - lib/ethon/easy/form.rb
 - lib/ethon/easy/header.rb
 - lib/ethon/easy/http.rb
@@ -103,6 +104,7 @@ files:
 - spec/ethon/curl_spec.rb
 - spec/ethon/easy/callbacks_spec.rb
 - spec/ethon/easy/debug_info_spec.rb
+- spec/ethon/easy/features_spec.rb
 - spec/ethon/easy/form_spec.rb
 - spec/ethon/easy/header_spec.rb
 - spec/ethon/easy/http/custom_spec.rb
@@ -159,6 +161,7 @@ test_files:
 - spec/ethon/curl_spec.rb
 - spec/ethon/easy/callbacks_spec.rb
 - spec/ethon/easy/debug_info_spec.rb
+- spec/ethon/easy/features_spec.rb
 - spec/ethon/easy/form_spec.rb
 - spec/ethon/easy/header_spec.rb
 - spec/ethon/easy/http/custom_spec.rb