erp_integration 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ef5b266cf00ceea7a3f9edda9f8a97245126b091cdae782ba847b02db82d55
-  data.tar.gz: b03d2ba35b1d16d810d00c1e23b608277ed636d565ce320dd2db15149dee7d4d
+  metadata.gz: cc78fc9da96c988f29c92bf41501a8827626453e66fdd806f51e16a9f1b8e1bc
+  data.tar.gz: 7f0d3551bdb15ae06fbe67c96ff2d257f14a61eddc3cbe56d554643ec767e6ae
 SHA512:
-  metadata.gz: 2210bedf6de54f4fcc4e215f6e7f9a357e4398b89555a1348c1baca68be74d763062b256b4f99ae08bd370646f23742f274d00ff3747370e06a54aca8747f2ff
-  data.tar.gz: 3b8a4877b3730a41b651ab6e2e637a14f2599b3718d3a9f3da8b2c2b1371478f8d520cae94a63835a45cfddf8cd5f175622bd61fdfad1502af99f201ff35ea29
+  metadata.gz: 642e6917b8580bece6dc22acde22db86f91060419a059eda273861c2c6bf02928220128e4123249533024cf9b88a3d9455208065b538dc82a3a3080ccebd7f69
+  data.tar.gz: 0f542badd49a4615043e4b237d48606d18c354091fe564d74a92a005846e22338c76b1abff03be6ac99c26f358d78f46ce205dec44c2cb8c02ddcccd5769f864

data/lib/erp_integration/fulfil/api_resource.rb

@@ -69,8 +69,8 @@ module ErpIntegration
               fields: selected_fields,
               filters: where_clauses,
               alternative_filters: or_clauses,
-              offset: offset_clause,
-              limit: limit_clause
+              offset: offset_value,
+              limit: limit_value
             )
           ).map { |item| resource_klass.new(item) }
       end

data/lib/erp_integration/fulfil/pagination_methods.rb

@@ -6,27 +6,36 @@ module ErpIntegration
       DEFAULT_OFFSET = 0
       MAX_LIMIT = 500 # Max limit set by FF
 
-      attr_accessor :offset_clause, :limit_clause
+      attr_accessor :offset_value, :limit_value
 
-      # 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
+      # The {#offset} method allows navigating through the returned resources from
+      # Fulfil's API endpoints just as with a regular database.
+      #
+      # @param value [Integer] The offset for the number of resources.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def offset(value)
+        clone.offset!(value)
+      end
 
+      def offset!(value)
+        self.offset_value = value
         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
+      # By default, Fulfil returns the first 500 records for every query to their
+      # API endpoints. With the {#limit} method, it's possible to modify the number
+      # of records to return.
+      #
+      # NOTE: The maximum limit is 500 per dictation of Fulfil.
+      #
+      # @param value [Integer] The number of resources to return.
+      # @return [ErpIntegration::Fulfil::ApiResource]
+      def limit(value)
+        clone.limit!(value)
+      end
 
+      def limit!(value)
+        self.limit_value = [value, MAX_LIMIT].min
         self
       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.18.0'
+  VERSION = '0.20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport