httpx 0.16.0 → 0.18.1

data/lib/httpx/response.rb

@@ -14,6 +14,8 @@ module HTTPX
 
     def_delegator :@body, :to_s
 
+    def_delegator :@body, :to_str
+
     def_delegator :@body, :read
 
     def_delegator :@body, :copy_to
@@ -45,7 +47,7 @@ module HTTPX
     end
 
     def content_type
-      ContentType.parse(@headers["content-type"])
+      @content_type ||= ContentType.new(@headers["content-type"])
     end
 
     def complete?
@@ -55,21 +57,50 @@ module HTTPX
     # :nocov:
     def inspect
       "#<Response:#{object_id} "\
-      "HTTP/#{version} " \
-      "@status=#{@status} " \
-      "@headers=#{@headers} " \
-      "@body=#{@body.bytesize}>"
+        "HTTP/#{version} " \
+        "@status=#{@status} " \
+        "@headers=#{@headers} " \
+        "@body=#{@body.bytesize}>"
     end
     # :nocov:
 
-    def raise_for_status
+    def error
       return if @status < 400
 
-      raise HTTPError, self
+      HTTPError.new(self)
+    end
+
+    def raise_for_status
+      return self unless (err = error)
+
+      raise err
+    end
+
+    def json(options = nil)
+      decode("json", options)
+    end
+
+    def form
+      decode("form")
     end
 
     private
 
+    def decode(format, options = nil)
+      # TODO: check if content-type is a valid format, i.e. "application/json" for json parsing
+      transcoder = Transcoder.registry(format)
+
+      raise Error, "no decoder available for \"#{format}\"" unless transcoder.respond_to?(:decode)
+
+      decoder = transcoder.decode(self)
+
+      raise Error, "no decoder available for \"#{format}\"" unless decoder
+
+      decoder.call(self, options)
+    rescue Registry::Error
+      raise Error, "no decoder available for \"#{format}\""
+    end
+
     def no_data?
       @status < 200 ||
         @status == 204 ||
@@ -93,16 +124,6 @@ module HTTPX
         @length = 0
         @buffer = nil
         @state = :idle
-        ObjectSpace.define_finalizer(self, self.class.finalize(@buffer))
-      end
-
-      def self.finalize(buffer)
-        proc {
-          return unless buffer
-
-          @buffer.close
-          @buffer.unlink if @buffer.respond_to?(:unlink)
-        }
       end
 
       def closed?
@@ -196,18 +217,20 @@ module HTTPX
       end
 
       def ==(other)
-        if other.respond_to?(:read)
-          _with_same_buffer_pos { FileUtils.compare_stream(@buffer, other) }
-        else
-          to_s == other.to_s
+        object_id == other.object_id || begin
+          if other.respond_to?(:read)
+            _with_same_buffer_pos { FileUtils.compare_stream(@buffer, other) }
+          else
+            to_s == other.to_s
+          end
         end
       end
 
       # :nocov:
       def inspect
         "#<HTTPX::Response::Body:#{object_id} " \
-        "@state=#{@state} " \
-        "@length=#{@length}>"
+          "@state=#{@state} " \
+          "@length=#{@length}>"
       end
       # :nocov:
 
@@ -264,30 +287,22 @@ module HTTPX
     MIME_TYPE_RE = %r{^([^/]+/[^;]+)(?:$|;)}.freeze
     CHARSET_RE   = /;\s*charset=([^;]+)/i.freeze
 
-    attr_reader :mime_type, :charset
-
-    def initialize(mime_type, charset)
-      @mime_type = mime_type
-      @charset = charset
+    def initialize(header_value)
+      @header_value = header_value
     end
 
-    class << self
-      # Parse string and return ContentType struct
-      def parse(str)
-        new(mime_type(str), charset(str))
-      end
+    def mime_type
+      return @mime_type if defined?(@mime_type)
 
-      private
+      m = @header_value.to_s[MIME_TYPE_RE, 1]
+      m && @mime_type = m.strip.downcase
+    end
 
