erp_integration 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c712cc4dfcd1f43280c21bd1443004faba4782699f3d0aae9dcbba54ecbed6e0
-  data.tar.gz: 24b062f2319f76ab2ef68609ce8608a0cd8901f18221067614023af8dc88b130
+  metadata.gz: af2d7c35bd0582dd14abd43703dfe8eaff596501a17e19d6b600ab7b77771437
+  data.tar.gz: d42c0df0a66e21e1b51e64da1761cd774d30bde60a273e5eda2fe907871405cf
 SHA512:
-  metadata.gz: cc31e26866ebec699087586d42163b747335bbd46f0e504f88d78b68ce22bb76c914a26a6a2397e714536d2099d00d8b8f5919176eace0ee5e63a7699d8eabce
-  data.tar.gz: 245c31dd21124a52dbbe957307a4fd7e2267bdbde024135e0966f018c82c919828269aabf8de0989962783e9660d100453c3e9a9b58cc941f8ca121c3c2a3ea1
+  metadata.gz: e9c61186614433de65b90c79eabed2980d44447c7b7f1dc7416960ad7d40f6ce92768fb7f81d9024cea3707dac48b0007f63d17c74b104fd112f2ce0dcf3c161
+  data.tar.gz: bec060c2f626b39e375561e4c19453e359243158877a10f12baf570aab10ae218ef9d30e9422178a704c54f9e2015ad7bcfb9f9cd0c13516af178cb1dcaa6259

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

data/lib/erp_integration/fulfil/client.rb

@@ -39,7 +39,7 @@ module ErpIntegration
           # Notice that logging headers will expose sensitive information
           # like api-key. To avoid use filters:
           # https://lostisland.github.io/faraday/middleware/logger
-          faraday.response :logger, @logger, { headers: false, bodies: true }
+          faraday.response :logger, @logger, { headers: false, bodies: true } if @logger
 
           # Custom error handling for the error response
           faraday.use ErpIntegration::Middleware::ErrorHandling

data/lib/erp_integration/fulfil/resources/sales_order.rb

@@ -8,6 +8,16 @@ module ErpIntegration
       class SalesOrder < ApiResource
         self.model_name = 'sale.sale'
 
+        class MissingIdempotencyKey < ErpIntegration::Error
+          def initialize
+            super(
+              '[ERP Integration] Missing the required reference attribute. ' \
+                'Setting the reference prevents Fulfil from processing the same sales ' \
+                "order twice. For this reason, it's required to provide it as a safeguard."
+            )
+          end
+        end
+
         # Allows cancelling the entire sales order in Fulfil.
         # @param id [Integer|String] The ID of the to be cancelled order.
         # @return [boolean] Whether the sales order was cancelled successfully or not.
@@ -29,25 +39,6 @@ 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.
-        def duplicate(id)
-          duplicated_order_id = client.put("model/sale.sale/#{id}/copy").first
-          ErpIntegration::SalesOrder.new(id: duplicated_order_id)
-
-        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a sales order couldn't
-        # be duplicated.
-        rescue ErpIntegration::HttpError::BadRequest
-          false
-        end
-
         # Confirm the order on Fulfil.
         # @param id [Integer|String] The ID of the to be confirmed order.
         # @return [boolean] Whether the sales order was confirmed successfully or not.
@@ -66,6 +57,45 @@ module ErpIntegration
           true
         end
 
+        # Creates the sales order in one API call in Fulfil.
+        #
+        # Fulfil allows two ways of creating a new sales order. Through their
+        # regular/generic API endpoint just like any other resource or through the
+        # sales channel.
+        #
+        # The benefit of using the Sales Channel route is it allows creating the sales
+        #
+        # @see https://developers.fulfil.io/guides/creating-orders/#create-order-api
+        #
+        # The sales order number is used as an idempotency key for Fulfil to prevent
+        # sales orders from being processed twice. Due to that it's a required attribute.
+        #
+        # @see https://developers.fulfil.io/guides/creating-orders/#channel_identifier
+        #
+        # @param sales_channel [String, Integer] The ID of the sales channel in Fulfil.
+        # @param attributes [Hash] The attributes of the sales order
+        # @return [ErpIntegration::SalesOrder]
+        def create_for(sales_channel, attributes:)
+          raise MissingIdempotencyKey if attributes['reference'].blank? && attributes[:reference].blank?
+
+          ErpIntegration::SalesOrder.new(
+            client.put("model/sale.channel/#{sales_channel}/create_order", [attributes])
+          )
+        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.
+        def duplicate(id)
+          duplicated_order_id = client.put("model/sale.sale/#{id}/copy").first
+          ErpIntegration::SalesOrder.new(id: duplicated_order_id)
+
+        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a sales order couldn't
+        # be duplicated.
+        rescue ErpIntegration::HttpError::BadRequest
+          false
+        end
+
         # Process the order on Fulfil.
         # @param id [Integer|String] The ID of the to be processed order.
         # @return [boolean] Whether the sales order was processed successfully or not.
@@ -83,6 +113,16 @@ module ErpIntegration
         rescue Faraday::ParsingError
           true
         end
+
+        # Creates a return order in Fulfil.
+        #
+        # @param id [Integer, String] The ID of the sales order
+        # @param options [Hash] The attributes needed for the return.
+        def return!(id, options)
+          client.put("model/sale.sale/#{id}/return_order", options)
+        rescue ErpIntegration::HttpError::BadRequest
+          false
+        end
       end
     end
   end

data/lib/erp_integration/resource.rb

@@ -80,12 +80,14 @@ module ErpIntegration
       # Due to `method_missing` we're able to delegate all the work automatically
       # to the adapter. However, if the method doesn't exist on the adapter, the
       # `NoMethodError` is still being raised.
+      #
       # @param method_name [Symbol] The name of the missing method.
-      # @param args [Array] The list of arguments for the missing method.
+      # @param args [Array] The list of positional arguments for the missing method.
+      # @param kwargs [Hash] The list of arguments for the missing method.
       # @param block [Proc] Any block given to the missing method.
-      def method_missing(method_name, *args, &block)
+      def method_missing(method_name, *args, **kwargs, &block)
         if adapter.respond_to?(method_name)
-          adapter.send(method_name, *args, &block)
+          adapter.send(method_name, *args, **kwargs, &block)
         else
           super
         end

data/lib/erp_integration/sales_order.rb

@@ -11,10 +11,9 @@ module ErpIntegration
                   :invoice_address, :invoice_method, :invoice_state, :invoices,
                   :lines, :metadata, :payment_term, :payment_total, :price_list,
                   :reference, :sales_person, :shipment_amount, :shipment_method,
-                  :shipment_state, :shipments, :shipping_start_date, :state,
-                  :tax_amount, :total_amount, :total_quantity, :total_shipment_cost,
-                  :untaxed_amount, :warehouse, :weight, :weight_uom, :write_date,
-                  :write_uid
+                  :shipment_returns, :shipment_state, :shipments, :shipping_start_date,
+                  :state, :tax_amount, :total_amount, :total_quantity, :total_shipment_cost,
+                  :untaxed_amount, :warehouse, :weight, :weight_uom, :write_date, :write_uid
 
     def cancel
       self.class.adapter.cancel(id)

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -3,6 +3,7 @@
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/module/delegation' # Allows using `delegate`
+require 'active_support/core_ext/object/blank'
 require 'faraday'
 require 'faraday_middleware'
 require 'json'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport