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

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

metadata

@@ -1,127 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.27
+  version: 1.0.0.pre.rc.1
 platform: ruby
 authors:
 - Julian Fiander
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.4
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: optimist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.1
+dependencies: []
 description: A wrapper for the iMIS API.
 email: jsfiander@gmail.com
-executables:
-- imis
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- Gemfile
+- Gemfile.lock
+- Rakefile
 - Readme.md
-- bin/imis
+- bin/console
+- bin/setup
+- lib/ext/hash.rb
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
-- lib/usps/imis/base_data.rb
-- lib/usps/imis/blank_object.rb
-- lib/usps/imis/business_object.rb
-- lib/usps/imis/command_line.rb
-- lib/usps/imis/command_line/interface.rb
-- lib/usps/imis/command_line/options_parser.rb
-- lib/usps/imis/command_line/performers.rb
 - lib/usps/imis/config.rb
-- lib/usps/imis/data.rb
-- lib/usps/imis/error.rb
-- lib/usps/imis/errors/api_error.rb
-- lib/usps/imis/errors/command_line_error.rb
-- lib/usps/imis/errors/config_error.rb
-- lib/usps/imis/errors/locked_id_error.rb
-- lib/usps/imis/errors/mapper_error.rb
-- lib/usps/imis/errors/missing_id_error.rb
-- lib/usps/imis/errors/not_found_error.rb
-- lib/usps/imis/errors/panel_unimplemented_error.rb
-- lib/usps/imis/errors/response_error.rb
-- lib/usps/imis/errors/unexpected_property_type_error.rb
-- lib/usps/imis/logger.rb
-- lib/usps/imis/logger_formatter.rb
-- lib/usps/imis/logger_helpers.rb
+- lib/usps/imis/error/api.rb
+- lib/usps/imis/error/mapper.rb
+- lib/usps/imis/error/response.rb
 - lib/usps/imis/mapper.rb
-- lib/usps/imis/mocks.rb
-- lib/usps/imis/mocks/business_object.rb
-- lib/usps/imis/panels.rb
-- lib/usps/imis/panels/base_panel.rb
-- lib/usps/imis/panels/education.rb
-- lib/usps/imis/panels/vsc.rb
-- lib/usps/imis/party_data.rb
-- lib/usps/imis/properties.rb
-- lib/usps/imis/query.rb
-- lib/usps/imis/requests.rb
+- lib/usps/imis/panel/base_panel.rb
+- lib/usps/imis/panel/education.rb
+- lib/usps/imis/panel/vsc.rb
 - lib/usps/imis/version.rb
-- spec/support/usps/vcr.rb
-- spec/support/usps/vcr/config.rb
-- spec/support/usps/vcr/filters.rb
-homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
+- spec/lib/usps/imis/api_spec.rb
+- spec/lib/usps/imis/config_spec.rb
+- spec/lib/usps/imis/error/api_spec.rb
+- spec/lib/usps/imis/error/response_spec.rb
+- spec/lib/usps/imis/mapper_spec.rb
+- spec/lib/usps/imis/panel/base_panel_spec.rb
+- spec/lib/usps/imis/panel/education_spec.rb
+- spec/lib/usps/imis/panel/vsc_spec.rb
+- spec/lib/usps/imis_spec.rb
+- spec/spec_helper.rb
+- usps-imis-api.gemspec
+homepage: http://rubygems.org/gems/usps-imis-api
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
-- spec/support
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/imis

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/usps/imis'
-require_relative '../lib/usps/imis/command_line'
-
-# Invoke CLI
-#
-Usps::Imis::CommandLine::Interface.run

data/lib/usps/imis/base_data.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'pp'
-require 'stringio'
-
-module Usps
-  module Imis
-    # Base class for API data response wrappers
-    #
-    class BaseData < Hash
-      # Load raw API response JSON to access properties
-      #
-      # @param json [String] Raw API response JSON
-      #
-      def self.from_json(json) = self[JSON.parse(json)]
-
-      alias raw to_h
-
-      # Access the iMIS ID property
-      #
-      def imis_id
-        raise Errors::ApiError, "#{self.class} must implement #imis_id"
-      end
-      alias id imis_id
-
-      # Access an individual property value by name
-      #
-      def [](_property_name)
-        raise Errors::ApiError, "#{self.class} must implement #[](property_name)"
-      end
-
-      # Hash of all property names to values
-      #
-      def properties(...)
-        raise Errors::ApiError, "#{self.class} must implement #properties"
-      end
-
-      def []=(...)
-        raise(
-          Errors::ApiError,
-          "#{self.class} does not support setting values. If you need to modify it, call `.raw` on it."
-        )
-      end
-
-      def inspect
-        stringio = StringIO.new
-        PP.pp(self, stringio)
-        stringio.string.delete("\n")
-      end
-
-      def pretty_print(pp)
-        pp.group(1, "#<#{self.class}", '>') do
-          pretty_print_data.each do |key, value|
-            pp.breakable
-            pp.text "#{key}="
-            pp.pp value
-          end
-        end
-      end
-    end
-  end
-end

data/lib/usps/imis/blank_object.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'requests'
-require_relative 'data'
-require_relative 'party_data'
-
-module Usps
-  module Imis
-    # Constructor for blank BusinessObject and BasePanel objects
-    #
-    class BlankObject
-      # The parent object
-      #
-      attr_reader :parent
-
-      def initialize(parent, ordinal = nil)
-        @parent = parent
-        @ordinal = ordinal
-      end
-
-      # Build a blank object for the current iMIS ID
-      #
-      def build(&) = payload_header.merge(Properties.build(parent.api.imis_id.to_s, @ordinal.to_s, &))
-
-    private
-
-      def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
-
-      def payload_header
-        {
-          '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
-          'EntityTypeName' => parent.business_object_name,
-          'PrimaryParentEntityTypeName' => 'Party',
-          'Identity' => identity,
-          'PrimaryParentIdentity' => primary_parent_identity
-        }
-      end
-
-      def identity
-        {
-          '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-          'EntityTypeName' => parent.business_object_name,
-          'IdentityElements' => {
-            '$type' => identity_type,
-            '$values' => [parent.api.imis_id.to_s, @ordinal&.to_s].compact
-          }
-        }
-      end
-
-      def primary_parent_identity
-        {
-          '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-          'EntityTypeName' => 'Party',
-          'IdentityElements' => {
-            '$type' => identity_type,
-            '$values' => [parent.api.imis_id.to_s]
-          }
-        }
-      end
-    end
-  end
-end