erp_integration 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca1bd38eb31b94933e07d32c1dfb1878b734fef2d001a84e56cf788697afe666
-  data.tar.gz: ed521ad8c1b95896aa152cbd113b63eda01ab49c47888270a4bfc5d6bf7b6662
+  metadata.gz: 346594300ff75a2d7f21a9e226287fe43b8b4765105d80d73840e4ff8fd9c355
+  data.tar.gz: 67b680a54fec9cb91866b6d9658dc7eeb4a63168f76826a7bba421148c0a77a5
 SHA512:
-  metadata.gz: 0ef6a74cf99711e42a3d64c30e44ff2cd65a445ed0f714c6a60fba6a56f895103e51fc74cbb767f719bab90af73dda54120607d41a16a63599b7dacb80b04c07
-  data.tar.gz: 818024cb6d381c71f883c8f5811eae27bfc29f9f2e245383c4600718651710abbc91f6021005182795e564a58f08fb4f825c1b957fd285e718363adcb3f36e28
+  metadata.gz: 5e36d2c2d1b0c5f231cef0477a5154fe4a101f262d9171f20cbb3fc051df8feff4655dcd9f5265634f241056a35a8562ca2caa580488b49d6c4c865fa4456aa1
+  data.tar.gz: b6dcd7aa6843c5e8686a2489ea88ba80c3a2ba543b941d00f652ef0621b0a6feaebc93c4ae9dcbab78f199e139fa7900060b46c7b812a96cffa0022821f3f36f

data/lib/erp_integration/bill_of_material.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::BillOfMaterial` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class BillOfMaterial < Resource
+    attr_accessor :active, :attachments, :cost, :create_date, :create_uid, :id,
+                  :inputs, :instructions, :is_built_on_the_fly, :location, :messages,
+                  :metadata, :name, :output_products, :outputs, :private_notes, :products,
+                  :public_notes, :quantity_buildable, :quantity_expected, :rec_blurb,
+                  :rec_name, :routing, :state, :supervisor, :version, :warehouse, :work_center,
+                  :write_date, :write_uid
+  end
+end

data/lib/erp_integration/bill_of_material_input.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::BillOfMaterialInput` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class BillOfMaterialInput < Resource
+    attr_accessor :attachments, :bom, :create_date, :create_uid, :id, :messages,
+                  :metadata, :private_notes, :product, :public_notes, :quantity,
+                  :rec_blurb, :rec_name, :sequence, :to_location, :unit_digits,
+                  :uom, :uom_category, :warehouse, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/bill_of_material_output.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::BillOfMaterialOutput` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class BillOfMaterialOutput < Resource
+    attr_accessor :attachments, :bom, :create_date, :create_uid, :id, :messages,
+                  :metadata, :private_notes, :product, :public_notes, :quantity,
+                  :rec_blurb, :rec_name, :sequence, :to_location, :unit_digits,
+                  :uom, :uom_category, :warehouse, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/configuration.rb

@@ -22,11 +22,31 @@ module ErpIntegration
     # @return [String] The merchant ID for Fulfil.
     attr_accessor :fulfil_merchant_id
 
+    # Allows configuring an adapter for the `BillOfMaterial` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the bill_of_material.
+    attr_writer :bill_of_material_adapter
+
+    # Allows configuring an adapter for the `BillOfMaterialInput` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the Bill of Material's input.
+    attr_writer :bill_of_material_input_adapter
+
+    # Allows configuring an adapter for the `BillOfMaterialOutput` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the bill_of_material.
+    attr_writer :bill_of_material_output_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 `ProductionOrder` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the production_order.
+    attr_writer :production_order_adapter
+
     # Allows configuring an adapter for the `PurchaseOrder` resource. When none is
     # configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the purchase orders.
@@ -68,10 +88,26 @@ module ErpIntegration
       end
     end
 
+    def bill_of_material_adapter
+      @bill_of_material_adapter || :fulfil
+    end
+
+    def bill_of_material_input_adapter
+      @bill_of_material_input_adapter || :fulfil
+    end
+
+    def bill_of_material_output_adapter
+      @bill_of_material_output_adapter || :fulfil
+    end
+
     def product_adapter
       @product_adapter || :fulfil
     end
 
+    def production_order_adapter
+      @production_order_adapter || :fulfil
+    end
+
     def purchase_order_adapter
       @purchase_order_adapter || :fulfil
     end

data/lib/erp_integration/errors.rb

@@ -17,6 +17,12 @@ module ErpIntegration
     end
   end
 
+  class ResourceNotFound < Error
+    def initialize
+      super "[ERP Integration] Couldn't find the requested resource."
+    end
+  end
+
   class HttpError < Faraday::Error
     class BadRequest < HttpError; end
     class AuthorizationRequired < HttpError; end

data/lib/erp_integration/fulfil/api_resource.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'finder_methods'
 require_relative 'query_methods'
 
 module ErpIntegration
   module Fulfil
     class ApiResource
       include Enumerable
+      include FinderMethods
       include QueryMethods
 
       attr_accessor :resource_klass

data/lib/erp_integration/fulfil/finder_methods.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Fulfil
+    # The `FinderMethods` add various, simplistic lookup methods to find API resources.
+    # These methods should be the last method in the chain as it will invoke the HTTP
+    # request to Fulfil immediately.
+    #
+    # If you need more attributes than the default ID attribute for an ApiResource
+    # to be returned, add the `select` method before the finder method is being called
+    # in your application code.
+    #
+    # @example
+    #   $ ErpIntegration::SalesOrder.select(:id, :product).find(100)
+    #   => <ErpIntegration::SalesOrder @id=100 @product=10 />
+    module FinderMethods
+      # Looks up an individual resource based on resource's ID.
+      #
+      # @example
+      #   $ ErpIntegration::SalesOrder.find(100)
+      #   => <ErpIntegration::SalesOrder @id=100 />
+      #
+      # @param id [Integer] The ID of the API resource.
+      # @return [ApiResource] The found resource in Fulfil.
+      def find(id)
+        find_by!(id: id) || raise(ResourceNotFound)
+      end
+
+      # Looks up an individual resource based on the given attributes.
+      #
+      # @example
+      #   $ ErpIntegration::SalesOrder.find_by(product: 10)
+      #   => <ErpIntegration::SalesOrder @id=100 />
+      #
+      # @return [ApiResource|nil] The found resource in Fulfil.
+      def find_by(args)
+        where(args).first
+      end
+
+      # Looks up an individual resource based on the given attributes and raises
+      # an `ErpIntegration::ResourceNotFound` when the resource doesn't exist.
+      #
+      # @example
+      #   $ ErpIntegration::SalesOrder.find_by!(product: 10)
+      #   => ErpIntegration::ResourceNotFound
+      #
+      # @return [ApiResource|nil] The found resource in Fulfil.
+      def find_by!(args)
+        find_by(args) || raise(ResourceNotFound)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class BillOfMaterialInput < ApiResource
+        self.model_name = 'production.bom.input'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class BillOfMaterialOutput < ApiResource
+        self.model_name = 'production.bom.output'
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module ErpIntegration
         # @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?
+          select(:boms).find_by!(code: sku).boms.any?
         end
         alias billing_of_materials? bom?
       end

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

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

data/lib/erp_integration/production_order.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::ProductionOrder` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class ProductionOrder < Resource
+    attr_accessor :allow_partial_done, :attachments, :bom, :byproduct_cost, :company,
+                  :company_currency_digits, :cost, :create_date, :create_uid, :effective_date,
+                  :effective_start_date, :from_location, :inputs, :inventory_cost, :inventory_cost_cache,
+                  :labor_cost, :labor_cost_cache, :last_modification, :location, :messages, :metadata, :number,
+                  :on_hold, :origin, :outputs, :outsourced_work_cost, :outsourced_work_cost_cache, :picked_at,
+                  :picker, :picking_status, :planned_date, :planned_start_date, :priority, :private_notes, :product,
+                  :product_code, :production_batch, :public_notes, :purchase_lines, :quantity, :quantity_done,
+                  :quantity_remaining, :rec_blurb, :description, :id, :subtitle, :thumbnail, :title, :rec_name,
+                  :reference, :reporting_date, :routing, :sales_order_number, :sales_order_reference, :shipments,
+                  :state, :supervisor, :to_location, :tsv, :unit_digits, :uom, :uom_category, :warehouse, :work_center,
+                  :works, :write_date, :write_uid
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -20,7 +20,11 @@ require_relative 'erp_integration/fulfil/client'
 # The `ErpIntegration` integrates Mejuri with third-party ERP vendors.
 module ErpIntegration
   # Resources
+  autoload :BillOfMaterial, 'erp_integration/bill_of_material'
+  autoload :BillOfMaterialInput, 'erp_integration/bill_of_material_input'
+  autoload :BillOfMaterialOutput, 'erp_integration/bill_of_material_output'
   autoload :Product, 'erp_integration/product'
+  autoload :ProductionOrder, 'erp_integration/production_order'
   autoload :PurchaseOrder, 'erp_integration/purchase_order'
   autoload :PurchaseOrderLine, 'erp_integration/purchase_order_line'
   autoload :PurchaseRequest, 'erp_integration/purchase_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -259,13 +259,21 @@ files:
 - bin/setup
 - erp_integration.gemspec
 - lib/erp_integration.rb
+- lib/erp_integration/bill_of_material.rb
+- lib/erp_integration/bill_of_material_input.rb
+- lib/erp_integration/bill_of_material_output.rb
 - lib/erp_integration/configuration.rb
 - lib/erp_integration/errors.rb
 - lib/erp_integration/fulfil/api_resource.rb
 - lib/erp_integration/fulfil/client.rb
+- lib/erp_integration/fulfil/finder_methods.rb
 - lib/erp_integration/fulfil/query.rb
 - lib/erp_integration/fulfil/query_methods.rb
+- 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/product.rb
+- lib/erp_integration/fulfil/resources/production_order.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
@@ -276,6 +284,7 @@ files:
 - lib/erp_integration/fulfil/where_clause.rb
 - lib/erp_integration/middleware/error_handling.rb
 - lib/erp_integration/product.rb
+- lib/erp_integration/production_order.rb
 - lib/erp_integration/purchase_order.rb
 - lib/erp_integration/purchase_order_line.rb
 - lib/erp_integration/purchase_request.rb