usps-imis-api 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 121b0049500e7ad8611d9a8baefc53a254f33a1d7ff98d68ea4c3f8dc8da3c8d
-  data.tar.gz: fe0969fbf121eab99f5d371ccdd66735293f61ed0059153faec9f1b21c7af17e
+  metadata.gz: 99786c3ccf2dc019726db917d318e8c992a61f091aa1b474402612a73c0558d7
+  data.tar.gz: bffec4e5ed9662e63112c1d8e26f99137d922439eb9c3bfb07fab0dad7236e56
 SHA512:
-  metadata.gz: 067f10874692d3ea518f9cb5302d6248d574d8200455fb4444a3849d16613d8eb81928ce390d66ec0cf5615c01db6fa0b33601240e8278299128ad8109a25982
-  data.tar.gz: ead4f120b284879a2a7e0a0ba9dee9f2ed47f106c44b066d6d9d69dd0bd57131d060aa070486d363421fcc9d42e536d5a356104ae0e1f881b77310f83f9baac8
+  metadata.gz: 1d0ba175348c95c4d7bdbea774b785f6ed3c807d5e3349b805544cbc1909b8695c3809d7c56765e77d3aadfb1d2c5c20ee0054840899b48b4385de9c27d59c4a
+  data.tar.gz: 533532e2686386bd3411550cb68f9da9503762b80f38fea86523f33d0ad168427af5ee5c9967959e9d56259f6dfd34c25124faad813abbbda5f83877fa1160e4

data/.github/workflows/main.yml

@@ -1,6 +1,15 @@
 name: 'USPS iMIS API - Ruby'
 on:
   push:
+    paths:
+      - '**.rb'
+      - '**.yml'
+      - '**.json'
+      - 'Gemfile'
+      - '.simplecov'
+    branches:
+      - 'main'
+      - '**'
   workflow_dispatch:
 
 jobs:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.4.0)
+    usps-imis-api (0.4.2)
 
 GEM
   remote: https://rubygems.org/

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.3.0'
+gem 'usps-imis-api', '>= 0.4.0'
 ```
 
 ## Setup
@@ -63,7 +63,7 @@ database, you can skip this step.
 To convert a member's certificate number into their iMIS ID, run the following method:
 
 ```ruby
-api.get_imis_id(certificate)
+api.imis_id_for(certificate)
 ```
 
 This will both return the ID, and store it for use with other requests. If you need to change which
@@ -245,9 +245,14 @@ Testing and linting are automatically run on every push.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and the created tag, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
 
 ## PHP
 

data/lib/usps/imis/api.rb

@@ -26,6 +26,8 @@ module Usps
       def imis_id_for(certificate)
         result = query(Imis.configuration.imis_id_query_name, { certificate: certificate })
         @imis_id = result['Items']['$values'][0]['ID']
+      rescue StandardError
+        raise Error::Api, 'Member not found'
       end
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope

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/panel/base_panel.rb

@@ -8,7 +8,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
 
         def get(ordinal)

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.4.0'
+    VERSION = '0.4.2'
   end
 end

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

@@ -3,43 +3,53 @@
 require 'spec_helper'
 
 describe Usps::Imis::Panel::Education do
-  let(:education) { described_class.new }
-
-  let(:details) do
-    {
-      certificate: 'E136924',
-      description: 'Marine Navigation',
-      effective_date: Time.now.strftime('%Y-%m-%dT00:00:00'),
-      source: 'Online Exams System',
-      code: 'MN',
-      type_code: 'CRS'
-
-    }
-  end
+  describe 'api example' do
+    let(:education) { described_class.new }
+
+    let(:details) do
+      {
+        certificate: 'E136924',
+        description: 'Marine Navigation',
+        effective_date: Time.now.strftime('%Y-%m-%dT00:00:00'),
+        source: 'Online Exams System',
+        code: 'MN',
+        type_code: 'CRS'
+
+      }
+    end
 
-  before { education.api.imis_id = 6374 }
+    before { education.api.imis_id = 6374 }
 
-  describe '#get' do
-    it 'loads a specific object' do
-      expect(education.get(90737)).to be_a(Hash)
+    describe '#get' do
+      it 'loads a specific object' do
+        expect(education.get(90737)).to be_a(Hash)
+      end
     end
-  end
 
-  # rubocop:disable RSpec/ExampleLength
-  it 'handles new records correctly', :aggregate_failures do
-    new_record = education.create(details)
-    expect(new_record).to be_a(Hash)
+    # rubocop:disable RSpec/ExampleLength
+    it 'handles new records correctly', :aggregate_failures do
+      new_record = education.create(details)
+      expect(new_record).to be_a(Hash)
+
+      ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
-    ordinal = new_record['Identity']['IdentityElements']['$values'][1]
+      update_result =
+        education.update(details.merge(source: 'Online Exams System - Modified', ordinal: ordinal))
+      updated = update_result['Properties']['$values'].find do |v|
+        v['Name'] == 'ABC_Educ_Source_System'
+      end
+      expect(updated['Value']).to eq('Online Exams System - Modified')
 
-    update_result =
-      education.update(details.merge(source: 'Online Exams System - Modified', ordinal: ordinal))
-    updated = update_result['Properties']['$values'].find do |v|
-      v['Name'] == 'ABC_Educ_Source_System'
+      expect(education.destroy(ordinal)).to eq('')
     end
-    expect(updated['Value']).to eq('Online Exams System - Modified')
+    # rubocop:enable RSpec/ExampleLength
+  end
+
+  describe 'initialization with ID' do
+    it 'can initialize with an iMIS ID' do
+      panel = described_class.new(imis_id: 6374)
 
-    expect(education.destroy(ordinal)).to eq('')
+      expect(panel.api.imis_id).to eq('6374')
+    end
   end
-  # rubocop:enable RSpec/ExampleLength
 end

metadata

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