erp_integration 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc78fc9da96c988f29c92bf41501a8827626453e66fdd806f51e16a9f1b8e1bc
-  data.tar.gz: 7f0d3551bdb15ae06fbe67c96ff2d257f14a61eddc3cbe56d554643ec767e6ae
+  metadata.gz: 0521d80838f8ccd03a3c0dd41d712f9313e3dfc0c399b32bfc61164196e0bafa
+  data.tar.gz: ab487dd4c2f93eb5c41178970c76811cbb986d513f5aea4dd7fa9d646ec90336
 SHA512:
-  metadata.gz: 642e6917b8580bece6dc22acde22db86f91060419a059eda273861c2c6bf02928220128e4123249533024cf9b88a3d9455208065b538dc82a3a3080ccebd7f69
-  data.tar.gz: 0f542badd49a4615043e4b237d48606d18c354091fe564d74a92a005846e22338c76b1abff03be6ac99c26f358d78f46ce205dec44c2cb8c02ddcccd5769f864
+  metadata.gz: 52e06719aa752a9c5e59723ab446285d1759190ddd5b467afa049de1e056710cf7564d4da13239384a7eb93cde799cd277e19bc3c2120fb8ce82cfd86a8716a0
+  data.tar.gz: cb8a670fc0a97172b4ac631c15b4ded0e600af49da29aebc1a80c11034bed903c63c76064c1f083d1ae33d9e2e1cdc1c14809a596407bb0e299e0188de46eb5f

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|UDL|AD|DU|AR|IN|CON|DIS|AS|MT|DEL-\d*\](\ )'
+          title-regex: '^\[RELEASE|NO-TICKET|DL|UDL|AD|DU|AR|IN|CON|DIS|AS|MT|SCR|DEL-\d*\](\ )'

data/lib/erp_integration/channel_listing.rb

@@ -4,6 +4,7 @@ module ErpIntegration
   # The `ErpIntegration::ChannelListing` exposes an uniformed API for interaction with
   # third-party ERP vendors.
   class ChannelListing < Resource
-    attr_accessor :id, :channel, :product, :quantity
+    attr_accessor :availability_source, :bom, :id, :channel, :product,
+                  :quantity, :product_identifier
   end
 end

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/fulfil/resources/sales_order.rb

@@ -29,6 +29,12 @@ module ErpIntegration
           true
         end
 
+        def return!(id, options)
+          client.put("model/sale.sale/#{id}/return_order", options)
+        rescue ErpIntegration::HttpError::BadRequest
+          false
+        end
+
         # Allows duplicating the entire sales order in Fulfil.
         # @param id [Integer|String] The ID of the to be duplicated order.
         # @return [Array|boolean] Whether the sales order was duplicated successfully or not.

data/lib/erp_integration/sales_order.rb

@@ -20,6 +20,10 @@ module ErpIntegration
       self.class.adapter.cancel(id)
     end
 
+    def return!(options)
+      self.class.adapter.return!(id, options)
+    end
+
     def duplicate
       self.class.adapter.duplicate(id)
     end

data/lib/erp_integration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.20.0'
+  VERSION = '0.22.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.22.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport