fulfil-io 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63d67b77df97810e72d56c2cd60a859004ee97de438bd11332cb643c8b8d0466
-  data.tar.gz: 82708a84ce96c3254236ab4ce7e05a9d64477dc12b94ebb47d758ad267cc818e
+  metadata.gz: 379e34db2187ee0e41cbc4a530deec467a6f7874c8474c6a5057981ed6ff7ffc
+  data.tar.gz: da1e1fcf9945729d29554c803fcd954611575ba54f74e7f1c1931fe4e4554731
 SHA512:
-  metadata.gz: 609049e9604f06602526be98da080e33bdbc1a1d5a46e4d338cc5a86cf5f9df9584963b6462e30da5d493b354bb73ca7c489d1c9229b37230ef7654af821cc43
-  data.tar.gz: f27513ccae674a68a294e12aacecf82c92a2caa6d65077a6abc7497c41703b7b689a4cb2a1b421a9b65c95584243d5a9d95b2f33b11571ec76eba009005cce13
+  metadata.gz: 12f8136e71bbe678bac2e3091209b5c56f03f3a70ceb3df50ebca4d88ac32f527e3f29c308affa2180f6e0e6c23964b48fed87801f18173c369f8cc161eb794f
+  data.tar.gz: 415ab129cabfe1bba36c7fd9bd94b083eeeb64fe0ff71ad508a6f29e74111ab863c281d4da93020b44ec54b1d9ef3fc1ac19ef1809e74af08091deb8824bac1f

data/README.md

@@ -146,6 +146,8 @@ $ Fulfil.rate_limit.resets_at
 => #<DateTime: 2022-01-21T16:36:01-04:00 />
 ```
 
+### Automatic retry API call after rate limit hit
+
 Automatic retries are supported whenever the rate limit is reached. However, it's not enabled by default. To enable it, set the `retry_on_rate_limit` to `true`. By default, the request will be retried in 1 second.
 
 ```ruby
@@ -157,6 +159,20 @@ Fulfil.configure do |config|
 end
 ```
 
+### Monitor rate limit hits
+
+Through the configurable `rate_limit_notification_handler` one can monitor the rate limit hits to the APM tool of choice.
+
+```ruby
+# config/initializers/fulfil.rb
+
+Fulfil.configure do |config|
+  config.rate_limit_notification_handler = proc {
+    FakeAPM.increment_counter('fulfil.rate_limit_exceeded')
+  }
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/fulfil/configuration.rb

@@ -9,6 +9,19 @@ module Fulfil
     attr_accessor :retry_on_rate_limit
     attr_accessor :retry_on_rate_limit_wait
 
+    # Allows the client to configure a notification handler. Can be used by APM
+    # tools to monitor the number of rate limit hits.
+    #
+    # @example Use APM to monitor the API rate limit hits
+    #   Fulfil.configure do |config|
+    #     config.rate_limit_notification_handler = proc {
+    #       FakeAPM.increment_counter('fulfil.rate_limit_exceeded')
+    #     }
+    #   end
+    #
+    # @return [Proc, nil]
+    attr_accessor :rate_limit_notification_handler
+
     def initialize
       @retry_on_rate_limit = false
       @retry_on_rate_limit_wait = 1

data/lib/fulfil/rate_limit.rb

@@ -8,7 +8,8 @@ module Fulfil
 
     # Analyses the rate limit based on the response headers from Fulfil.
     # @param headers [HTTP::Headers] The HTTP response headers from Fulfil.
-    # @return [Fulfil::RateLimit]
+    # @raise [Fulfil::RateLimitExceeded] When the rate limit is hit.
+    # @return [true]
     def analyse!(headers)
       rate_limit_headers = RateLimitHeaders.new(headers)
 
@@ -16,7 +17,9 @@ module Fulfil
       self.requests_left = rate_limit_headers.requests_left
       self.resets_at = rate_limit_headers.resets_at
 
-      raise Fulfil::RateLimitExceeded unless requests_left?
+      return true if requests_left?
+
+      report_rate_limit_hit_and_raise
     end
 
     # Returns whether there are any requests left in the current rate limit window.
@@ -24,5 +27,13 @@ module Fulfil
     def requests_left?
       requests_left&.positive?
     end
+
+    private
+
+    # @raise [Fulfil::RateLimitExceeded]
+    def report_rate_limit_hit_and_raise
+      Fulfil.config.rate_limit_notification_handler&.call
+      raise Fulfil::RateLimitExceeded
+    end
   end
 end

data/lib/fulfil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fulfil
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Chris Moore
 - Kat Fairbanks
+- Stefan Vermaas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -20,7 +21,7 @@ dependencies:
         version: 4.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +31,7 @@ dependencies:
         version: 4.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement