erp_integration 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ec55a600cfb88679e7c8ac4a8e397cd304312a5f85a7c2e54d63307d7c86ff
-  data.tar.gz: 106c3c7f314668d09bb8589d1ea5243e4586a705871f891edf95efd0d9228028
+  metadata.gz: 07ca72811d7f1eb2659d9161890f3a43ce8b773e9637e55dea2e7c0f5b6d8d44
+  data.tar.gz: 7ab55ad7cf24cbbf761e344f5a8a4a91fca2110637f28112d47ce49a0b11e639
 SHA512:
-  metadata.gz: 9b8cd54866c82420eed9237a40d8d668494763ed7ef15ac588a15d73260e163eb416a1fb8bc316cd4e08624dddfc70a99e99b3056b046ed4ebb0601298ae0728
-  data.tar.gz: 90e3145efef13b1d5f6307dd75a74811604cc2766f643970847d3570ff7dcba62fa11c252590b94d9f43f46df2b42352e1de754cf3a55a17f2472ce89a8fc980
+  metadata.gz: cb0053f0c8d31c3e3fd003aa9c65e141be176f4f60c787a132ffd3dc16300ecdca01be39e2b2c4e7897f5120464957979ab052139e4a381033e5f1467860bedd
+  data.tar.gz: 9987a496c6ee7bbd02f5faa92f3fb93172544ee999444d9f2851bbc30cbb59b3fe1ca10b424187f27e553eb0fd947ebe6118190546e167679c0166e4f840f9e5

data/lib/erp_integration/fulfil/api_resource.rb

@@ -2,6 +2,7 @@
 
 require_relative 'context'
 require_relative 'finder_methods'
+require_relative 'pagination_methods'
 require_relative 'persistence'
 require_relative 'query_methods'
 
@@ -11,6 +12,7 @@ module ErpIntegration
       include Context
       include Enumerable
       include FinderMethods
+      include PaginationMethods
       include Persistence
       include QueryMethods
 
@@ -63,10 +65,35 @@ module ErpIntegration
         @results =
           client.put(
             api_resource_path,
-            Query.new(selected_fields, where_clauses, or_clauses)
+            Query.new(
+              fields: selected_fields,
+              filters: where_clauses,
+              alternative_filters: or_clauses,
+              offset: offset_clause,
+              limit: limit_clause
+            )
           ).map { |item| resource_klass.new(item) }
       end
 
+      # As with the `all` method, the `query methods` lazyly build a search/read
+      # or search/count query for Fulfil.
+      # By calling `count`, the prepared search/count will actually be executed and
+      # the result will be fetched
+      # @return [Integer] The count of records that match with the query in Fulfil
+      def count
+        return @count if defined?(@count)
+
+        @count =
+          client.put(
+            "model/#{model_name}/search_count",
+            Query.new(
+              fields: nil,
+              filters: where_clauses,
+              alternative_filters: or_clauses
+            ).to_h.except(:fields, :offset, :limit)
+          )
+      end
+
       # The `each` method turns the `ApiResource` instance into an enumerable object.
       # For more information, see https://ruby-doc.org/core-3.0.2/Enumerable.html
       def each(&block)

data/lib/erp_integration/fulfil/pagination_methods.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ErpIntegration
+  module Fulfil
+    module PaginationMethods
+      DEFAULT_OFFSET = 0
+      MAX_LIMIT = 500 # Max limit set by FF
+
+      attr_accessor :offset_clause, :limit_clause
+
+      # Fulfil by default is returning us the first 500 records on every query that we made.
+      # The `offset` method, as the name sais, will allow us to move the offset of the results.
+      # @example
+      #   $ ErpIntegration::SalesOrder.offset(10).all
+      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @offset=10 />] />
+      def offset(offset)
+        self.offset_clause = offset
+
+        self
+      end
+
+      # Fulfil by default is returning us the first 500 records on every query that we made.
+      # The `limit` method will allow us to modify the amount of records that we want to receive.
+      # @example
+      #   $ ErpIntegration::SalesOrder.limit(5).all
+      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @limit=5 />] />
+      def limit(limit)
+        self.limit_clause = [limit, MAX_LIMIT].min
+
+        self
+      end
+    end
+  end
+end

data/lib/erp_integration/fulfil/query.rb

@@ -18,22 +18,32 @@ module ErpIntegration
     # @example
     #   Faraday.post("/api-endpoint", Query.new([:id, 'product.id'], [WhereClause.new(key: :id, value: 100)]))
     class Query
