httpi 4.0.4 → 4.0.6

data/lib/httpi/adapter.rb

@@ -1,5 +1,4 @@
 module HTTPI
-
   # = HTTPI::Adapter
   #
   # Manages the adapter classes. Currently supports:
@@ -9,21 +8,22 @@ module HTTPI
   # * em_http
   # * net/http
   module Adapter
-
     ADAPTERS = {}
     ADAPTER_CLASS_MAP = {}
 
     LOAD_ORDER = [:httpclient, :curb, :em_http, :excon, :http, :net_http, :net_http_persistent]
 
     class << self
-
       def register(name, adapter_class, deps)
-        ADAPTERS[name] = { :class => adapter_class, :deps => deps }
+        ADAPTERS[name] = {class: adapter_class, deps: deps}
         ADAPTER_CLASS_MAP[adapter_class] = name
       end
 
       def use=(adapter)
-        return @adapter = nil if adapter.nil?
+        if adapter.nil?
+          @adapter = nil
+          return
+        end
 
         validate_adapter! adapter
         load_adapter adapter
@@ -62,15 +62,12 @@ module HTTPI
 
       def default_adapter
         LOAD_ORDER.each do |adapter|
-          begin
-            load_adapter adapter
-            return adapter
-          rescue LoadError
-            next
-          end
+          load_adapter adapter
+          return adapter
+        rescue LoadError
+          next
         end
       end
-
     end
   end
 end

data/lib/httpi/auth/config.rb

@@ -2,13 +2,11 @@ require "httpi/auth/ssl"
 
 module HTTPI
   module Auth
-
     # = HTTPI::Auth::Config
     #
     # Manages HTTP and SSL auth configuration. Currently supports HTTP basic/digest,
     # Negotiate/SPNEGO, and SSL client authentication.
     class Config
-
       # Supported authentication types.
       TYPES = [:basic, :digest, :gssnegotiate, :ssl, :ntlm]
 
@@ -83,7 +81,6 @@ module HTTPI
 
       # Accessor for the authentication type in use.
       attr_accessor :type
-
     end
   end
 end

data/lib/httpi/auth/ssl.rb

@@ -2,12 +2,10 @@ require "openssl"
 
 module HTTPI
   module Auth
-
     # = HTTPI::Auth::SSL
     #
     # Provides SSL client authentication.
     class SSL
-
       VERIFY_MODES = [:none, :peer, :fail_if_no_peer_cert, :client_once]
       CERT_TYPES = [:pem, :der]
 
@@ -21,7 +19,7 @@ module HTTPI
       end.sort.reverse
 
       # Returns OpenSSL::SSL::*_VERSION values for min_version and max_version
-      MIN_MAX_VERSIONS = OpenSSL::SSL.constants.select{|constant| constant =~/_VERSION$/}.map{|version| version.to_s.gsub(/_VERSION$/,'').to_sym}.reverse
+      MIN_MAX_VERSIONS = OpenSSL::SSL.constants.select { |constant| constant =~ /_VERSION$/ }.map { |version| version.to_s.gsub(/_VERSION$/, "").to_sym }.reverse
 
       # Returns whether SSL configuration is present.
       def present?
@@ -74,8 +72,8 @@ module HTTPI
       # Sets the cert type to validate SSL certificates PEM|DER.
       def cert_type=(type)
         unless CERT_TYPES.include? type
-          raise ArgumentError, "Invalid SSL cert type #{type.inspect}\n" +
-                               "Please specify one of #{CERT_TYPES.inspect}"
+          raise ArgumentError, "Invalid SSL cert type #{type.inspect}\n" \
+            "Please specify one of #{CERT_TYPES.inspect}"
         end
 
         @cert_type = type
@@ -89,8 +87,8 @@ module HTTPI
       # Sets the SSL verify mode. Expects one of <tt>HTTPI::Auth::SSL::VERIFY_MODES</tt>.
       def verify_mode=(mode)
         unless VERIFY_MODES.include? mode
-          raise ArgumentError, "Invalid SSL verify mode #{mode.inspect}\n" +
-                               "Please specify one of #{VERIFY_MODES.inspect}"
+          raise ArgumentError, "Invalid SSL verify mode #{mode.inspect}\n" \
+            "Please specify one of #{VERIFY_MODES.inspect}"
         end
 
         @verify_mode = mode
