usps-imis-api 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6237ee6d52c0fdfc8cd33809a90600b68a19926490facab194e751b8c983d3
-  data.tar.gz: f66d10f8a53e2df13e42a96fec6a4fc2cb61d798f80dbe7ddc88cf2f84418277
+  metadata.gz: ca358fc80eed74b0335f6137f71e503fffbc84d6c396c8e1c23c90501eab5b36
+  data.tar.gz: 239111a5dfd7cb186fe358fc0227e3063744225cf619e12a91e994f639142e56
 SHA512:
-  metadata.gz: 16b7a7e05c2fa1cb5d3e2de1604a4a06e5d551a650f7ee451662afa7f43b2b1917f0be04a2c3d4af063a18c0b22515d304bcc25afca79e9214e76542d3b39438
-  data.tar.gz: bfe78effec93b84b65963c54decb29ae114e10231e537ad216d1c3d2b250348474efeb0bd20b5f5759a7b6440eca6b28660a10c94d617c90fa70708c1c85727e
+  metadata.gz: 2f31860395762aeead9f002f96867111758a8474ada928ba1369e3122b767f0b27052ed41157d8eac008fade27bdb779389cd65c74ad7cadbb87129ee9c238ff
+  data.tar.gz: 7c0f5eaae8592a93192e08ca4cf88e604629de246b8e2f9272880d19e39a218d01a027387720a6c289b7f4490bc6617b57c637ab00201868ecd36fd178748031

data/Gemfile.lock

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

data/Readme.md

@@ -77,6 +77,10 @@ You can also manually set the current ID, if you already have it for a given mem
 api.imis_id = imis_id
 ```
 
+#### Without an iMIS ID
+
+Running requests without an iMIS ID set will result in query results returned from the API.
+
 ### Business Object and Panel Actions
 
 Business Objects and Panels support the following actions.
@@ -91,6 +95,12 @@ To fetch member data, run e.g.:
 data = api.on('ABC_ASC_Individual_Demog').get
 ```
 
+You can also pass in specific field names to filter the returned member data, e.g.:
+
+```ruby
+data = api.on('ABC_ASC_Individual_Demog').get('TotMMS', 'MMS_Updated')
+```
+
 Alias: `read`
 
 #### GET Field
@@ -103,6 +113,16 @@ tot_mms = api.on('ABC_ASC_Individual_Demog').get_field('TotMMS')
 
 Alias: `fetch`
 
+#### GET Fields
+
+To fetch multiple specific fields from member data, run e.g.:
+
+```ruby
+data = api.on('ABC_ASC_Individual_Demog').get_fields('TotMMS', 'MMS_Updated')
+```
+
+Alias: `fetch_all`
+
 #### PUT Fields
 
 To update member data, run e.g.:

data/lib/usps/imis/business_object.rb

@@ -34,28 +34,35 @@ module Usps
 
       # Get a business object for the current member
       #
-      # @return [Hash] Response data from the API
+      # If +fields+ is provided, will return only those field values
       #
-      def get
-        request = Net::HTTP::Get.new(uri)
-        result = submit(uri, authorize(request))
-        JSON.parse(result.body)
-      end
+      # @param fields [String] Field names to return
+      #
+      # @return [Hash, Array<Hash>] Response data from the API
+      #
+      def get(*fields) = fields.any? ? get_fields(*fields) : raw_object
       alias read get
 
       # Get a single named field from a business object for the current member
       #
-      # @param name [String] Field name to return
+      # @param field [String] Field name to return
       #
       # @return [Hash] Response data from the API
       #
-      def get_field(name)
-        values = get['Properties']['$values']
-        value = values.find { it['Name'] == name }['Value']
+      def get_field(field) = extract_field_value(raw_object_values, field)
+      alias fetch get_field
 
-        value.is_a?(String) ? value : value['$value']
+      # Get named fields from a business object for the current member
+      #
+      # @param names [Array<String>] Field names to return
+      #
+      # @return [Array<Hash>] Response data from the API
+      #
+      def get_fields(*fields)
+        values = raw_object_values
+        fields.map { extract_field_value(values, it) }
       end
-      alias fetch get_field
+      alias fetch_all get_fields
 
       # Update only specific fields on a business object for the current member
       #
@@ -63,10 +70,7 @@ module Usps
       #
       # @return [Hash] Response data from the API
       #
-      def put_fields(fields)
-        updated = filter_fields(fields)
-        put(updated)
-      end
+      def put_fields(fields) = put(filter_fields(fields))
       alias patch put_fields
 
       # Update a business object for the current member
@@ -77,12 +81,7 @@ module Usps
       #
       # @return [Hash] Response data from the API
       #
-      def put(body)
-        request = Net::HTTP::Put.new(uri)
-        request.body = JSON.dump(body)
-        result = submit(uri, authorize(request))
-        JSON.parse(result.body)
-      end
+      def put(body) = put_object(Net::HTTP::Put.new(uri), body)
       alias update put
 
       # Create a business object for the current member
@@ -91,23 +90,14 @@ module Usps
       #
       # @return [Hash] Response data from the API
       #
-      def post(body)
-        request = Net::HTTP::Post.new(uri(id: ''))
-        request.body = JSON.dump(body)
-        result = submit(uri, authorize(request))
-        JSON.parse(result.body)
-      end
+      def post(body) = put_object(Net::HTTP::Post.new(uri(id: '')), body)
       alias create post
 
       # Remove a business object for the current member
       #
-      # @return [String] Error response body from the API, or empty string on success
+      # @return [true] Only on success response (i.e. blank string from the API)
       #
-      def delete
-        request = Net::HTTP::Delete.new(uri)
-        result = submit(uri, authorize(request))
-        result.body
-      end
+      def delete = submit(uri, authorize(Net::HTTP::Delete.new(uri))).body == '' # rubocop:disable Naming/PredicateMethod
       alias destroy delete
 
     private
@@ -159,6 +149,35 @@ module Usps
           end
         end
       end
+
+      # Get a raw object response from the API
+      #
+      # Useful for stubbing data in tests
+      #
+      def raw_object
+        request = Net::HTTP::Get.new(uri)
+        result = submit(uri, authorize(request))
+        JSON.parse(result.body)
+      end
+
+      # Get just the property values from an object response from the API
+      #
+      def raw_object_values
+        raw_object['Properties']['$values']
+      end
+
+      def extract_field_value(values, field)
+        value = values.find { it['Name'] == field }['Value']
+        value.is_a?(String) ? value : value['$value']
+      end
+
+      # Upload an object to the API
+      #
+      def put_object(request, body)
+        request.body = JSON.dump(body)
+        result = submit(uri, authorize(request))
+        JSON.parse(result.body)
+      end
     end
   end
 end

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

@@ -17,25 +17,37 @@ module Usps
 
         # Get a specific object from the Panel
         #
+        # If +fields+ is provided, will return only those field values
+        #
+        # @param fields [String] Field names to return
+        #
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
-        def get(ordinal)
-          api.on(business_object, ordinal:).get
-        end
+        # @return [Hash, Array<Hash>] Response data from the API
+        #
+        def get(ordinal, *fields) = api.on(business_object, ordinal:).get(*fields)
         alias read get
 
         # Get a single named field from a Panel for the current member
         #
         # @param ordinal [Integer] The ordinal identifier for the desired object
-        # @param name [String] Field name to return
+        # @param field [String] Field name to return
         #
         # @return [Hash] Response data from the API
         #
-        def get_field(ordinal, name)
-          api.on(business_object, ordinal:).get_field(name)
-        end
+        def get_field(ordinal, field) = api.on(business_object, ordinal:).get_field(field)
         alias fetch get_field
 
+        # Get named fields from a Panel for the current member
+        #
+        # @param ordinal [Integer] The ordinal identifier for the desired object
+        # @param fields [Array<String>] Field names to return
+        #
+        # @return [Hash] Response data from the API
+        #
+        def get_fields(ordinal, *fields) = api.on(business_object, ordinal:).get_fields(*fields)
+        alias fetch_all get_fields
+
         # Update only specific fields on a Panel for the current member
         #
         # @param ordinal [Integer] The ordinal identifier for the desired object
@@ -43,9 +55,7 @@ module Usps
         #
         # @return [Hash] Response data from the API
         #
-        def put_fields(ordinal, fields)
-          api.on(business_object, ordinal:).put_fields(fields)
-        end
+        def put_fields(ordinal, fields) = api.on(business_object, ordinal:).put_fields(fields)
         alias patch put_fields
 
         # Update an existing object in the Panel
@@ -53,27 +63,21 @@ module Usps
         # @param data [Hash] The record data for the desired object -- including the required
         #                    +ordinal+ identifier
         #
-        def put(data)
-          api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
-        end
+        def put(data) = api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
         alias update put
 
         # Create a new object in the Panel
         #
         # @param data [Hash] The record data for the desired object
         #
