usps-imis-api 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2539e0ba94306f96b55dc0bb009875a4ef810b1ddd361dff751eabe113d1d1d7
-  data.tar.gz: 82f4733468b0b00d9dd7be58d2d3a5dea23ba6a082e5f3948d0def97ba787d95
+  metadata.gz: 3e49829b6dee8973f1de4b275516060ced7b426cedd00fe7e4ccaba5e29efc52
+  data.tar.gz: 8558346d33b416f3d58f9fa5047b925f580c8d8d5123463c6fe137335ddd93d7
 SHA512:
-  metadata.gz: 77732983cdfd02ee695173f8873000f70ab98d2cb20e4ff8742119e167dc4757f6bdb278a26114823f998a7706ed5034b48600ffc9c5bf79851352e0db6fc6e6
-  data.tar.gz: 30a48655eb204abbaf8a4084241661bb52bc27937964984b59e13bffb8373919550f93c51f770d3d4c627a77970c1461525237adbcd3540b9d5360462bc8d02e
+  metadata.gz: 89f31684df0cb6001fa31966eec99bf8ec9e9dbdab86ae8213a43200f23bf306b204bc9ecb61d9f6ac066869387e4ba048923af1a77b4c7dd1dec59a9cb9b215
+  data.tar.gz: 376cc34e675f9caadd5c985733b28ea2e93d4ba3752de8d9fd843d3a15866280f3075138a275be47dfd77d06bb24f2ba81cad8527308060a1e8893befbe5381e

data/.github/workflows/main.yml

@@ -16,17 +16,25 @@ jobs:
   rubocop:
     runs-on: ubuntu-24.04
     environment: "USPS iMIS API - Ruby"
+    strategy:
+      matrix:
+        ruby: ['3.4', head]
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
-        with: { bundler-cache: true }
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run Rubocop
         run: bundle exec rubocop
   rspec:
     runs-on: ubuntu-24.04
     environment: "USPS iMIS API - Ruby"
+    strategy:
+      matrix:
+        ruby: ['3.4', head]
     env:
       IMIS_USERNAME: ${{ secrets.IMIS_USERNAME }}
       IMIS_PASSWORD: ${{ secrets.IMIS_PASSWORD }}
@@ -36,12 +44,14 @@ jobs:
         uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
-        with: { bundler-cache: true }
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run Rspec
         run: bundle exec rspec --format documentation --order rand --color --tty
       - name: Store Coverage
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-rspec
+          name: coverage-rspec-${{ matrix.ruby }}
           include-hidden-files: true
           path: coverage/

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.4
   Exclude:
     - bin/**/*
     - config/**/*

data/.ruby-version

@@ -1 +1 @@
-3.2.3
+3.5-dev

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'dotenv',        '>= 3.1.4'
+gem 'irb',           '>= 1.15.2'
 gem 'rake',          '>= 13.2.1'
 gem 'rspec',         '>= 3.13.0'
 gem 'rubocop',       '>= 1.66.1'

data/Gemfile.lock

@@ -1,25 +1,44 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.4.1)
+    usps-imis-api (0.4.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    date (3.4.1)
     diff-lcs (1.5.1)
     docile (1.4.1)
     dotenv (3.1.4)
+    erb (5.0.3)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.26.3)
     parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.6)
