erp_integration 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10feefb3de410db28d960dcab694fd3ac8cbc08e9d2ea06627e8cd5f514b2a57
-  data.tar.gz: a7d6540c305bf8519789aa11073dc38141cdb60226a1296a99c5ea2e2d412838
+  metadata.gz: 33c09fbc8ebeff2b8b907e88e8b9bc147aefba15d5f7c1245de69cf66b24a8e6
+  data.tar.gz: c4ffdceea9bd5510bbee71647868e54a1ef36cc58bd7832a9333216811a3dd81
 SHA512:
-  metadata.gz: e64d55ee5b4ab827fb78ebd864ea278bfaaa50506de7e73737cfd88cc9e9f83485b34c7c96d840f3b3a5e26b3a8df730d69f8822d1c513f31b7f4d11bf8dd2e4
-  data.tar.gz: dacaceb6e96523354e470e70056f574933cd8dd4e9bf30757a5ab9742545d7b460c73b3b32ff9e41a6284a99c25cb62d4eed9f312b7e4c443242f0d18d3dc894
+  metadata.gz: 4e7a15d4a90a16905aab8c8be40e751c3b16148ad616631e6adad6033fdf444eeaeb9d6f37e30ba4639f17f5a1a7e800281051a2e98e44aa93936e74eed7c0de
+  data.tar.gz: bfba3edd52a0529d5ca11457b12ab255c3aed41fb2ca08df17c2c09333fa7c22c76ce96a0b96436c84327b62442d4129429d5a928863e5185c3724d926ddcef2

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

data/.reek.yml

@@ -79,7 +79,8 @@ detectors:
     max_instance_variables: 4
   TooManyMethods:
     enabled: true
-    exclude: []
+    exclude:
+      - ErpIntegration::Configuration # There are a lot of configuration options available.
     max_methods: 15
   TooManyStatements:
     enabled: true

data/erp_integration.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '< 0.82.0'
   spec.add_development_dependency 'rubocop-rake', '~> 0.5'
   spec.add_development_dependency 'rubocop-rspec', '< 1.39.0'
-  spec.add_development_dependency 'webmock', '~> 3.14.0'
+  spec.add_development_dependency 'webmock', '~> 3.17.0'
 
   # The `parallel` gem is a dev dependency for Rubocop. However, the versions
   # for parallel after 1.19.2 don't work with ruby 2.3.x. As ruby 2.3.x is

data/lib/erp_integration/configuration.rb

@@ -82,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.
@@ -92,6 +97,11 @@ 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
@@ -150,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
@@ -157,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/fulfil/api_resource.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'context'
 require_relative 'finder_methods'
 require_relative 'persistence'
 require_relative 'query_methods'
@@ -7,6 +8,7 @@ require_relative 'query_methods'
 module ErpIntegration
   module Fulfil
     class ApiResource
+      include Context
       include Enumerable
       include FinderMethods
       include Persistence
@@ -19,26 +21,6 @@ module ErpIntegration
         @resource_klass = resource_klass
       end
 
-      # The `where` and `includes` methods lazyly build a search/read query
-      # for Fulfil. By calling `all`, the prepared search/read query will actually
-      # be executed and the results will be fetched.
-      # @return [Array] An enumerable collection object with all API results.
-      def all
-        return @results if defined?(@results)
-
-        @results =
-          client.put(
-            "model/#{model_name}/search_read",
-            Query.new(selected_fields, where_clauses)
-          ).map { |item| resource_klass.new(item) }
-      end
-
-      # The `each` method turns the `ApiResource` instance into an enumerable object.
-      # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
-      def each(&block)
-        all.each(&block)
-      end
-
       # The `client` exposes the `ErpIntegration::Fulfil::Client` to the class.
       # @return [ErpIntegration::Fulfil::Client] The HTTP client for Fulfil.
       def self.client
@@ -70,6 +52,38 @@ module ErpIntegration
       def self.model_name
         instance_variable_get(:@model_name)
       end
+
+      # The `where` and `includes` methods lazyly build a search/read query
+      # for Fulfil. By calling `all`, the prepared search/read query will actually
+      # be executed and the results will be fetched.
+      # @return [Array] An enumerable collection object with all API results.
+      def all
+        return @results if defined?(@results)
+
+        @results =
+          client.put(
+            api_resource_path,
+            Query.new(selected_fields, where_clauses)
+          ).map { |item| resource_klass.new(item) }
+      end
+
+      # The `each` method turns the `ApiResource` instance into an enumerable object.
+      # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
+      def each(&block)
+        all.each(&block)
+      end
+
+      private
+
+      # Builds the relative resource path and adds the context if needed.
+      #
+      # @return [String]
+      def api_resource_path
+        base_path = "model/#{model_name}/search_read"
+        return base_path unless context?
+
+        "#{base_path}?context=#{context.to_json}"
+      end
     end
   end
 end

data/lib/erp_integration/fulfil/context.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Fulfil
+    # When making HTTP requests to the Fulfil API endpoints, it's possible to define
+    # the warehouses that should be considered part of the querying context.
+    #
+    # This means that it's possible to fetch the stock levels for a specific "warehouse"
+    # when it's specified in the context of the HTTP request to the API endpoints of
+    # Fulfil.
+    #
+    # @example without any context, the main warehouse will be used as configured
+    #           in Fulfil through the application settings.
+    #
+    #   $ ErpIntegration::Product.find_by(sku: "PT123").quantity_available
+    #   => 25
+    #
+    # @example with context, the given warehouse will be used to find the requested
+    #           data in Fulfil.
+    #
+    #   $ ErpIntegration::Product.with_context(locations: [25]).find_by(sku: "PT123").quantity_available
+    #   => 15
+    module Context
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :context
+      end
+
+      # Verifies whether or not the context is set.
+      #
+      # @return [Boolean]
+      def context?
+        !@context.nil? && !@context.empty?
+      end
+
+      # Allows setting the context for the HTTP request to the Fulfil API endpoints.
+      #
+      # @param context [Hash] The context for the HTTP request.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def with_context(context)
+        @context = (@context || {}).merge(context)
+        self
+      end
+    end
+  end
+end

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/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.11.0'
+  VERSION = '0.13.0'
 end

data/lib/erp_integration.rb

@@ -33,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.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,14 +202,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.17.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +224,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.2
-description: 
+description:
 email:
 - stefan@knowndecimal.com
 executables: []
@@ -268,6 +268,7 @@ files:
 - lib/erp_integration/errors.rb
 - lib/erp_integration/fulfil/api_resource.rb
 - lib/erp_integration/fulfil/client.rb
+- lib/erp_integration/fulfil/context.rb
 - lib/erp_integration/fulfil/finder_methods.rb
 - lib/erp_integration/fulfil/persistence.rb
 - lib/erp_integration/fulfil/query.rb
@@ -284,8 +285,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
@@ -299,8 +302,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:
@@ -310,7 +315,7 @@ metadata:
   homepage_uri: https://www.github.com/mejuri-inc/erp-integration
   source_code_uri: https://www.github.com/mejuri-inc/erp-integration
   changelog_uri: https://www.github.com/mejuri-inc/erp-integration/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -325,8 +330,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors
 test_files: []