-        def post(data)
-          api.on(business_object).post(payload(data))
-        end
+        def post(data) = api.on(business_object).post(payload(data))
         alias create post
 
         # Remove a specific object from the Panel
         #
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
-        def delete(ordinal)
-          api.on(business_object, ordinal:).delete
-        end
+        def delete(ordinal) = api.on(business_object, ordinal:).delete
         alias destroy delete
 
       private

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.7.0'
+    VERSION = '0.7.1'
   end
 end

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

@@ -6,20 +6,8 @@ describe Usps::Imis::BusinessObject do
   let(:business_object) { described_class.new(api, 'Stub') }
   let(:api) { Usps::Imis::Api.new }
 
-  let(:expected) do
-    {
-      'Properties' => {
-        '$values' => [
-          { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-          { 'Name' => 'Stub String', 'Value' => 'other' }
-        ]
-      }
-    }
-  end
-
   before do
-    allow(business_object).to receive(:get).and_return({
+    allow(business_object).to receive(:raw_object).and_return({
       'Properties' => {
         '$values' => [
           { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
@@ -30,6 +18,22 @@ describe Usps::Imis::BusinessObject do
     })
   end
 
+  describe '#get' do
+    it 'returns multiple values' do
+      expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+    end
+
+    describe 'delegation to get_fields' do
+      before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
+
+      it 'delegates to get_fields' do
+        business_object.get('Stub String', 'Stub Integer')
+
+        expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
+      end
+    end
+  end
+
   describe '#get_field' do
     it 'returns a string value' do
       expect(business_object.get_field('Stub String')).to eq('something')
@@ -40,7 +44,25 @@ describe Usps::Imis::BusinessObject do
     end
   end
 
+  describe '#get_fields' do
+    it 'returns multiple values' do
+      expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
+    end
+  end
+
   describe '#filter_fields' do
+    let(:expected) do
+      {
+        'Properties' => {
+          '$values' => [
+            { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
+            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+            { 'Name' => 'Stub String', 'Value' => 'other' }
+          ]
+        }
+      }
+    end
+
     it 'formats fields correctly' do
       updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
 

data/spec/lib/usps/imis/panels/education_spec.rb

@@ -23,6 +23,10 @@ describe Usps::Imis::Panels::Education do
       it 'loads a specific object' do
         expect(education.get(90737)).to be_a(Hash)
       end
+
+      it 'returns specific fields' do
+        expect(education.get(90737, 'ABC_Product_Code', 'ABC_Other_Code')).to eq(%w[CRS AP])
+      end
     end
 
     describe '#get_field' do
@@ -31,6 +35,12 @@ describe Usps::Imis::Panels::Education do
       end
     end
 
+    describe '#get_fields' do
+      it 'returns specific fields' do
+        expect(education.get_fields(90737, 'ABC_Product_Code', 'ABC_Other_Code')).to eq(%w[CRS AP])
+      end
+    end
+
     # rubocop:disable RSpec/ExampleLength
     it 'interacts with records correctly', :aggregate_failures do
       new_record = education.create(details)
@@ -51,7 +61,7 @@ describe Usps::Imis::Panels::Education do
       end
       expect(patched['Value']).to eq('Online Exams System - Mod2')
 
-      expect(education.destroy(ordinal)).to eq('')
+      expect(education.destroy(ordinal)).to be(true)
     end
     # rubocop:enable RSpec/ExampleLength
   end

data/spec/lib/usps/imis/panels/vsc_spec.rb

@@ -32,7 +32,7 @@ describe Usps::Imis::Panels::Vsc do
     updated = update_result['Properties']['$values'].find { it['Name'] == 'Quantity' }
     expect(updated['Value']['$value']).to eq(43)
 
-    expect(vsc.destroy(ordinal)).to eq('')
+    expect(vsc.destroy(ordinal)).to be(true)
   end
   # rubocop:enable RSpec/ExampleLength
 end

data/usps-imis-api.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version       = Usps::Imis::VERSION
   s.summary       = 'iMIS API Wrapper'
   s.description   = 'A wrapper for the iMIS API.'
-  s.homepage      = 'http://rubygems.org/gems/usps-imis-api'
+  s.homepage      = 'https://github.com/unitedstatespowersquadrons/imis-api-ruby'
   s.authors       = ['Julian Fiander']
   s.email         = 'jsfiander@gmail.com'
   s.require_paths = %w[lib]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Julian Fiander
@@ -78,7 +78,7 @@ files:
 - spec/lib/usps/imis_spec.rb
 - spec/spec_helper.rb
 - usps-imis-api.gemspec
-homepage: http://rubygems.org/gems/usps-imis-api
+homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'