erp_integration 0.7.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b7edee1b77a371325210af94802cbd0d6c1df5d730bcfd8d9d326bc8a5eb2c3
-  data.tar.gz: d59ecb758fde883746da4fec059e99c53b71f7a526f81d7fa272eb139f567ff4
+  metadata.gz: 10feefb3de410db28d960dcab694fd3ac8cbc08e9d2ea06627e8cd5f514b2a57
+  data.tar.gz: a7d6540c305bf8519789aa11073dc38141cdb60226a1296a99c5ea2e2d412838
 SHA512:
-  metadata.gz: 0c34649c0ab233be00b9e9b35897faa934eb85824318528f7df4261b8f093319902d82636bd6e4cbba22d82afec604e6d4136b6f64ad7398ee2227aa5b17dca9
-  data.tar.gz: 70cac86409b77043c0d0ec4f62946d01b48bd96b4abfaaf88c3b57f9600ada205c505b072ac91836ca693621c37302e2223b65b2769e8157ff2fe0b4c734eb10
+  metadata.gz: e64d55ee5b4ab827fb78ebd864ea278bfaaa50506de7e73737cfd88cc9e9f83485b34c7c96d840f3b3a5e26b3a8df730d69f8822d1c513f31b7f4d11bf8dd2e4
+  data.tar.gz: dacaceb6e96523354e470e70056f574933cd8dd4e9bf30757a5ab9742545d7b460c73b3b32ff9e41a6284a99c25cb62d4eed9f312b7e4c443242f0d18d3dc894

data/.gitignore

@@ -13,3 +13,4 @@
 Gemfile.lock
 .byebug_history
 *.gem
+/.idea/

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,16 @@ 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.
+    attr_writer :customer_shipment_return_adapter
+
     # Allows configuring an adapter for the `Product` resource. When none is
     # configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the products.
@@ -82,6 +92,10 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the stock move.
     attr_writer :stock_move_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}=")
@@ -100,6 +114,14 @@ 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
+
     def product_adapter
       @product_adapter || :fulfil
     end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::CustomerShipmentReturn` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class CustomerShipmentReturn < Resource
+    attr_accessor :aes_itn, :attachments, :available_carrier_services, :carrier,
+                  :carrier_billing_account, :carrier_cost_method, :carrier_duties_account,
+                  :carrier_service, :channels, :company, :contents_explanation, :contents_type,
+                  :cost, :cost_currency, :cost_currency_digits, :create_date, :create_uid,
+                  :customer, :customer_location, :customs_items, :delivery_address, :delivery_mode,
+                  :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,
+                  :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,
+                  :weight_uom_symbol, :write_date, :write_uid
+  end
+end

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

@@ -5,21 +5,26 @@ module ErpIntegration
     module Persistence
       # Allows creating new resources in Fulfil.
       #
-      # @example
-      #   $ ErpIntegration::Product.create(code: 'MT100eu', variant: 10)
-      #   => <ErpIntegration::Product @id=2 @code="MT100eu" @variant=10 />
-      #
-      # @param attributes [Hash] A list of attributes.
-      # @return [ErpIntegration::Resource] The newly created resource.
-      def create(attributes = {})
+      # @param attributes [Hash] A list of attributes for the new resource.
+      # @return [Array|Hash] The response from the API
+      def create(attributes)
         client
           .post("model/#{model_name}", normalize_attributes(attributes))
-          .map { |new_record_id| resource_klass.new(attributes.merge(id: new_record_id)) }
+          .map { |new_record_id| attributes.merge!(id: new_record_id) }
           .first
       rescue ErpIntegration::HttpError::BadRequest => e
-        record = resource_klass.new(attributes)
-        record.errors.add(extract_error_message(e))
-        record
+        [attributes, [extract_error_message(e)]]
+      end
+
+      # Updates the resource with the given attributes.
+      #
+      # @param resource_id [Integer] The ID of the resource.
+      # @param attributes [Hash] A list of attributes to update for the resource.
+      # @return [Array|Hash] The response from the API
+      def update(resource_id, attributes)
+        client.put("model/#{model_name}/#{resource_id}", attributes)
+      rescue ErpIntegration::HttpError::BadRequest => e
+        [attributes, [extract_error_message(e)]]
       end
 
       private

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

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

data/lib/erp_integration/resource.rb

@@ -29,22 +29,25 @@ module ErpIntegration
   #   5. Create a new adapter class prefixed with the adapter's name
   #      (e.g. `FulfilOrder` for the `Order` resource in the `lib/erp_integration/orders` folder).
   class Resource
+    include Resources::Validations
+    include Resources::Persistence
+
     attr_accessor :raw_api_response
 
     def initialize(attributes = {})
       @raw_api_response = attributes
+      assign_attributes(attributes)
+    end
 
+    # Allows assigning attributes to an resource instance.
+    # @param attributes [Hash] A list of attributes for the resource.
+    # @return [Hash] The list of assigned attributes.
+    def assign_attributes(attributes = {})
       attributes.each_pair do |name, value|
         public_send(:"#{name}=", value) if respond_to?(:"#{name}=")
       end
     end
 
-    # Exposes all errors related to an `ErpIntegration::Resource`.
-    # @return [ErpIntegration::Resources::Errors] Encapsulation of all error messages.
-    def errors
-      @errors ||= Resources::Errors.new
-    end
-
     class << self
       # Dynamically defines and loads the adapter for the class inheriting from
       # the `ErpIntegration::Resource`.

data/lib/erp_integration/resources/persistence.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Resources
+    module Persistence
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Creates a new resource in the ERP.
+        # @param attributes [Hash] A list of attributes for the new resource.
+        # @return [ErpIntegration::Resource] The (to be) created resource.
+        def create(attributes)
+          attrs, error_messages = adapter.create(**attributes)
+
+          new_resource = new(attrs)
+          new_resource.validate_with(error_messages)
+          new_resource
+        end
+      end
+
+      # Determines whether a `ErpIntegration::Resource` is considered to be persisted.
+      # @return [Boolean] Whether it's persisted or not.
+      def persisted?
+        !id.nil?
+      end
+
+      # Update an resource in the ERP.
+      # @param attributes [Hash] A list of attributes to update.
+      # @return [Boolean] Whether the update action was succcesful or not.
+      def update(attributes)
+        attrs, error_messages = self.class.adapter.update(id, **attributes)
+
+        assign_attributes(attrs)
+        validate_with(error_messages)
+      end
+    end
+  end
+end

data/lib/erp_integration/resources/validations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Resources
+    module Validations
+      # Exposes all errors related to an `ErpIntegration::Resource`.
+      #
+      # @return [ErpIntegration::Resources::Errors] Encapsulation of all error messages.
+      def errors
+        @errors ||= Resources::Errors.new
+      end
+
+      # Checks whether an resource is considered valid or not.
+      #
+      # @return [Boolean] Is the resource valid according to the ERP?
+      def valid?
+        errors.none?
+      end
+
+      # Validates the resource by checking the given error messages.
+      #
+      # @param error_messages [Array] A list of error messages.
+      # @return [Boolean] Whether the resource is valid or not.
+      def validate_with(*error_messages)
+        errors.clear
+
+        error_messages.flatten.compact.each do |error_message|
+          errors.add(error_message)
+        end
+
+        valid?
+      end
+    end
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -23,6 +23,8 @@ 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'
   autoload :PurchaseOrder, 'erp_integration/purchase_order'
@@ -36,5 +38,7 @@ module ErpIntegration
 
   module Resources
     autoload :Errors, 'erp_integration/resources/errors'
+    autoload :Persistence, 'erp_integration/resources/persistence'
+    autoload :Validations, 'erp_integration/resources/validations'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -263,6 +263,8 @@ 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
 - lib/erp_integration/fulfil/client.rb
@@ -273,6 +275,8 @@ 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
 - lib/erp_integration/fulfil/resources/purchase_order.rb
@@ -291,6 +295,8 @@ files:
 - lib/erp_integration/purchase_request.rb
 - lib/erp_integration/resource.rb
 - lib/erp_integration/resources/errors.rb
+- lib/erp_integration/resources/persistence.rb
+- lib/erp_integration/resources/validations.rb
 - lib/erp_integration/sales_order.rb
 - lib/erp_integration/sales_order_line.rb
 - lib/erp_integration/stock_move.rb
@@ -319,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors