fulfil-io 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63d67b77df97810e72d56c2cd60a859004ee97de438bd11332cb643c8b8d0466
-  data.tar.gz: 82708a84ce96c3254236ab4ce7e05a9d64477dc12b94ebb47d758ad267cc818e
+  metadata.gz: 5e82498f50af6f27434982cbeb6bb3faec54a085e999f4d86293d4378afb801a
+  data.tar.gz: d2596d9afedaf2f67aa3f573c139d1c5a03b706e638fdf2407fc482f25336d6f
 SHA512:
-  metadata.gz: 609049e9604f06602526be98da080e33bdbc1a1d5a46e4d338cc5a86cf5f9df9584963b6462e30da5d493b354bb73ca7c489d1c9229b37230ef7654af821cc43
-  data.tar.gz: f27513ccae674a68a294e12aacecf82c92a2caa6d65077a6abc7497c41703b7b689a4cb2a1b421a9b65c95584243d5a9d95b2f33b11571ec76eba009005cce13
+  metadata.gz: 67ad033ab2a666abc04747a37e1d4859690158cfdf1c6455cdc3e3383ccfd6aa74b556def1b02e7584945120b426357ed4a85fa1f1feaa74ad118fbe6161280c
+  data.tar.gz: 1ade1a109a650b56c76fcaea49ed71d92b87d8f87e6659748ea5c739d6e6f1715ec6099835f2faefd7c515e8482054d580c17b0fcb74342c2cc214d40fabaeee

data/README.md