-      attr_reader :fields, :filters
+      delegate :to_json, to: :to_h
+
+      attr_reader :fields, :filters, :offset, :limit
+
       DEFAULT_FIELDS = %w[id].freeze
 
       # @param fields [Array<String|Symbol>] A list of fields for Fulfil.
       # @param filters [Array<WhereClause>] A list of where clauses for Fulfil.
-      def initialize(fields, filters, alternative_filters = [])
+      # @param alternative_filters [Array<OrClause>] A list of or clauses for Fulfil.
+      # @param offset [Integer] Offset for pagination.
+      # @param limit [Integer] Limit for pagination.
+      def initialize(fields:, filters:, alternative_filters: [], offset: nil, limit: nil)
         @fields = (fields || DEFAULT_FIELDS).map(&:to_s).uniq
         @filters = (filters || []).map(&:to_filter).uniq
         @filters += alternative_filters.map(&:to_filter).uniq if alternative_filters&.any?
+        @offset = offset
+        @limit = limit
       end
 
-      def to_json(*_object)
+      def to_h
         {
           fields: @fields,
-          filters: @filters
-        }.to_json
+          filters: @filters,
+          offset: @offset,
+          limit: @limit
+        }
       end
     end
   end

data/lib/erp_integration/fulfil/query_methods.rb

@@ -71,12 +71,13 @@ module ErpIntegration
       end
 
       def where!(args)
+        domain = args.delete(:domain)
         comparison_operator = args.delete(:comparison_operator)
 
         args.each_pair do |key, value|
           self.where_clauses =
             (where_clauses || []) << WhereClause.new(
-              key: key, value: value, comparison_operator: comparison_operator
+              key: key, value: value, domain: domain, comparison_operator: comparison_operator
             )
         end
 
@@ -124,6 +125,24 @@ module ErpIntegration
         self
       end
 
+      # The `where_domain` method provides an interface for querying resources
+      # in Fulfil when filtered attributes require specifying
+      # the name of the domain model in which they are located.
+      #
+      # @example
+      #   $ ErpIntegration::SalesOrder.where_domain('stock.shipment.out', 'shipment.state': 'done').all
+      #   # => <ErpIntegration::Fulfil::Collection @items=[<ErpIntegration::SalesOrder @id=100 />] />
+      #
+      # Adds the domain model name as a fourth argument to each filers parameter
+      #
+      # @example
+      #   :filters=>[
+      #     ['shipment.state', '=', 'done', 'stock.shipment.out']
+      #   ]
+      def where_domain(domain, args)
+        where(args.merge!(domain: domain))
+      end
+
       def where_ilike(args)
         where(args.merge(comparison_operator: 'ilike'))
       end

data/lib/erp_integration/fulfil/where_clause.rb

@@ -23,16 +23,21 @@ module ErpIntegration
 
       DEFAULT_COMPARISON_OPERATOR = '='
 
-      def initialize(key:, value:, comparison_operator: DEFAULT_COMPARISON_OPERATOR)
+      # @param key [String] The name of filtered attribute.
+      # @param value [String] The value by filtering will be performed.
+      # @param domain [String] The domain model name to specify filtering attributes location.
+      # @param comparison_operator [String] The way the key and the value are compared.
+      def initialize(key:, value:, domain: nil, comparison_operator: DEFAULT_COMPARISON_OPERATOR)
         @comparison_operator = verify_comparison_operator(comparison_operator)
         @key = key.to_s
         @value = value
+        @domain = domain
       end
 
       # Transforms the `WhereClause` into a filter object for Fulfil.
       # @return [Array<String>] The formatted filter for Fulfil.
       def to_filter
-        [@key, @comparison_operator, @value]
+        [@key, @comparison_operator, @value, @domain].compact
       end
 
       # The `===` allows comparing different WhereClause objects. Under the hood,

data/lib/erp_integration/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Stefan Vermaas
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-24 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: []
@@ -272,6 +272,7 @@ files:
 - lib/erp_integration/fulfil/context.rb
 - lib/erp_integration/fulfil/finder_methods.rb
 - lib/erp_integration/fulfil/or_clause.rb
+- lib/erp_integration/fulfil/pagination_methods.rb
 - lib/erp_integration/fulfil/persistence.rb
 - lib/erp_integration/fulfil/query.rb
 - lib/erp_integration/fulfil/query_methods.rb
@@ -320,7 +321,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
@@ -335,8 +336,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.11
+signing_key: 
 specification_version: 4
 summary: Connects Mejuri with third-party ERP vendors
 test_files: []