usps-imis-api 0.4.0.pre.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4e11dc87c8bb7fd70aaa15146afaffa667de0da75cf54117672f42e46a8f4bd
-  data.tar.gz: e9e8abd630971b1151849d17d45196b1ec1f509dcd1abf213840d83e24a1eb07
+  metadata.gz: 2539e0ba94306f96b55dc0bb009875a4ef810b1ddd361dff751eabe113d1d1d7
+  data.tar.gz: 82f4733468b0b00d9dd7be58d2d3a5dea23ba6a082e5f3948d0def97ba787d95
 SHA512:
-  metadata.gz: 0ceaf850a029c05cf002189e286a2d83d83c52a34fe638511dfcc8c18f1e73a620243eccd48ec299459e43813402f379c2d005d0abb01cb4edbc1d55f79652de
-  data.tar.gz: 568a3c2134674c2be717c5653d16b90015c18d699eea58ba2ac6d9c832f8fbe5a4bdd46f3d25ed3dd95fa94413849f369718a98fbe54811cb9bb8fe831ea8109
+  metadata.gz: 77732983cdfd02ee695173f8873000f70ab98d2cb20e4ff8742119e167dc4757f6bdb278a26114823f998a7706ed5034b48600ffc9c5bf79851352e0db6fc6e6
+  data.tar.gz: 30a48655eb204abbaf8a4084241661bb52bc27937964984b59e13bffb8373919550f93c51f770d3d4c627a77970c1461525237adbcd3540b9d5360462bc8d02e

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.pre.1)
+    usps-imis-api (0.4.1)
 
 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
@@ -149,7 +151,7 @@ module Usps
 
       def submit(uri, request)
         client(uri).request(request).tap do |result|
-          raise Error::Response.new(result) unless result.is_a?(Net::HTTPSuccess)
+          raise Error::Response.from(result) unless result.is_a?(Net::HTTPSuccess)
         end
       end
 

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

@@ -14,7 +14,7 @@ module Usps
         end
 
         def bugsnag_meta_data
-          metadata != {} ? { api: metadata } : {}
+          metadata == {} ? {} : { api: metadata }
         end
 
       private

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

@@ -7,7 +7,11 @@ module Usps
         attr_reader :response
         attr_accessor :metadata
 
-        def initialize(response, metadata = {})
+        def self.from(response)
+          new(nil, response)
+        end
+
+        def initialize(_message, response, metadata = {})
           @response = response
           super(message, metadata)
         end

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-2'
+    VERSION = '0.4.1'
   end
 end

data/spec/lib/usps/imis/error/response_spec.rb

@@ -5,6 +5,7 @@ require 'spec_helper'
 ApiResponseStub = Struct.new(:code, :body)
 
 describe Usps::Imis::Error::Response do
+  let(:response) { ApiResponseStub.new('500', 'Body of the API response error') }
   let(:warning_text) do
     <<~WARNING.chomp
       Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
@@ -13,8 +14,6 @@ describe Usps::Imis::Error::Response do
   end
 
   it 'handles an API response correctly' do
-    response = ApiResponseStub.new('500', 'Body of the API response error')
-
-    expect(described_class.new(response).message).to eq(warning_text)
+    expect(described_class.from(response).message).to eq(warning_text)
   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.pre.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Julian Fiander