-      def mime_type(str)
-        m = str.to_s[MIME_TYPE_RE, 1]
-        m && m.strip.downcase
-      end
+    def charset
+      return @charset if defined?(@charset)
 
-      def charset(str)
-        m = str.to_s[CHARSET_RE, 1]
-        m && m.strip.delete('"')
-      end
+      m = @header_value.to_s[CHARSET_RE, 1]
+      m && @charset = m.strip.delete('"')
     end
   end
 
@@ -304,17 +319,18 @@ module HTTPX
     end
 
     def status
+      warn ":#{__method__} is deprecated, use :error.message instead"
       @error.message
     end
 
     if Exception.method_defined?(:full_message)
       def to_s
-        @error.full_message
+        @error.full_message(highlight: false)
       end
     else
       def to_s
         "#{@error.message} (#{@error.class})\n" \
-        "#{@error.backtrace.join("\n") if @error.backtrace}"
+          "#{@error.backtrace.join("\n") if @error.backtrace}"
       end
     end
 

data/lib/httpx/selector.rb

@@ -2,20 +2,6 @@
 
 require "io/wait"
 
-module IOExtensions
-  refine IO do
-    # provides a fallback for rubies where IO#wait isn't implemented,
-    # but IO#wait_readable and IO#wait_writable are.
-    def wait(timeout = nil, _mode = :read_write)
-      r, w = IO.select([self], [self], nil, timeout)
-
-      return unless r || w
-
-      self
-    end
-  end
-end
-
 class HTTPX::Selector
   READABLE = %i[rw r].freeze
   WRITABLE = %i[rw w].freeze
@@ -23,7 +9,7 @@ class HTTPX::Selector
   private_constant :READABLE
   private_constant :WRITABLE
 
-  using IOExtensions unless IO.method_defined?(:wait) && IO.instance_method(:wait).arity == 2
+  using HTTPX::IOExtensions
 
   def initialize
     @selectables = []
@@ -58,11 +44,13 @@ class HTTPX::Selector
           selectables = @selectables
           @selectables = []
 
-          selectables.each do |io|
+          selectables.delete_if do |io|
             interests = io.interests
 
             (r ||= []) << io if READABLE.include?(interests)
             (w ||= []) << io if WRITABLE.include?(interests)
+
+            io.state == :closed
           end
 
           if @selectables.empty?
@@ -70,7 +58,7 @@ class HTTPX::Selector
 
             # do not run event loop if there's nothing to wait on.
             # this might happen if connect failed and connection was unregistered.
-            return if (!r || r.empty?) && (!w || w.empty?)
+            return if (!r || r.empty?) && (!w || w.empty?) && !selectables.empty?
 
             break
           else
@@ -86,7 +74,7 @@ class HTTPX::Selector
 
       readers, writers = IO.select(r, w, nil, interval)
 
-      raise HTTPX::TimeoutError.new(interval, "timed out while waiting on select") if readers.nil? && writers.nil?
+      raise HTTPX::TimeoutError.new(interval, "timed out while waiting on select") if readers.nil? && writers.nil? && interval
     rescue IOError, SystemCallError
       @selectables.reject!(&:closed?)
       retry
@@ -109,6 +97,8 @@ class HTTPX::Selector
   def select_one(interval)
     io = @selectables.first
 
+    return unless io
+
     interests = io.interests
 
     result = case interests
@@ -118,7 +108,7 @@ class HTTPX::Selector
              when nil then return
     end
 
-    raise HTTPX::TimeoutError.new(interval, "timed out while waiting on select") unless result
+    raise HTTPX::TimeoutError.new(interval, "timed out while waiting on select") unless result || interval.nil?
 
     yield io
   rescue IOError, SystemCallError

data/lib/httpx/session.rb

@@ -11,7 +11,7 @@ module HTTPX
       @options = self.class.default_options.merge(options)
       @responses = {}
       @persistent = @options.persistent
-      wrap(&blk) if block_given?
+      wrap(&blk) if blk
     end
 
     def wrap
