erp_integration 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba635456dc688941f6d3a1d52b48f9a24ef6a6ccfd8ebb5f522749b6054546b
-  data.tar.gz: 802f67bc96c101f8945a27c8925b2690d4d7513f2435457c69fee91f9fad2de0
+  metadata.gz: 346594300ff75a2d7f21a9e226287fe43b8b4765105d80d73840e4ff8fd9c355
+  data.tar.gz: 67b680a54fec9cb91866b6d9658dc7eeb4a63168f76826a7bba421148c0a77a5
 SHA512:
-  metadata.gz: acd6cb73c26c593d2c01e78ca994274a84c4bbaea429542f21b524411fef9ab3e1e4e1b3bbf84bdf17cb8c2e66efef4969bed6531bcbd165acde0dbd87195952
-  data.tar.gz: '0680d849ab5f42043ec2a8903c1f139e7c180e295737218cb83511c83122ecf3e3f038e0bc2943aed51da85f8b24dade4ee858e4eb1a158d39dbd4109ab815a8'
+  metadata.gz: 5e36d2c2d1b0c5f231cef0477a5154fe4a101f262d9171f20cbb3fc051df8feff4655dcd9f5265634f241056a35a8562ca2caa580488b49d6c4c865fa4456aa1
+  data.tar.gz: b6dcd7aa6843c5e8686a2489ea88ba80c3a2ba543b941d00f652ef0621b0a6feaebc93c4ae9dcbab78f199e139fa7900060b46c7b812a96cffa0022821f3f36f

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -266,6 +266,7 @@ files:
 - 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