+      date
+      stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
+    rdoc (6.15.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
     regexp_parser (2.9.2)
+    reline (0.6.2)
+      io-console (~> 0.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -54,6 +73,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
+    stringio (3.1.7)
+    tsort (0.2.0)
     unicode-display_width (2.6.0)
 
 PLATFORMS
@@ -62,6 +83,7 @@ PLATFORMS
 
 DEPENDENCIES
   dotenv (>= 3.1.4)
+  irb (>= 1.15.2)
   rake (>= 13.2.1)
   rspec (>= 3.13.0)
   rubocop (>= 1.66.1)

data/lib/usps/imis/api.rb

@@ -6,7 +6,7 @@ module Usps
       AUTHENTICATION_PATH = 'Token'
       API_PATH = 'api'
       QUERY_PATH = 'api/Query'
-      PANELS = Struct.new(:vsc)
+      PANELS = Struct.new(:vsc, :education)
 
       attr_reader :token, :token_expiration, :imis_id
 
@@ -24,7 +24,7 @@ module Usps
       # Convert a member's certificate number into an iMIS ID number
       #
       def imis_id_for(certificate)
-        result = query(Imis.configuration.imis_id_query_name, { certificate: certificate })
+        result = query(Imis.configuration.imis_id_query_name, { certificate: })
         @imis_id = result['Items']['$values'][0]['ID']
       rescue StandardError
         raise Error::Api, 'Member not found'
@@ -34,10 +34,10 @@ module Usps
       #
       # This should be used with methods that do not change the value of `imis_id`
       #
-      def with(id, &block)
+      def with(id, &)
         old_id = imis_id
         self.imis_id = id
-        instance_eval(&block)
+        instance_eval(&)
       ensure
         self.imis_id = old_id
       end
@@ -45,7 +45,7 @@ module Usps
       # Get a business object for the current member
       #
       def get(business_object_name, url_id: nil)
-        uri = uri_for(business_object_name, url_id: url_id)
+        uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Get.new(uri)
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
@@ -57,13 +57,13 @@ module Usps
       #
       def put_fields(business_object_name, fields, url_id: nil)
         updated = filter_fields(business_object_name, fields)
-        put(business_object_name, updated, url_id: url_id)
+        put(business_object_name, updated, url_id:)
       end
 
       # Update a business object for the current member
       #
       def put(business_object_name, body, url_id: nil)
-        uri = uri_for(business_object_name, url_id: url_id)
+        uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Put.new(uri)
         request.body = JSON.dump(body)
         result = submit(uri, authorize(request))
@@ -73,7 +73,7 @@ module Usps
       # Create a business object for the current member
       #
       def post(business_object_name, body, url_id: nil)
-        uri = uri_for(business_object_name, url_id: url_id)
+        uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Post.new(uri)
         request.body = JSON.dump(body)
         result = submit(uri, authorize(request))
@@ -85,7 +85,7 @@ module Usps
       # Returns empty string on success
       #
       def delete(business_object_name, url_id: nil)
-        uri = uri_for(business_object_name, url_id: url_id)
+        uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Delete.new(uri)
         result = submit(uri, authorize(request))
         result.body
@@ -111,7 +111,8 @@ module Usps
 
       def panels
         @panels ||= PANELS.new(
-          Panel::Vsc.new(self)
+          Panel::Vsc.new(self),
+          Panel::Education.new(self)
         )
       end
 
@@ -119,6 +120,8 @@ module Usps
         mapper.update(data)
       end
 
+      def instance_variables_to_inspect = %i[@token_expiration @imis_id]
+
     private
 
       def client(uri)

data/lib/usps/imis/config.rb

@@ -22,6 +22,8 @@ module Usps
           raise Error::Api, "Unexpected API environment: #{environment}"
         end
       end
+
+      def instance_variables_to_inspect = %i[@environment @imis_id_query_name @username]
     end
   end
 end

data/lib/usps/imis/error/response.rb

@@ -31,7 +31,7 @@ module Usps
       private
 
         def base_metadata
-          { api: { status: status, body: body } }
+          { api: { status:, body: } }
         end
 
         def status

data/lib/usps/imis/mapper.rb

@@ -16,7 +16,7 @@ module Usps
 
       def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
-        api.imis_id = imis_id if imis_id
+        @api.imis_id = imis_id if imis_id
       end
 
       # Update a member's data on multiple affected business objects by arbitrary field names

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.4.1'
+    VERSION = '0.4.3'
   end
 end

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

@@ -34,4 +34,16 @@ describe Usps::Imis::Api do
       expect(api.with(6374) { panels.vsc.get(1433) }).to be_a(Hash)
     end
   end
+
+  describe '#inspect' do
+    it 'is configured to exclude the token instance variable' do
+      expect(api.instance_variables_to_inspect).not_to include(:@token)
+    end
+
+    it 'does not show the token instance variable' do
+      pending 'Requires Ruby 3.5' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(3.5)
+
+      expect(api.inspect).not_to match(/ @token="/)
+    end
+  end
 end

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

@@ -34,7 +34,7 @@ describe Usps::Imis::Panel::Education do
       ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
       update_result =
-        education.update(details.merge(source: 'Online Exams System - Modified', ordinal: ordinal))
+        education.update(details.merge(source: 'Online Exams System - Modified', ordinal:))
       updated = update_result['Properties']['$values'].find do |v|
         v['Name'] == 'ABC_Educ_Source_System'
       end

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

@@ -28,7 +28,7 @@ describe Usps::Imis::Panel::Vsc do
 
     ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
-    update_result = vsc.update(details.merge(count: 43, ordinal: ordinal))
+    update_result = vsc.update(details.merge(count: 43, ordinal:))
     updated = update_result['Properties']['$values'].find { |v| v['Name'] == 'Quantity' }
     expect(updated['Value']['$value']).to eq(43)
 

data/usps-imis-api.gemspec

@@ -14,5 +14,5 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version = '>= 3.0'
+  s.required_ruby_version = '>= 3.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Julian Fiander
@@ -56,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.0.dev
 specification_version: 4
 summary: iMIS API Wrapper
 test_files: []