chimera_http_client 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0909ba0cb053a18ffbbe0c81e866f61692b7eadb86cf790e97e5ab8178dbb69
-  data.tar.gz: 2583f9ea44ef1d2868cb8b421e680795cb474bccc4ef3e0a006c3c02135d3f17
+  metadata.gz: 5a1e1ddc7ca2263c940a81d57b6fbd4a94cb013ba040cf47a10e9428b4ad2fee
+  data.tar.gz: 2314f9fac4ec7b9514d19fe50d96051f47e9a9fce4cc588c3c2f5381bf53b8d2
 SHA512:
-  metadata.gz: b193b7ed042727cc5a9c8b937cd7542b743a0f6530f47be8e842484be19cfc2edd9c9756564d3eb683d3875a65c84aefb482abb9df6d54a8c4d634c106337227
-  data.tar.gz: ad18499c13ad4bc2ca9a02a1ae52f99ca559c2dff880e19553968d06e2bd7da5ab65b258f07d58767759e08974438c050fd7f4c17b17bdc1e89a71f47208b484
+  metadata.gz: 3074c920d64e9b4ce923590c320e1db14ede59d63527bbf29070b8625edfc3738a9354fa00ca21dcf61635882f97d6a755be10fa0c0776e567c13264a5f7358c
+  data.tar.gz: 2530bee55981a60ce9beaf1959b8af1b7ca333f1d16655de7782bd994bf75d6aff094beced3a8ebe31ea8dc3c2109e1bc9159058bf45932cb006e305925f8567

data/README.markdown

@@ -83,12 +83,13 @@ Setting the `base_url` is meant to be a comfort feature, as you can then pass sh
 
 The optional parameters are:
 
+* `cache` - an instance of your cache solution, can be overwritten in any request
+* `deserializers` - custom methods to deserialize the response body, below more details
 * `logger` - an instance of a logger class that implements `#info` and `#warn` methods
+* `monitor` - to collect metrics about requests, the basis for your instrumentation needs
 * `timeout` - the timeout for all requests, can be overwritten in any request, the default are 3 seconds
 * `user_agent` - if you would like your calls to identify with a specific user agent
 * `verbose` - the default is `false`, set it to true while debugging issues
-* `cache` - an instance of your cache solution, can be overwritten in any request
-* `deserializers` - custom methods to deserialize the response body, below more details
 
 ##### Custom deserializers
 
@@ -102,6 +103,23 @@ A Deserializer has to be an object on which the method `call` with the parameter
 
 where `body` is the response body (in the default case a JSON object). The class `Deserializer` contains the default objects that are used. They might help you creating your own. Don't forget to make requests with another header than the default `"Content-Type" => "application/json"`, when the API you connect to does not support JSON.
 
+##### Monitoring, metrics, instrumentation
+
+Pass an object as `:monitor` to a connection that defines the method `call` and accepts a hash as parameter.
+
+    monitor.call({...})
+
+It will receive information about every request as soon as it finished. What you do with this information is up for you to implement.
+
+| Field          | Description                                                           |
+|:---------------|:----------------------------------------------------------------------|
+| `url`          | URL of the endpoint that was called                                   |
+| `method`       | HTTP method: get, post, ...                                           |
+| `status`       | HTTP status code: 200, ...                                            |
+| `runtime`      | the time in seconds it took the request to finish                     |
+| `completed_at` | Time.now.utc.iso8601(3)                                               |
+| `context`      | Whatever you pass as `monitoring_context` to the options of a request |
+
 ### Request methods
 
 The available methods are:
@@ -142,6 +160,7 @@ All request methods expect a mandatory `endpoint` and an optional hash as parame
 * `password` - used for a BasicAuth login
 * `timeout` - set a custom timeout per request (the default is 3 seconds)
 * `cache` - optionally overwrite the cache store set in `Connection` in any request
+* `monitoring_context` - pass additional information you want to collect with your instrumentation `monitor`
 
 Example:
 

data/TODO.markdown

@@ -14,8 +14,9 @@ _none known_
 * [x] ~~include the total_time of the requests in the log~~
 * [x] ~~add (example) to README~~
 * [ ] add logger.warn / .error for error cases (?)
