nxt_http_client 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46524948cd4090f671207e4bd80e79494304185c04872e86ab69de5fca62024
-  data.tar.gz: 1f8e3173afaf3251ec5fde4c3b2cf2482aa3018139e79ea1faf51eb5e78e3091
+  metadata.gz: aebfa8039d0d512c58392115ba1e7362a47acd59311e032e30b518db87b7a3ea
+  data.tar.gz: 29f82bfb73f10f8006351a7a9f0c61d58ca734f1b118df0fe4f6d7bee1c97caa
 SHA512:
-  metadata.gz: 530c4ce286a20f2eb1495e869f16bb0d3e4495bb44e5fc1f0e48067add813ff7196aca74b47bd7b3e2a199bbf3a441b344a7ec1d83823d6cebabdc9da0969194
-  data.tar.gz: 4c96dead69a3b9c7cab56929e1f40e6d9332324a97e569e3747b0d4405386168f7f3b4b72f8a235d529126281bc2b394903c5a8f3d2a1d082679ab33a2c6a117
+  metadata.gz: 66d043d9c7dfde0e562d38fb42be8d338facb674feae608b85aa69b03320c19426351b8c636e2bba2c0107dfe217a2a04ca5f9205d701c0e9ebfb5d82b74c858
+  data.tar.gz: 31321953bc43d2d9f19bf46a0ae5e3e2bbd223c4d13eb29c28024a07882588f31530839c378915531d1fa54f56668490bb8abe55528b7782ca364cfecf375130

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.0.2 2021-02-17
+
+### Update NxtHttpClient::Error
+- delegate timed_out? and status_message to response
+
 # v1.0.1 2021-02-04
 
 ### Update NxtRegistry

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_http_client (1.0.1)
+    nxt_http_client (1.0.2)
       activesupport (~> 6.0)
       nxt_registry
       typhoeus
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (6.1.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -26,7 +26,7 @@ GEM
       ffi (>= 1.3.0)
     ffi (1.14.2)
     hashdiff (1.0.1)
-    i18n (1.8.8)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.3)
@@ -35,7 +35,7 @@ GEM
     nxt_vcr_harness (0.1.4)
       rspec (~> 3.0)
       vcr (~> 6.0)
-    pry (0.13.1)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
@@ -57,7 +57,7 @@ GEM
     rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    timecop (0.9.2)
+    timecop (0.9.4)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.4)
@@ -86,4 +86,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.4
+   2.2.7

data/README.md

@@ -1,9 +1,9 @@
 # NxtHttpClient
 
 Build http clients with ease. NxtHttpClient is a simple DSL on top of the [typhoeus](https://github.com/typhoeus/typhoeus)
-gem. NxtHttpClient mostly provides you a simple configuration functionality to setup http connections on the class level. 
+gem. NxtHttpClient mostly provides you a simple configuration functionality to setup http connections on the class level.
 Furthermore it's mostly a callback framework that allows you to seamlessly handle your responses. Since it's is just a simple
-layer on top of [typhoeus](https://github.com/typhoeus/typhoeus) it also allows to access and configure the original 
+layer on top of [typhoeus](https://github.com/typhoeus/typhoeus) it also allows to access and configure the original
 `Typhoeus::Request` before making a request.
 
 
@@ -40,14 +40,14 @@ class UserFetcher < Client
       end
     end
   end
-  
+
   private
 
   attr_reader :url
 end
 ```
 
-In order to setup a shared configuration you would therefore setup a client base class. The configuration and any 
+In order to setup a shared configuration you would therefore setup a client base class. The configuration and any
 response handler or callbacks you setup in your base class are then inherited to your concrete client implementations.
 
 ```ruby
@@ -59,13 +59,13 @@ class Client < NxtHttpClient
       method: :get,
       followlocation: true
     )
-    config.x_request_id_proc = -> { ('a'..'z').to_a.shuffle.take(10).join } 
+    config.x_request_id_proc = -> { ('a'..'z').to_a.shuffle.take(10).join }
   end
-  
+
   log do |info|
     Rails.logger.info(info)
   end
-  
+
   response_handler do |handler|
     handler.on(:error) do |response|
       Raven.extra_context(error_details: error.to_h)
@@ -77,7 +77,7 @@ end
 
 ### HTTP Methods
 
-In order to build a request and execute it NxtHttpClient implements all http standard methods. 
+In order to build a request and execute it NxtHttpClient implements all http standard methods.
 
 ```ruby
 class Client < NxtHttpClient
@@ -111,20 +111,20 @@ end
 
 ### configure
 
-Register your default request options on the class level. Available options are `request_options` that are passed 
+Register your default request options on the class level. Available options are `request_options` that are passed
 directly to the underlying Typhoeus Request. Then there is `base_url` and `x_request_id_proc`.
 
 ### response_handler
 
-Register a default response handler for your client class. You can reconfigure or overwrite this in subclasses and 
-on the instance level. 
+Register a default response handler for your client class. You can reconfigure or overwrite this in subclasses and
+on the instance level.
 
 ### fire
 
-All http methods internally are delegate to `fire('uri', **request_options)`. Since `fire` is a public method you can 
+All http methods internally are delegate to `fire('uri', **request_options)`. Since `fire` is a public method you can
 also use it to fire your requests and use the response handler to register callbacks for specific responses.
 
-Registered callbacks have a hierarchy by which they are executed. Specific callbacks will come first 
+Registered callbacks have a hierarchy by which they are executed. Specific callbacks will come first
 and more common callbacks will come later in case none of the specific callbacks matched. It this is not what you want you
 can simply put the logic you need into one common callback that is called in any case. You can also use strings with wildcards
 to match a group of response by status code. `handler.on('4**') { ... }` basically would match all client errors.   
@@ -138,33 +138,33 @@ fire('uri', **request_options) do |handler|
   handler.on(:success) do |response|
     response.body
   end
-  
+
   handler.on(:timed_out) do |response|
     raise StandardError, 'Timeout'
   end
-  
+
   handler.on(:error) do |response|
     raise StandardError, 'This is bad'
   end
-  
+
   handler.on(:others) do |response|
     raise StandardError, 'Other problem'
   end
-  
+
   handler.on(:headers) do |response|
     # This is already executed when the headers are received
   end
-  
+
   handler.on(:body) do |chunk|
-   # Use this to stream the body in chunks 
+   # Use this to stream the body in chunks
   end
 end
-``` 
+```
 
 ### Callbacks around fire
 
-Next to implementing callbacks for handling responses there are also callbacks around making requests. Note tht you can 
-have as many callbacks as you want. In case you need to reset them because you do not want to inherit them from your 
+Next to implementing callbacks for handling responses there are also callbacks around making requests. Note tht you can
+have as many callbacks as you want. In case you need to reset them because you do not want to inherit them from your
 parent class (might be a smell when you need to...) you can reset callbacks via `clear_fire_callbacks` on the class level.
 
 ```ruby
@@ -190,9 +190,12 @@ end
 
 NxtHttpClient also provides an error base class that you might want to use as the base for your client errors.
 It comes with a nice set of useful methods. You can ask the error for the request and response options since it
-requires the response for initialization. Furthermore it has a handy `to_h` method that provides you all info about 
+requires the response for initialization. Furthermore it has a handy `to_h` method that provides you all info about
 the request and response.
 
+#### Timeouts
+NxtHttpClient::Error exposes the `timed_out?` method from `Typhoeus::Response`, so you can check if an error is raised due to a timeout. This is useful when setting a custom timeout value in your configuration.
+
 ### Logging
 
 NxtHttpClient also comes with a log method on the class level that you can pass a proc if you want to log your request.
@@ -218,23 +221,23 @@ end
 
 ### Caching
 
-Typhoeus ships with caching built in. Checkout the [typhoeus](https://github.com/typhoeus/typhoeus) docu to figure out 
-how to set it up. NxtHttpClient builds some functionality on top of this and offer to cache requests within the current 
-thread or globally. You can simply make use of it by providing one of the caching options `:thread` or`:global` as config 
-request option or the actual request options when building the request. 
+Typhoeus ships with caching built in. Checkout the [typhoeus](https://github.com/typhoeus/typhoeus) docu to figure out
+how to set it up. NxtHttpClient builds some functionality on top of this and offer to cache requests within the current
+thread or globally. You can simply make use of it by providing one of the caching options `:thread` or`:global` as config
+request option or the actual request options when building the request.
 
 ```ruby
 class Client < NxtHttpClient::Client
   configure do |config|
     config.request_options = { cache: :thread }
   end
-  
+
   response_handler do |handler|
     handler.on(200) do |response|
       # ...
     end
   end
-  
+
   def call
     get('.../url.com', cache: :thread) # configure caching per request level
   end

data/lib/nxt_http_client/error.rb

@@ -9,6 +9,7 @@ module NxtHttpClient
     end
 
     attr_reader :response, :id, :message
+    delegate :timed_out?, :status_message, to: :response
 
     alias_method :to_s, :message
 
@@ -76,5 +77,3 @@ module NxtHttpClient
     end
   end
 end
-
-

data/lib/nxt_http_client/version.rb

@@ -1,3 +1,3 @@
 module NxtHttpClient
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: nxt_http_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andreas Robecke
 - Nils Sommer
 - Raphael Kallensee
 - Luetfi Demirci
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -233,7 +233,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/nxt-insurance
   source_code_uri: https://github.com/nxt-insurance/nxt_http_client
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -248,8 +248,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: NxtHttpClinet is a simple DSL on top the typhoeus http gem
 test_files: []