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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.5
+  version: 1.0.0.pre.rc.8
 platform: ruby
 authors:
 - Julian Fiander
@@ -41,35 +41,47 @@ files:
 - Readme.md
 - bin/console
 - bin/setup
-- lib/ext/hash.rb
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/business_object.rb
 - lib/usps/imis/config.rb
-- lib/usps/imis/error/api_error.rb
-- lib/usps/imis/error/mapper_error.rb
-- lib/usps/imis/error/response_error.rb
+- lib/usps/imis/data.rb
+- lib/usps/imis/error.rb
+- lib/usps/imis/errors/api_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/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/mapper.rb
-- lib/usps/imis/panel/base_panel.rb
-- lib/usps/imis/panel/education.rb
-- lib/usps/imis/panel/panel_properties.rb
-- lib/usps/imis/panel/vsc.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/properties.rb
+- lib/usps/imis/query.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
 - spec/lib/usps/imis/api_spec.rb
 - spec/lib/usps/imis/business_object_spec.rb
 - spec/lib/usps/imis/config_spec.rb
-- spec/lib/usps/imis/error/api_error_spec.rb
-- spec/lib/usps/imis/error/response_error_spec.rb
+- spec/lib/usps/imis/data_spec.rb
+- spec/lib/usps/imis/error_spec.rb
+- spec/lib/usps/imis/errors/response_error_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/panel_properties_spec.rb
-- spec/lib/usps/imis/panel/vsc_spec.rb
+- spec/lib/usps/imis/mocks/business_object_spec.rb
+- spec/lib/usps/imis/panels/base_panel_spec.rb
+- spec/lib/usps/imis/panels/education_spec.rb
+- spec/lib/usps/imis/panels/vsc_spec.rb
+- spec/lib/usps/imis/properties_spec.rb
 - spec/lib/usps/imis_spec.rb
 - spec/spec_helper.rb
 - usps-imis-api.gemspec
-homepage: http://rubygems.org/gems/usps-imis-api
+homepage: https://github.com/unitedstatespowersquadrons/imis-api-ruby
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'

data/lib/ext/hash.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# Import a simplified version of to_query from Rails if not already defined
-class Hash
-  def to_query
-    map do |key, value|
-      "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
-    end.sort * '&'
-  end
-end

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Error
-      # Base error class for all internal exceptions
-      #
-      class ApiError < StandardError
-        # Additional call-specific metadata to pass through to Bugsnag
-        #
-        attr_accessor :metadata
-
-        # A new instance of +ApiError+
-        #
-        # @param message [String] The base exception message
-        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
-        #
-        def initialize(message, metadata = {})
-          super(message)
-          @metadata = metadata
-        end
-
-        # Additional metadata to include in Bugsnag reports
-        #
-        # Can include fields at the top level, which will be shows on the custom tab
-        #
-        # Can include fields nested under a top-level key, which will be shown on a tab with the
-        # top-level key as its name
-        #
-        # @return [Hash]
-        #
-        def bugsnag_meta_data
-          metadata == {} ? {} : base_metadata
-        end
-
-      private
-
-        def base_metadata
-          { api: metadata }
-        end
-      end
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Error
-      # Exception raised by a +Mapper+
-      #
-      class MapperError < ApiError; end
-    end
-  end
-end

data/lib/usps/imis/panel/base_panel.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Panel
-      # Base class for configuring Panels
-      #
-      class BasePanel
-        # The parent +Api+ object
-        #
-        attr_reader :api
-
-        def initialize(api = nil, imis_id: nil)
-          @api = api || Api.new
-          @api.imis_id = imis_id if imis_id
-        end
-
-        # Get a specific object from the Panel
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        #
-        def get(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").get
-        end
-
-        # Create a new object in the Panel
-        #
-        # @param data [Hash] The record data for the desired object
-        #
-        def create(data)
-          api.business_object(business_object, url_id: '').post(payload(data))
-        end
-
-        # Update an existing object in the Panel
-        #
-        # @param data [Hash] The record data for the desired object -- including the required
-        #                    +ordinal+ identifier
-        #
-        def update(data)
-          api
-            .business_object(business_object, url_id: "~#{api.imis_id}|#{data[:ordinal]}")
-            .put(payload(data))
-        end
-
-        # Remove a specific object from the Panel
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        #
-        def destroy(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").delete
-        end
-
-      private
-
-        def business_object
-          raise Error::ApiError, "#{self.class.name} must implement #business_object"
-        end
-
-        def payload(_data)
-          raise Error::ApiError, "#{self.class.name} must implement #payload(data)"
-        end
-
-        def payload_header(data)
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
-            'EntityTypeName' => business_object,
-            'PrimaryParentEntityTypeName' => 'Party',
-            'Identity' => identity(data[:ordinal]),
-            'PrimaryParentIdentity' => primary_parent_identity
-          }
-        end
-
-        def identity(ordinal = nil)
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => business_object,
-            'IdentityElements' => {
-              '$type' => identity_type,
-              '$values' => [api.imis_id, ordinal&.to_s].compact
-            }
-          }
-        end
-
-        def primary_parent_identity
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => 'Party',
-            'IdentityElements' => {
-              '$type' => identity_type,
-              '$values' => [api.imis_id]
-            }
-          }
-        end
-
-        def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
-
-        def build_payload(data, &) = payload_header(data).merge(PanelProperties.build(&))
-      end
-    end
-  end
-end

data/lib/usps/imis/panel/panel_properties.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Panel
-      # Constructor for the Properties field for Panel requests
-      #
-      class PanelProperties
-        # Build a new Properties field
-        #
-        def self.build(&) = new.build(&)
-
-        # Build the Properties field
-        #
-        def build
-          yield(self)
-
-          {
-            'Properties' => {
-              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
-              '$values' => @properties
-            }
-          }
-        end
-
-        # Add an individual property to the field
-        #
-        def add(name, value)
-          @properties ||= []
-          @properties << {
-            '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-            'Name' => name,
-            'Value' => property_value(value)
-          }
-        end
-
-      private
-
-        def property_value(value)
-          case value
-          when String then value
-          when Time, DateTime then value.strftime('%Y-%m-%dT%H:%I:%S')
-          when Integer then { '$type' => 'System.Int32', '$value' => value }
-          when true, false then { '$type' => 'System.Boolean', '$value' => value }
-          else
-            raise Error::ApiError, "Unexpected property type: #{value.inspect}"
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# 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::ApiError, '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::ApiError,
-      'Usps::Imis::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
-    )
-  end
-end

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

@@ -1,55 +0,0 @@
-# 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/panel_properties_spec.rb

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