erp_integration 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ca72811d7f1eb2659d9161890f3a43ce8b773e9637e55dea2e7c0f5b6d8d44
-  data.tar.gz: 7ab55ad7cf24cbbf761e344f5a8a4a91fca2110637f28112d47ce49a0b11e639
+  metadata.gz: c03eaf82065763fce0b3bf8b771b2af9a04e588ab56056f3b617f7696db110ad
+  data.tar.gz: bfdf6e68ea49ad4e72a5cfcaa28d2b99d39d67f26cebb866214583076e607047
 SHA512:
-  metadata.gz: cb0053f0c8d31c3e3fd003aa9c65e141be176f4f60c787a132ffd3dc16300ecdca01be39e2b2c4e7897f5120464957979ab052139e4a381033e5f1467860bedd
-  data.tar.gz: 9987a496c6ee7bbd02f5faa92f3fb93172544ee999444d9f2851bbc30cbb59b3fe1ca10b424187f27e553eb0fd947ebe6118190546e167679c0166e4f840f9e5
+  metadata.gz: e368a61cd727304adf94f5dbfb14f149b2c976b27e68c7d1de00b93dee9d279f35dfcbf58d197ef3f9775cbf6a0e1d18af1c4ac0883edf8e3466eabe8c7c9fd4
+  data.tar.gz: b82940b549df5f315167152bcc65c60ce7fc44ed44d8863513238e06c66e330e553dd2cdbe6799bd01b7c3b418b5fb45d8e2d14d8f0e949e8b9a2c787c93be69

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
+              limit: limit_value,
+              offset: calculated_offset
             )
           ).map { |item| resource_klass.new(item) }
       end
@@ -90,7 +90,7 @@ module ErpIntegration
               fields: nil,
               filters: where_clauses,
               alternative_filters: or_clauses
-            ).to_h.except(:fields, :offset, :limit)
+            ).to_h.except(:fields)
           )
       end
 

data/lib/erp_integration/fulfil/pagination_methods.rb

@@ -3,32 +3,84 @@
 module ErpIntegration
   module Fulfil
     module PaginationMethods
-      DEFAULT_OFFSET = 0
+      DEFAULT_LIMIT = 500 # Default limit set in FF
+      DEFAULT_OFFSET = 0 # Default offset set by FF
       MAX_LIMIT = 500 # Max limit set by FF
 
-      attr_accessor :offset_clause, :limit_clause
+      attr_accessor :limit_value, :offset_value, :page_number
 
-      # 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 [String, Integer] The offset for the number of resources.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def offset(value)
+        clone.offset!(value.to_i)
+      end
+
+      def offset!(value)
+        self.offset_value = value
+        self
+      end
 
+      # 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 [String, Integer] The number of resources to return.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def limit(value)
+        clone.limit!(value.to_i)
+      end
+
+      def limit!(value)
+        self.limit_value = [value, MAX_LIMIT].min
         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
+      alias per_page limit
+
+      # The `page` method  will simplify the use of `limit` and `offset` together with
+      # the `per_page` method. Is the quantity of pages that we want to get on the response.
+      # It sets the instance variable page_number which will be useful to calculate the offset
+      # lazily when the  method `calculated_offset` is called. This is because we need to know
+      # first the limit before calculate the offset
+      #
+      # @param page_number [Integer, String]
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def page(page_number)
+        clone.page!(page_number.to_i)
+      end
 
+      # @param page_number [Integer]
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def page!(page_number)
+        self.page_number = page_number
         self
       end
+
+      private
+
+      # @return [Boolean]
+      def paginating?
+        !page_number.nil?
+      end
+
+      # The `calculated_offset` will calculate the offset_value instance variable lazily
+      # @return [Integer]
+      def calculated_offset
+        return offset_value unless paginating?
+
+        # When paginating we want to set the {#limit_value} to equal the {MAX_LIMIT}
+        # when the {#limit_value} isn't set to prevent inconsistencies in the API response.
+        limit!(MAX_LIMIT) if limit_value.nil?
+
+        # Now, calculate the offset_value based on the {#limit_value} and the {#page_number}.
+        offset!((page_number - 1) * limit_value)
+        offset_value
+      end
     end
   end
 end

data/lib/erp_integration/fulfil/query.rb

@@ -38,12 +38,12 @@ module ErpIntegration
       end
 
       def to_h
-        {
-          fields: @fields,
-          filters: @filters,
-          offset: @offset,
-          limit: @limit
-        }
+        {}.tap do |hash|
+          hash[:fields] = @fields
+          hash[:filters] = @filters
+          hash[:limit] = @limit if @limit
+          hash[:offset] = @offset if @offset
+        end
       end
     end
   end

data/lib/erp_integration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.19.0'
+  VERSION = '0.21.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.21.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-31 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: []