fulfil-io 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379e34db2187ee0e41cbc4a530deec467a6f7874c8474c6a5057981ed6ff7ffc
-  data.tar.gz: da1e1fcf9945729d29554c803fcd954611575ba54f74e7f1c1931fe4e4554731
+  metadata.gz: 4c465ec839e9c594b602b0e70f3058214630c38e6b8544ed456a16e5c518aeac
+  data.tar.gz: 22d0df9435f0f5432bf16193b40f25cd6f681c796c163f5aac6c6439e940c8c5
 SHA512:
-  metadata.gz: 12f8136e71bbe678bac2e3091209b5c56f03f3a70ceb3df50ebca4d88ac32f527e3f29c308affa2180f6e0e6c23964b48fed87801f18173c369f8cc161eb794f
-  data.tar.gz: 415ab129cabfe1bba36c7fd9bd94b083eeeb64fe0ff71ad508a6f29e74111ab863c281d4da93020b44ec54b1d9ef3fc1ac19ef1809e74af08091deb8824bac1f
+  metadata.gz: dfa7f4dde51c08ff6f4b33520817db32a374b99dc41543926256277cb70ead338cd24987c1cefde9100a53492c848e6c87ce7e19308be7d2e5188b9b26060f9e
+  data.tar.gz: 4462c5a7b4526802270e1eb80941077faa956b6822e5fe034b84cbdb72021f50d610e461b22419ea4b8d3aa9d1c90be529ab3ad36fbb9b91308de084b4853414

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## 0.8.1
+
+* Add logger to configuration by @cdmwebs in https://github.com/knowndecimal/fulfil/pull/49
+
+## 0.8.0
+
+* Add rubocop by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/35
+* Remove _now from testing example by @swanny85 in https://github.com/knowndecimal/fulfil/pull/32
+* Add SimpleCov for test coverage by @cdmwebs in https://github.com/knowndecimal/fulfil/pull/38
+* Add support for Fulfil sale duplication by @swanny85 in https://github.com/knowndecimal/fulfil/pull/48
+
+## 0.6.1
+
+* Fixes a typo in the examples of the readme by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/25
+* Fix requiring gemfiles manually by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/27
+
+## 0.6.0
+
+* Streamline the usage of environment variables. by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/18
+* Update http requirement from ~> 4.4.1 to >= 4.4.1, < 5.1.0 by @dependabot in https://github.com/knowndecimal/fulfil/pull/12
+* Remove extremely precise User-Agent from mocks. by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/20
+* Use GitHub Actions instead of Travis CI and Circle CI by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/21
+* Remove persistent connection and client caching by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/22
+* Add rate limit detection by @stefanvermaas in https://github.com/knowndecimal/fulfil/pull/24
+
+## 0.5.0
+
+* Better response parsing and error handling.
+* Documentation updates.
+* Add release script.
+
 ## 0.4.9
 
 * Add client tests and stub with Webmock.

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
 
@@ -173,6 +175,18 @@ Fulfil.configure do |config|
 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
@@ -213,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: config.logger } : {})
       client = client.auth("Bearer #{@token}") if @token
-      client = client.headers(@headers)
-      client
+      client.headers(@headers)
     end
 
     def config

data/lib/fulfil/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module Fulfil
   # The `Fulfil::Configuration` contains the available configuration options
   # for the `Fulfil` gem.
@@ -22,9 +24,21 @@ module Fulfil
     # @return [Proc, nil]
     attr_accessor :rate_limit_notification_handler
 
+    # Allows the client to configure a logger. Logs are output to $stderr by default.
+    #
+    # @example Use a logger to log the API rate limit hits
+    #  Fulfil.configure do |config|
+    #    config.logger = Logger.new($stderr)
+    #  end
+    #
+    # @return [Logger, nil]
+    #
+    attr_accessor :logger
+
     def initialize
       @retry_on_rate_limit = false
       @retry_on_rate_limit_wait = 1
+      @logger = Logger.new($stderr)
     end
 
     def retry_on_rate_limit?

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/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.1"
+  VERSION = '0.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Chris Moore
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -32,110 +32,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 5.2.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
 description:
 email:
 - chris@knowndecimal.com
@@ -166,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:
@@ -175,14 +72,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API