erp_integration 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b7edee1b77a371325210af94802cbd0d6c1df5d730bcfd8d9d326bc8a5eb2c3
-  data.tar.gz: d59ecb758fde883746da4fec059e99c53b71f7a526f81d7fa272eb139f567ff4
+  metadata.gz: 2636d8881ff93450aabba350ae21870e98ebf72dbe104b952567a37f49685fde
+  data.tar.gz: 84d2fc64b31a928e93d10c9090f7f1ebbbe187b933889437c62f914b6dacc72a
 SHA512:
-  metadata.gz: 0c34649c0ab233be00b9e9b35897faa934eb85824318528f7df4261b8f093319902d82636bd6e4cbba22d82afec604e6d4136b6f64ad7398ee2227aa5b17dca9
-  data.tar.gz: 70cac86409b77043c0d0ec4f62946d01b48bd96b4abfaaf88c3b57f9600ada205c505b072ac91836ca693621c37302e2223b65b2769e8157ff2fe0b4c734eb10
+  metadata.gz: bc1fe8cf4bd8739773092308b849f78fa40e740d347850b887f5e33f1d5df873d07635b9b66249ed5c9297e1405f0058f03d99eb433e9d32fdf330686c4cd129
+  data.tar.gz: 43e155e350b9e3cf3be08a3c08770213b5cf06f81c24d579971a75d62d173f21a3a6d49cd316ff9508df9d3548a0df444621870416f951663eacfd63d26265b9

data/lib/erp_integration/fulfil/persistence.rb

@@ -5,21 +5,26 @@ module ErpIntegration
     module Persistence
       # Allows creating new resources in Fulfil.
       #
-      # @example
-      #   $ ErpIntegration::Product.create(code: 'MT100eu', variant: 10)
-      #   => <ErpIntegration::Product @id=2 @code="MT100eu" @variant=10 />
-      #
-      # @param attributes [Hash] A list of attributes.
-      # @return [ErpIntegration::Resource] The newly created resource.
-      def create(attributes = {})
+      # @param attributes [Hash] A list of attributes for the new resource.
+      # @return [Array|Hash] The response from the API
+      def create(attributes)
         client
           .post("model/#{model_name}", normalize_attributes(attributes))
-          .map { |new_record_id| resource_klass.new(attributes.merge(id: new_record_id)) }
+          .map { |new_record_id| attributes.merge!(id: new_record_id) }
           .first
       rescue ErpIntegration::HttpError::BadRequest => e
-        record = resource_klass.new(attributes)
-        record.errors.add(extract_error_message(e))
-        record
+        [attributes, [extract_error_message(e)]]
+      end
+
+      # Updates the resource with the given attributes.
+      #
+      # @param resource_id [Integer] The ID of the resource.
+      # @param attributes [Hash] A list of attributes to update for the resource.
+      # @return [Array|Hash] The response from the API
+      def update(resource_id, attributes)
+        client.put("model/#{model_name}/#{resource_id}", attributes)
+      rescue ErpIntegration::HttpError::BadRequest => e
+        [attributes, [extract_error_message(e)]]
       end
 
       private

data/lib/erp_integration/resource.rb

@@ -29,22 +29,25 @@ module ErpIntegration
   #   5. Create a new adapter class prefixed with the adapter's name
   #      (e.g. `FulfilOrder` for the `Order` resource in the `lib/erp_integration/orders` folder).
   class Resource
+    include Resources::Validations
+    include Resources::Persistence
+
     attr_accessor :raw_api_response
 
     def initialize(attributes = {})
       @raw_api_response = attributes
+      assign_attributes(attributes)
+    end
 
+    # Allows assigning attributes to an resource instance.
+    # @param attributes [Hash] A list of attributes for the resource.
+    # @return [Hash] The list of assigned attributes.
+    def assign_attributes(attributes = {})
       attributes.each_pair do |name, value|
         public_send(:"#{name}=", value) if respond_to?(:"#{name}=")
       end
     end
 
-    # Exposes all errors related to an `ErpIntegration::Resource`.
-    # @return [ErpIntegration::Resources::Errors] Encapsulation of all error messages.
-    def errors
-      @errors ||= Resources::Errors.new
-    end
-
     class << self
       # Dynamically defines and loads the adapter for the class inheriting from
       # the `ErpIntegration::Resource`.

data/lib/erp_integration/resources/persistence.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Resources
+    module Persistence
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Creates a new resource in the ERP.
+        # @param attributes [Hash] A list of attributes for the new resource.
+        # @return [ErpIntegration::Resource] The (to be) created resource.
+        def create(attributes)
+          attrs, error_messages = adapter.create(**attributes)
+
+          new_resource = new(attrs)
+          new_resource.validate_with(error_messages)
+          new_resource
+        end
+      end
+
+      # Determines whether a `ErpIntegration::Resource` is considered to be persisted.
+      # @return [Boolean] Whether it's persisted or not.
+      def persisted?
+        !id.nil?
+      end
+
+      # Update an resource in the ERP.
+      # @param attributes [Hash] A list of attributes to update.
+      # @return [Boolean] Whether the update action was succcesful or not.
+      def update(attributes)
+        attrs, error_messages = self.class.adapter.update(id, **attributes)
+
+        assign_attributes(attrs)
+        validate_with(error_messages)
+      end
+    end
+  end
+end

data/lib/erp_integration/resources/validations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Resources
+    module Validations
+      # Exposes all errors related to an `ErpIntegration::Resource`.
+      #
+      # @return [ErpIntegration::Resources::Errors] Encapsulation of all error messages.
+      def errors
+        @errors ||= Resources::Errors.new
+      end
+
+      # Checks whether an resource is considered valid or not.
+      #
+      # @return [Boolean] Is the resource valid according to the ERP?
+      def valid?
+        errors.none?
+      end
+
+      # Validates the resource by checking the given error messages.
+      #
+      # @param error_messages [Array] A list of error messages.
+      # @return [Boolean] Whether the resource is valid or not.
+      def validate_with(*error_messages)
+        errors.clear
+
+        error_messages.flatten.compact.each do |error_message|
+          errors.add(error_message)
+        end
+
+        valid?
+      end
+    end
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration.rb

@@ -36,5 +36,7 @@ module ErpIntegration
 
   module Resources
     autoload :Errors, 'erp_integration/resources/errors'
+    autoload :Persistence, 'erp_integration/resources/persistence'
+    autoload :Validations, 'erp_integration/resources/validations'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,7 +224,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.2
-description: 
+description:
 email:
 - stefan@knowndecimal.com
 executables: []
@@ -291,6 +291,8 @@ files:
 - lib/erp_integration/purchase_request.rb
 - lib/erp_integration/resource.rb
 - lib/erp_integration/resources/errors.rb
+- lib/erp_integration/resources/persistence.rb
+- lib/erp_integration/resources/validations.rb
 - lib/erp_integration/sales_order.rb
 - lib/erp_integration/sales_order_line.rb
 - lib/erp_integration/stock_move.rb
@@ -304,7 +306,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
@@ -320,7 +322,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: []