erp_integration 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc78fc9da96c988f29c92bf41501a8827626453e66fdd806f51e16a9f1b8e1bc
-  data.tar.gz: 7f0d3551bdb15ae06fbe67c96ff2d257f14a61eddc3cbe56d554643ec767e6ae
+  metadata.gz: c03eaf82065763fce0b3bf8b771b2af9a04e588ab56056f3b617f7696db110ad
+  data.tar.gz: bfdf6e68ea49ad4e72a5cfcaa28d2b99d39d67f26cebb866214583076e607047
 SHA512:
-  metadata.gz: 642e6917b8580bece6dc22acde22db86f91060419a059eda273861c2c6bf02928220128e4123249533024cf9b88a3d9455208065b538dc82a3a3080ccebd7f69
-  data.tar.gz: 0f542badd49a4615043e4b237d48606d18c354091fe564d74a92a005846e22338c76b1abff03be6ac99c26f358d78f46ce205dec44c2cb8c02ddcccd5769f864
+  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_value,
-              limit: limit_value
+              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,18 +3,19 @@
 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_value, :limit_value
+      attr_accessor :limit_value, :offset_value, :page_number
 
       # 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.
+      # @param value [String, Integer] The offset for the number of resources.
       # @return [ErpIntegration::Fulfil::ApiResource]
       def offset(value)
-        clone.offset!(value)
+        clone.offset!(value.to_i)
       end
 
       def offset!(value)
@@ -28,16 +29,58 @@ module ErpIntegration
       #
       # NOTE: The maximum limit is 500 per dictation of Fulfil.
       #
-      # @param value [Integer] The number of resources to return.
+      # @param value [String, Integer] The number of resources to return.
       # @return [ErpIntegration::Fulfil::ApiResource]
       def limit(value)
-        clone.limit!(value)
+        clone.limit!(value.to_i)
       end
 
       def limit!(value)
         self.limit_value = [value, MAX_LIMIT].min
         self
       end
+
+      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.20.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.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport