fulfil-io 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c58e4104ae9106550bca7c000cbf3f576f551c9e4512cee93dc74dd0aa5604f
-  data.tar.gz: ee0644f88360b5356efa034833772a54d207ce4be7e81040219e8d66019ff301
+  metadata.gz: 63d67b77df97810e72d56c2cd60a859004ee97de438bd11332cb643c8b8d0466
+  data.tar.gz: 82708a84ce96c3254236ab4ce7e05a9d64477dc12b94ebb47d758ad267cc818e
 SHA512:
-  metadata.gz: d697a2153dcbcd379621b59bc7ef8af428c4f6ecc2445d454afc38eddb34247430279136f758fe52e538abcda923c386dbc4d7f2af00c27e9e41c26f71a4c5e2
-  data.tar.gz: e6e891f839dd472f24f1dc89ce1189cb80b9218ac09c35c4141c0dd0b575097ecb0d238d47de8e688bc69c3298da0f4e1b2478ebfed1010d139c3fb4087f0ccf
+  metadata.gz: 609049e9604f06602526be98da080e33bdbc1a1d5a46e4d338cc5a86cf5f9df9584963b6462e30da5d493b354bb73ca7c489d1c9229b37230ef7654af821cc43
+  data.tar.gz: f27513ccae674a68a294e12aacecf82c92a2caa6d65077a6abc7497c41703b7b689a4cb2a1b421a9b65c95584243d5a9d95b2f33b11571ec76eba009005cce13

data/README.md

@@ -9,7 +9,7 @@ A Ruby library for the [Fulfil.io](https://fulfil.io) API.
 Add this line to your application's Gemfile:
 
 ```ruby
-  gem 'fulfil-io', require: 'fulfil'
+  gem 'fulfil-io'
 ```
 
 And then execute:
@@ -37,8 +37,6 @@ if oauth doesn't work, returning an Unauthorized error, to use the
 `FULFIL_API_KEY`, the `FULFIL_OAUTH_TOKEN` shouldn't be specified.
 
 ```ruby
-require 'fulfil' # this is necessary only in case of running without bundler
-
 fulfil = Fulfil::Client.new # or, to enable request debugging, Fulfil::Client.new(debug: true)
 
 sale_model = Fulfil::Model.new(
@@ -47,7 +45,7 @@ sale_model = Fulfil::Model.new(
 )
 
 sales = sale_model.search(
-  domain: [['id', '=', [10]]],
+  domain: [['id', '=', 10]],
   fields: ['id', 'rec_name', 'lines']
 )
 
@@ -147,6 +145,18 @@ $ Fulfil.rate_limit.limit
 $ Fulfil.rate_limit.resets_at
 => #<DateTime: 2022-01-21T16:36:01-04:00 />
 ```
+
+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
+# config/initializers/fulfil.rb
+
+Fulfil.configure do |config|
+  config.retry_on_rate_limit = true # Defaults to false
+  config.retry_on_rate_limit_wait = 0.25 # Defaults to 1 (second)
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/fulfil/client.rb

@@ -164,6 +164,13 @@ module Fulfil
     rescue HTTP::ResponseError => e
       raise ResponseError, "Can't process response: #{e}"
       []
+    # If configured, the client will wait whenever the `RateLimitExceeded` exception
+    # is raised. Check `Fulfil::Configuration` for more details.
+    rescue RateLimitExceeded => e
+      raise e unless config.retry_on_rate_limit?
+
+      sleep config.retry_on_rate_limit_wait
+      retry
     end
 
     def client
@@ -172,5 +179,9 @@ module Fulfil
       client = client.headers(@headers)
       client
     end
+
+    def config
+      Fulfil.config
+    end
   end
 end

data/lib/fulfil/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Fulfil
+  # The `Fulfil::Configuration` contains the available configuration options
+  # for the `Fulfil` gem.
+  class Configuration
+    # Allow the `Fulfil::Client` to automatically retry when the rate limit is hit.
+    # By default, the `Fulfil::Client` will wait 1 second before retrying again.
+    attr_accessor :retry_on_rate_limit
+    attr_accessor :retry_on_rate_limit_wait
+
+    def initialize
+      @retry_on_rate_limit = false
+      @retry_on_rate_limit_wait = 1
+    end
+
+    def retry_on_rate_limit?
+      @retry_on_rate_limit
+    end
+  end
+
+  # Returns Fulfil's configuration.
+  # @return [Fulfil::Configuration] Fulfil's configuration
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Allows setting a new configuration for Fulfil.
+  # @return [Fulfil::Configuration] Fulfil's new configuration
+  def self.config=(configuration)
+    @config = configuration
+  end
+
+  # Allows modifying Fulfil's configuration.
+  #
+  # Example usage:
+  #
+  #   Fulfil.configure do |config|
+  #     config.api_key = "..."
+  #   end
+  #
+  def self.configure
+    yield(config)
+  end
+end

data/lib/fulfil/version.rb

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

data/lib/fulfil-io.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# By convention, Bundler will attempt to load the `fulfil/io.rb` or `fulfil-io.rb` file.
+# See https://guides.rubygems.org/name-your-gem/
+#
+# Due to this convention, the developer using this gem will need to manually
+# require fulfil in the Gemfile or anywhere else in their application.
+#
+# To make it a little bit more convenient, we've added the `fulfil-io.rb` file
+# that is loaded by default by Bundler and it's only job is to include all of
+# the other gem files.
+
+require 'fulfil'

data/lib/fulfil.rb

@@ -2,6 +2,7 @@
 
 require 'fulfil/version'
 require 'fulfil/error'
+require 'fulfil/configuration'
 require 'fulfil/client'
 require 'fulfil/model'
 require 'fulfil/interactive_report'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Moore
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -149,8 +149,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/fulfil-io.rb
 - lib/fulfil.rb
 - lib/fulfil/client.rb
+- lib/fulfil/configuration.rb
 - lib/fulfil/error.rb
 - lib/fulfil/interactive_report.rb
 - lib/fulfil/model.rb
@@ -179,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API