httpi 2.4.0 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7fdb3bb23a9cba076a235fac76aa7aa0aa04a803
-  data.tar.gz: 7740630503dc0ffedc3f909f1418d45f0a443156
+SHA256:
+  metadata.gz: d4ef171693207d4179542cd91eb6de5c8a1dc4b30458fcb5e255098e60a6297e
+  data.tar.gz: fb6977168d9ad78ab44fdfcbce528145fbe4c43f433a195cd6cd1ca5e33f1f54
 SHA512:
-  metadata.gz: 14a720954983eecb0fd4497f2c0e87269ceb5373c0856e19d4de9b7a102c7adba108e8fb44b020a80dc038b820355efffff9dfcdf0dad94f24668953c4d9b38d
-  data.tar.gz: 5f8119a473f8daf6c7dfd597a172002ead1f5b1fceea7456c083e14a9daee93da63d23a7018030103389a3397ae9e6df986780e032a7612f5d39a482b3619f5c
+  metadata.gz: fb1092a0fb53a39f2d7f327b0f7c02b914f8f1e1f80f20e64178592d81b98d414016a62310a532931c3ba0da969f9fde269da22ea62fb594220f111a351e64ba
+  data.tar.gz: 5ce7bd00cb3ed67cace0e21ca2a4b459f6da89d618da1857b641a37413a0da98b5619b617dd86fab0a68ba280713a24d4ab54ae6b44362b91c3bc04df43a9e3a

data/.travis.yml