@@ -104,8 +102,8 @@ module HTTPI
       # Sets the SSL version number. Expects one of <tt>HTTPI::Auth::SSL::SSL_VERSIONS</tt>.
       def ssl_version=(version)
         unless SSL_VERSIONS.include? version
-          raise ArgumentError, "Invalid SSL version #{version.inspect}\n" +
-                               "Please specify one of #{SSL_VERSIONS.inspect}"
+          raise ArgumentError, "Invalid SSL version #{version.inspect}\n" \
+            "Please specify one of #{SSL_VERSIONS.inspect}"
         end
 
         @ssl_version = version
@@ -119,8 +117,8 @@ module HTTPI
       # Sets the SSL min_version number. Expects one of <tt>HTTPI::Auth::SSL::MIN_MAX_VERSIONS</tt>.
       def min_version=(version)
         unless MIN_MAX_VERSIONS.include? version
-          raise ArgumentError, "Invalid SSL min_version #{version.inspect}\n" +
-                               "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
+          raise ArgumentError, "Invalid SSL min_version #{version.inspect}\n" \
+            "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
         end
 
         @min_version = version
@@ -134,8 +132,8 @@ module HTTPI
       # Sets the SSL min_version number. Expects one of <tt>HTTPI::Auth::SSL::MIN_MAX_VERSIONS</tt>.
       def max_version=(version)
         unless MIN_MAX_VERSIONS.include? version
-          raise ArgumentError, "Invalid SSL max_version #{version.inspect}\n" +
-                               "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
+          raise ArgumentError, "Invalid SSL max_version #{version.inspect}\n" \
+            "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
         end
 
         @max_version = version
@@ -168,13 +166,12 @@ module HTTPI
       # Returns the SSL verify mode as a <tt>OpenSSL::SSL::VERIFY_*</tt> constant.
       def openssl_verify_mode
         case verify_mode
-          when :none                 then OpenSSL::SSL::VERIFY_NONE
-          when :peer                 then OpenSSL::SSL::VERIFY_PEER
-          when :fail_if_no_peer_cert then OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
-          when :client_once          then OpenSSL::SSL::VERIFY_CLIENT_ONCE
+        when :none then OpenSSL::SSL::VERIFY_NONE
+        when :peer then OpenSSL::SSL::VERIFY_PEER
+        when :fail_if_no_peer_cert then OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+        when :client_once then OpenSSL::SSL::VERIFY_CLIENT_ONCE
         end
       end
-
     end
   end
 end

data/lib/httpi/cookie.rb

@@ -1,5 +1,4 @@
 module HTTPI
-
   # = HTTPI::Cookie
   #
   # Represents a single delicious cookie.
@@ -11,7 +10,6 @@ module HTTPI
   #   cookie.name            # "token"
   #   cookie.name_and_value  # "token=choc-choc-chip"
   class Cookie
-
     # Returns a list of cookies from a Hash of +headers+.
     def self.list_from_headers(headers)
       Array(headers["Set-Cookie"]).map { |cookie| new(cookie) }
@@ -30,6 +28,5 @@ module HTTPI
     def name_and_value
       @cookie.split(";").first
     end
-
   end
 end

data/lib/httpi/cookie_store.rb

@@ -1,5 +1,4 @@
 module HTTPI
-
   # = HTTPI::CookieStore
   #
   # Stores a unique list of cookies for future requests.
@@ -13,7 +12,6 @@ module HTTPI
   #   # Fetch the names and values for the "Cookie" header
   #   cookie_store.fetch  # => "token=choc-choc-chip"
   class CookieStore
-
     def initialize
       @cookies = {}
     end
@@ -29,6 +27,5 @@ module HTTPI
     def fetch
       @cookies.values.join(";") unless @cookies.empty?
     end
-
   end
 end

data/lib/httpi/dime.rb

@@ -1,17 +1,15 @@
 module HTTPI
-
   DimeRecord = Struct.new(
-    'DimeRecord', :version, :first, :last, :chunked,
-                  :type_format, :options, :id, :type, :data
+    "DimeRecord", :version, :first, :last, :chunked,
+    :type_format, :options, :id, :type, :data
   )
 
   class Dime < Array
-
     BINARY = 1
     XML = 2
 
     def initialize(body)
-      bytes = body.unpack('C*')
+      bytes = body.unpack("C*")
 
       while bytes.length > 0
         record = DimeRecord.new