@@ -21,6 +21,7 @@ module HTTPX
         yield self
       ensure
         @persistent = prev_persistent
+        close unless @persistent
       end
     end
 
@@ -32,7 +33,7 @@ module HTTPX
       raise ArgumentError, "must perform at least one request" if args.empty?
 
       requests = args.first.is_a?(Request) ? args : build_requests(*args, options)
-      responses = send_requests(*requests, options)
+      responses = send_requests(*requests)
       return responses.first if responses.size == 1
 
       responses
@@ -40,7 +41,8 @@ module HTTPX
 
     def build_request(verb, uri, options = EMPTY_HASH)
       rklass = @options.request_class
-      request = rklass.new(verb, uri, @options.merge(options).merge(persistent: @persistent))
+      options = @options.merge(options) unless options.is_a?(Options)
+      request = rklass.new(verb, uri, options.merge(persistent: @persistent))
       request.on(:response, &method(:on_response).curry(2)[request])
       request.on(:promise, &method(:on_promise))
       request
@@ -174,37 +176,38 @@ module HTTPX
       end
     end
 
-    def send_requests(*requests, options)
-      request_options = @options.merge(options)
-
-      connections = _send_requests(requests, request_options)
-      receive_requests(requests, connections, request_options)
+    def send_requests(*requests)
+      connections = _send_requests(requests)
+      receive_requests(requests, connections)
     end
 
-    def _send_requests(requests, options)
+    def _send_requests(requests)
       connections = []
 
       requests.each do |request|
         error = catch(:resolve_error) do
-          connection = find_connection(request, connections, options)
+          connection = find_connection(request, connections, request.options)
           connection.send(request)
         end
         next unless error.is_a?(ResolveError)
 
-        request.emit(:response, ErrorResponse.new(request, error, options))
+        request.emit(:response, ErrorResponse.new(request, error, request.options))
       end
 
       connections
     end
 
-    def receive_requests(requests, connections, options)
+    def receive_requests(requests, connections)
       responses = []
 
       begin
         # guarantee ordered responses
         loop do
           request = requests.first
-          pool.next_tick until (response = fetch_response(request, connections, options))
+
+          return responses unless request
+
+          pool.next_tick until (response = fetch_response(request, connections, request.options))
 
           responses << response
           requests.shift
@@ -218,13 +221,17 @@ module HTTPX
           # opportunity to traverse the requests, hence we're returning only a fraction of the errors
           # we were supposed to. This effectively fetches the existing responses and return them.
           while (request = requests.shift)
-            responses << fetch_response(request, connections, options)
+            responses << fetch_response(request, connections, request.options)
           end
           break
         end
         responses
       ensure
-        close(connections) unless @persistent
+        if @persistent
+          pool.deactivate(connections)
+        else
+          close(connections)
+        end
       end
     end
 

data/lib/httpx/session2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "session"
 module HTTPX
   class Session
@@ -5,7 +7,7 @@ module HTTPX
       @options = self.class.default_options.merge(options)
       @responses = {}
       @persistent = @options.persistent
-      wrap(&blk) if block_given?
+      wrap(&blk) if blk
     end
 
     def wrap

data/lib/httpx/timers.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module HTTPX
+  class Timers
+    def initialize
+      @intervals = []
+    end
+
+    def after(interval_in_secs, &blk)
+      return unless interval_in_secs
+
+      # I'm assuming here that most requests will have the same
+      # request timeout, as in most cases they share common set of
+      # options. A user setting different request timeouts for 100s of
+      # requests will already have a hard time dealing with that.
+      unless (interval = @intervals.find { |t| t == interval_in_secs })
+        interval = Interval.new(interval_in_secs)
+        @intervals << interval
+        @intervals.sort!
+      end
+
+      interval << blk
+    end
+
+    def wait_interval
+      return if @intervals.empty?
+
+      @next_interval_at = Utils.now
+
+      @intervals.first.interval
+    end
+
+    def fire(error = nil)
+      raise error if error && error.timeout != @intervals.first
+      return if @intervals.empty? || !@next_interval_at
+
+      elapsed_time = Utils.elapsed_time(@next_interval_at)
+
+      @intervals.delete_if { |interval| interval.elapse(elapsed_time) <= 0 }
+    end
+
+    def cancel
+      @intervals.clear
+    end
+
+    class Interval
+      include Comparable
+
+      attr_reader :interval
+
+      def initialize(interval)
+        @interval = interval
+        @callbacks = []
+      end
+
+      def <=>(other)
+        @interval <=> other.interval
+      end
+
+      def ==(other)
+        return @interval == other if other.is_a?(Numeric)
+
+        @interval == other.to_f # rubocop:disable Lint/FloatComparison
+      end
+
+      def to_f
+        @interval
+      end
+
+      def <<(callback)
+        @callbacks << callback
+      end
+
+      def elapse(elapsed)
+        @interval -= elapsed
+
+        @callbacks.each(&:call) if @interval <= 0
+
+        @interval
+      end
+    end
+    private_constant :Interval
+  end
+end

data/lib/httpx/transcoder/body.rb

@@ -9,6 +9,7 @@ module HTTPX::Transcoder
     module_function
 
     class Encoder
+      using HTTPX::ArrayExtensions
       extend Forwardable
 
       def_delegator :@raw, :to_s
@@ -21,7 +22,7 @@ module HTTPX::Transcoder
         if @raw.respond_to?(:bytesize)
           @raw.bytesize
         elsif @raw.respond_to?(:to_ary)
-          @raw.map(&:bytesize).reduce(0, :+)
+          @raw.sum(&:bytesize)
         elsif @raw.respond_to?(:size)
           @raw.size || Float::INFINITY
         elsif @raw.respond_to?(:length)

data/lib/httpx/transcoder/form.rb

@@ -7,6 +7,8 @@ module HTTPX::Transcoder
   module Form
     module_function
 
+    PARAM_DEPTH_LIMIT = 32
+
     class Encoder
       extend Forwardable
 
@@ -31,9 +33,27 @@ module HTTPX::Transcoder
       end
     end
 
+    module Decoder
+      module_function
+
+      def call(response, _)
+        URI.decode_www_form(response.to_s).each_with_object({}) do |(field, value), params|
+          HTTPX::Transcoder.normalize_query(params, field, value, PARAM_DEPTH_LIMIT)
+        end
+      end
+    end
+
     def encode(form)
       Encoder.new(form)
     end
+
+    def decode(response)
+      content_type = response.content_type.mime_type
+
+      raise HTTPX::Error, "invalid form mime type (#{content_type})" unless content_type == "application/x-www-form-urlencoded"
+
+      Decoder
+    end
   end
   register "form", Form
 end

data/lib/httpx/transcoder/json.rb

@@ -5,6 +5,10 @@ require "json"
 
 module HTTPX::Transcoder
   module JSON
+    JSON_REGEX = %r{\bapplication/(?:vnd\.api\+)?json\b}i.freeze
+
+    using HTTPX::RegexpExtensions unless Regexp.method_defined?(:match?)
+
     module_function
 
     class Encoder
@@ -27,6 +31,14 @@ module HTTPX::Transcoder
     def encode(json)
       Encoder.new(json)
     end
+
+    def decode(response)
+      content_type = response.content_type.mime_type
+
+      raise HTTPX::Error, "invalid json mime type (#{content_type})" unless JSON_REGEX.match?(content_type)
+
+      ::JSON.method(:parse)
+    end
   end
   register "json", JSON
 end

data/lib/httpx/transcoder.rb

@@ -4,7 +4,11 @@ module HTTPX
   module Transcoder
     extend Registry
 
-    def self.normalize_keys(key, value, cond = nil, &block)
+    using RegexpExtensions unless Regexp.method_defined?(:match?)
+
+    module_function
+
+    def normalize_keys(key, value, cond = nil, &block)
       if (cond && cond.call(value))
         block.call(key.to_s, value)
       elsif value.respond_to?(:to_ary)
@@ -23,6 +27,63 @@ module HTTPX
         block.call(key.to_s, value)
       end
     end
+
+    # based on https://github.com/rack/rack/blob/d15dd728440710cfc35ed155d66a98dc2c07ae42/lib/rack/query_parser.rb#L82
+    def normalize_query(params, name, v, depth)
+      raise Error, "params depth surpasses what's supported" if depth <= 0
+
+      name =~ /\A[\[\]]*([^\[\]]+)\]*/
+      k = Regexp.last_match(1) || ""
+      after = Regexp.last_match ? Regexp.last_match.post_match : ""
+
+      if k.empty?
+        return Array(v) if !v.empty? && name == "[]"
+
+        return
+      end
+
+      case after
+      when ""
+        params[k] = v
+      when "["
+        params[name] = v
+      when "[]"
+        params[k] ||= []
+        raise Error, "expected Array (got #{params[k].class}) for param '#{k}'" unless params[k].is_a?(Array)
+
+        params[k] << v
+      when /^\[\]\[([^\[\]]+)\]$/, /^\[\](.+)$/
+        child_key = Regexp.last_match(1)
+        params[k] ||= []
+        raise Error, "expected Array (got #{params[k].class}) for param '#{k}'" unless params[k].is_a?(Array)
+
+        if params[k].last.is_a?(Hash) && !params_hash_has_key?(params[k].last, child_key)
+          normalize_query(params[k].last, child_key, v, depth - 1)
+        else
+          params[k] << normalize_query({}, child_key, v, depth - 1)
+        end
+      else
+        params[k] ||= {}
+        raise Error, "expected Hash (got #{params[k].class}) for param '#{k}'" unless params[k].is_a?(Hash)
+
+        params[k] = normalize_query(params[k], after, v, depth - 1)
+      end
+
+      params
+    end
+
+    def params_hash_has_key?(hash, key)
+      return false if /\[\]/.match?(key)
+
+      key.split(/[\[\]]+/).inject(hash) do |h, part|
+        next h if part == ""
+        return false unless h.is_a?(Hash) && h.key?(part)
+
+        h[part]
+      end
+
+      true
+    end
   end
 end
 

data/lib/httpx/utils.rb

@@ -6,6 +6,14 @@ module HTTPX
 
     module_function
 
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def elapsed_time(monotonic_timestamp)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC) - monotonic_timestamp
+    end
+
     # The value of this field can be either an HTTP-date or a number of
     # seconds to delay after the response is received.
     def parse_retry_after(retry_after)
@@ -28,9 +36,9 @@ module HTTPX
       URIParser = URI::RFC2396_Parser.new
 
       def to_uri(uri)
-        return Kernel.URI(uri) unless uri.is_a?(String) && !uri.ascii_only?
+        return URI(uri) unless uri.is_a?(String) && !uri.ascii_only?
 
-        uri = Kernel.URI(URIParser.escape(uri))
+        uri = URI(URIParser.escape(uri))
 
         non_ascii_hostname = URIParser.unescape(uri.host)
 

data/lib/httpx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTPX
-  VERSION = "0.16.0"
+  VERSION = "0.18.1"
 end

data/lib/httpx.rb

@@ -13,6 +13,7 @@ require "httpx/callbacks"
 require "httpx/loggable"
 require "httpx/registry"
 require "httpx/transcoder"
+require "httpx/timers"
 require "httpx/pool"
 require "httpx/headers"
 require "httpx/request"

data/sig/buffer.rbs

@@ -1,7 +1,7 @@
 module HTTPX
   class Buffer
     extend Forwardable
-    
+
     include _ToS
     include _ToStr
 
@@ -13,7 +13,7 @@ module HTTPX
     def shift!: (Integer) -> void
 
     # delegated
-    def <<: (string data) -> void
+    def <<: (string data) -> String
     def empty?: () -> bool
     def bytesize: () -> Integer
     def clear: () -> void