usps-imis-api 1.0.0.pre.rc.5 → 1.0.0.pre.rc.8

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

@@ -17,13 +17,13 @@ describe Usps::Imis::Api do
     it 'stores the initial imis_id' do
       api = described_class.new(imis_id: 42)
 
-      expect(api.imis_id).to eq('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')
+      expect(api.imis_id_for('E231625')).to eq(31092)
     end
 
     context 'with a query error' do
@@ -31,25 +31,38 @@ describe Usps::Imis::Api do
 
       it 'wraps errors' do
         expect { api.imis_id_for('E231625') }.to raise_error(
-          Usps::Imis::Error::ApiError, 'Member not found'
+          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.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)).to(
-        be_a(Hash)
-      )
+      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::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+          Usps::Imis::Errors::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
           Something went wrong
         WARNING
       end
@@ -63,8 +76,8 @@ describe Usps::Imis::Api do
       end
 
       it 'wraps the error' do
-        expect { api.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
-          raise_error(Usps::Imis::Error::ApiError, warning_text)
+        expect { api.on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
+          raise_error(Usps::Imis::Errors::ResponseError, warning_text)
         )
       end
     end
@@ -73,7 +86,7 @@ describe Usps::Imis::Api do
   describe '#with' do
     it 'sends an update from put' do
       expect(
-        api.with(31092) { business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }
+        api.with(31092) { on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }
       ).to be_a(Hash)
     end
 
@@ -88,13 +101,13 @@ describe Usps::Imis::Api do
     it 'blocks calling imis_id=' do
       expect do
         api.with(31092) { self.imis_id = 31092 }
-      end.to raise_error(Usps::Imis::Error::ApiError, 'Cannot change iMIS ID while locked')
+      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::Error::ApiError, 'Cannot change iMIS ID while locked')
+      end.to raise_error(Usps::Imis::Errors::LockedIdError, 'Cannot change iMIS ID while locked')
     end
   end
 
@@ -118,7 +131,7 @@ describe Usps::Imis::Api do
       end
 
       expect(result).to be_a(Hash)
-      expect(api.imis_id).to eq('31092')
+      expect(api.imis_id).to eq(31092)
     end
 
     it 'nests on and with', :aggregate_failures do

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

@@ -3,48 +3,85 @@
 require 'spec_helper'
 
 describe Usps::Imis::BusinessObject do
-  let(:business_object) { described_class.new(api, 'Stub') }
-  let(:api) { Usps::Imis::Api.new }
-
-  let(:expected) do
-    {
-      'Properties' => {
-        '$values' => [
-          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-          { 'Name' => 'Stub String', 'Value' => 'other' }
-        ]
-      }
-    }
+  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
 
-  before do
-    allow(business_object).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' }
+  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
+      )
+    end
+
+    describe '#get' do
+      it 'returns multiple values' do
+        expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+      end
 
-  describe '#get_field' do
-    it 'returns a string value' do
-      expect(business_object.get_field('Stub String')).to eq('something')
+      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
 
-    it 'returns an integer value' do
-      expect(business_object.get_field('Stub Integer')).to eq(42)
+    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
-  end
 
-  describe '#filter_fields' do
-    it 'formats fields correctly' do
-      updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
+    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)
+        expect(updated).to eq(expected)
+      end
     end
   end
 end

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

@@ -24,7 +24,7 @@ describe Usps::Imis::Config do
       subject { config.environment }
 
       let(:config) do
-        described_class.new { |c| c.environment = 'test' }
+        described_class.new { it.environment = 'test' }
       end
 
       it { is_expected.to be_test }
@@ -51,7 +51,7 @@ describe Usps::Imis::Config do
 
       it 'raises an error' do
         expect { config.hostname }.to raise_error(
-          Usps::Imis::Error::ApiError, 'Unexpected API environment: nothing'
+          Usps::Imis::Errors::ConfigError, 'Unexpected API environment: nothing'
         )
       end
     end

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

@@ -0,0 +1,66 @@
+# 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/api_error_spec.rb → error_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Error::ApiError do
+describe Usps::Imis::Error do
   it 'builds Bugsnag metadata' do
     error = described_class.new('Example', something: :else)
 

data/spec/lib/usps/imis/{error → errors}/response_error_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 ApiResponseStub = Struct.new(:code, :body)
 
-describe Usps::Imis::Error::ResponseError do
+describe Usps::Imis::Errors::ResponseError do
   let(:error) { described_class.from(response) }
 
   describe 'error codes' do
@@ -61,7 +61,7 @@ describe Usps::Imis::Error::ResponseError do
     let(:response) { ApiResponseStub.new('500', 'Body of the API response error') }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Errors::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         Body of the API response error
       WARNING
     end
@@ -78,7 +78,7 @@ describe Usps::Imis::Error::ResponseError do
     let(:response) { ApiResponseStub.new('500', response_body) }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Errors::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         description
       WARNING
     end
@@ -95,7 +95,7 @@ describe Usps::Imis::Error::ResponseError do
     let(:response) { ApiResponseStub.new('500', response_body) }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Errors::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         #{response_body}
       WARNING
     end

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

@@ -9,7 +9,31 @@ describe Usps::Imis::Mapper do
     it 'stores the initial imis_id' do
       mapper = described_class.new(imis_id: 42)
 
-      expect(mapper.api.imis_id).to eq('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
 
@@ -22,8 +46,8 @@ describe Usps::Imis::Mapper do
 
     it 'raises for unmapped updates' do
       expect { api.mapper.update(something: 'anything') }.to raise_error(
-        Usps::Imis::Error::MapperError,
-        'Unrecognized field: "something". ' \
+        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

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

@@ -0,0 +1,65 @@
+# 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

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

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

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Panels::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(Usps::Imis::Data)
+      end
+
+      it 'returns specific fields' do
+        expect(education.get(90737, 'ABC_Product_Code', 'ABC_Other_Code')).to eq(%w[CRS AP])
+      end
+    end
+
+    describe '#get_field' do
+      it 'returns a specific field' do
+        expect(education.get_field(90737, 'ABC_Product_Code')).to eq('CRS')
+      end
+    end
+
+    describe '#get_fields' do
+      it 'returns specific fields' do
+        expect(education.get_fields(90737, 'ABC_Product_Code', 'ABC_Other_Code')).to eq(%w[CRS AP])
+      end
+    end
+
+    # rubocop:disable RSpec/ExampleLength
+    it 'interacts with records correctly', :aggregate_failures do
+      new_record = education.create(details)
+      expect(new_record).to be_a(Usps::Imis::Data)
+
+      ordinal = new_record.ordinal
+
+      update_result =
+        education.update(details.merge(source: 'Online Exams System - Modified', ordinal:))
+      expect(update_result['ABC_Educ_Source_System']).to eq('Online Exams System - Modified')
+
+      put_fields_result = education.put_fields(ordinal, 'ABC_Educ_Source_System' => 'Online Exams System - Mod2')
+      expect(put_fields_result['ABC_Educ_Source_System']).to eq('Online Exams System - Mod2')
+
+      expect(education.destroy(ordinal)).to be(true)
+    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 → panels}/vsc_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Panel::Vsc do
+describe Usps::Imis::Panels::Vsc do
   let(:vsc) { described_class.new }
 
   let(:details) do
@@ -17,22 +17,21 @@ describe Usps::Imis::Panel::Vsc do
 
   describe '#get' do
     it 'loads a specific object' do
-      expect(vsc.get(1433)).to be_a(Hash)
+      expect(vsc.get(1433)).to be_a(Usps::Imis::Data)
     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)
+    expect(new_record).to be_a(Usps::Imis::Data)
 
-    ordinal = new_record['Identity']['IdentityElements']['$values'][1]
+    ordinal = new_record.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)
+    expect(update_result['Quantity']).to eq(43)
 
-    expect(vsc.destroy(ordinal)).to eq('')
+    expect(vsc.destroy(ordinal)).to be(true)
   end
   # rubocop:enable RSpec/ExampleLength
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Properties do
+  let(:builder) { described_class.new }
+
+  it 'wraps boolean property values' do
+    expect(builder.send(:wrap, true)).to eq(
+      '$type' => 'System.Boolean', '$value' => true
+    )
+  end
+
+  it 'raises an error for unexpected property types' do
+    expect { builder.send(:wrap, {}) }.to raise_error(
+      Usps::Imis::Errors::UnexpectedPropertyTypeError, 'Unexpected property type: {}'
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -31,6 +31,8 @@ RSpec.configure do |config|
 
       imis_config.username = ENV.fetch('IMIS_USERNAME', '')
       imis_config.password = ENV.fetch('IMIS_PASSWORD', '')
+
+      imis_config.logger = Logger.new(nil)
     end
   end
 end

data/usps-imis-api.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   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.homepage      = 'https://github.com/unitedstatespowersquadrons/imis-api-ruby'
   s.authors       = ['Julian Fiander']
   s.email         = 'jsfiander@gmail.com'
   s.require_paths = %w[lib]