usps-imis-api 0.15.2 → 1.0.0.pre.rc.1

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Api do
+  let(:api) { described_class.new }
+
+  describe '#initialize' do
+    it 'skips authentication' do
+      # rubocop:disable RSpec/AnyInstance
+      expect_any_instance_of(described_class).not_to receive(:authenticate)
+      # rubocop:enable RSpec/AnyInstance
+
+      described_class.new(skip_authentication: true)
+    end
+
+    it 'stores the initial imis_id' do
+      api = described_class.new(imis_id: 42)
+
+      expect(api.imis_id).to eq('42')
+    end
+  end
+
+  describe '#imis_id_for' do
+    it 'gets the iMIS ID' do
+      expect(api.imis_id_for('E231625')).to eq('31092')
+    end
+
+    context 'with a query error' do
+      before { allow(api).to receive(:query).and_raise('Stub') }
+
+      it 'wraps errors' do
+        expect { api.imis_id_for('E231625') }.to raise_error(
+          Usps::Imis::Error::Api, 'Member not found'
+        )
+      end
+    end
+  end
+
+  describe '#put' do
+    before { api.imis_id = 31092 }
+
+    it 'sends an update' do
+      expect(api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })).to be_a(Hash)
+    end
+
+    context 'when receiving a response error' do
+      let(:warning_text) do
+        <<~WARNING.chomp
+          Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+          Something went wrong
+        WARNING
+      end
+
+      before do
+        error = Struct.new(:code, :body).new('500', 'Something went wrong')
+
+        # rubocop:disable RSpec/AnyInstance
+        allow_any_instance_of(Net::HTTP).to receive(:request).and_return(error)
+        # rubocop:enable RSpec/AnyInstance
+      end
+
+      it 'wraps the error' do
+        expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
+          Usps::Imis::Error::Api, warning_text
+        )
+      end
+    end
+  end
+
+  describe '#with' do
+    it 'sends an update from put' do
+      expect(
+        api.with(31092) { put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }
+      ).to be_a(Hash)
+    end
+
+    it 'sends an update from update' do
+      expect(api.with(31092) { update(mm: 15) }.first).to be_a(Hash)
+    end
+
+    it 'uses a panel correctly' 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
+
+  describe '#authorize' do
+    before { allow(api).to receive(:authenticate) }
+
+    it 'automatically refreshes an expired token' do
+      api.instance_variable_set(:@token_expiration, Time.now - 60)
+
+      request = Net::HTTP::Put.new('/')
+      api.send(:authorize, request)
+
+      expect(api).to have_received(:authenticate)
+    end
+  end
+
+  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' }
+          ]
+        }
+      }
+    end
+
+    before do
+      allow(api).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
+
+    it 'formats fields correctly' do
+      updated = api.send(:filter_fields, 'Stub', { 'Stub Integer' => 43, 'Stub String' => 'other' })
+
+      expect(updated).to eq(expected)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Config do
+  let(:config) { described_class.new }
+
+  it 'sets values on initialize' do
+    config = described_class.new { |c| c.environment = 'test' }
+
+    expect(config.environment).to eq('test')
+  end
+
+  describe '#hostname' do
+    context 'with production environment' do
+      before { config.environment = 'production' }
+
+      it 'returns the production hostname' do
+        expect(config.hostname).to eq(described_class::IMIS_ROOT_URL_PROD)
+      end
+    end
+
+    context 'with unrecognized environment' do
+      before { config.environment = 'nothing' }
+
+      it 'raises an error' do
+        expect { config.hostname }.to raise_error(
+          Usps::Imis::Error::Api, 'Unexpected API environment: nothing'
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Error::Api do
+  it 'builds Bugsnag metadata' do
+    error = described_class.new('Example', something: :else)
+
+    expect(error.bugsnag_meta_data).to eq(api: { something: :else })
+  end
+
+  it 'ignores Bugsnag metadata with none provided' do
+    error = described_class.new('Example')
+
+    expect(error.bugsnag_meta_data).to eq({})
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+ApiResponseStub = Struct.new(:code, :body)
+
+describe Usps::Imis::Error::Response do
+  let(:error) { described_class.from(response) }
+
+  describe 'error codes' do
+    context 'with a 400' do
+      let(:response) { ApiResponseStub.new('400', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :bad_request, body: 'body' })
+      end
+    end
+
+    context 'with a 401' do
+      let(:response) { ApiResponseStub.new('401', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :unauthorized, body: 'body' })
+      end
+    end
+
+    context 'with a 404' do
+      let(:response) { ApiResponseStub.new('404', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :not_found, body: 'body' })
+      end
+    end
+
+    context 'with a 422' do
+      let(:response) { ApiResponseStub.new('422', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :unprocessable_entity, body: 'body' })
+      end
+    end
+
+    context 'with a 500' do
+      let(:response) { ApiResponseStub.new('500', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :internal_server_error, body: 'body' })
+      end
+    end
+
+    context 'with a 429' do
+      let(:response) { ApiResponseStub.new('429', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: '429', body: 'body' })
+      end
+    end
+  end
+
+  context 'with a string response body' 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.
+        Body of the API response error
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
+  end
+
+  context 'with an invalid_grant hash response body' do
+    let(:response_body) do
+      { 'error' => 'invalid_grant', 'error_description' => 'description' }
+    end
+    let(:response) { ApiResponseStub.new('500', response_body) }
+    let(:warning_text) do
+      <<~WARNING.chomp
+        Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        description
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
+  end
+
+  context 'with a generic hash response body' do
+    let(:response_body) do
+      { 'error' => 'summary', 'error_description' => 'description' }
+    end
+    let(:response) { ApiResponseStub.new('500', response_body) }
+    let(:warning_text) do
+      <<~WARNING.chomp
+        Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        #{response_body}
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Mapper do
+  let(:api) { described_class.new.api }
+
+  describe 'initialize with imis_id' do
+    it 'stores the initial imis_id' do
+      mapper = described_class.new(imis_id: 42)
+
+      expect(mapper.api.imis_id).to eq('42')
+    end
+  end
+
+  describe '#update' do
+    before { api.imis_id = 31092 }
+
+    it 'sends a mapped update' do
+      expect(api.mapper.update(mm: 15).first).to be_a(Hash)
+    end
+
+    it 'raises for unmapped updates' do
+      expect { api.mapper.update(something: 'anything') }.to raise_error(
+        Usps::Imis::Error::Mapper,
+        'Unrecognized field: "something". ' \
+        'Please report what data you are attempting to work with to ITCom leadership.'
+      )
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Usps
+  module Imis
+    module Panel
+      class InvalidPanel < BasePanel; end
+
+      class InvalidPanelWithBusinessObject < BasePanel
+      private
+
+        def business_object = 'Something'
+      end
+    end
+  end
+end
+
+describe Usps::Imis::Panel::BasePanel do
+  it 'requires #business_object to be defined' do
+    expect { Usps::Imis::Panel::InvalidPanel.new.get(1) }.to raise_error(
+      Usps::Imis::Error::Api, 'Usps::Imis::Panel::InvalidPanel must implement #business_object'
+    )
+  end
+
+  it 'requires #payload(data) to be defined' do
+    expect { Usps::Imis::Panel::InvalidPanelWithBusinessObject.new.create({}) }.to raise_error(
+      Usps::Imis::Error::Api,
+      'Usps::Imis::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
+    )
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Panel::Education do
+  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 }
+
+    describe '#get' do
+      it 'loads a specific object' do
+        expect(education.get(90737)).to be_a(Hash)
+      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)
+
+      ordinal = new_record['Identity']['IdentityElements']['$values'][1]
+
+      update_result =
+        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
+      expect(updated['Value']).to eq('Online Exams System - Modified')
+
+      expect(education.destroy(ordinal)).to eq('')
+    end
+    # 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(panel.api.imis_id).to eq('6374')
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Panel::Vsc do
+  let(:vsc) { described_class.new }
+
+  let(:details) do
+    {
+      certificate: 'E136924',
+      year: 2024,
+      count: 42
+    }
+  end
+
+  before { vsc.api.imis_id = 6374 }
+
+  describe '#get' do
+    it 'loads a specific object' do
+      expect(vsc.get(1433)).to be_a(Hash)
+    end
+  end
+
+  # rubocop:disable RSpec/ExampleLength
+  it 'handles new records correctly', :aggregate_failures do
+    new_record = vsc.create(details)
+    expect(new_record).to be_a(Hash)
+
+    ordinal = new_record['Identity']['IdentityElements']['$values'][1]
+
+    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)
+
+    expect(vsc.destroy(ordinal)).to eq('')
+  end
+  # rubocop:enable RSpec/ExampleLength
+end

data/spec/lib/usps/imis_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis do
+  it 'returns configuration from configure without a block' do
+    described_class.configuration.environment = 'development'
+
+    expect(described_class.configure.environment).to eq('development')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.setup
+require 'simplecov'
+SimpleCov.minimum_coverage(line: 100, branch: 100)
+
+require 'dotenv/load'
+require 'usps/imis'
+
+ENV['TESTING'] = 'true'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = 'tmp/.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expose_dsl_globally = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:suite) do
+    Usps::Imis.configure do |imis_config|
+      imis_config.environment = :development
+      imis_config.imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', '')
+
+      imis_config.username = ENV.fetch('IMIS_USERNAME', '')
+      imis_config.password = ENV.fetch('IMIS_PASSWORD', '')
+    end
+  end
+end

data/usps-imis-api.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'lib/usps/imis/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'usps-imis-api'
+  s.version       = Usps::Imis::VERSION
+  s.summary       = 'iMIS API Wrapper'
+  s.description   = 'A wrapper for the iMIS API.'
+  s.homepage      = 'http://rubygems.org/gems/usps-imis-api'
+  s.authors       = ['Julian Fiander']
+  s.email         = 'jsfiander@gmail.com'
+  s.require_paths = %w[lib]
+  s.files         = `git ls-files`.split("\n")
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.required_ruby_version = '>= 3.4'
+end