erp_integration 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa8a1bdac1da55e10572a0f25ad21f3e608d77e014e6abfb1c8e93667dee23f
-  data.tar.gz: 7bda7954766e6925764a2477acdf7dbd5974d8fb463a44ba8ee6d9ad4b695a26
+  metadata.gz: f838562b7bce4ffaab0944a370300bfa1c9d2f43d71777342a34be928857622b
+  data.tar.gz: f693bb521585a843abe5afd0fa1637a6235198a0a466cfe116130bd8f4906c81
 SHA512:
-  metadata.gz: 7f72a741e0c219a30b961acea16804e9c47d8941e941518942856c20faef421ed0465b58e202ce0b79c29b6289334e6e3ae09e5a82bcc921aecb0d17fbcd80f2
-  data.tar.gz: 210749ddda85e42fa4cd8a4503580ca0c7e53de84f4c5339dd4a7c2476de8da14eb67023bdfafa47ae748481c09965acd53aac1fdd667f949d475ef5b704abfe
+  metadata.gz: a008498534cd8274a24dcb37fe11c090126f128756d388173c908a29458aedc7fe8f8b70a53652c5499aafad5f27896ca61c7648c8bf3dacb8d032e0d21a66a3
+  data.tar.gz: 99ac0de4fa2bfb6a1a6bbbc709bb8b84eac47157561e45a16e5df4827f8e8b12ecfd7222ba262a626546b20fee27919655a01b6b25a820cd31bda389d083c519

data/README.md

@@ -104,7 +104,7 @@ It's important to note that you'll need the right privileges to publish the gem.
 
 2. Create Pull Request
 
-3. Merge it to main
+3. Merge it to develop
 
 4. Run Release script
   ```shell

data/lib/erp_integration/configuration.rb

@@ -37,6 +37,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the bill_of_material.
     attr_writer :bill_of_material_output_adapter
 
+    # Allows configuring an adapter for the `CustomerShipment` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the customer shipment.
+    attr_writer :customer_shipment_adapter
+
     # Allows configuring an adapter for the `CustomerShipmentReturn` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the customer shipment.
@@ -77,6 +82,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the order lines.
     attr_writer :sales_order_line_adapter
 
+    # Allows configuring an adapter for the `SalesReturnReason` resource. When none is
+    # configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the order lines.
+    attr_writer :sales_return_reason_adapter
+
     # Allows configuring an adapter for the `SupplierShipment` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the supplier shipment.
@@ -87,6 +97,15 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the stock move.
     attr_writer :stock_move_adapter
 
+    # Allows configuring an adapter for the `TrackingNumber` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the tracking number.
+    attr_writer :tracking_number_adapter
+
+    # Logger that will be used for HTTP operations on Client
+    # @return [Logger] The configured logger
+    attr_accessor :logger
+
     def initialize(**options)
       options.each_pair do |key, value|
         public_send("#{key}=", value) if respond_to?("#{key}=")
@@ -105,6 +124,10 @@ module ErpIntegration
       @bill_of_material_output_adapter || :fulfil
     end
 
+    def customer_shipment_adapter
+      @customer_shipment_adapter || :fulfil
+    end
+
     def customer_shipment_return_adapter
       @customer_shipment_return_adapter || :fulfil
     end
@@ -137,6 +160,10 @@ module ErpIntegration
       @sales_order_adapter || :fulfil
     end
 
+    def sales_return_reason_adapter
+      @sales_return_reason_adapter || :fulfil
+    end
+
     def supplier_shipment_adapter
       @supplier_shipment_adapter || :fulfil
     end
@@ -144,6 +171,10 @@ module ErpIntegration
     def stock_move_adapter
       @stock_move_adapter || :fulfil
     end
+
+    def tracking_number_adapter
+      @tracking_number_adapter || :fulfil
+    end
   end
 
   # Returns ERP Integration's configuration.

data/lib/erp_integration/customer_shipment.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::CustomerShipment` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class CustomerShipment < Resource
+    attr_accessor :acknowledged_by_3pl_at, :aes_itn, :assigned_by, :assigned_time, :attachments,
+                  :available_carrier_services, :avg_cycle_time, :avg_cycle_time_cache, :carrier,
+                  :carrier_billing_account, :carrier_cost_method, :carrier_duties_account,
+                  :carrier_service, :channel_carrier_service_code, :channel_logo_url, :channels,
+                  :checklists, :company, :consumable_moves, :consumables_cost, :consumables_cost_cache,
+                  :contact_categories, :contents_explanation, :contents_type, :cost, :cost_currency,
+                  :cost_currency_digits, :cost_invoice_line, :create_date, :create_return_label, :create_uid,
+                  :customer, :customer_location, :customs_items, :default_box_type, :delivery_address,
+                  :delivery_address_datetime, :delivery_mode, :done_by, :duties_tax_id, :duties_tax_id_type,
+                  :eel_pfc, :effective_date, :eori_number, :fedex_saturday_delivery, :full_delivery_address,
+                  :gift_message, :has_gift_message, :hold_reason, :id, :incoterm, :insurance_amount, :inventory_moves,
+                  :invoices, :is_international_shipping, :is_shippo, :last_modification, :license_plates, :messages,
+                  :metadata, :moves, :non_delivery_option, :number, :on_hold, :on_hold_until, :order_confirmation_time,
+                  :order_numbers, :origins, :outgoing_moves, :packages, :packed_at, :packed_by, :packed_date, :packer,
+                  :payment_status, :payment_transactions, :picked_at, :picked_date, :picker, :picking_started_at,
+                  :picking_status, :planned_date, :planned_datetime, :planned_time, :priority, :private_notes,
+                  :productions, :public_notes, :rec_blurb, :rec_name, :reference, :request_confirmation,
+                  :requested_delivery_date, :requested_shipping_service, :require_customs, :root_packages, :sale_date,
+                  :sales, :sent_to_3pl_at, :shipped_at, :shipper, :shipping_batch, :shipping_instructions,
+                  :shipping_label_date, :shipping_label_printed, :shipping_manifest, :sscc_code, :state, :tax_id,
+                  :total_amount_ccy, :total_cost, :total_customs_value, :total_item_cost_ccy, :total_quantity, :tpl,
+                  :tpl_status, :tracking_export_status, :tracking_number, :tracking_number_blurb, :tsv,
+                  :ups_saturday_delivery, :warehouse, :warehouse_output, :warehouse_storage, :weight, :weight_digits,
+                  :weight_uom, :weight_uom_symbol, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/customer_shipment_return.rb

