erp_integration 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0820135e4a0b603c15f4e46615a3682c229f415ac5f9023b6a8c8fdd118f2471'
-  data.tar.gz: e7a1cdb300cebb0c9005823160ccfc54162eb27b4037b427a391f79ce21cc822
+  metadata.gz: ce9166d556b18b7bc901a79897d91aac2fe7eb55c5aaddf9af9294c4bd998565
+  data.tar.gz: e1691411b7567d04cd7f005be725df6be5934bf5ce6bbf3c827f622ac05f2ad5
 SHA512:
-  metadata.gz: f225c537e56518eab0d9356b965802a074ab67995ff0ee3aaabc23eafd383094c6eb0650add2589496fb9dbcbe9810cefec1677b278d46363082850f931cf0ec
-  data.tar.gz: 0d63e7169eb701247f5f89e0759de9f3a8f2a936a093e93b9cda449b9ba163e307010e0c25c059b9932935ca344e8d33613c2a669538a5ed49256bcb4747ae2e
+  metadata.gz: 59b3d087c5218481e4482a37f6b48ea3a889fd4e1c63e9a38704a636a45b0c15f2fc622231819ee7f1ebb78687e7313e1044227d3094d9f157f502959bab53fd
+  data.tar.gz: b41b6762a7b5667ea55732c1e2d184c3074223ea3508fb08a1bb917424a76b1b9907434d1c9083c33efd45d4f6c0ec49528b500dec10e0df4e0a0d476faa4fe7

data/lib/erp_integration/customer_shipment_return.rb

@@ -32,5 +32,13 @@ module ErpIntegration
     def create_default_package(id)
       self.class.adapter.create_default_package(id)
     end
+
+    # Create a package for a {CustomerShipmentReturn}.
+    #
+    # @param id [Integer] The ID of the {CustomerShipmentReturn}.
+    # @param options [Hash] The attributes needed for the new package.
+    def create_package(id, options)
+      self.class.adapter.create_package(id, options)
+    end
   end
 end

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

@@ -21,6 +21,10 @@ module ErpIntegration
         def create_default_package(id)
           client.put("model/#{model_name}/#{id}/create_default_packages")
         end
+
+        def create_package(id, options)
+          client.put("model/#{model_name}/#{id}", options)
+        end
       end
     end
   end

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.26.0'
+  VERSION = '0.28.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.26.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport