usps-imis-api 0.6.10 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5103e3c7de24d79be7d86bfd21883d572d5cc88f6c58509973ab2bcce3d99202
-  data.tar.gz: 1e96b2dbf536e4205f2fb721ddba91cd2640af1893c30db3d911fea6824b6ea9
+  metadata.gz: 03dbc937f5336d48ede502436a3ddcee7d77f8f357d18d807ac4119b52acf7e8
+  data.tar.gz: 9052ead6d9fb967e5faadb730d7000f32d0e97e83545e60fdef7e9a0b3deda18
 SHA512:
-  metadata.gz: 53fa63489cda9a6dd09401605daf22329cad3a6f2f3313b068eb3ecd339d9ceff518134305601a2591451acdd03723f566096cb2bcc754c90da03d79d32de315
-  data.tar.gz: df0052735b664cc91e4d4b923b1c7ecffe065acc44d320624cc84e834607f557df7c3c39b04cc95410642de07df665da56700c9d543be3cb0f15e1644bf12f15
+  metadata.gz: 33d7ced678ecc240e405b73fe5ba6c006fedece86612f76018296166c53e8226996b27617fb1a7212f885c4a5107c9c03186ad922106ccc79714e6a522127fd9
+  data.tar.gz: 78b04d51fde868adf81b86231083bdafdb6f08a7f6e7664ba3406b65557be09bb875cc9f1c37846a353872f784cdc872506b27415150ad1b5f79363b5baf29aa

data/Gemfile.lock

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

data/lib/usps/imis/api.rb

@@ -113,6 +113,25 @@ 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

data/lib/usps/imis/{mock.rb → business_object_mock.rb}

@@ -4,7 +4,7 @@ module Usps
   module Imis
     # Mock data response for testing
     #
-    class Mock
+    class BusinessObjectMock
       attr_reader :fields
 
       def initialize(**fields)
@@ -18,6 +18,18 @@ module Usps
           fields.each { |name, value| props.add(name, value) }
         end
       end
+
+      def put_fields(data)
+        Usps::Imis::Properties.build do |props|
+          fields.merge(data.transform_keys(&:to_s)).each { |name, value| props.add(name, value) }
+        end
+      end
+
+      def put(data) = data
+
+      def post(data) = data
+
+      def delete = ''
     end
   end
 end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.10'
+    VERSION = '0.6.12'
   end
 end

data/lib/usps/imis.rb

@@ -23,7 +23,7 @@ require_relative 'imis/business_object'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/properties'
-require_relative 'imis/mock'
+require_relative 'imis/business_object_mock'
 require_relative 'imis/panel/base_panel'
 require_relative 'imis/panel/vsc'
 require_relative 'imis/panel/education'

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 }
 

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::BusinessObjectMock do
+  let(:mock) { described_class.new(**fields) }
+  let(:fields) { { TotMMS: 2 } }
+
+  let(:data) do
+    Usps::Imis::Properties.build do |props|
+      props.add 'TotMMS', 2
+    end
+  end
+
+  describe 'get' do
+    it 'returns the correct data' do
+      expect(mock.get).to eq(data)
+    end
+  end
+
+  describe 'get_field' do
+    it 'returns the correct field value' do
+      expect(mock.get_field('TotMMS')).to eq(2)
+    end
+  end
+
+  describe 'put_fields' do
+    let(:combined_data) do
+      Usps::Imis::Properties.build do |props|
+        props.add 'TotMMS', 2
+        props.add 'SomethingElse', 'interesting'
+      end
+    end
+
+    it 'returns the correct data' do
+      expect(mock.put_fields(SomethingElse: 'interesting')).to eq(combined_data)
+    end
+  end
+
+  describe 'put' do
+    it 'returns the correct data' do
+      expect(mock.put(data)).to eq(data)
+    end
+  end
+
+  describe 'post' do
+    it 'returns the correct data' do
+      expect(mock.post(data)).to eq(data)
+    end
+  end
+
+  describe 'delete' do
+    it 'returns the correct data' do
+      expect(mock.delete).to eq('')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.6.12
 platform: ruby
 authors:
 - Julian Fiander
@@ -45,12 +45,12 @@ files:
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/business_object.rb
+- lib/usps/imis/business_object_mock.rb
 - lib/usps/imis/config.rb
 - lib/usps/imis/error/api_error.rb
 - lib/usps/imis/error/mapper_error.rb
 - lib/usps/imis/error/response_error.rb
 - lib/usps/imis/mapper.rb
-- lib/usps/imis/mock.rb
 - lib/usps/imis/panel/base_panel.rb
 - lib/usps/imis/panel/education.rb
 - lib/usps/imis/panel/vsc.rb
@@ -58,12 +58,12 @@ files:
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
 - spec/lib/usps/imis/api_spec.rb
+- spec/lib/usps/imis/business_object_mock_spec.rb
 - spec/lib/usps/imis/business_object_spec.rb
 - spec/lib/usps/imis/config_spec.rb
 - spec/lib/usps/imis/error/api_error_spec.rb
 - spec/lib/usps/imis/error/response_error_spec.rb
 - spec/lib/usps/imis/mapper_spec.rb
-- spec/lib/usps/imis/mock_spec.rb
 - spec/lib/usps/imis/panel/base_panel_spec.rb
 - spec/lib/usps/imis/panel/education_spec.rb
 - spec/lib/usps/imis/panel/vsc_spec.rb

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::Mock do
-  let(:mock) { described_class.new(**fields) }
-  let(:fields) { { TotMMS: 2 } }
-
-  describe 'get' do
-    it 'returns the correct Properties data' do
-      expect(mock.get).to eq(
-        'Properties' => {
-          '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
-          '$values' => [
-            {
-              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-              'Name' => 'TotMMS',
-              'Value' => {
-                '$type' => 'System.Int32',
-                '$value' => 2
-              }
-            }
-          ]
-        }
-      )
-    end
-  end
-end