usps-imis-api 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f53d9f4d8fc199b09d71f6b5e566c91d7e1052005e511d3921412d569900f584
-  data.tar.gz: 1843a632acc1c9c3e5db431c443e8b8d150ab8efa4834f0c80ee76e842161a86
+  metadata.gz: d2b1b801709e2ccfbbb85b2a3f2393cc9132b016264e573d01a91bb3696a211e
+  data.tar.gz: 76abe88f06a0f2246d2845815d57cd35fcf63536feb467865cf609ffd4591b47
 SHA512:
-  metadata.gz: 19d6a858ab56b41eff03cc80f499779fe28500b6c5664916f3c08dc8506f170d3b0aa6ffdcc7cf79801a912a020239685b7142029109a4118e896bead1953c62
-  data.tar.gz: aac564fc27bbfd9afd0b6e0db552e808b14e8be9fdd6e7e29c4fb5f5c95c6fa4c7225e16821dc43dd97c2c0d412ab6a9401169149093a7846d2662e9da937455
+  metadata.gz: 4a16a5b54c2547ce1fd5db54589a3a741320be6b62e4ad7bd057d3d074b205abbd35e10460870c1e69bdf97a93a81b7f350cf1a76d512039c37fc7944c75721d
+  data.tar.gz: 0ffc668c62f27783fd0a01c3a6bca8bc2fdc2e8c350c0b043e592105bcffa4fceb7f43b6eb6cd44bb91f7538a4e0d05a14c0554b1a566a97c2a081f625cd2486

data/Gemfile.lock

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

data/Readme.md

@@ -34,7 +34,7 @@ Usps::Imis.configure do |config|
   config.password = ENV['IMIS_PASSWORD']
 
   # These options will use these defaults
-  config.logger = Logger.new($stdout)
+  config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
   config.logger.level = :info
 end
 ```
@@ -213,13 +213,24 @@ end
 ### Field Mapper
 
 For fields that have already been mapped between the ITCom database and iMIS, you can use the
-Mapper class to further simplify the update interface:
+Mapper class to further simplify the fetch / update interfaces:
+
+```ruby
+mm = api.mapper.fetch(:mm)
+mm = api.mapper[:mm]
+```
 
 ```ruby
 api.mapper.update(mm: 15)
 ```
 
-For simplicity, you can also call `update` on the `Api` class directly:
+For simplicity, you can also call `fetch` (or simply use Hash access syntax) and `update` on the
+`Api` class directly:
+
+```ruby
+api.fetch(:mm)
+api[:mm]
+```
 
 ```ruby
 api.update(mm: 15)

data/lib/usps/imis/api.rb

@@ -128,11 +128,14 @@ module Usps
         @mapper ||= Mapper.new(self)
       end
 
+      # Convenience alias for reading mapped fields
+      #
+      def fetch(field_key) = mapper.fetch(field_key)
+      alias [] fetch
+
       # Convenience alias for updating mapped fields
       #
-      def update(data)
-        mapper.update(data)
-      end
+      def update(data) = mapper.update(data)
 
       # Convenience accessor for available Panel objects, each using this instance as its parent
       # +Api+

data/lib/usps/imis/errors/mapper_error.rb

@@ -19,7 +19,7 @@ module Usps
         #
         def message
           <<~MESSAGE.chomp
-            Mapper does not recognize field: "#{metadata[:field_name]}".
+            Mapper does not recognize field: "#{metadata[:field_key]}".
             Please report what data you are attempting to work with to ITCom leadership.
           MESSAGE
         end

data/lib/usps/imis/mapper.rb

@@ -28,6 +28,14 @@ module Usps
         @api.imis_id = imis_id if imis_id
       end
 
+      def fetch(field_key)
+        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
+
+        business_object_name, field = FIELD_MAPPING[field_key]
+        api.on(business_object_name)[field]
+      end
+      alias [] fetch
+
       # Update a member's data on multiple affected business objects by arbitrary field names
       #
       # Does not require knowing which business object / iMIS-specific field name to use
@@ -59,25 +67,25 @@ module Usps
 
       def logger = Imis.logger('Mapper')
 
-      def map_update(field_name)
-        missing_mapping!(field_name) unless FIELD_MAPPING.key?(field_name.to_sym)
+      def map_update(field_key)
+        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 
-        business_object_name, field = FIELD_MAPPING[field_name.to_sym]
+        business_object_name, field = FIELD_MAPPING[field_key.to_sym]
         yield(business_object_name, field)
       end
 
-      def missing_mapping!(field_name)
+      def missing_mapping!(field_key)
         unless ENV['TESTING']
           # :nocov:
-          warn(
-            "Mapper does not know how to handle field \"#{field_name}\".\n\n" \
-            'You can use api.put_fields(business_object_name, { field_name => value })  ' \
-            "if you know the business object and iMIS-specific field name.\n\n"
-          )
+          "Mapper does not know how to handle field \"#{field_key}\".\n\n" \
+          'You can use api.put_fields(business_object_name, { field_name => value })  ' \
+          "if you know the business object and iMIS-specific field name.\n\n"
+            .split("\n")
+            .each { logger.warn(it) }
           # :nocov:
         end
 
-        raise Errors::MapperError.new({ field_name: })
+        raise Errors::MapperError.new({ field_key: })
       end
     end
   end

data/lib/usps/imis/mocks/business_object.rb

@@ -12,25 +12,35 @@ module Usps
           @fields = fields.transform_keys(&:to_s)
         end
 
-        def get_field(name) = fields[name]
-
         def get
           Usps::Imis::Properties.build do |props|
             fields.each { |name, value| props.add(name, value) }
           end
         end
+        alias read get
+
+        def get_field(name) = fields[name]
+        alias fetch get_field
+        alias [] get_field
+
+        def get_fields(*field_names) = field_names.map { fields[it] }
+        alias fetch_all get_fields
 
         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
+        alias patch put_fields
 
         def put(data) = data
+        alias update put
 
         def post(data) = data
+        alias create post
 
         def delete = ''
+        alias destroy delete
       end
     end
   end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.9.4'
+    VERSION = '0.9.6'
   end
 end

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

@@ -13,6 +13,30 @@ describe Usps::Imis::Mapper do
     end
   end
 
+  describe '#fetch' do
+    before { api.imis_id = 31092 }
+
+    it 'fetches a mapped field' do
+      expect(api.mapper.fetch(:mm)).to be_a(Integer)
+    end
+
+    it 'supports Hash access syntax' do
+      expect(api.mapper[:mm]).to be_a(Integer)
+    end
+
+    it 'supports Hash access syntax on the Api directly' do
+      expect(api[:mm]).to be_a(Integer)
+    end
+
+    it 'raises for unmapped updates' do
+      expect { api.mapper.fetch(:another) }.to raise_error(
+        Usps::Imis::Errors::MapperError,
+        %(Mapper does not recognize field: "another".\n) \
+        'Please report what data you are attempting to work with to ITCom leadership.'
+      )
+    end
+  end
+
   describe '#update' do
     before { api.imis_id = 31092 }
 

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

@@ -4,11 +4,12 @@ require 'spec_helper'
 
 describe Usps::Imis::Mocks::BusinessObject do
   let(:mock) { described_class.new(**fields) }
-  let(:fields) { { TotMMS: 2 } }
+  let(:fields) { { TotMMS: 2, Something: 'Another' } }
 
   let(:data) do
     Usps::Imis::Properties.build do |props|
       props.add 'TotMMS', 2
+      props.add 'Something', 'Another'
     end
   end
 
@@ -24,10 +25,17 @@ describe Usps::Imis::Mocks::BusinessObject do
     end
   end
 
+  describe 'get_fields' do
+    it 'returns the correct field values' do
+      expect(mock.get_fields('TotMMS', 'Something')).to eq([2, 'Another'])
+    end
+  end
+
   describe 'put_fields' do
     let(:combined_data) do
       Usps::Imis::Properties.build do |props|
         props.add 'TotMMS', 2
+        props.add 'Something', 'Another'
         props.add 'SomethingElse', 'interesting'
       end
     end

metadata

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