@@ -1,4 +1,6 @@
 [![Tests](https://github.com/knowndecimal/fulfil/actions/workflows/tests.yml/badge.svg)](https://github.com/knowndecimal/fulfil/actions/workflows/tests.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c6100940d3debd3a3a7c/maintainability)](https://codeclimate.com/github/knowndecimal/fulfil/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c6100940d3debd3a3a7c/test_coverage)](https://codeclimate.com/github/knowndecimal/fulfil/test_coverage)
 
 # Fulfil.io Rubygem
 
@@ -146,6 +148,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 +161,32 @@ 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
+```
+
+## Retrieve multiple records
+
+To retrieve multiple records at once, one can pass the IDs into the find method directly.
+
+```ruby
+FulfilClient.find(
+  model: 'sale.sale',
+  ids: [1, 2, 3, 4],
+  fields: %w[id status]
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -197,7 +227,7 @@ def test_find_one
   stub_fulfil_get('sale.sale/213112', 'sale_sale')
 
   client = Fulfil::Client.new
-  response = client.find_one(model: 'sale.sale', id: 213_112)
+  response = client.find(model: 'sale.sale', id: 213_112)
 
   assert_equal 213_112, response['id']
 end

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/fulfil/client.rb

@@ -5,8 +5,8 @@ require 'logger'
 require 'fulfil/response_parser'
 
 module Fulfil
-  SUBDOMAIN = ENV['FULFIL_SUBDOMAIN']
-  API_KEY = ENV['FULFIL_API_KEY']
+  SUBDOMAIN = ENV.fetch('FULFIL_SUBDOMAIN', nil)
+  API_KEY = ENV.fetch('FULFIL_API_KEY', nil)
 
   class Client
     class InvalidClientError < StandardError
@@ -93,6 +93,7 @@ module Fulfil
       uri = URI(model_url(model: model, id: id, endpoint: endpoint))
 
       result = request(verb: :put, endpoint: uri, json: body)
+
       parse(result: result)
     end
 
@@ -114,10 +115,10 @@ module Fulfil
     def oauth_token
       if ENV['FULFIL_TOKEN']
         puts "You're using an deprecated environment variable. Please update your " \
-              'FULFIL_TOKEN to FULFIL_OAUTH_TOKEN.'
+             'FULFIL_TOKEN to FULFIL_OAUTH_TOKEN.'
       end
 
-      ENV['FULFIL_OAUTH_TOKEN'] || ENV['FULFIL_TOKEN']
+      ENV['FULFIL_OAUTH_TOKEN'] || ENV.fetch('FULFIL_TOKEN', nil)
     end
 
     def parse(result: nil, results: [])
@@ -174,10 +175,9 @@ module Fulfil
     end
 
     def client
-      client = HTTP.use(logging: @debug ? { logger: Logger.new(STDOUT) } : {})
+      client = HTTP.use(logging: @debug ? { logger: Logger.new($stdout) } : {})
       client = client.auth("Bearer #{@token}") if @token
-      client = client.headers(@headers)
-      client
+      client.headers(@headers)
     end
 
     def config

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/interactive_report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fulfil
   class InteractiveReport
     def initialize(client:, report:)
@@ -37,4 +39,4 @@ module Fulfil
       }
     end
   end
-end
+end

data/lib/fulfil/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fulfil/query'
 
 module Fulfil
@@ -12,15 +14,15 @@ module Fulfil
 
     # Delegate this to the client, including the model_name so we don't have to
     # type it every time.
-    def find(model: model_name, id:)
+    def find(id:, model: model_name)
       @client.find(model: model, id: id)
     end
 
     # Delegate this to the client, including the model_name so we don't have to
     # type it every time.
     def search(
-      model: model_name,
       domain:,
+      model: model_name,
       fields: %w[id rec_name],
       limit: nil,
       offset: nil,
@@ -51,7 +53,7 @@ module Fulfil
 
     def attributes
       results = @client.search(model: model_name, domain: [], limit: 1)
-      @client.find(model: model_name, id: results.first.dig('id'))
+      @client.find(model: model_name, id: results.first['id'])
     end
 
     def fetch_associated(models:, association_name:, source_key:, fields:)
@@ -66,7 +68,7 @@ module Fulfil
           model: association_name, ids: associated_ids, fields: fields
         )
 
-      associated_models_by_id = associated_models.map { |m| [m['id'], m] }.to_h
+      associated_models_by_id = associated_models.to_h { |m| [m['id'], m] }
 
       models.each do |model|
         filtered_models =

data/lib/fulfil/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fulfil
   class Query
     def initialize
@@ -9,11 +11,12 @@ module Fulfil
     end
 
     def search(*args)
-      options = args.first { |arg| arg.is_a?(Hash) && arg.keys.include?(:options) }.fetch(:options, {})
+      options = args.first { |arg| arg.is_a?(Hash) && arg.key?(:options) }.fetch(:options, {})
 
       args.each do |arg|
         arg.each do |field, value|
           next if value == options
+
           @matchers.concat(build_search_term(field: field, value: value, options: options))
         end
       end
@@ -22,17 +25,18 @@ module Fulfil
     end
 
     def exclude(*args)
-      options = args.first { |arg| arg.is_a?(Hash) && arg.keys.include?(:options) }.fetch(:options, {})
+      options = args.first { |arg| arg.is_a?(Hash) && arg.key?(:options) }.fetch(:options, {})
 
       terms = args.flat_map do |arg|
-                arg.map do |field, value|
-                  next if value == options
-                  build_exclude_term(field: field, value: value, options: options)
-                end
-              end
+        arg.map do |field, value|
+          next if value == options
+
+          build_exclude_term(field: field, value: value, options: options)
+        end
+      end
 
       if terms.length > 1
-        @matchers.push(["OR"].concat(terms))
+        @matchers.push(['OR'].concat(terms))
       else
         @matchers.concat(terms.first)
       end
@@ -62,7 +66,7 @@ module Fulfil
     #
     # IN, NOT IN: (Array)
     #
-    def build_search_term(prefix: nil, field:, value:, options:)
+    def build_search_term(field:, value:, options:, prefix: nil)
       key = [prefix, field.to_s].compact.join('.')
 
       case value.class.name
@@ -73,7 +77,7 @@ module Fulfil
       when 'Range'
         [
           [key, '>=', value.first],
-          [key, '<=', value.last],
+          [key, '<=', value.last]
         ]
       when 'String'
         if options[:case_sensitive]
@@ -82,15 +86,15 @@ module Fulfil
           [[key, 'ilike', value]]
         end
       when 'Hash'
-        value.flat_map { |nested_field, nested_value|
+        value.flat_map do |nested_field, nested_value|
           build_search_term(prefix: field, field: nested_field, value: nested_value, options: options)
-        }
+        end
       else
         raise "Unhandled value type: #{value} (#{value.class.name})"
       end
     end
 
-    def build_exclude_term(prefix: nil, field:, value:, options:)
+    def build_exclude_term(field:, value:, options:, prefix: nil)
       key = [prefix, field.to_s].compact.join('.')
 
       case value.class.name
@@ -101,12 +105,12 @@ module Fulfil
       when 'Range'
         [
           [key, '<', value.first],
-          [key, '>', value.last],
+          [key, '>', value.last]
         ]
       when 'Hash'
-        value.flat_map { |nested_field, nested_value|
+        value.flat_map do |nested_field, nested_value|
           build_exclude_term(prefix: field, field: nested_field, value: nested_value, options: options)
-        }
+        end
       else
         raise "Unhandled value type: #{value} (#{value.class.name})"
       end

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/response_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fulfil
   module ResponseParser
     class UnhandledTypeError < StandardError
@@ -17,19 +19,19 @@ module Fulfil
     # }
     #
     def self.mapped_value_field(value:)
-      return value unless value.is_a?(Hash) && value.dig('__class__')
+      return value unless value.is_a?(Hash) && value['__class__']
 
-      json_class = value.dig('__class__')
+      json_class = value['__class__']
 
       case json_class
       when 'date'
-        date = value.dig('iso_string')
+        date = value['iso_string']
         Date.parse(date)
       when 'datetime'
-        time = value.dig('iso_string')
+        time = value['iso_string']
         DateTime.parse(time)
       when 'Decimal', 'timedelta'
-        value.dig('decimal').to_f
+        value['decimal'].to_f
       else
         raise UnhandledTypeError.new(
           "received a value that we don't know how to handle: #{json_class}",
@@ -46,15 +48,19 @@ module Fulfil
           [group_key, mapped_value_field(value: kv_tuples[0][1])]
         else
           id = kv_tuples[0]
-          attrs = kv_tuples[1..-1].map { |tuple| [tuple[0][1..-1], tuple[1]] }
+          attrs = kv_tuples[1..].map { |tuple| [tuple[0][1..], tuple[1]] }
           [group_key, [['id', id[1]]].concat(group(attrs)).to_h]
         end
       end
     end
 
     def self.parse(item:)
-      key_value_tuples = item.to_a.map { |item_tuple| [item_tuple[0].split('.'), item_tuple[1]] }
-      group(key_value_tuples).to_h
+      case item
+      when Hash
+        group(item.map { |(key, value)| [key.split('.'), value] }).to_h
+      else
+        item
+      end
     end
   end
 end

data/lib/fulfil/version.rb

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

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Chris Moore
 - Kat Fairbanks
+- Stefan Vermaas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2023-04-20 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,111 +31,7 @@ dependencies:
         version: 4.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: 5.2.0
 description:
 email:
 - chris@knowndecimal.com
@@ -165,7 +62,8 @@ files:
 homepage: https://github.com/knowndecimal/fulfil
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -174,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="