erp_integration 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ca72811d7f1eb2659d9161890f3a43ce8b773e9637e55dea2e7c0f5b6d8d44
-  data.tar.gz: 7ab55ad7cf24cbbf761e344f5a8a4a91fca2110637f28112d47ce49a0b11e639
+  metadata.gz: cc78fc9da96c988f29c92bf41501a8827626453e66fdd806f51e16a9f1b8e1bc
+  data.tar.gz: 7f0d3551bdb15ae06fbe67c96ff2d257f14a61eddc3cbe56d554643ec767e6ae
 SHA512:
-  metadata.gz: cb0053f0c8d31c3e3fd003aa9c65e141be176f4f60c787a132ffd3dc16300ecdca01be39e2b2c4e7897f5120464957979ab052139e4a381033e5f1467860bedd
-  data.tar.gz: 9987a496c6ee7bbd02f5faa92f3fb93172544ee999444d9f2851bbc30cbb59b3fe1ca10b424187f27e553eb0fd947ebe6118190546e167679c0166e4f840f9e5
+  metadata.gz: 642e6917b8580bece6dc22acde22db86f91060419a059eda273861c2c6bf02928220128e4123249533024cf9b88a3d9455208065b538dc82a3a3080ccebd7f69
+  data.tar.gz: 0f542badd49a4615043e4b237d48606d18c354091fe564d74a92a005846e22338c76b1abff03be6ac99c26f358d78f46ce205dec44c2cb8c02ddcccd5769f864

data/lib/erp_integration/fulfil/api_resource.rb

@@ -69,8 +69,8 @@ module ErpIntegration
               fields: selected_fields,
               filters: where_clauses,
               alternative_filters: or_clauses,
-              offset: offset_clause,
-              limit: limit_clause
+              offset: offset_value,
+              limit: limit_value
             )
           ).map { |item| resource_klass.new(item) }
       end

data/lib/erp_integration/fulfil/pagination_methods.rb

@@ -6,27 +6,36 @@ module ErpIntegration
       DEFAULT_OFFSET = 0
       MAX_LIMIT = 500 # Max limit set by FF
 
-      attr_accessor :offset_clause, :limit_clause
+      attr_accessor :offset_value, :limit_value
 
-      # Fulfil by default is returning us the first 500 records on every query that we made.
-      # The `offset` method, as the name sais, will allow us to move the offset of the results.
-      # @example
-      #   $ ErpIntegration::SalesOrder.offset(10).all
-      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @offset=10 />] />
-      def offset(offset)
-        self.offset_clause = offset
+      # The {#offset} method allows navigating through the returned resources from
+      # Fulfil's API endpoints just as with a regular database.
+      #
+      # @param value [Integer] The offset for the number of resources.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def offset(value)
+        clone.offset!(value)
+      end
 
+      def offset!(value)
+        self.offset_value = value
         self
       end
 
-      # Fulfil by default is returning us the first 500 records on every query that we made.
-      # The `limit` method will allow us to modify the amount of records that we want to receive.
-      # @example
-      #   $ ErpIntegration::SalesOrder.limit(5).all
-      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @limit=5 />] />
-      def limit(limit)
-        self.limit_clause = [limit, MAX_LIMIT].min
+      # By default, Fulfil returns the first 500 records for every query to their
+      # API endpoints. With the {#limit} method, it's possible to modify the number
+      # of records to return.
+      #
+      # NOTE: The maximum limit is 500 per dictation of Fulfil.
+      #
+      # @param value [Integer] The number of resources to return.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def limit(value)
+        clone.limit!(value)
+      end
 
+      def limit!(value)
+        self.limit_value = [value, MAX_LIMIT].min
         self
       end
     end

data/lib/erp_integration/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,7 +224,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.2
-description: 
+description:
 email:
 - stefan@knowndecimal.com
 executables: []
@@ -321,7 +321,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
@@ -336,9 +336,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.11
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors
 test_files: []