usps-imis-api 0.9.8 → 0.9.10.pre.1

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/bin/console

@@ -1,21 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'usps/imis'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# Configure from the environment automatically
-require 'dotenv/load'
-Usps::Imis.configure do |config|
-  config.environment = :development
-  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
-
-  config.username = ENV['IMIS_USERNAME']
-  config.password = ENV['IMIS_PASSWORD']
-end
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

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

@@ -1,171 +0,0 @@
-# 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::Errors::NotFoundError, 'Member not found'
-        )
-      end
-    end
-  end
-
-  describe '#query' do
-    let(:query) { api.query('$/ABC/ExampleQueryAll', {}) }
-
-    before do
-      allow(query).to receive(:fetch).and_return(
-        { 'Items' => { '$values' => [{ 'key1' => 'value1' }] }, 'HasNext' => true, 'NextOffset' => 1 },
-        { 'Items' => { '$values' => [{ 'key1' => 'value2' }] }, 'HasNext' => false, 'NextOffset' => 0 }
-      )
-    end
-
-    it 'collects all query results' do
-      expect(query.to_a).to eq([{ 'key1' => 'value1' }, { 'key1' => 'value2' }])
-    end
-  end
-
-  describe '#put' do
-    before { api.imis_id = 31092 }
-
-    it 'sends an update' do
-      expect(api.on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)).to be_a(Hash)
-    end
-
-    context 'when receiving a response error' do
-      let(:warning_text) do
-        <<~WARNING.chomp
-          Usps::Imis::Errors::ResponseError: [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.on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
-          raise_error(Usps::Imis::Errors::ResponseError, warning_text)
-        )
-      end
-    end
-  end
-
-  describe '#with' do
-    it 'sends an update from put' do
-      expect(
-        api.with(31092) { on('ABC_ASC_Individual_Demog').put_fields('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
-
-    it 'blocks calling imis_id=' do
-      expect do
-        api.with(31092) { self.imis_id = 31092 }
-      end.to raise_error(Usps::Imis::Errors::LockedIdError, 'Cannot change iMIS ID while locked')
-    end
-
-    it 'blocks calling imis_id_for' do
-      expect do
-        api.with(31092) { imis_id_for('E231625') }
-      end.to raise_error(Usps::Imis::Errors::LockedIdError, 'Cannot change iMIS ID while locked')
-    end
-  end
-
-  describe '#on' do
-    it 'returns a BusinessObject without a block' do
-      expect(api.on('ABC_ASC_Individual_Demog')).to be_a(Usps::Imis::BusinessObject)
-    end
-
-    it 'sends an update from put', :aggregate_failures do
-      result = api.with(31092) do
-        on('ABC_ASC_Individual_Demog') { put_fields({ 'TotMMS' => 15 }) }
-      end
-
-      expect(result).to be_a(Hash)
-      expect(api.imis_id).to be_nil
-    end
-
-    it 'chains .with().on() to a single block', :aggregate_failures do
-      result = api.with(31092).on('ABC_ASC_Individual_Demog') do
-        put_fields({ 'TotMMS' => 15 })
-      end
-
-      expect(result).to be_a(Hash)
-      expect(api.imis_id).to eq(31092)
-    end
-
-    it 'nests on and with', :aggregate_failures do
-      result = api.on('ABC_ASC_Individual_Demog') do |object|
-        api.with(31092) { object.put_fields({ 'TotMMS' => 15 }) }
-      end
-
-      expect(result).to be_a(Hash)
-      expect(api.imis_id).to be_nil
-    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
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::BusinessObject do
-  describe '#put_field' do
-    let(:business_object) { api.on('ABC_ASC_Individual_Demog') }
-    let(:api) { Usps::Imis::Api.new.with(31092) }
-
-    before { business_object.put_field('TotMMS', 15) }
-
-    it 'submits the correct update request' do
-      expect { business_object['TotMMS'] = 16 }.to change { business_object['TotMMS'] }.from(15).to(16)
-    end
-  end
-
-  context 'with stubbed data' do
-    let(:business_object) { described_class.new(api, 'Stub') }
-    let(:api) { Usps::Imis::Api.new }
-
-    before do
-      allow(business_object).to receive(:raw_object).and_return(
-        Usps::Imis::Data[
-          'Properties' => {
-            '$values' => [
-              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-              { 'Name' => 'Stub String', 'Value' => 'something' }
-            ]
-          }
-        ]
-      )
-    end
-
-    describe '#get' do
-      it 'returns multiple values' do
-        expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
-      end
-
-      describe 'delegation to get_fields' do
-        before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
-
-        it 'delegates to get_fields' do
-          business_object.get('Stub String', 'Stub Integer')
-
-          expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
-        end
-      end
-    end
-
-    describe '#get_field' do
-      it 'returns a string value' do
-        expect(business_object.get_field('Stub String')).to eq('something')
-      end
-
-      it 'returns an integer value' do
-        expect(business_object.get_field('Stub Integer')).to eq(42)
-      end
-    end
-
-    describe '#get_fields' do
-      it 'returns multiple values' do
-        expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
-      end
-    end
-
-    describe '#filter_fields' do
-      let(:expected) do
-        {
-          'Properties' => {
-            '$values' => [
-              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-              { 'Name' => 'Stub String', 'Value' => 'other' }
-            ]
-          }
-        }
-      end
-
-      it 'formats fields correctly' do
-        updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
-
-        expect(updated).to eq(expected)
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::Config do
-  let(:config) { described_class.new }
-
-  describe 'environment' do
-    subject { config.environment }
-
-    let(:config) { described_class.new }
-
-    context 'when not specified' do
-      it { is_expected.to be_development }
-    end
-
-    context 'when specified' do
-      before { config.environment = 'something' }
-
-      it { is_expected.to be_something }
-    end
-
-    context 'when specified on initialize' do
-      subject { config.environment }
-
-      let(:config) do
-        described_class.new { it.environment = 'test' }
-      end
-
-      it { is_expected.to be_test }
-    end
-
-    context 'when in Rails' do
-      before { stub_const('Rails', Struct.new(:env).new(ActiveSupport::StringInquirer.new('qa'))) }
-
-      it { is_expected.to be_qa }
-    end
-  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::Errors::ConfigError, 'Unexpected API environment: nothing'
-        )
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::Data do
-  let(:data) do
-    described_class[
-      'EntityTypeName' => 'ABC_ASC_Individual_Demog',
-      'Properties' => {
-        '$values' => [
-          { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-          { 'Name' => 'Stub String', 'Value' => 'something' }
-        ]
-      }
-    ]
-  end
-
-  describe 'missing property' do
-    it 'returns nil for missing properties' do
-      expect(data['Not Found']).to be_nil
-    end
-  end
-
-  describe '#properties' do
-    it 'iterates over the properties, excluding IDs' do
-      expect(data.properties.map { |field, value| "#{field}: #{value}" }).to eq(
-        ['Stub Integer: 42', 'Stub String: something']
-      )
-    end
-
-    it 'iterates over the properties, including IDs' do
-      expect(data.properties(include_ids: true).map { |field, value| "#{field}: #{value}" }).to eq(
-        ['ID: 31092', 'Stub Integer: 42', 'Stub String: something']
-      )
-    end
-  end
-
-  describe '#inspect' do
-    it 'generates the correct inspect string' do
-      expect(data.inspect).to eq('#<Usps::Imis::Data entity="ABC_ASC_Individual_Demog" imis_id=31092>')
-    end
-
-    context 'with data from a Panel' do
-      let(:data) do
-        described_class[
-          'EntityTypeName' => 'ABC_ASC_Individual_Demog',
-          'Properties' => {
-            '$values' => [
-              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-              { 'Name' => 'Ordinal', 'Value' => { '$value' => '99' } },
-              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-              { 'Name' => 'Stub String', 'Value' => 'something' }
-            ]
-          }
-        ]
-      end
-
-      it 'generates the correct inspect string with an ordinal' do
-        expect(data.inspect).to eq(
-          '#<Usps::Imis::Data entity="ABC_ASC_Individual_Demog" imis_id=31092 ordinal=99>'
-        )
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::Error 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/errors/response_error_spec.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-ApiResponseStub = Struct.new(:code, :body)
-
-describe Usps::Imis::Errors::ResponseError 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::Errors::ResponseError: [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::Errors::ResponseError: [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::Errors::ResponseError: [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

@@ -1,55 +0,0 @@
-# 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 '#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 }
-
-    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::Errors::MapperError,
-        %(Mapper does not recognize field: "something".\n) \
-        'Please report what data you are attempting to work with to ITCom leadership.'
-      )
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Usps::Imis::Mocks::BusinessObject do
-  let(:mock) { described_class.new(**fields) }
-  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
-
-  describe 'get' do
-    it 'returns the correct data' do
-      expect(mock.get).to eq(data)
-    end
-  end
-
-  describe 'get_field' do
-    it 'returns the correct field value' do
-      expect(mock.get_field('TotMMS')).to eq(2)
-    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
-
-    it 'returns the correct data' do
-      expect(mock.put_fields(SomethingElse: 'interesting')).to eq(combined_data)
-    end
-  end
-
-  describe 'put' do
-    it 'returns the correct data' do
-      expect(mock.put(data)).to eq(data)
-    end
-  end
-
-  describe 'post' do
-    it 'returns the correct data' do
-      expect(mock.post(data)).to eq(data)
-    end
-  end
-
-  describe 'delete' do
-    it 'returns the correct data' do
-      expect(mock.delete).to eq('')
-    end
-  end
-end