erp_integration 0.34.0 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c2613fa4d588241f06f9a130cdc5fece97ba69c5e732d66d4ff141adabb080
-  data.tar.gz: 71e0908f8b3fbfcf89a28d15445cd8d3b170a19ba81182c0af03be0933a64631
+  metadata.gz: 4bf1b8a88038684ef2a0192d9980e29c13fa8c5b2ea5078478d47db28fe6d050
+  data.tar.gz: e5e37d4c3c39647d1a1118a946f0e1808eaffa2a60b373e4a681f5942f48afce
 SHA512:
-  metadata.gz: 273b05cc0dbf4030cb6a0a39788614165aba29392795e196228987300a74043a81760ded720d8ba548f0c74708293bb0e845add3b4f3ecef7d69e3939fb5a558
-  data.tar.gz: 0e8969487347f3a661ffaa5c789b65fae4da98f1c2e117f19aef0286e86a8856b70f70e71b095c48d5698f39112fea808ef28620935308f268fb74574b211a69
+  metadata.gz: d23ae16ce5d712adf1ecb1ae6af31feaf29d773214281546902cc641496e89894fbac35ce3a6da05cd2248ca1b674e589ea3be62114112d32b77933dc3df3465
+  data.tar.gz: 6990bf1cacbf87418692ca4ed5b2b63b16e181f4e35b94de5843a5c3b661a5cad55603809318098c23aaada1ba778bb0e5009d49e443a31ea5fff3a9d58ed858

data/.rubocop.yml

@@ -82,6 +82,8 @@ Naming/PredicateName:
   Enabled: true
 
 Metrics/ClassLength:
+  Exclude:
+    - lib/erp_integration/configuration.rb
   Enabled: true
 
 Style/AndOr:

data/lib/erp_integration/configuration.rb

@@ -97,6 +97,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the supplier shipment.
     attr_writer :supplier_shipment_adapter
 
+    # Allows configuring an adapter for the `StockBinTransfer` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the stock bin transfer.
+    attr_writer :stock_bin_transfer_adapter
+
     # Allows configuring an adapter for the `StockMove` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the stock move.
@@ -199,6 +204,10 @@ module ErpIntegration
       @supplier_shipment_adapter || :fulfil
     end
 
+    def stock_bin_transfer_adapter
+      @stock_bin_transfer_adapter || :fulfil
+    end
+
     def stock_move_adapter
       @stock_move_adapter || :fulfil
     end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class StockBinTransfer < ApiResource
+        self.model_name = 'stock.bin_transfer'
+
+        # Allows bulk force assign bin transfers over the API to move assigned
+        # inventory to the new bin location.
+        # @param id [Integer|String] The ID of the stock bin transfer.
+        # @return [boolean] Whether the stock bin transfer was assigned force successfully or not.
+        def assign_force(id)
+          client.put("model/stock.bin_transfer/#{id}/assign_force")
+          true
+
+        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a bin trasfer couldn't
+        # be done. If a bit trasfer isn't assignable by design, no exception should be raised.
+        #
+        # See the Fulfil's documentation for more information:
+        # https://developers.fulfil.io/rest_api/model/stock.bin_transfer/#force-allocate-inventory-to-the-transfer
+        rescue ErpIntegration::HttpError::BadRequest
+          false
+        # Workaround: Fulfil api does not return a json when status code is 200 (a.k.a. "Ok")
+        # and faraday is having an error when trying to parse it. Let's skip the parse error
+        # and move on.
+        rescue Faraday::ParsingError
+          true
+        end
+
+        # Allows bulk mark the bin transfers as done over the API to finish
+        # moving the inventory to the new bin location.
+        # It is better practice for inventory accuracy to mark the bin transfer
+        # as done once the inventory is physically moved to the new location.
+        # @param id [Integer|String] The ID of the stock bin transfer.
+        # @return [boolean] Whether the stock bin transfer was mark as done successfully or not.
+        def done(id)
+          client.put("model/stock.bin_transfer/#{id}/done")
+          true
+
+        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a bin trasfer couldn't
+        # be done. If a bit trasfer isn't doneable by design, no exception should be raised.
+        #
+        # See the Fulfil's documentation for more information:
+        # https://developers.fulfil.io/rest_api/model/stock.bin_transfer/#mark-transfer-as-done
+        rescue ErpIntegration::HttpError::BadRequest
+          false
+        # Workaround: Fulfil api does not return a json when status code is 200 (a.k.a. "Ok")
+        # and faraday is having an error when trying to parse it. Let's skip the parse error
+        # and move on.
+        rescue Faraday::ParsingError
+          true
+        end
+      end
+    end
+  end
+end

data/lib/erp_integration/stock_bin_transfer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  class StockBinTransfer < Resource
+    attr_accessor :id, :attachments, :company, :create_date, :create_uid,
+                  :description, :effective_date, :messages, :metadata,
+                  :metafields, :moves, :number, :origin, :picker, :priority,
+                  :picking_status, :planned_date, :private_notes, :public_notes,
+                  :quantity_total, :rec_blurb, :rec_name, :reference, :state,
+                  :storage_zone, :warehouse, :write_date, :write_uid
+
+    def assign_force
+      self.class.adapter.assign_force(id)
+    end
+
+    def done
+      self.class.adapter.done(id)
+    end
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -39,6 +39,7 @@ module ErpIntegration
   autoload :SalesOrder, 'erp_integration/sales_order'
   autoload :SalesOrderLine, 'erp_integration/sales_order_line'
   autoload :SalesReturnReason, 'erp_integration/sales_return_reason'
+  autoload :StockBinTransfer, 'erp_integration/stock_bin_transfer'
   autoload :StockMove, 'erp_integration/stock_move'
   autoload :SupplierShipment, 'erp_integration/supplier_shipment'
   autoload :Task, 'erp_integration/task'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.35.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -297,6 +297,7 @@ files:
 - lib/erp_integration/fulfil/resources/sales_order.rb
 - lib/erp_integration/fulfil/resources/sales_order_line.rb
 - lib/erp_integration/fulfil/resources/sales_return_reason.rb
+- lib/erp_integration/fulfil/resources/stock_bin_transfer.rb
 - lib/erp_integration/fulfil/resources/stock_move.rb
 - lib/erp_integration/fulfil/resources/supplier_shipment.rb
 - lib/erp_integration/fulfil/resources/task.rb
@@ -317,6 +318,7 @@ files:
 - lib/erp_integration/sales_order.rb
 - lib/erp_integration/sales_order_line.rb
 - lib/erp_integration/sales_return_reason.rb
+- lib/erp_integration/stock_bin_transfer.rb
 - lib/erp_integration/stock_move.rb
 - lib/erp_integration/supplier_shipment.rb
 - lib/erp_integration/task.rb