ezclient 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660378e18a953d9e32bbc4065c11838322e4c5159a8335c7640637aa9a20f195
-  data.tar.gz: b4846e3532320c28bc5d100e4359effd6a0165fe4abf01cf866dd9d0e56fda3b
+  metadata.gz: 3a33b8998ea8d1bc9064fe5756119e298e054e27fc521cac42a0d9260e59b924
+  data.tar.gz: b18b2ea63f170e11753e516615834775facfac462084c689f3ec1d7d3467da5c
 SHA512:
-  metadata.gz: c54d24d6cda9e8cc8938eaf96bf03af4665e1013ec5166f89e06d41709a730177ebb81b6f68fd6c5009e684fc17214841c517b8c31680f2a7860f8c49a52d4ea
-  data.tar.gz: fbf878bc7dfabf8e36a3e69d18e5573a7e55ebc52b54dc122452416033c4718a49093cb3ca7800cefdbb42be0cf8bc174ec0d06ff8a93b217ef638ee21ae07f6
+  metadata.gz: 8357a3071ed41858d52f27639fb6c72c90915d5fe46a10da91ec59bd711ef577f8b2e2970d2e6d364276321c1502f6b768ad557bd8a2f1ff52e283ce323e9c6d
+  data.tar.gz: dd8116c2553ee074b89b9a18d3595899f3e54a4adaf8e65dec8384a011a2b8de3a783277eb066dd5ccdb5059786e2cfaa580c9269374006f8b6fe0b79f2fbde4

data/lib/ezclient/check_options.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EzClient::CheckOptions
+  def self.call(options, allowed_keys)
+    if (options.keys - allowed_keys).any?
+      raise ArgumentError, "Unrecognized options: #{options.keys.map(&:inspect).join(", ")}"
+    end
+
+    options
+  end
+end

data/lib/ezclient/client.rb

@@ -1,13 +1,28 @@
 # frozen_string_literal: true
 
 class EzClient::Client
+  REQUEST_OPTION_KEYS = %i[
+    api_auth
+    basic_auth
+    headers
+    keep_alive
+    max_retries
+    on_complete
+    on_error
+    on_retry
+    retry_exceptions
+    ssl_context
+    timeout
+  ].freeze
+
   def initialize(options = {})
-    self.options = options
+    self.request_options = options
     self.clients = {}
+    EzClient::CheckOptions.call(options, REQUEST_OPTION_KEYS)
   end
 
   def request(verb, url, **options)
-    options = { **default_options, **options } # TODO: raise on unknown options
+    options = { **request_options, **options }
 
     keep_alive_timeout = options.delete(:keep_alive)
     api_auth = options.delete(:api_auth)
@@ -33,26 +48,10 @@ class EzClient::Client
 
   private
 
-  attr_accessor :options, :clients
+  attr_accessor :request_options, :clients
 
   def persistent_client_for(url, timeout: 600)
     uri = HTTP::URI.parse(url)
     clients[uri.origin] ||= HTTP.persistent(uri.origin, timeout: timeout)
   end
-
-  def default_options
-    keys = %i[
-      api_auth
-      keep_alive
-      max_retries
-      on_complete
-      on_error
-      retry_exceptions
-      ssl_context
-      timeout
-    ]
-
-    # RUBY25: Hash#slice
-    options.select { |key| keys.include?(key) }
-  end
 end

data/lib/ezclient/request.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
 class EzClient::Request
+  OPTION_KEYS = %i[
+    body
+    form
+    json
+    metadata
+    params
+    query
+  ].freeze
+
   attr_accessor :verb, :url, :options
 
   def initialize(verb, url, options)
     self.verb = verb.to_s.upcase
     self.url = url
+    self.client = options.delete(:client)
     self.options = options
+    EzClient::CheckOptions.call(options, OPTION_KEYS + EzClient::Client::REQUEST_OPTION_KEYS)
   end
 
   def perform
@@ -53,6 +64,8 @@ class EzClient::Request
 
   private
 
+  attr_accessor :client
+
   def http_request
     @http_request ||= begin
       # RUBY25: Hash#slice
@@ -68,10 +81,10 @@ class EzClient::Request
   def http_client
     # Only used to build proper HTTP::Request and HTTP::Options instances
     @http_client ||= begin
-      client = options[:client].dup
-      client = client.timeout(timeout) if timeout
-      client = client.basic_auth(basic_auth) if basic_auth
-      client
+      http_client = client.dup
+      http_client = http_client.timeout(timeout) if timeout
+      http_client = http_client.basic_auth(basic_auth) if basic_auth
+      http_client
     end
   end
 
@@ -80,12 +93,13 @@ class EzClient::Request
 
     begin
       retry_on_connection_error do
-        client = options.fetch(:client) # Use original client so that connection can be reused
+        # Use original client so that connection can be reused
         client.perform(http_request, http_options)
       end
-    rescue *retried_exceptions
+    rescue *retried_exceptions => error
       if retries < max_retries.to_i
         retries += 1
+        on_retry.call(self, error, options[:metadata])
         retry
       else
         raise
@@ -97,7 +111,8 @@ class EzClient::Request
     # This may result in 2 requests reaching the server so I hope HTTP fixes it
     # https://github.com/httprb/http/issues/459
     yield
-  rescue HTTP::ConnectionError
+  rescue HTTP::ConnectionError => error
+    on_retry.call(self, error, options[:metadata])
     yield
   end
 
@@ -113,6 +128,10 @@ class EzClient::Request
     options[:on_error] || proc {}
   end
 
+  def on_retry
+    options[:on_retry] || proc {}
+  end
+
   def retried_exceptions
     Array(options[:retry_exceptions])
   end

data/lib/ezclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzClient
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end

data/lib/ezclient.rb

@@ -6,6 +6,7 @@ require "ezclient/client"
 require "ezclient/request"
 require "ezclient/response"
 require "ezclient/errors"
+require "ezclient/check_options"
 
 module EzClient
   def self.new(*args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Yuri Smirnov
@@ -153,6 +153,7 @@ files:
 - Rakefile
 - ezclient.gemspec
 - lib/ezclient.rb
+- lib/ezclient/check_options.rb
 - lib/ezclient/client.rb
 - lib/ezclient/errors.rb
 - lib/ezclient/request.rb