erp_integration 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ec55a600cfb88679e7c8ac4a8e397cd304312a5f85a7c2e54d63307d7c86ff
-  data.tar.gz: 106c3c7f314668d09bb8589d1ea5243e4586a705871f891edf95efd0d9228028
+  metadata.gz: 06ef5b266cf00ceea7a3f9edda9f8a97245126b091cdae782ba847b02db82d55
+  data.tar.gz: b03d2ba35b1d16d810d00c1e23b608277ed636d565ce320dd2db15149dee7d4d
 SHA512:
-  metadata.gz: 9b8cd54866c82420eed9237a40d8d668494763ed7ef15ac588a15d73260e163eb416a1fb8bc316cd4e08624dddfc70a99e99b3056b046ed4ebb0601298ae0728
-  data.tar.gz: 90e3145efef13b1d5f6307dd75a74811604cc2766f643970847d3570ff7dcba62fa11c252590b94d9f43f46df2b42352e1de754cf3a55a17f2472ce89a8fc980
+  metadata.gz: 2210bedf6de54f4fcc4e215f6e7f9a357e4398b89555a1348c1baca68be74d763062b256b4f99ae08bd370646f23742f274d00ff3747370e06a54aca8747f2ff
+  data.tar.gz: 3b8a4877b3730a41b651ab6e2e637a14f2599b3718d3a9f3da8b2c2b1371478f8d520cae94a63835a45cfddf8cd5f175622bd61fdfad1502af99f201ff35ea29

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '0.17.0'
+  VERSION = '0.18.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.18.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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