usps-imis-api 0.6.11 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd7f53417285bbe15766b1e79e88448807a1e481f13cb20a16d1bfb791a96f15
-  data.tar.gz: fb6c040f10270293db091bd20c25de73679de83fd24bf1253cbd50f82e53c1e3
+  metadata.gz: ce718cab17b65f021cb739faa943d2437f2f4e83f051ad50c37a9ae0cfe48131
+  data.tar.gz: 34cece880ed383d43536f915b1c9480fe557587a61d69c9ed32c061932bbfd3a
 SHA512:
-  metadata.gz: e65d398030e74648c5c0ceadcc1ab9bd3b94e481d5c20c14761d30e3efa4dcb6a3293e1b4d2d5de2f3678acd8cac80f0051074cff86c99386023e097ce3e2b4e
-  data.tar.gz: f436a6c796ffef704e7fd73ceb59e9352b77bb1a35efa0cbf96909e47a3ee7c24fbf4288cbe413941da49e6bf69c8b88aa2a952c0426523ec4ff9b5ae8f2c3df
+  metadata.gz: a05b5e0bc67ac874b306e688decd19d61c28d4a734165817395f2194a5ac2e166c5e75bcfc900488036f83941c81b4fd0c840810a261813d8b2ae343d5597608
+  data.tar.gz: aa402f52a26d2eb0d44928d9461707bc671d6ebf4f3e85325407762d2529b09668b02c2970f58528ad125d1e36c87718439817307f676b0858d764ac358cc7df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.11)
+    usps-imis-api (0.6.13)
       activesupport (~> 8.0)
 
 GEM

data/lib/usps/imis/api.rb

@@ -113,13 +113,32 @@ module Usps
         JSON.parse(result.body)
       end
 
+      # Run an IQA Query, paging through all responses
+      #
+      # @param query_name [String] Full path of the query in IQA, e.g. +$/_ABC/Fiander/iMIS_ID+
+      # @query_params [Hash] Conforms to pattern +{ param_name => param_value }+
+      #
+      # @return [Array<Hash>] Collected response item values from the API
+      #
+      def query_all(query_name, query_params = {})
+        response = query(query_name, **query_params)
+        results = response['Items']['$values']
+
+        while response['HasNext']
+          response = query(query_name, **query_params, Offset: response['NextOffset'])
+          results += response['Items']['$values']
+        end
+
+        results
+      end
+
       # An instance of +BusinessObject+, using this instance as its parent +Api+
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def business_object(business_object_name, url_id: nil)
-        BusinessObject.new(self, business_object_name, url_id:)
+      def business_object(business_object_name, ordinal: nil)
+        BusinessObject.new(self, business_object_name, ordinal:)
       end
 
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
@@ -127,15 +146,13 @@ module Usps
       # If no block is given, this returns the specified +BusinessObject+.
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def on(business_object_name, url_id: nil, &)
-        object = business_object(business_object_name, url_id:)
+      def on(business_object_name, ordinal: nil, &)
+        object = business_object(business_object_name, ordinal:)
         return object unless block_given?
 
-        result = nil
-        object.tap { |obj| result = obj.instance_eval(&) }
-        result
+        object.instance_eval(&)
       end
 
       # An instance of +Mapper+, using this instance as its parent +Api+

data/lib/usps/imis/business_object.rb

@@ -18,16 +18,16 @@ module Usps
       #
       attr_reader :business_object_name
 
-      # Override ID param of the URL (e.g. used for Panels)
+      # Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      attr_reader :url_id
+      attr_reader :ordinal
 
       # A new instance of +BusinessObject+
       #
-      def initialize(api, business_object_name, url_id: nil)
+      def initialize(api, business_object_name, ordinal: nil)
         @api = api
         @business_object_name = business_object_name
-        @url_id = url_id
+        @ordinal = ordinal
       end
 
       # Get a business object for the current member
@@ -84,7 +84,7 @@ module Usps
       # @return [Hash] Response data from the API
       #
       def post(body)
-        request = Net::HTTP::Post.new(uri)
+        request = Net::HTTP::Post.new(uri(id: ''))
         request.body = JSON.dump(body)
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
@@ -107,12 +107,20 @@ module Usps
 
       # Construct a business object API endpoint address
       #
-      def uri
-        id_for_url = url_id ? CGI.escape(url_id) : api.imis_id
-        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_url}"
+      def uri(id: nil)
+        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_uri(id)}"
         URI(File.join(Imis.configuration.hostname, full_path))
       end
 
+      # Select the correct ID to use in the URI
+      #
+      def id_for_uri(id = nil)
+        return CGI.escape(id) unless id.nil?
+        return CGI.escape("~#{api.imis_id}|#{ordinal}") if ordinal
+
+        api.imis_id
+      end
+
       # Manually assemble the matching data structure, with fields in the correct order
       #
       def filter_fields(fields)

data/lib/usps/imis/panel/base_panel.rb

@@ -20,7 +20,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def get(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").get
+          api.on(business_object, ordinal:).get
         end
 
         # Create a new object in the Panel
@@ -28,7 +28,7 @@ module Usps
         # @param data [Hash] The record data for the desired object
         #
         def create(data)
-          api.business_object(business_object, url_id: '').post(payload(data))
+          api.on(business_object).post(payload(data))
         end
 
         # Update an existing object in the Panel
@@ -37,9 +37,7 @@ module Usps
         #                    +ordinal+ identifier
         #
         def update(data)
-          api
-            .business_object(business_object, url_id: "~#{api.imis_id}|#{data[:ordinal]}")
-            .put(payload(data))
+          api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
         end
 
         # Remove a specific object from the Panel
@@ -47,7 +45,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def destroy(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").delete
+          api.on(business_object, ordinal:).delete
         end
 
       private

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.11'
+    VERSION = '0.6.13'
   end
 end

data/spec/lib/usps/imis/api_spec.rb

@@ -37,6 +37,21 @@ describe Usps::Imis::Api do
     end
   end
 
+  describe '#query_all' do
+    before do
+      allow(api).to receive(:query).and_return(
+        { 'Items' => { '$values' => [{ 'key1' => 'value1' }] }, 'HasNext' => true, 'NextOffset' => 1 },
+        { 'Items' => { '$values' => [{ 'key1' => 'value2' }] }, 'HasNext' => false, 'NextOffset' => 0 }
+      )
+    end
+
+    it 'collects all query results' do
+      expect(api.query_all('$/ABC/ExampleQueryAll')).to eq(
+        [{ 'key1' => 'value1' }, { 'key1' => 'value2' }]
+      )
+    end
+  end
+
   describe '#put' do
     before { api.imis_id = 31092 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.6.13
 platform: ruby
 authors:
 - Julian Fiander