usps-imis-api 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cbe7660dffdee043ffdbe92a012879ceb439946b737f34fe9ca16d6f34e68b1
-  data.tar.gz: 065c486f386c7b73501dda6bf92a0214680e3ab13104388de29613d4bb4d7315
+  metadata.gz: eeff742b04ebe9046cb57d7cf8501b3a175a9e50729cba6f812f44ed12d90c43
+  data.tar.gz: 5960918afa1fd57e141cdd52408380ce135e53fa81eb7da4f9c48849436974ac
 SHA512:
-  metadata.gz: 67e8a5cf1cb919bccaada7960f1680426491880340f68eb8ed3ed57e5922bfdd6ab98208534367679aaec6b0026c1afb8161e5df73c7fd1dff383293882239b7
-  data.tar.gz: 830f0e96d1528bd434a4122511ab15165d27ef42f0383713e10640906395d19742e49b5da8858021fa3a2dbd64be699c5adf2c08f4897a5c3d6b94f8bb3d270f
+  metadata.gz: eb267af35e92cfa0c7511b1ed78eae72b6811569324486ea0f411dcf988c0f5d0515f079b0356cac0776555dd93b62f677fccc0fcf78ae43e424cb8f856469a6
+  data.tar.gz: 83c81ac9c0ef3ef658ae32c6de1026ec9aa5bea89f6f4e7bd2e0b5e7bcd6052562d93ab4d7f01db7b5bb4ab57e1eb1b00fe26a8121efeadf013cd2007a7e32e9

data/Gemfile.lock

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

data/Readme.md

@@ -13,7 +13,7 @@ gem install usps-imis-api
 or add this line to your Gemfile:
 
 ```ruby
-gem 'usps-imis-api', '~> 0.6.1'
+gem 'usps-imis-api', '~> 0.6.3'
 ```
 
 ## Setup
@@ -87,6 +87,16 @@ api.imis_id = 31092
 data = api.on('ABC_ASC_Individual_Demog').get
 ```
 
+### GET Field
+
+To fetch a specific field from member data, run e.g.:
+
+```ruby
+api.imis_id = 31092
+
+tot_mms = api.on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+```
+
 ### PUT Fields
 
 To update member data, run e.g.:
@@ -204,7 +214,7 @@ previous value.
 
 ```ruby
 api.with(31092) do
-  # These four requests are identical:
+  # These requests are identical:
 
   on('ABC_ASC_Individual_Demog') { put('TotMMS' => 15) }
 
@@ -222,6 +232,23 @@ api.with(6374) do
 end
 ```
 
+```ruby
+api.with(31092) do
+  # These requests are identical:
+
+  api.on('ABC_ASC_Individual_Demog') do
+    get['Properties']['$values'].find { |hash| hash['Name'] == 'TotMMS' }['Value']['$value']
+  end
+
+  api.on('ABC_ASC_Individual_Demog') { get_field('TotMMS') }
+
+  api.on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+end
+
+# This request fetches the same data, but leaves the iMIS ID selected
+api.with(31092).on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+```
+
 ## Exception Handling
 
 All internal exceptions inherit from `Usps::Imis::ApiError`.

data/lib/usps/imis/business_object.rb

@@ -40,6 +40,19 @@ module Usps
         JSON.parse(result.body)
       end
 
+      # Get a single named field from a business object for the current member
+      #
+      # @param name [String] Field name to return
+      #
+      # @return [Hash] Response data from the API
+      #
+      def get_field(name)
+        values = get['Properties']['$values']
+        value = values.find { |hash| hash['Name'] == name }['Value']
+
+        value.is_a?(String) ? value : value['$value']
+      end
+
       # Update only specific fields on a business object for the current member
       #
       # @param fields [Hash] Conforms to pattern +{ field_key => value }+

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.1'
+    VERSION = '0.6.3'
   end
 end

data/lib/usps/imis.rb

@@ -6,6 +6,8 @@ require 'json'
 require 'time'
 require 'cgi'
 
+require 'active_support/string_inquirer'
+
 # Extensions
 # :nocov:
 require 'ext/hash' unless defined?(Rails)

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

@@ -6,31 +6,41 @@ describe Usps::Imis::BusinessObject do
   let(:business_object) { described_class.new(api, 'Stub') }
   let(:api) { Usps::Imis::Api.new }
 
-  describe '#filter_fields' do
-    let(:expected) do
-      {
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-            { 'Name' => 'Stub String', 'Value' => 'other' }
-          ]
-        }
+  let(:expected) do
+    {
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS 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({
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+          { 'Name' => 'Stub String', 'Value' => 'something' }
+        ]
       }
+    })
+  end
+
+  describe '#get_field' do
+    it 'returns a string value' do
+      expect(business_object.get_field('Stub String')).to eq('something')
     end
 
-    before do
-      allow(business_object).to receive(:get).and_return({
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-            { 'Name' => 'Stub String', 'Value' => 'something' }
-          ]
-        }
-      })
+    it 'returns an integer value' do
+      expect(business_object.get_field('Stub Integer')).to eq(42)
     end
+  end
 
+  describe '#filter_fields' do
     it 'formats fields correctly' do
       updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
 

metadata

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