erp_integration 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f838562b7bce4ffaab0944a370300bfa1c9d2f43d71777342a34be928857622b
-  data.tar.gz: f693bb521585a843abe5afd0fa1637a6235198a0a466cfe116130bd8f4906c81
+  metadata.gz: 33c09fbc8ebeff2b8b907e88e8b9bc147aefba15d5f7c1245de69cf66b24a8e6
+  data.tar.gz: c4ffdceea9bd5510bbee71647868e54a1ef36cc58bd7832a9333216811a3dd81
 SHA512:
-  metadata.gz: a008498534cd8274a24dcb37fe11c090126f128756d388173c908a29458aedc7fe8f8b70a53652c5499aafad5f27896ca61c7648c8bf3dacb8d032e0d21a66a3
-  data.tar.gz: 99ac0de4fa2bfb6a1a6bbbc709bb8b84eac47157561e45a16e5df4827f8e8b12ecfd7222ba262a626546b20fee27919655a01b6b25a820cd31bda389d083c519
+  metadata.gz: 4e7a15d4a90a16905aab8c8be40e751c3b16148ad616631e6adad6033fdf444eeaeb9d6f37e30ba4639f17f5a1a7e800281051a2e98e44aa93936e74eed7c0de
+  data.tar.gz: bfba3edd52a0529d5ca11457b12ab255c3aed41fb2ca08df17c2c09333fa7c22c76ce96a0b96436c84327b62442d4129429d5a928863e5185c3724d926ddcef2

data/.github/workflows/pull_requests.yml

@@ -15,4 +15,4 @@ jobs:
     steps:
       - uses: seferov/pr-lint-action@master
         with:
-          title-regex: '^\[RELEASE|NO-TICKET|DL|AD|DU|AR|IN|MT-\d*\](\ )'
+          title-regex: '^\[RELEASE|NO-TICKET|DL|UDL|AD|DU|AR|IN|CON|DIS|AS|MT|DEL-\d*\](\ )'

data/.reek.yml

@@ -79,7 +79,8 @@ detectors:
     max_instance_variables: 4
   TooManyMethods:
     enabled: true
-    exclude: []
+    exclude:
+      - ErpIntegration::Configuration # There are a lot of configuration options available.
     max_methods: 15
   TooManyStatements:
     enabled: true

data/erp_integration.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '< 0.82.0'
   spec.add_development_dependency 'rubocop-rake', '~> 0.5'
   spec.add_development_dependency 'rubocop-rspec', '< 1.39.0'
-  spec.add_development_dependency 'webmock', '~> 3.14.0'
+  spec.add_development_dependency 'webmock', '~> 3.17.0'
 
   # The `parallel` gem is a dev dependency for Rubocop. However, the versions
   # for parallel after 1.19.2 don't work with ruby 2.3.x. As ruby 2.3.x is

data/lib/erp_integration/fulfil/api_resource.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'context'
 require_relative 'finder_methods'
 require_relative 'persistence'
 require_relative 'query_methods'
@@ -7,6 +8,7 @@ require_relative 'query_methods'
 module ErpIntegration
   module Fulfil
     class ApiResource
+      include Context
       include Enumerable
       include FinderMethods
       include Persistence
@@ -19,26 +21,6 @@ module ErpIntegration
         @resource_klass = resource_klass
       end
 
-      # The `where` and `includes` methods lazyly build a search/read query
-      # for Fulfil. By calling `all`, the prepared search/read query will actually
-      # be executed and the results will be fetched.
-      # @return [Array] An enumerable collection object with all API results.
-      def all
-        return @results if defined?(@results)
-
-        @results =
-          client.put(
-            "model/#{model_name}/search_read",
-            Query.new(selected_fields, where_clauses)
-          ).map { |item| resource_klass.new(item) }
-      end
-
-      # The `each` method turns the `ApiResource` instance into an enumerable object.
-      # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
-      def each(&block)
-        all.each(&block)
-      end
-
       # The `client` exposes the `ErpIntegration::Fulfil::Client` to the class.
       # @return [ErpIntegration::Fulfil::Client] The HTTP client for Fulfil.
       def self.client
@@ -70,6 +52,38 @@ module ErpIntegration
       def self.model_name
         instance_variable_get(:@model_name)
       end
+
+      # The `where` and `includes` methods lazyly build a search/read query
+      # for Fulfil. By calling `all`, the prepared search/read query will actually
+      # be executed and the results will be fetched.
+      # @return [Array] An enumerable collection object with all API results.
+      def all
+        return @results if defined?(@results)
+
+        @results =
+          client.put(
+            api_resource_path,
+            Query.new(selected_fields, where_clauses)
+          ).map { |item| resource_klass.new(item) }
+      end
+
+      # The `each` method turns the `ApiResource` instance into an enumerable object.
+      # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
+      def each(&block)
+        all.each(&block)
+      end
+
+      private
+
+      # Builds the relative resource path and adds the context if needed.
+      #
+      # @return [String]
+      def api_resource_path
+        base_path = "model/#{model_name}/search_read"
+        return base_path unless context?
+
+        "#{base_path}?context=#{context.to_json}"
+      end
     end
   end
 end

data/lib/erp_integration/fulfil/context.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Fulfil
+    # When making HTTP requests to the Fulfil API endpoints, it's possible to define
+    # the warehouses that should be considered part of the querying context.
+    #
+    # This means that it's possible to fetch the stock levels for a specific "warehouse"
+    # when it's specified in the context of the HTTP request to the API endpoints of
+    # Fulfil.
+    #
+    # @example without any context, the main warehouse will be used as configured
+    #           in Fulfil through the application settings.
+    #
+    #   $ ErpIntegration::Product.find_by(sku: "PT123").quantity_available
+    #   => 25
+    #
+    # @example with context, the given warehouse will be used to find the requested
+    #           data in Fulfil.
+    #
+    #   $ ErpIntegration::Product.with_context(locations: [25]).find_by(sku: "PT123").quantity_available
+    #   => 15
+    module Context
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :context
+      end
+
+      # Verifies whether or not the context is set.
+      #
+      # @return [Boolean]
+      def context?
+        !@context.nil? && !@context.empty?
+      end
+
+      # Allows setting the context for the HTTP request to the Fulfil API endpoints.
+      #
+      # @param context [Hash] The context for the HTTP request.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def with_context(context)
+        @context = (@context || {}).merge(context)
+        self
+      end
+    end
+  end
+end

data/lib/erp_integration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,14 +202,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.17.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +224,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.2
-description: 
+description:
 email:
 - stefan@knowndecimal.com
 executables: []
@@ -268,6 +268,7 @@ files:
 - lib/erp_integration/errors.rb
 - lib/erp_integration/fulfil/api_resource.rb
 - lib/erp_integration/fulfil/client.rb
+- lib/erp_integration/fulfil/context.rb
 - lib/erp_integration/fulfil/finder_methods.rb
 - lib/erp_integration/fulfil/persistence.rb
 - lib/erp_integration/fulfil/query.rb
@@ -314,7 +315,7 @@ metadata:
   homepage_uri: https://www.github.com/mejuri-inc/erp-integration
   source_code_uri: https://www.github.com/mejuri-inc/erp-integration
   changelog_uri: https://www.github.com/mejuri-inc/erp-integration/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -330,7 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors
 test_files: []