@@ -29,34 +27,34 @@ module HTTPI
     def configure_record(record, bytes)
       byte = bytes.shift
 
-      record.version     = (byte >> 3) & 31         # 5 bits  DIME format version (always 1)
-      record.first       = (byte >> 2) & 1          # 1 bit   Set if this is the first part in the message
-      record.last        = (byte >> 1) & 1          # 1 bit   Set if this is the last part in the message
-      record.chunked     = byte & 1                 # 1 bit   This file is broken into chunked parts
+      record.version = (byte >> 3) & 31         # 5 bits  DIME format version (always 1)
+      record.first = (byte >> 2) & 1          # 1 bit   Set if this is the first part in the message
+      record.last = (byte >> 1) & 1          # 1 bit   Set if this is the last part in the message
+      record.chunked = byte & 1                 # 1 bit   This file is broken into chunked parts
       record.type_format = (bytes.shift >> 4) & 15  # 4 bits  Type of file in the part (1 for binary data, 2 for XML)
-                                                    # 4 bits  Reserved (skipped in the above command)
+      # 4 bits  Reserved (skipped in the above command)
     end
 
     # Fetch big-endian lengths.
     def big_endian_lengths(bytes)
       lengths = [] # we can't use a hash since the order will be screwed in Ruby 1.8
       lengths << [:options, (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "options" field
-      lengths << [:id,      (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "ID" or "name" field
-      lengths << [:type,    (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "type" field
-      lengths << [:data,    (bytes.shift << 24) | (bytes.shift << 16) | (bytes.shift << 8) | bytes.shift] # 4 bytes   Size of the included file
+      lengths << [:id, (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "ID" or "name" field
+      lengths << [:type, (bytes.shift << 8) | bytes.shift]                                             # 2 bytes   Length of the "type" field
+      lengths << [:data, (bytes.shift << 24) | (bytes.shift << 16) | (bytes.shift << 8) | bytes.shift] # 4 bytes   Size of the included file
       lengths
     end
 
     # Read in padded data.
     def read_data(record, bytes, attribute_set)
       attribute, length = attribute_set
-      content = bytes.slice!(0, length).pack('C*')
+      content = bytes.slice!(0, length).pack("C*")
 
       if attribute == :data && record.type_format == BINARY
         content = StringIO.new(content)
       end
 
-      record.send "#{attribute.to_s}=", content
+      record.send "#{attribute}=", content
       bytes.slice!(0, 4 - (length & 3)) if (length & 3) != 0
     end
 
@@ -67,6 +65,5 @@ module HTTPI
     def binary_records
       select { |r| r.type_format == BINARY }
     end
-
   end
 end

data/lib/httpi/logger.rb

@@ -1,9 +1,7 @@
 require "logger"
 
 module HTTPI
-
   class << self
-
     # Sets whether to log HTTP requests.
     attr_writer :log
 
@@ -47,7 +45,7 @@ module HTTPI
     end
 
     def request_ssl_info(request)
-      if request.auth && request.auth.ssl
+      if request.auth&.ssl
         "#{request.auth.ssl.ssl_version}/#{request.auth.ssl.verify_mode}"
       end
     end

data/lib/httpi/query_builder.rb

@@ -1,8 +1,6 @@
 module HTTPI
   module QueryBuilder
-
     class Flat
-
       # Returns a +query+ string given a +Hash+.
       # Example:
       #
@@ -11,11 +9,9 @@ module HTTPI
       def self.build(query)
         Rack::Utils.build_query(query)
       end
-
     end
 
     class Nested
-
       # Returns a +query+ string given a +Hash+.
       # Example:
       #
@@ -31,17 +27,15 @@ module HTTPI
       # Changes Hash values into Strings
       def self.stringify_hash_values(query)
         query.each do |param, value|
-          if value.kind_of?(Hash)
-            query[param] = stringify_hash_values(value)
-          elsif value.kind_of?(Array)
-            query[param] = value.map(&:to_s)
+          query[param] = if value.is_a?(Hash)
+            stringify_hash_values(value)
+          elsif value.is_a?(Array)
+            value.map(&:to_s)
           else
-            query[param] = value.to_s
+            value.to_s
           end
         end
       end
-
     end
-
   end
 end

data/lib/httpi/request.rb

@@ -4,20 +4,18 @@ require "httpi/auth/config"
 require "rack/utils"
 
 module HTTPI
-
   # = HTTPI::Request
   #
   # Represents an HTTP request and contains various methods for customizing that request.
   class Request
-
     # Available attribute writers.
     ATTRIBUTES = [:url, :proxy, :headers, :body, :open_timeout, :read_timeout, :write_timeout, :follow_redirect, :redirect_limit, :query]
 
     # Accepts a Hash of +args+ to mass assign attributes and authentication credentials.
     def initialize(args = {})
-      if args.kind_of? String
+      if args.is_a? String
         self.url = args
-      elsif args.kind_of?(Hash) && !args.empty?
+      elsif args.is_a?(Hash) && !args.empty?
         mass_assign args
       end
     end
@@ -25,7 +23,7 @@ module HTTPI
     # Sets the +url+ to access. Raises an +ArgumentError+ unless the +url+ is valid.
     def url=(url)
       @url = normalize_url! url
-      auth.basic @url.user, @url.password || '' if @url.user
+      auth.basic @url.user, @url.password || "" if @url.user
     end
 
     # Returns the +url+ to access.
@@ -33,17 +31,17 @@ module HTTPI
 
     # Sets the +query+ from +url+. Raises an +ArgumentError+ unless the +url+ is valid.
     def query=(query)
-      raise ArgumentError, "Invalid URL: #{self.url}" unless self.url.respond_to?(:query)
-      if query.kind_of?(Hash)
+      raise ArgumentError, "Invalid URL: #{url}" unless url.respond_to?(:query)
+      if query.is_a?(Hash)
         query = build_query_from_hash(query)
       end
       query = query.to_s unless query.is_a?(String)
-      self.url.query = query
+      url.query = query
     end
 
     # Returns the +query+ from +url+.
     def query
-      self.url.query if self.url.respond_to?(:query)
+      url.query if url.respond_to?(:query)
     end
 
     # Sets the +proxy+ to use. Raises an +ArgumentError+ unless the +proxy+ is valid.
@@ -95,14 +93,14 @@ module HTTPI
 
     # Sets a body request given a String or a Hash.
     def body=(params)
-      @body = params.kind_of?(Hash) ? build_query_from_hash(params) : params
+      @body = params.is_a?(Hash) ? build_query_from_hash(params) : params
     end
 
     # Sets the block to be called while processing the response. The block
     # accepts a single parameter - the chunked response body.
     def on_body(&block)
       @on_body ||= nil
-      if block_given? then
+      if block_given?
         @on_body = block
       end
       @on_body
@@ -146,14 +144,13 @@ module HTTPI
 
     # Expects a +url+, validates its validity and returns a +URI+ object.
     def normalize_url!(url)
-      raise ArgumentError, "Invalid URL: #{url}" unless url.to_s =~ /^http|socks/
-      url.kind_of?(URI) ? url : URI(url)
+      raise ArgumentError, "Invalid URL: #{url}" unless /^http|socks/.match?(url.to_s)
+      url.is_a?(URI) ? url : URI(url)
     end
 
     # Returns a +query+ string given a +Hash+
     def build_query_from_hash(query)
       HTTPI.query_builder.build(query)
     end
-
   end
 end

data/lib/httpi/response.rb

@@ -6,12 +6,10 @@ require "httpi/dime"
 require "httpi/cookie"
 
 module HTTPI
-
   # = HTTPI::Response
   #
   # Represents an HTTP response and contains various response details.
   class Response
-
     # Range of HTTP response codes considered to be successful.
     SuccessfulResponseCodes = 200..299
     # HTTP response codes considered to be a redirect.
@@ -79,12 +77,12 @@ module HTTPI
 
     # Returns the gzip decoded response body.
     def decoded_gzip_body
-      unless gzip = Zlib::GzipReader.new(StringIO.new(raw_body))
+      unless (gzip = Zlib::GzipReader.new(StringIO.new(raw_body)))
         raise ArgumentError, "Unable to create Zlib::GzipReader"
       end
       gzip.read
     ensure
-      gzip.close if gzip
+      gzip&.close
     end
 
     # Returns the DIME decoded response body.
@@ -93,6 +91,5 @@ module HTTPI
       self.attachments = dime.binary_records
       dime.xml_records.first.data
     end
-
   end
 end

data/lib/httpi/utils.rb

@@ -1,6 +1,6 @@
 # mostly verbatim from: https://github.com/rack/rack/blob/main/lib/rack/headers.rb
-# Because this is part of httpi's public API, its better not to load an external 
-# library for it. 
+# Because this is part of httpi's public API, its better not to load an external
+# library for it.
 module HTTPI
   module Utils
     # A case-insensitive Hash that preserves the original case of a
@@ -9,9 +9,9 @@ module HTTPI
     class Headers < Hash
       def self.[](headers)
         if headers.is_a?(Headers) && !headers.frozen?
-          return headers
+          headers
         else
-          return self.new(headers)
+          new(headers)
         end
       end
 
@@ -46,20 +46,19 @@ module HTTPI
       end
 
       def [](k)
-        super(k) || super(@names[k.downcase])
+        super || super(@names[k.downcase])
       end
 
       def []=(k, v)
         canonical = k.downcase.freeze
         delete k if @names[canonical] && @names[canonical] != k # .delete is expensive, don't invoke it unless necessary
         @names[canonical] = k
-        super k, v
+        super
       end
 
       def delete(k)
         canonical = k.downcase
-        result = super @names.delete(canonical)
-        result
+        super(@names.delete(canonical))
       end
 
       def include?(k)
@@ -87,9 +86,8 @@ module HTTPI
       end
 
       protected
-        def names
-          @names
-        end
+
+      attr_reader :names
     end
   end
 end

data/lib/httpi/version.rb

@@ -1,3 +1,3 @@
 module HTTPI
-  VERSION = '4.0.4'
+  VERSION = "4.0.6"
 end

data/lib/httpi.rb

@@ -81,7 +81,6 @@ require "httpi/adapter/http"
 #     http.follow_redirect_count = 3  # HTTPClient example
 #   end
 module HTTPI
-
   REQUEST_METHODS = [:get, :post, :head, :put, :delete]
 
   DEFAULT_LOG_LEVEL = :debug
@@ -102,7 +101,6 @@ module HTTPI
   end
 
   class << self
-
     def query_builder
       @query_builder ||= HTTPI::QueryBuilder::Flat
     end
@@ -124,7 +122,7 @@ module HTTPI
 
     # Executes an HTTP GET request.
     def get(request, adapter = nil, &block)
-      request = Request.new(request) if request.kind_of? String
+      request = Request.new(request) if request.is_a? String
       request(:get, request, adapter, &block)
     end
 
@@ -136,7 +134,7 @@ module HTTPI
 
     # Executes an HTTP HEAD request.
     def head(request, adapter = nil, &block)
-      request = Request.new(request) if request.kind_of? String
+      request = Request.new(request) if request.is_a? String
       request(:head, request, adapter, &block)
     end
 
@@ -148,22 +146,22 @@ module HTTPI
 
     # Executes an HTTP DELETE request.
     def delete(request, adapter = nil, &block)
-      request = Request.new(request) if request.kind_of? String
+      request = Request.new(request) if request.is_a? String
       request(:delete, request, adapter, &block)
     end
 
     # Executes an HTTP request for the given +method+.
     def request(method, request, adapter = nil, redirects = 0)
       adapter_class = load_adapter(adapter, request)
-      
-      Adapter.client_setup_block.call(adapter_class.client) if Adapter.client_setup_block
+
+      Adapter.client_setup_block&.call(adapter_class.client)
       yield adapter_class.client if block_given?
       log_request(method, request, Adapter.identify(adapter_class.class))
 
       response = adapter_class.request(method)
 
       if response && HTTPI::Response::RedirectResponseCodes.member?(response.code) && request.follow_redirect? && redirects < request.redirect_limit
-        request.url = URI.join(request.url, response.headers['location'])
+        request.url = URI.join(request.url, response.headers["location"])
         log("Following redirect: '#{request.url}'.")
         return request(method, request, adapter, redirects + 1)
       end
@@ -183,13 +181,12 @@ module HTTPI
     private
 
     def request_and_adapter_from(args)
-      return args if args[0].kind_of? Request
-      [Request.new(:url => args[0], :body => args[1]), args[2]]
+      return args if args[0].is_a? Request
+      [Request.new(url: args[0], body: args[1]), args[2]]
     end
 
     def load_adapter(adapter, request)
       Adapter.load(adapter).new(request)
     end
-
   end
 end