@@ -1,8 +1,6 @@
 language: "ruby"
 script: "bundle exec rake ci"
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - jruby-19mode
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+### 2.4.5
+
+* Improvement: [#209](https://github.com/savonrb/httpi/pull/209) Drop Travis CI support for Ruby < 2.3.0 and jruby.
+*     Feature: [#208](https://github.com/savonrb/httpi/pull/208) Add SSL min/max_version configuration for supporting adapters
+* Improvement: [#206](https://github.com/savonrb/httpi/pull/206) Support for net-http-persistent v3
+* Improvement: [#204](https://github.com/savonrb/httpi/pull/204) Avoid excon warning
+
+### 2.4.4
+
+* Improvement: [#197](https://github.com/savonrb/httpi/pull/197) Add support for new write timeout option to all adapters
+* Fix: [#196](https://github.com/savonrb/httpi/pull/196) Fix httpi adapters support for read/open timeout
+* Improvement: [Remove references to broken site](https://github.com/savonrb/httpi/commit/345e5e2b1a4376a7be769f67088a431895de09ad)
+* Fix: [#190](https://github.com/savonrb/httpi/pull/190) Don't convert port to string on Excon adapter
+
+### 2.4.3
+
+* Fix: [#171](https://github.com/savonrb/httpi/pull/171) bug with rubyntlm v0.6.0
+* Fix: [#181](https://github.com/savonrb/httpi/pull/181) excon and http adapters
+* Feature: [#183](https://github.com/savonrb/httpi/pull/183) Logging ssl information of a request
+* Fix: [#187](https://github.com/savonrb/httpi/pull/187) only require ntlm if ntlm auth was requested
+
+
+### 2.4.2
+
+* Feature: [#165](https://github.com/savonrb/httpi/pull/165) Extended net_http adapter ssl options with cert_store and ca_path
+* Improvement: [#166](https://github.com/savonrb/httpi/pull/166) fix some warnings
+* Feature: [#167](https://github.com/savonrb/httpi/pull/167) adds missing support for cert password
+* Feature: [#163](https://github.com/savonrb/httpi/pull/163) Support HTTP Basic auth in Rack adapter
+* Fix: [#162](https://github.com/savonrb/httpi/pull/162) fixing excon adapter to pass client_cert and key as strings instead of objects
+* Fix: [#160](https://github.com/savonrb/httpi/pull/160) httpclient adapter now accepts NTLM auth
+* Improvement: [#158](https://github.com/savonrb/httpi/pull/158) Limit the maximum of redirects to prevent infinite redirects
+* Improvement: [#153](https://github.com/savonrb/httpi/pull/153) Dynamically determine methods Net::HTTP supports
+* Improvement: [#155](https://github.com/savonrb/httpi/pull/155) Enable socks proxy server specification
+* Improvement: [#151](https://github.com/savonrb/httpi/pull/151) Fix excon verify mode
+* Fix: [#149](https://github.com/savonrb/httpi/pull/149) Ensure that header exists before accessing it
+
+### 2.4.1
+
+* Fix: [#147](https://github.com/savonrb/httpi/pull/147) Fix call Curb client "SSL peer certificate or SSH remote key was not OK" bug
+* Feature: [#145](https://github.com/savonrb/httpi/pull/145) Add support to http.rb adapter
+* Feature: [#144](https://github.com/savonrb/httpi/pull/144) Add NTLM support for CURB
+
 ### 2.4.0
 
 * Formally drop support for ruby 1.8.7

data/Gemfile

@@ -3,13 +3,17 @@ gemspec
 
 gem 'jruby-openssl',                                       :platforms => :jruby
 
+# compatibility restrictions for http clients under existing travis test environments
+gem 'public_suffix', '~> 2.0'   # or remove rubies < 2.1 from travis.yml
+
 # http clients
 gem 'httpclient',          '~> 2.3',    :require => false
 gem 'curb',                '~> 0.8',    :require => false, :platforms => :ruby
 gem 'em-http-request',                  :require => false, :platforms => [:ruby, :jruby]
 gem 'em-synchrony',                     :require => false, :platforms => [:ruby, :jruby]
-gem 'excon',               '~> 0.21.0', :require => false, :platforms => [:ruby, :jruby]
+gem 'excon',               '~> 0.21',   :require => false, :platforms => [:ruby, :jruby]
 gem 'net-http-persistent', '~> 2.8',    :require => false
+gem 'http',                             :require => false
 
 # coverage
 gem 'simplecov',                        :require => false

data/README.md

@@ -2,18 +2,18 @@
 
 A common interface for Ruby's HTTP libraries.
 
-[Documentation](http://httpirb.com) | [RDoc](http://rubydoc.info/gems/httpi) |
+[Documentation](https://www.rubydoc.info/gems/httpi) |
 [Mailing list](https://groups.google.com/forum/#!forum/httpirb)
 
-[![Build Status](https://secure.travis-ci.org/savonrb/httpi.png?branch=master)](http://travis-ci.org/savonrb/httpi)
-[![Gem Version](https://badge.fury.io/rb/httpi.png)](http://badge.fury.io/rb/httpi)
-[![Code Climate](https://codeclimate.com/github/savonrb/httpi.png)](https://codeclimate.com/github/savonrb/httpi)
-[![Coverage Status](https://coveralls.io/repos/savonrb/httpi/badge.png?branch=master)](https://coveralls.io/r/savonrb/httpi)
+[![Build Status](https://secure.travis-ci.org/savonrb/httpi.svg?branch=master)](http://travis-ci.org/savonrb/httpi)
+[![Gem Version](https://badge.fury.io/rb/httpi.svg)](http://badge.fury.io/rb/httpi)
+[![Code Climate](https://codeclimate.com/github/savonrb/httpi.svg)](https://codeclimate.com/github/savonrb/httpi)
+[![Coverage Status](https://coveralls.io/repos/savonrb/httpi/badge.svg?branch=master)](https://coveralls.io/r/savonrb/httpi)
 
 
 ## Installation
 
-HTTPI is available through [Rubygems](http://rubygems.org/gems/httpi) and can be installed via:
+HTTPI is available through [Rubygems](https://rubygems.org/gems/httpi) and can be installed via:
 
 ```
 $ gem install httpi
@@ -52,4 +52,4 @@ HTTPI.request(:custom, request)
 
 ## Documentation
 
-Continue reading at [httpirb.com](http://httpirb.com)
+Continue reading at https://www.rubydoc.info/gems/httpi

data/Rakefile

@@ -10,7 +10,9 @@ RSpec::Core::RakeTask.new "spec_integration" do |t|
   t.pattern = "spec/integration/*_spec.rb"
 end
 
-task :default => :spec
-
 desc "Run RSpec code and integration examples"
-task :ci => [:spec, :spec_integration]
+RSpec::Core::RakeTask.new "ci" do |t|
+  t.pattern = "spec/{httpi,integration}/**/*_spec.rb"
+end
+
+task :default => :spec

data/httpi.gemspec

@@ -13,16 +13,17 @@ Gem::Specification.new do |s|
   s.description = s.summary
   s.required_ruby_version = '>= 1.9.2'
 
-  s.rubyforge_project = s.name
   s.license = 'MIT'
 
   s.add_dependency 'rack'
+  s.add_dependency 'socksify'
 
   s.add_development_dependency 'rubyntlm', '~> 0.3.2'
   s.add_development_dependency 'rake',     '~> 10.0'
   s.add_development_dependency 'rspec',    '~> 2.14'
   s.add_development_dependency 'mocha',    '~> 0.13'
   s.add_development_dependency 'puma',     '~> 2.3.2'
+  s.add_development_dependency 'webmock'
 
   s.files = `git ls-files`.split("\n")
   s.require_path = 'lib'

data/lib/httpi.rb

@@ -11,6 +11,7 @@ require "httpi/adapter/net_http"
 require "httpi/adapter/net_http_persistent"
 require "httpi/adapter/em_http"
 require "httpi/adapter/rack"
+require "httpi/adapter/http"
 
 # = HTTPI
 #
@@ -102,7 +103,7 @@ module HTTPI
   class << self
 
     def query_builder
-      @query_builder || HTTPI::QueryBuilder::Flat
+      @query_builder ||= HTTPI::QueryBuilder::Flat
     end
 
     def query_builder=(builder)
@@ -151,7 +152,7 @@ module HTTPI
     end
 
     # Executes an HTTP request for the given +method+.
-    def request(method, request, adapter = nil)
+    def request(method, request, adapter = nil, redirects = 0)
       adapter_class = load_adapter(adapter, request)
 
       yield adapter_class.client if block_given?
@@ -159,10 +160,10 @@ module HTTPI
 
       response = adapter_class.request(method)
 
-      if response &&  HTTPI::Response::RedirectResponseCodes.member?(response.code) && request.follow_redirect?
+      if response && HTTPI::Response::RedirectResponseCodes.member?(response.code) && request.follow_redirect? && redirects < request.redirect_limit
         request.url = URI.join(request.url, response.headers['location'])
         log("Following redirect: '#{request.url}'.")
-        return request(method, request, adapter)
+        return request(method, request, adapter, redirects + 1)
       end
 
       response

data/lib/httpi/adapter.rb

@@ -13,7 +13,7 @@ module HTTPI
     ADAPTERS = {}
     ADAPTER_CLASS_MAP = {}
 
-    LOAD_ORDER = [:httpclient, :curb, :em_http, :excon, :net_http, :net_http_persistent]
+    LOAD_ORDER = [:httpclient, :curb, :em_http, :excon, :http, :net_http, :net_http_persistent]
 
     class << self
 

data/lib/httpi/adapter/curb.rb

@@ -59,10 +59,11 @@ module HTTPI
       def setup_client
         basic_setup
 
-        if @request.auth.ntlm?
-          raise NotSupportedError, "curb does not support NTLM authentication"
+        if @request.auth.ntlm? && !Curl.ntlm?
+          raise NotSupportedError, "installed version of libcurl does not support NTLM authentication"
         end
 
+        setup_ntlm_auth if @request.auth.ntlm?
         setup_http_auth if @request.auth.http?
         setup_gssnegotiate_auth if @request.auth.gssnegotiate?
         setup_ssl_auth if @request.auth.ssl? || @request.ssl?
@@ -71,8 +72,9 @@ module HTTPI
       def basic_setup
         @client.url = @request.url.to_s
         @client.proxy_url = @request.proxy.to_s if @request.proxy
-        @client.timeout = @request.read_timeout if @request.read_timeout
-        @client.connect_timeout = @request.open_timeout if @request.open_timeout
+        read_or_write_timeout = @request.read_timeout || @request.write_timeout
+        @client.timeout_ms = read_or_write_timeout * 1000 if read_or_write_timeout
+        @client.connect_timeout_ms = @request.open_timeout * 1000 if @request.open_timeout
         @client.headers = @request.headers.to_hash
         @client.verbose = false
         # cURL workaround
@@ -81,6 +83,11 @@ module HTTPI
         @client.set(:NOSIGNAL, true)
       end
 
+      def setup_ntlm_auth
+        @client.http_auth_types = @request.auth.type
+        @client.username, @client.password = *@request.auth.credentials
+      end
+
       def setup_http_auth
         @client.http_auth_types = @request.auth.type
         @client.username, @client.password = *@request.auth.credentials
@@ -98,7 +105,9 @@ module HTTPI
         ssl = @request.auth.ssl
 
         if @request.auth.ssl?
-          unless ssl.verify_mode == :none
+          if ssl.verify_mode == :none
+            @client.ssl_verify_host = 0
+          else
             @client.cacert = ssl.ca_cert_file if ssl.ca_cert_file
             @client.certtype = ssl.cert_type.to_s.upcase
           end
@@ -106,6 +115,7 @@ module HTTPI
           # Send client-side certificate regardless of state of SSL verify mode
           @client.cert_key = ssl.cert_key_file
           @client.cert = ssl.cert_file
+          @client.certpassword = ssl.cert_key_password
 
           @client.ssl_verify_peer = ssl.verify_mode == :peer
         end
@@ -118,6 +128,9 @@ module HTTPI
           when :SSLv23  then 2
           when :SSLv3   then 3
         end
+        if ssl.min_version || ssl.max_version
+          raise NotSupportedError, 'Curb adapter does not support #min_version or #max_version. Please, use #ssl_version instead.'
+        end
       end
 
       def respond_with(client)

data/lib/httpi/adapter/em_http.rb

@@ -69,10 +69,11 @@ module HTTPI
       end
 
       def connection_options
-        options = {
-          :connect_timeout    => @request.open_timeout,
-          :inactivity_timeout => @request.read_timeout
-        }
+        options = {}
+
+        read_or_write_timeout = @request.read_timeout || @request.write_timeout
+        options[:inactivity_timeout] = read_or_write_timeout if read_or_write_timeout
+        options[:connect_timeout] = @request.open_timeout if @request.open_timeout
 
         options[:proxy] = proxy_options if @request.proxy
 

data/lib/httpi/adapter/excon.rb

@@ -41,8 +41,9 @@ module HTTPI
 
         opts = {
           :host => url.host,
+          :hostname => url.hostname,
           :path => url.path,
-          :port => url.port.to_s,
+          :port => url.port,
           :query => url.query,
           :scheme => url.scheme,
           :headers => @request.headers,
@@ -58,23 +59,33 @@ module HTTPI
         opts[:user], opts[:password] = *@request.auth.credentials if @request.auth.basic?
         opts[:connect_timeout] = @request.open_timeout if @request.open_timeout
         opts[:read_timeout]    = @request.read_timeout if @request.read_timeout
+        opts[:write_timeout]   = @request.write_timeout if @request.write_timeout
         opts[:response_block]  = @request.on_body if @request.on_body
         opts[:proxy]           = @request.proxy if @request.proxy
 
-        if ssl.verify_mode == :peer
+        case ssl.verify_mode
+        when :peer
           opts[:ssl_verify_peer] = true
           opts[:ssl_ca_file] = ssl.ca_cert_file if ssl.ca_cert_file
-          opts[:client_cert] = ssl.cert     if ssl.cert
-          opts[:client_key]  = ssl.cert_key if ssl.cert_key
+          opts[:certificate] = ssl.cert.to_pem     if ssl.cert
+          opts[:private_key] = ssl.cert_key.to_pem if ssl.cert_key
+        when :none
+          opts[:ssl_verify_peer] = false
         end
 
         opts[:ssl_version] = ssl.ssl_version if ssl.ssl_version
+        opts[:ssl_min_version] = ssl.min_version if ssl.min_version
+        opts[:ssl_max_version] = ssl.max_version if ssl.max_version
 
         opts
       end
 
       def respond_with(response)
-        Response.new response.status, response.headers, response.body
+        headers = response.headers.dup
+        if (cookies = response.data[:cookies]) && !cookies.empty?
+          headers["Set-Cookie"] = cookies
+        end
+        Response.new response.status, headers, response.body
       end
 
     end

data/lib/httpi/adapter/http.rb

@@ -0,0 +1,88 @@
+require "httpi/adapter/base"
+require "httpi/response"
+
+module HTTPI
+  module Adapter
+
+    # = HTTPI::Adapter::HTTP
+    #
+    # Adapter for the http.rb client.
+    # https://github.com/httprb/http.rb
+    class HTTP < Base
+
+      register :http, :deps => %w(http)
+
+      def initialize(request)
+        if request.auth.digest?
+          raise NotSupportedError, "http.rb does not support HTTP digest authentication"
+        end
+        if request.auth.ntlm?
+          raise NotSupportedError, "http.rb does not support NTLM digest authentication"
+        end
+
+        @request = request
+        @client = create_client
+      end
+
+      attr_reader :client
+
+      # Executes arbitrary HTTP requests.
+      # @see HTTPI.request
+      def request(method)
+        unless ::HTTP::Request::METHODS.include? method
+          raise NotSupportedError, "http.rb does not support custom HTTP methods"
+        end
+        response = begin
+          @client.send(method, @request.url, :body => @request.body)
+        rescue OpenSSL::SSL::SSLError
+          raise SSLError
+        end
+
+        Response.new(response.code, response.headers.to_h, response.body.to_s)
+      end
+
+      private
+
+      def create_client
+        if @request.ssl?
+          context = OpenSSL::SSL::SSLContext.new
+
+          context.options = OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options]
+
+          if @request.auth.ssl.ca_cert_file != nil
+            context.ca_file = @request.auth.ssl.ca_cert_file
+          else
+            context.cert_store = OpenSSL::SSL::SSLContext::DEFAULT_CERT_STORE
+          end
+
+          context.cert        = @request.auth.ssl.cert
+          context.key         = @request.auth.ssl.cert_key
+          context.ssl_version = @request.auth.ssl.ssl_version if @request.auth.ssl.ssl_version != nil
+          context.min_version = @request.auth.ssl.min_version if @request.auth.ssl.min_version != nil
+          context.max_version = @request.auth.ssl.max_version if @request.auth.ssl.max_version != nil
+          context.verify_mode = @request.auth.ssl.openssl_verify_mode
+
+          client = ::HTTP::Client.new(:ssl_context => context)
+        else
+          client = ::HTTP
+        end
+
+        if @request.auth.basic?
+          client = client.basic_auth(:user => @request.auth.credentials[0], :pass => @request.auth.credentials[1])
+        end
+
+        if @request.proxy != nil
+          client = client.via(@request.proxy.host, @request.proxy.port, @request.proxy.user, @request.proxy.password)
+        end
+
+        timeouts = {}
+        timeouts[:connect] = @request.open_timeout if @request.open_timeout
+        timeouts[:read] = @request.read_timeout if @request.read_timeout
+        timeouts[:write] = @request.write_timeout if @request.write_timeout
+        client = client.timeout(timeouts) if timeouts.any?
+
+        client.headers(@request.headers)
+      end
+    end
+  end
+end

data/lib/httpi/adapter/httpclient.rb

@@ -36,11 +36,8 @@ module HTTPI
       def setup_client
         basic_setup
 
-        if @request.auth.ntlm?
-          raise NotSupportedError, "HTTPClient adapter does not support NTLM authentication"
-        end
-
         setup_auth if @request.auth.http?
+        setup_ntlm_auth if @request.auth.ntlm?
         setup_ssl_auth if @request.auth.ssl? || @request.ssl?
       end
 
@@ -48,12 +45,23 @@ module HTTPI
         @client.proxy = @request.proxy if @request.proxy
         @client.connect_timeout = @request.open_timeout if @request.open_timeout
         @client.receive_timeout = @request.read_timeout if @request.read_timeout
+        @client.send_timeout = @request.write_timeout if @request.write_timeout
       end
 
       def setup_auth
         @client.set_auth @request.url, *@request.auth.credentials
       end
 
+      def setup_ntlm_auth
+        username, password, domain = @request.auth.credentials
+
+        unless domain.nil?
+          username = "#{domain.upcase}\\#{username}"
+        end
+
+        @client.set_auth @request.url, username, password
+      end
+
       def setup_ssl_auth
         ssl = @request.auth.ssl
 
@@ -70,6 +78,9 @@ module HTTPI
         end
 
         @client.ssl_config.ssl_version = ssl.ssl_version.to_s if ssl.ssl_version
+        if ssl.min_version || ssl.max_version
+          raise NotSupportedError, 'Httpclient adapter does not support #min_version or #max_version. Please, use #ssl_version instead'
+        end
       end
 
       def respond_with(response)