erp_integration 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c09fbc8ebeff2b8b907e88e8b9bc147aefba15d5f7c1245de69cf66b24a8e6
-  data.tar.gz: c4ffdceea9bd5510bbee71647868e54a1ef36cc58bd7832a9333216811a3dd81
+  metadata.gz: 54fc417ece0422718783a178a6a70d86e9d822d0a195996463e07d07a67aeb21
+  data.tar.gz: a3252c16fc30517a4829b0e617b5c9b4d3d8fd26d86ef1562af33ac1ceb953b9
 SHA512:
-  metadata.gz: 4e7a15d4a90a16905aab8c8be40e751c3b16148ad616631e6adad6033fdf444eeaeb9d6f37e30ba4639f17f5a1a7e800281051a2e98e44aa93936e74eed7c0de
-  data.tar.gz: bfba3edd52a0529d5ca11457b12ab255c3aed41fb2ca08df17c2c09333fa7c22c76ce96a0b96436c84327b62442d4129429d5a928863e5185c3724d926ddcef2
+  metadata.gz: c4e59e843c9740007d99511ea3a5a364f57d0077e40826c2d7528c2c4665dcbb1ebc6ba4f217628b4584cf25f257fd39f944c5d214036232377acf0ce5e06caf
+  data.tar.gz: bd78fe69cc0d4218a18dda58291a6f18cb37a6d7ac922e80cfff298fb5352ac42848f097d97c6ce931ac134cf54ac0e445a9568b6979edb556e68ac7a6c8d42c

data/erp_integration.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '< 0.82.0'
   spec.add_development_dependency 'rubocop-rake', '~> 0.5'
   spec.add_development_dependency 'rubocop-rspec', '< 1.39.0'
-  spec.add_development_dependency 'webmock', '~> 3.17.0'
+  spec.add_development_dependency 'webmock', '~> 3.18.1'
 
   # The `parallel` gem is a dev dependency for Rubocop. However, the versions
   # for parallel after 1.19.2 don't work with ruby 2.3.x. As ruby 2.3.x is

data/lib/erp_integration/configuration.rb

@@ -175,6 +175,10 @@ module ErpIntegration
     def tracking_number_adapter
       @tracking_number_adapter || :fulfil
     end
+
+    def webhook_adapter
+      @webhook_adapter || :fulfil
+    end
   end
 
   # Returns ERP Integration's configuration.

data/lib/erp_integration/fulfil/query_methods.rb

@@ -8,24 +8,40 @@ module ErpIntegration
     module QueryMethods
       attr_accessor :selected_fields, :where_clauses
 
+      # The `QueryMethods#select` works in two unique ways
+      #
+      # First, it takes a block to allow it to function like a regular `Enumerable#select`.
+      #
+      # @example
+      #   $ ErpIntegration::SalesOrder.select { |sales_order| sales_order.id > 100  }
+      #   # => [<ErpIntegration::SalesOrder @id=101 />, <ErpIntegration::Resource @id=102 />]
+      #
+      # Secondly, it allows us to select specific fields to be returned by Fulfil.
+      #
       # Fulfil only returns an ID by default when one would query their API. However,
       # the ID is seldom the only value one will need. The `select` method allows
       # selecting multiple fields at once.
       #
       # @example
       #   $ ErpIntegration::SalesOrder.select(:id, :name, 'product.name')
-      #   # => <ErpIntegration::Fulfil::Resources::Order @selected_fields=[:id, :name, "product.name"] />
+      #   # => <ErpIntegration::Fulfil::Resources::SalesOrder @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::SalesOrder.select(:id, :name, 'product.name').all
-      #   # => <ErpIntegration::Fulfil::Collection @items=[...] />
+      #   # => [<ErpIntegration::SalesOrder @id=101 />, <ErpIntegration::Resource @id=102 />]
       #
       # Both a list of Strings, Symbols or a combination of these can be passed
       # to the `select` method.
       def select(*fields)
+        if block_given?
+          raise ArgumentError, "'select' with block doesn't take arguments." if fields.any?
+
+          return super()
+        end
+
         clone.select!(*fields)
       end
 

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../api_resource'
+
+module ErpIntegration
+  module Fulfil
+    module Resources
+      class Webhook < ApiResource
+        self.model_name = 'ir.webhook'
+
+        # Archives the webhook with the given ID.
+        # @param id [Integer] The ID of the webhook to archive.
+        # @return [Boolean] Whether the webhook was archived successfully or not.
+        def archive(id)
+          client.put("model/#{model_name}/archive", [[id]])
+          true
+        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
+
+        # Restores the webhook with the given ID.
+        # @param id [Integer] The ID of the webhook to be restored.
+        # @return [Boolean] Whether the webhook was restored successfully or not.
+        def restore(id)
+          client.put("model/#{model_name}/restore", [[id]])
+          true
+        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
+  end
+end

data/lib/erp_integration/version.rb

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

data/lib/erp_integration/webhook.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  # The `ErpIntegration::Webhook` exposes an uniformed API for interaction with
+  # third-party ERP vendors.
+  class Webhook < Resource
+    attr_accessor :id, :active, :attachments, :create_date, :create_uid, :event,
+                  :messages, :metadata, :metafields, :private_notes, :public_notes,
+                  :rec_blurb, :rec_name, :recent_deliveries, :secret, :url, :write_date,
+                  :write_uid
+
+    class << self
+      def archive(id)
+        adapter.archive(id)
+      end
+
+      def restore(id)
+        adapter.restore(id)
+      end
+    end
+  end
+end

data/lib/erp_integration.rb

@@ -37,6 +37,7 @@ module ErpIntegration
   autoload :StockMove, 'erp_integration/stock_move'
   autoload :SupplierShipment, 'erp_integration/supplier_shipment'
   autoload :TrackingNumber, 'erp_integration/tracking_number'
+  autoload :Webhook, 'erp_integration/webhook'
 
   module Resources
     autoload :Errors, 'erp_integration/resources/errors'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -202,14 +202,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.18.1
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -289,6 +289,7 @@ files:
 - lib/erp_integration/fulfil/resources/stock_move.rb
 - lib/erp_integration/fulfil/resources/supplier_shipment.rb
 - lib/erp_integration/fulfil/resources/tracking_number.rb
+- lib/erp_integration/fulfil/resources/webhook.rb
 - lib/erp_integration/fulfil/where_clause.rb
 - lib/erp_integration/middleware/error_handling.rb
 - lib/erp_integration/product.rb
@@ -307,6 +308,7 @@ files:
 - lib/erp_integration/supplier_shipment.rb
 - lib/erp_integration/tracking_number.rb
 - lib/erp_integration/version.rb
+- lib/erp_integration/webhook.rb
 homepage: https://www.github.com/mejuri-inc/erp-integration
 licenses:
 - MIT