erp_integration 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5657cdcc644e079869eeb3189a451e97b558cb0c64f93b123280301acd0886b1
-  data.tar.gz: 5a279cf9b1c38ebba6939861e6f15bd5d4ad66acc03364068d5c5ffe46dfa3be
+  metadata.gz: 99b2b058b12b3b5d0b1212c9d077b9aaa224a9a20bc96f624dd7b5de3016bcaa
+  data.tar.gz: de266b8b0bb2c412866bf64ba0a28b75500faf79173e8d9bb1d56fd84c0a45b0
 SHA512:
-  metadata.gz: 2a3203a5b4277d6656f955aa015b01ab9c180cf628510eceeff4f6b6cab878a349a403c495342a0d050cd5c23c25fb0bda5bbe945b658e64fe53261c7fd78e38
-  data.tar.gz: f9014829733dd877118093fc7375517ba73982a87c1ad84f1497c183e514900372297c127551de9591801e1404f65ef21439bf0ef8aa3778fb3c27fb650eca6c
+  metadata.gz: '09c9117df5560187b9c5010b56ec0cc9ce30b3313a801e687795a0d97bc1c8dd2acae6ebc1cba7b186e777c2198def26e4071b7dfc52f28a04be0265657c68e6'
+  data.tar.gz: 3da4be6f4775e272d118ccb93ecec41c9744702a73f328245f472032d66c69796cbec23bb70286bd034e7b2593734f6c169bcd8d6e32d13e089b60ddab3784bc

data/README.md

@@ -37,15 +37,15 @@ end
 After configuring the gem, one can easily query all the available ERP resources from the connected third-parties.
 
 ```ruby
-$ ErpIntegration::Order.where(reference: 'MT1000SKX')
-=> #<ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::Order @id=100 />] />
+$ ErpIntegration::SalesOrder.where(reference: 'MT1000SKX')
+=> #<ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @id=100 />] />
 ```
 
 By default, only the `id` will be added to the found ERP resources. However, one can use the `select` method to include more fields.
 
 ```ruby
-$ ErpIntegration::Order.select(:id, :reference).where(reference: 'MT1000SKX')
-=> #<ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::Order @id=100 @reference=MT1000SKX />] />
+$ ErpIntegration::SalesOrder.select(:id, :reference).where(reference: 'MT1000SKX')
+=> #<ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @id=100 @reference=MT1000SKX />] />
 ```
 
 There are also other type of `where` queries available:

data/bin/prerelease

@@ -17,4 +17,4 @@ git push origin "release_v.$VERSION"
 
 # Tag the new gem version.
 git tag v$VERSION
-git push --tags
+git push origin v$VERSION

data/erp_integration.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   # Faraday is a HTTP/REST API client library to interact with third-party API vendors
   spec.add_dependency 'faraday', '>= 0.17.3', '< 1.9.0'
-  spec.add_dependency 'faraday_middleware', '~> 0.14.0'
+  spec.add_dependency 'faraday_middleware', '>= 0.14', '< 1.3'
 
   # Development dependencies
   spec.add_development_dependency 'byebug', '~> 11.0'

data/lib/erp_integration/configuration.rb

@@ -22,10 +22,20 @@ module ErpIntegration
     # @return [String] The merchant ID for Fulfil.
     attr_accessor :fulfil_merchant_id
 
-    # Allows configuring an adapter for the `Order` resource. When none is
+    # Allows configuring an adapter for the `SalesOrder` resource. When none is
     # configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the orders
-    attr_writer :order_adapter
+    # @return [Symbol] The configured adapter for the sales orders
+    attr_writer :sales_order_adapter
+
+    # Allows configuring an adapter for the `SalesOrderLine` resource. When none is
+    # configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the order lines.
+    attr_writer :sales_order_line_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.
+    attr_writer :product_adapter
 
     # Allows configuring an adapter for the `PurchaseOrder` resource. When none is
     # configured, it will default to Fulfil.
@@ -37,14 +47,27 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the purchase order lines.
     attr_writer :purchase_order_line_adapter
 
+    # Allows configuring an adapter for the `PurchaseRequest` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the purchase request.
+    attr_writer :purchase_request_adapter
+
     def initialize(**options)
       options.each_pair do |key, value|
         public_send("#{key}=", value) if respond_to?("#{key}=")
       end
     end
 
-    def order_adapter
-      @order_adapter || :fulfil
+    def sales_order_adapter
+      @sales_order_adapter || :fulfil
+    end
+
+    def sales_order_line_adapter
+      @sales_order_line_adapter || :fulfil
+    end
+
+    def product_adapter
+      @product_adapter || :fulfil
     end
 
     def purchase_order_adapter
@@ -54,6 +77,10 @@ module ErpIntegration
     def purchase_order_line_adapter
       @purchase_order_line_adapter || :fulfil
     end
+
+    def purchase_request_adapter
+      @purchase_request_adapter || :fulfil
+    end
   end
 
   # Returns ERP Integration's configuration.

data/lib/erp_integration/fulfil/api_resource.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'collection'
 require_relative 'query_methods'
 
 module ErpIntegration
   module Fulfil
     class ApiResource
+      include Enumerable
       include QueryMethods
 
       cattr_accessor :resource_klass, instance_accessor: false
-
       delegate :client, :model_name, :resource_klass, to: 'self.class'
-      delegate_missing_to :all
 
       def initialize(resource_klass)
         self.class.resource_klass = resource_klass
@@ -20,17 +18,21 @@ module ErpIntegration
       # 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 [ErpIntegration::Fulfil::Collection] An enumerable collection object with all API results.
+      # @return [Array] An enumerable collection object with all API results.
       def all
         return @results if defined?(@results)
 
-        @results = Collection.new(
+        @results =
           client.put(
             "model/#{model_name}/search_read",
             Query.new(selected_fields, where_clauses)
-          ),
-          resource_klass: resource_klass
-        )
+          ).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.

data/lib/erp_integration/fulfil/query_methods.rb

@@ -13,14 +13,14 @@ module ErpIntegration
       # selecting multiple fields at once.
       #
       # @example
-      #   $ ErpIntegration::Order.select(:id, :name, 'product.name')
+      #   $ ErpIntegration::SalesOrder.select(:id, :name, 'product.name')
       #   # => <ErpIntegration::Fulfil::Resources::Order @selected_fields=[:id, :name, "product.name"] />
       #
       # When one calls the `all` method, it will fetch all the resources from Fulfil
       # and it will return all the given fields (if available).
       #
       # @example
-      #   $ ErpIntegration::Order.select(:id, :name, 'product.name').all
+      #   $ ErpIntegration::SalesOrder.select(:id, :name, 'product.name').all
       #   # => <ErpIntegration::Fulfil::Collection @items=[...] />
       #
       # Both a list of Strings, Symbols or a combination of these can be passed
@@ -41,8 +41,8 @@ module ErpIntegration
       # to query resources in Fulfil.
       #
       # @example
-      #   $ ErpIntegration::Order.where(id: 100).all
-      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::Order @id=100 />] />
+      #   $ ErpIntegration::SalesOrder.where(id: 100).all
+      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @id=100 />] />
       #
       # If one adds the `comparison_operator` key to the arguments, it will use
       # that comparison operator to build the query to Fulfil.

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class Product < ApiResource
+        self.model_name = 'product.product'
+
+        # Checks whether a certain product is a BOM.
+        # @param sku [String] The product's SKU.
+        # @return [Boolean] Whether it's a BOM or not.
+        def bom?(sku)
+          select(:boms).where(code: sku).first.boms.any?
+        end
+        alias billing_of_materials? bom?
+      end
+    end
+  end
+end

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

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

data/lib/erp_integration/fulfil/resources/{order.rb → sales_order.rb}

@@ -5,7 +5,7 @@ require_relative '../api_resource'
 module ErpIntegration
   module Fulfil
     module Resources
-      class Order < ApiResource
+      class SalesOrder < ApiResource
         self.model_name = 'sale.sale'
 
         # Allows cancelling the entire sales order in Fulfil.
@@ -22,6 +22,11 @@ module ErpIntegration
         # https://developers.fulfil.io/rest_api/model/sale.sale/#cancel-a-sales-order
         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

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

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

data/lib/erp_integration/fulfil/where_clause.rb

@@ -26,7 +26,7 @@ module ErpIntegration
       def initialize(key:, value:, comparison_operator: DEFAULT_COMPARISON_OPERATOR)
         @comparison_operator = verify_comparison_operator(comparison_operator)
         @key = key.to_s
-        @value = value.to_s
+        @value = value
       end
 
       # Transforms the `WhereClause` into a filter object for Fulfil.

data/lib/erp_integration/product.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::Product` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class Product < Resource
+    attr_accessor :id, :code, :cost_price, :cost_price_method, :quantity_available,
+                  :quantity_buildable, :quantity_inbound, :quantity_on_hand, :salable,
+                  :template, :variant_name, :abc_classification, :account_category,
+                  :account_cogs_used, :account_expense_used, :account_revenue_used,
+                  :account_stock_lost_found_used, :account_stock_production_used,
+                  :account_stock_supplier_used, :account_stock_used, :active,
+                  :asin, :attachments, :attribute_set, :attributes, :attributes_json,
+                  :average_daily_consumed, :average_daily_sales, :average_monthly_consumed,
+                  :average_monthly_sales, :average_price, :boms, :box_type, :brand, :channel_listings,
+                  :consumable, :country_of_origin, :create_date, :create_uid, :customs_description,
+                  :customs_value, :days_of_inventory_left, :default_uom, :default_uom_category,
+                  :description, :dimensions_uom, :ean, :fulfil_strategy, :gc_max, :gc_min,
+                  :gift_card_delivery_mode, :gift_card_prices, :google_product_category,
+                  :gross_margin, :gross_profit, :height, :hs_code, :is_gift_card, :landed_cost,
+                  :lead_time_in_days, :length, :list_price, :long_description, :metadata,
+                  :next_shipping_date, :product_suppliers, :purchasable, :purchase_uom,
+                  :quantity_on_confirmed_purchase_orders, :quantity_outbound, :quantity_returned,
+                  :quantity_sold, :quantity_waiting_consumption, :quantity_wip, :safety_stock_days,
+                  :sale_uom, :scan_required, :ship_from_stock_if_available, :type,
+                  :upc, :use_name_as_customs_description, :weight, :weight_uom,
+                  :width, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/purchase_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::PurchaseRequest` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class PurchaseRequest < Resource
+    attr_accessor :id, :party, :product, :quantity, :attachments, :company,
+                  :create_date, :create_uid, :customer, :delivery_address,
+                  :metadata, :purchase, :purchase_date, :purchase_line, :state,
+                  :uom, :warehouse, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/resource.rb

@@ -16,8 +16,8 @@ module ErpIntegration
   #     config.order_adapter = :fulfil
   #   end
   #
-  #   $ ErpIntegration::Order.adapter
-  #   => #<ErpIntegration::Orders::FulfilOrder />
+  #   $ ErpIntegration::SalesOrder.adapter
+  #   => #<ErpIntegration::SalesOrders::FulfilOrder />
   #
   # To add a new resource, follow these steps:
   #   1. Add a new `attr_writer` in the `ErpIntegration::Configuration` class.