+* [ ] streamline log message
 
-### Custom De-serializer
+### ~~Custom De-serializer~~
 
 * [x] ~~allow to pass custom deserializer~~
 * [x] ~~use custom deserializer in #parsed_body instead of default JSON parsing~~
@@ -40,15 +41,18 @@ _none known_
 
 - [ ] Determine by parameter if 3xx Redirects should be handled as an Error or not
 - [x] ~~Add a longer description to the gemspec file~~
+- [ ] Refactor README to explain simple use case vs. all the powerful options?
 
-### Instrumentation
+### ~~Instrumentation~~
 
-- [ ] allow to pass object to collect metrics for monitoring
-  - [ ] request URL
-  - [ ] request resonse code
-  - [ ] request datetime
-  - [ ] request runtime
-- [ ] add example to README
+- [x] ~~allow to pass object to collect metrics for monitoring~~
+  - [x] ~~request URL~~
+  - [x] ~~request HTTP method~~
+  - [x] ~~request response code~~
+  - [x] ~~request datetime~~
+  - [x] ~~request runtime~~
+  - [x] ~~custom context information per request~~
+- [x] ~~add example to README~~
 
 ### Enable more Typhoeus functionality
 
@@ -93,7 +97,7 @@ _none known_
 * [x] ~~allow to set custom timeout per call~~
 * [x] ~~add (example) to README~~
 
-### Release
+### ~~Release~~
 
 * [x] ~~rename module to have unique namespace~~
 * [x] ~~release to rubygems to add to the plethora of similar gems~~

data/lib/chimera_http_client/base.rb

@@ -8,6 +8,7 @@ module ChimeraHttpClient
       @base_url = options.fetch(:base_url)
       @deserializer = default_deserializer.merge(options.fetch(:deserializer, {}))
       @logger = options[:logger]
+      @monitor = options[:monitor]
       @timeout = options[:timeout]
 
       Typhoeus::Config.cache = options[:cache]

data/lib/chimera_http_client/connection.rb

@@ -12,8 +12,9 @@ module ChimeraHttpClient
 
     def request
       options = {
-        logger: @logger,
         deserializer: @deserializer,
+        logger: @logger,
+        monitor: @monitor,
       }
 
       @request ||= Request.new(options)

data/lib/chimera_http_client/queue.rb

@@ -38,12 +38,13 @@ module ChimeraHttpClient
     private
 
     def create_request(method:, url:, body:, headers:, options:)
-      class_options = {
-        logger: @logger,
+      instance_options = {
         deserializer: @deserializer,
+        logger: @logger,
+        monitor: @monitor,
       }
 
-      Request.new(class_options).create(
+      Request.new(instance_options).create(
         method: method,
         url: url,
         body: body,

data/lib/chimera_http_client/request.rb

@@ -5,7 +5,6 @@ module ChimeraHttpClient
     attr_reader :request, :result
 
     def initialize(options = {})
-      @logger = options[:logger]
       @options = options
     end
 
@@ -37,13 +36,21 @@ module ChimeraHttpClient
 
       @result = nil
       @request.on_complete do |response|
-        @logger&.info("Completed HTTP request: #{method.upcase} #{url} " \
-          "in #{response.total_time&.round(3)}sec with status code #{response.code}")
+        runtime = response.total_time&.round(3)
+
+        @options[:monitor]&.call(
+          {
+            url: url, method: method, status: response.code, runtime: runtime,
+            completed_at: Time.now.utc.iso8601(3), context: options[:monitoring_context]
+          }
+        )
+        @options[:logger]&.info("Completed HTTP request: #{method.upcase} #{url} " \
+          "in #{runtime}sec with status code #{response.code}")
 
         @result = on_complete_handler(response)
       end
 
-      @logger&.info("Starting HTTP request: #{method.upcase} #{url}")
+      @options[:logger]&.info("Starting HTTP request: #{method.upcase} #{url}")
 
       self
     end

data/lib/chimera_http_client/version.rb

@@ -1,3 +1,3 @@
 module ChimeraHttpClient
-  VERSION = "1.1.2".freeze
+  VERSION = "1.2.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chimera_http_client
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andreas Finger