erp_integration 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373cc92b70776b3ab2547879840468b0b5e2c9269aaf4991a1e3c283435609c4
-  data.tar.gz: cd372fe6aed0b7f88ddcf0007ad895386a75ca593a0bfff4ce978cad8de84cce
+  metadata.gz: 99b2b058b12b3b5d0b1212c9d077b9aaa224a9a20bc96f624dd7b5de3016bcaa
+  data.tar.gz: de266b8b0bb2c412866bf64ba0a28b75500faf79173e8d9bb1d56fd84c0a45b0
 SHA512:
-  metadata.gz: e711394078bb8e517436cd9b10f4231248cbef3bf6bb744834270e305e6329e0672611761b091d98a53fcd5d00f7f781ef2309b76c4db64cbe2bbd8b2ad3a519
-  data.tar.gz: 5490ad8f93dfabc1e77d8ef326ab34ee29d62b416f061cf83780f49fcb7d42882aab46e29e16e36f730ba7555a1d1482b55a2f45255fb71b252b5758a9cdf58b
+  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/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,15 +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 `OrderLine` resource. When none is
+    # 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 :order_line_adapter
+    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.
@@ -53,12 +58,16 @@ module ErpIntegration
       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 order_line_adapter
-      @order_line_adapter || :fulfil
+    def product_adapter
+      @product_adapter || :fulfil
     end
 
     def purchase_order_adapter

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/{order.rb → sales_order.rb}

@@ -5,20 +5,14 @@ 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.
         # @param id [Integer|String] The ID of the to be cancelled order.
         # @return [boolean] Whether the sales order was cancelled successfully or not.
         def cancel(id)
-          begin
-            client.put("model/sale.sale/#{id}/cancel")
-          rescue Faraday::Error::ParsingError
-            # 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.
-          end
+          client.put("model/sale.sale/#{id}/cancel")
           true
 
         # Fulfil will return an 400 (a.k.a. "Bad Request") status code when a sales order couldn't
@@ -28,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/{order_line.rb → sales_order_line.rb}

@@ -5,7 +5,7 @@ require_relative '../api_resource'
 module ErpIntegration
   module Fulfil
     module Resources
-      class OrderLine < ApiResource
+      class SalesOrderLine < ApiResource
         self.model_name = 'sale.line'
       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/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/{order.rb → sales_order.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  # The `ErpIntegration::Order` exposes an uniformed API for interaction with
+  # The `ErpIntegration::SalesOrder` exposes an uniformed API for interaction with
   # third-party ERP vendors.
-  class Order < Resource
+  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,

data/lib/erp_integration/{order_line.rb → sales_order_line.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  # The `ErpIntegration::OrderLine` exposes an uniformed API for interaction with
+  # The `ErpIntegration::SalesOrderLine` exposes an uniformed API for interaction with
   # third-party ERP vendors.
-  class OrderLine < Resource
+  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,

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -20,10 +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 :OrderLine, 'erp_integration/order_line'
+  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.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-14 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
@@ -218,7 +224,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.2
-description: 
+description:
 email:
 - stefan@knowndecimal.com
 executables: []
@@ -259,19 +265,21 @@ files:
 - lib/erp_integration/fulfil/client.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/order_line.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/order_line.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:
@@ -281,7 +289,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
@@ -297,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors
 test_files: []