data/lib/erp_integration/sales_order.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::SalesOrder` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class SalesOrder < Resource
+    attr_accessor :id, :channel, :number, :party, :sale_date, :shipment_address,
+                  :amount_invoiced, :attachments, :carrier, :carrier_service,
+                  :channel_identifier, :comment, :company, :confirmation_time,
+                  :create_date, :currency, :description, :gateway_transaction,
+                  :invoice_address, :invoice_method, :invoice_state, :invoices,
+                  :lines, :metadata, :payment_term, :payment_total, :price_list,
+                  :reference, :sales_person, :shipment_amount, :shipment_method,
+                  :shipment_state, :shipments, :shipping_start_date, :state,
+                  :tax_amount, :total_amount, :total_quantity, :total_shipment_cost,
+                  :untaxed_amount, :warehouse, :weight, :weight_uom, :write_date,
+                  :write_uid
+
+    def cancel
+      self.class.adapter.cancel(id)
+    end
+  end
+end

data/lib/erp_integration/sales_order_line.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::SalesOrderLine` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class SalesOrderLine < Resource
+    attr_accessor :id, :product, :quantity, :unit, :unit_price, :amount, :attachments,
+                  :channel_identifier, :create_date, :create_uid, :delivery_address,
+                  :delivery_date, :delivery_mode, :description, :discount, :gift_message,
+                  :gross_profit_cpny_cc, :is_gift_card, :list_price, :listing_sku,
+                  :metadata, :note, :options, :purhcase_request, :quantity_canceled,
+                  :quantity_reserved, :quantity_shipped, :return_reason, :sale,
+                  :sequence, :shipping_date, :taxes, :type, :warehouse, :write_date,
+                  :write_uid
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -3,7 +3,6 @@
 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/module/attribute_accessors' # Allows using `delegate_missing_to`
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
@@ -21,8 +20,11 @@ require_relative 'erp_integration/fulfil/client'
 # The `ErpIntegration` integrates Mejuri with third-party ERP vendors.
 module ErpIntegration
   # Resources
-  autoload :Resource, 'erp_integration/resource'
-  autoload :Order, 'erp_integration/order'
+  autoload :Product, 'erp_integration/product'
   autoload :PurchaseOrder, 'erp_integration/purchase_order'
   autoload :PurchaseOrderLine, 'erp_integration/purchase_order_line'
+  autoload :PurchaseRequest, 'erp_integration/purchase_request'
+  autoload :Resource, 'erp_integration/resource'
+  autoload :SalesOrder, 'erp_integration/sales_order'
+  autoload :SalesOrderLine, 'erp_integration/sales_order_line'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,16 +48,22 @@ dependencies:
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -257,18 +263,23 @@ files:
 - lib/erp_integration/errors.rb
 - lib/erp_integration/fulfil/api_resource.rb
 - lib/erp_integration/fulfil/client.rb
-- lib/erp_integration/fulfil/collection.rb
 - lib/erp_integration/fulfil/query.rb
 - lib/erp_integration/fulfil/query_methods.rb
-- lib/erp_integration/fulfil/resources/order.rb
+- lib/erp_integration/fulfil/resources/product.rb
 - lib/erp_integration/fulfil/resources/purchase_order.rb
 - lib/erp_integration/fulfil/resources/purchase_order_line.rb
+- 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/where_clause.rb
 - lib/erp_integration/middleware/error_handling.rb
-- lib/erp_integration/order.rb
+- lib/erp_integration/product.rb
 - lib/erp_integration/purchase_order.rb
 - lib/erp_integration/purchase_order_line.rb
+- lib/erp_integration/purchase_request.rb
 - lib/erp_integration/resource.rb
+- lib/erp_integration/sales_order.rb
+- lib/erp_integration/sales_order_line.rb
 - lib/erp_integration/version.rb
 homepage: https://www.github.com/mejuri-inc/erp-integration
 licenses:

data/lib/erp_integration/fulfil/collection.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ErpIntegration
-  module Fulfil
-    # The `Collection` class provides an enumerable interface for the `ApiResource`
-    # to consume. It turns all the given items into the passed resource class.
-    #
-    # @example
-    #   $ Collection.new([...], resource_klass: ErpIntegration::Order)
-    #   # => <Collection @items=[<ErpIntegration::Order ... />, <ErpIntegration::Order ... />]
-    class Collection
-      include Enumerable
-      attr_reader :items
-
-      def initialize(items, resource_klass:)
-        @items = items.map { |item| resource_klass.new(item) }
-      end
-
-      # The `each` method turns the `Collection` instance into an enumerable object.
-      # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
-      def each(&block)
-        @items.each(&block)
-      end
-    end
-  end
-end

data/lib/erp_integration/order.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ErpIntegration
-  # The `ErpIntegration::Order` exposes an uniformed API for interaction with
-  # third-party ERP vendors.
-  class Order < Resource
-    attr_accessor :id, :number
-  end
-end