@@ -12,8 +12,8 @@ module ErpIntegration
                   :done_by, :duties_tax_id, :duties_tax_id_type, :eel_pfc, :effective_date,
                   :eori_number, :id, :incoming_moves, :inventory_moves, :is_international_shipping,
                   :is_shippo, :last_modification, :license_plates, :messages, :metadata, :moves,
-                  :packages, :planned_date, :private_notes, :public_notes, :putaway_by, :rec_blurb,
-                  :rec_name, :received_by, :reference, :require_customs, :root_packages, :sales,
+                  :origins, :number, :packages, :planned_date, :private_notes, :public_notes, :putaway_by,
+                  :rec_blurb, :rec_name, :received_by, :reference, :require_customs, :root_packages, :sales,
                   :sent_to_3pl_at, :shipping_instructions, :shipping_manifest, :sscc_code, :state,
                   :total_customs_value, :tpl_status, :tracking_number, :tsv, :warehouse, :warehouse_input,
                   :warehouse_storage, :warehouse_type, :weight, :weight_digits, :weight_uom,

data/lib/erp_integration/fulfil/api_resource.rb

@@ -44,7 +44,8 @@ module ErpIntegration
       def self.client
         Client.new(
           api_key: config.fulfil_api_key,
-          merchant_id: config.fulfil_merchant_id
+          merchant_id: config.fulfil_merchant_id,
+          logger: config.logger
         )
       end
 

data/lib/erp_integration/fulfil/client.rb

@@ -6,9 +6,10 @@ module ErpIntegration
       attr_reader :api_key, :merchant_id
       attr_writer :connection, :faraday_adapter
 
-      def initialize(api_key:, merchant_id:)
+      def initialize(api_key:, merchant_id:, logger: nil)
         @api_key = api_key
         @merchant_id = merchant_id
+        @logger = logger
       end
 
       # Generates the url prefix for the Faraday connection client.
@@ -35,6 +36,11 @@ module ErpIntegration
           faraday.response :follow_redirects
           faraday.response :json # Decode response bodies as JSON
 
+          # 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 }
+
           # Custom error handling for the error response
           faraday.use ErpIntegration::Middleware::ErrorHandling
 

data/lib/erp_integration/fulfil/persistence.rb

@@ -27,6 +27,17 @@ module ErpIntegration
         [attributes, [extract_error_message(e)]]
       end
 
+      # Destroys the resource.
+      #
+      # @param resource_id [Integer] The ID of the resource.
+      # @return [Boolean] Returns true if the resource was deleted
+      def destroy(resource_id)
+        client.delete("model/#{model_name}/#{resource_id}")
+        { id: resource_id }
+      rescue ErpIntegration::HttpError::BadRequest => e
+        [{ id: resource_id }, [extract_error_message(e)]]
+      end
+
       private
 
       # Fulfil returns a 400 status code (e.g. Bad Request) with the error message

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class CustomerShipment < ApiResource
+        self.model_name = 'stock.shipment.out'
+      end
+    end
+  end
+end

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

@@ -28,6 +28,55 @@ module ErpIntegration
         rescue Faraday::ParsingError
           true
         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.
+        def confirm(id)
+          client.put("model/sale.sale/#{id}/confirm")
+          true
+
+        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a sales order couldn't
+        # be confirmed.
+        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
+
+        # 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.
+        def process(id)
+          client.put("model/sale.sale/#{id}/process")
+          true
+
+        # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a sales order couldn't
+        # be processed.
+        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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class SalesReturnReason < ApiResource
+        self.model_name = 'sale.return.reason'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class TrackingNumber < ApiResource
+        self.model_name = 'shipment.tracking'
+      end
+    end
+  end
+end

data/lib/erp_integration/resources/persistence.rb

@@ -35,6 +35,15 @@ module ErpIntegration
         assign_attributes(attrs)
         validate_with(error_messages)
       end
+
+      # Destroy an resource in the ERP.
+      # @return [Boolean] Whether the destroy action was succcesful or not.
+      def destroy(id)
+        attrs, error_messages = self.class.adapter.destroy(id)
+
+        assign_attributes(attrs)
+        validate_with(error_messages)
+      end
     end
   end
 end

data/lib/erp_integration/sales_order.rb

@@ -19,5 +19,17 @@ module ErpIntegration
     def cancel
       self.class.adapter.cancel(id)
     end
+
+    def duplicate
+      self.class.adapter.duplicate(id)
+    end
+
+    def confirm
+      self.class.adapter.confirm(id)
+    end
+
+    def process
+      self.class.adapter.process(id)
+    end
   end
 end

data/lib/erp_integration/sales_return_reason.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::SalesReturnReason` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class SalesReturnReason < Resource
+    attr_accessor :attachments, :create_date, :create_uid, :description,
+                  :id, :messages, :metadata, :name, :private_notes,
+                  :public_notes, :rec_blurb, :rec_name, :write_date,
+                  :write_uid
+  end
+end

data/lib/erp_integration/tracking_number.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::TrackingNumber` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class TrackingNumber < Resource
+    attr_accessor :attachments, :attempts, :carrier, :carrier_identifier,
+                  :carrier_service, :create_date, :create_uid, :delivered_at,
+                  :delivered_date, :delivery_date, :delivery_time, :easypost_order_id,
+                  :estimated_delivery_date, :id, :is_master, :messages, :metadata,
+                  :next_update_at, :origin, :private_notes, :public_notes, :rec_blurb,
+                  :rec_name, :reference, :scac, :state, :tracking_number,
+                  :tracking_url, :transportation_mode, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -23,6 +23,7 @@ module ErpIntegration
   autoload :BillOfMaterial, 'erp_integration/bill_of_material'
   autoload :BillOfMaterialInput, 'erp_integration/bill_of_material_input'
   autoload :BillOfMaterialOutput, 'erp_integration/bill_of_material_output'
+  autoload :CustomerShipment, 'erp_integration/customer_shipment'
   autoload :CustomerShipmentReturn, 'erp_integration/customer_shipment_return'
   autoload :Product, 'erp_integration/product'
   autoload :ProductionOrder, 'erp_integration/production_order'
@@ -32,8 +33,10 @@ module ErpIntegration
   autoload :Resource, 'erp_integration/resource'
   autoload :SalesOrder, 'erp_integration/sales_order'
   autoload :SalesOrderLine, 'erp_integration/sales_order_line'
+  autoload :SalesReturnReason, 'erp_integration/sales_return_reason'
   autoload :StockMove, 'erp_integration/stock_move'
   autoload :SupplierShipment, 'erp_integration/supplier_shipment'
+  autoload :TrackingNumber, 'erp_integration/tracking_number'
 
   module Resources
     autoload :Errors, 'erp_integration/resources/errors'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -263,6 +263,7 @@ files:
 - lib/erp_integration/bill_of_material_input.rb
 - lib/erp_integration/bill_of_material_output.rb
 - lib/erp_integration/configuration.rb
+- lib/erp_integration/customer_shipment.rb
 - lib/erp_integration/customer_shipment_return.rb
 - lib/erp_integration/errors.rb
 - lib/erp_integration/fulfil/api_resource.rb
@@ -274,6 +275,7 @@ files:
 - lib/erp_integration/fulfil/resources/bill_of_material.rb
 - lib/erp_integration/fulfil/resources/bill_of_material_input.rb
 - lib/erp_integration/fulfil/resources/bill_of_material_output.rb
+- lib/erp_integration/fulfil/resources/customer_shipment.rb
 - lib/erp_integration/fulfil/resources/customer_shipment_return.rb
 - lib/erp_integration/fulfil/resources/product.rb
 - lib/erp_integration/fulfil/resources/production_order.rb
@@ -282,8 +284,10 @@ files:
 - lib/erp_integration/fulfil/resources/purchase_request.rb
 - 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_move.rb
 - lib/erp_integration/fulfil/resources/supplier_shipment.rb
+- lib/erp_integration/fulfil/resources/tracking_number.rb
 - lib/erp_integration/fulfil/where_clause.rb
 - lib/erp_integration/middleware/error_handling.rb
 - lib/erp_integration/product.rb
@@ -297,8 +301,10 @@ files:
 - lib/erp_integration/resources/validations.rb
 - lib/erp_integration/sales_order.rb
 - lib/erp_integration/sales_order_line.rb
+- lib/erp_integration/sales_return_reason.rb
 - lib/erp_integration/stock_move.rb
 - lib/erp_integration/supplier_shipment.rb
+- lib/erp_integration/tracking_number.rb
 - lib/erp_integration/version.rb
 homepage: https://www.github.com/mejuri-inc/erp-integration
 licenses:
@@ -323,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors