usps-imis-api 1.0.0.pre.rc.2 → 1.0.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd103cb82cf705d717bd293bef46390aee8a82dca66ec103fa28510bb67b921c
-  data.tar.gz: 4d1dee0de5129874d612b8b888d57b24918582925b61ffac91ef7722a5cbc9cd
+  metadata.gz: 927a6d408196ed631d013daac7854beb5b0c27b7b138a454c0078af710cad204
+  data.tar.gz: 8d747f8023487b5fa1d2e4fc50a3aa5d26676cc99c818849b6fa9af205a8e50b
 SHA512:
-  metadata.gz: 30acc54f0082681a9c38ba36bdfe6252331a0199416e131557352a880df66b465cd30de07fb3c3ab0d66366df97b096210e58be649387a3929609c09b9293010
-  data.tar.gz: 729b191b9d78e62f0acc659730d3761e4dc8a60f72304dd5b584a6ac9a63853c659c0fc335ceb7cbd35d903bc2c85656c0642259b2ee8c2f318669741d0d31fe
+  metadata.gz: b87668b7e37cfa951b729ef0c01b580055b0d48076f6ffab10bff81e0d47ad255df3718e3c63daece6c0a2fc256506eb9ceefec0bed564ce09b1c5bc4e8ba116
+  data.tar.gz: e0c08859e7e890887267d13166023ef903355ed70416bd83e856d143de0eab6753d78c0b976acdcc3356144bd3ae92a95ebef43233c6b40a89b17315bb29de0e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (1.0.0.pre.rc.2)
+    usps-imis-api (1.0.0.pre.rc.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/usps/imis/api.rb

@@ -31,6 +31,10 @@ module Usps
       #
       attr_reader :imis_id
 
+      # Whether to lock changes to the selected iMIS ID
+      #
+      attr_reader :lock_imis_id
+
       # A new instance of +Api+
       #
       # @param skip_authentication [bool] Skip authentication on initialization (used for tests)
@@ -46,6 +50,8 @@ module Usps
       # @param id [Integer, String] iMIS ID to select for future requests
       #
       def imis_id=(id)
+        raise Error::ApiError, 'Cannot change iMIS ID while locked' if lock_imis_id
+
         @imis_id = id.to_i.to_s
       end
 
@@ -56,15 +62,19 @@ module Usps
       # @return [String] Corresponding iMIS ID
       #
       def imis_id_for(certificate)
-        result = query(Imis.configuration.imis_id_query_name, { certificate: })
-        @imis_id = result['Items']['$values'][0]['ID']
-      rescue StandardError
-        raise Error::Api, 'Member not found'
+        raise Error::ApiError, 'Cannot change iMIS ID while locked' if lock_imis_id
+
+        begin
+          result = query(Imis.configuration.imis_id_query_name, { certificate: })
+          @imis_id = result['Items']['$values'][0]['ID']
+        rescue StandardError
+          raise Error::ApiError, 'Member not found'
+        end
       end
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope
       #
-      # This should be used with methods that do not change the value of `imis_id`
+      # While in this block, changes to the value of +imis_id+ are not allowed
       #
       # @param id [Integer, String] iMIS ID to select for requests within the block
       #
@@ -76,8 +86,11 @@ module Usps
       def with(id, &)
         old_id = imis_id
         self.imis_id = id
+
+        @lock_imis_id = true
         instance_eval(&)
       ensure
+        @lock_imis_id = false
         self.imis_id = old_id
       end
 
@@ -228,7 +241,7 @@ module Usps
 
       def submit(uri, request)
         client(uri).request(request).tap do |result|
-          raise Error::Response.from(result) unless result.is_a?(Net::HTTPSuccess)
+          raise Error::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
         end
       end
 

data/lib/usps/imis/config.rb

@@ -25,7 +25,7 @@ module Usps
         when :development
           IMIS_ROOT_URL_DEV
         else
-          raise Error::Api, "Unexpected API environment: #{environment}"
+          raise Error::ApiError, "Unexpected API environment: #{environment}"
         end
       end
 

data/lib/usps/imis/error/{api.rb → api_error.rb}

@@ -5,12 +5,12 @@ module Usps
     module Error
       # Base error class for all internal exceptions
       #
-      class Api < StandardError
+      class ApiError < StandardError
         # Additional call-specific metadata to pass through to Bugsnag
         #
         attr_accessor :metadata
 
-        # A new instance of +Error::Api+
+        # A new instance of +ApiError+
         #
         # @param message [String] The base exception message
         # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag

data/lib/usps/imis/error/{mapper.rb → mapper_error.rb}

@@ -5,7 +5,7 @@ module Usps
     module Error
       # Exception raised by a +Mapper+
       #
-      class Mapper < Api; end
+      class MapperError < ApiError; end
     end
   end
 end

data/lib/usps/imis/error/{response.rb → response_error.rb}

@@ -5,7 +5,7 @@ module Usps
     module Error
       # Exception raised due to receiving an error response from the API
       #
-      class Response < Api
+      class ResponseError < ApiError
         # [Net::HTTPResponse] The response received from the API
         #
         attr_reader :response
@@ -14,7 +14,7 @@ module Usps
         #
         attr_accessor :metadata
 
-        # Create a new instance of +Error::Response+ from an API response
+        # Create a new instance of +ResponseError+ from an API response
         #
         # @param response [Net::HTTPResponse] The response received from the API
         #
@@ -22,7 +22,7 @@ module Usps
           new(nil, response)
         end
 
-        # Create a new instance of +Error::Response+
+        # Create a new instance of +ResponseError+
         #
         # @param _message Ignored
         # @param response [Net::HTTPResponse] The response received from the API

data/lib/usps/imis/mapper.rb

@@ -74,7 +74,7 @@ module Usps
         end
 
         raise(
-          Error::Mapper,
+          Error::MapperError,
           "Unrecognized field: \"#{field_name}\". " \
           'Please report what data you are attempting to work with to ITCom leadership.'
         )

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

@@ -51,11 +51,11 @@ module Usps
       private
 
         def business_object
-          raise Error::Api, "#{self.class.name} must implement #business_object"
+          raise Error::ApiError, "#{self.class.name} must implement #business_object"
         end
 
         def payload(_data)
-          raise Error::Api, "#{self.class.name} must implement #payload(data)"
+          raise Error::ApiError, "#{self.class.name} must implement #payload(data)"
         end
       end
     end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '1.0.0-rc.2'
+    VERSION = '1.0.0-rc.3'
   end
 end

data/lib/usps/imis.rb

@@ -13,9 +13,9 @@ require 'ext/hash' unless defined?(Rails)
 
 # Internal requires
 require_relative 'imis/config'
-require_relative 'imis/error/api'
-require_relative 'imis/error/mapper'
-require_relative 'imis/error/response'
+require_relative 'imis/error/api_error'
+require_relative 'imis/error/mapper_error'
+require_relative 'imis/error/response_error'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/panel/base_panel'

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

@@ -31,7 +31,7 @@ describe Usps::Imis::Api do
 
       it 'wraps errors' do
         expect { api.imis_id_for('E231625') }.to raise_error(
-          Usps::Imis::Error::Api, 'Member not found'
+          Usps::Imis::Error::ApiError, 'Member not found'
         )
       end
     end
@@ -47,7 +47,7 @@ describe Usps::Imis::Api do
     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.
+          Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
           Something went wrong
         WARNING
       end
@@ -62,7 +62,7 @@ describe Usps::Imis::Api do
 
       it 'wraps the error' do
         expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
-          Usps::Imis::Error::Api, warning_text
+          Usps::Imis::Error::ApiError, warning_text
         )
       end
     end
@@ -82,6 +82,18 @@ describe Usps::Imis::Api do
     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::Error::ApiError, '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
   end
 
   describe '#inspect' do

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

@@ -25,7 +25,7 @@ describe Usps::Imis::Config do
 
       it 'raises an error' do
         expect { config.hostname }.to raise_error(
-          Usps::Imis::Error::Api, 'Unexpected API environment: nothing'
+          Usps::Imis::Error::ApiError, 'Unexpected API environment: nothing'
         )
       end
     end

data/spec/lib/usps/imis/error/{api_spec.rb → api_error_spec.rb}

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

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

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 ApiResponseStub = Struct.new(:code, :body)
 
-describe Usps::Imis::Error::Response do
+describe Usps::Imis::Error::ResponseError do
   let(:error) { described_class.from(response) }
 
   describe 'error codes' do
@@ -61,7 +61,7 @@ describe Usps::Imis::Error::Response 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.
+        Usps::Imis::Error::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::Response do
     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.
+        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         description
       WARNING
     end
@@ -95,7 +95,7 @@ describe Usps::Imis::Error::Response do
     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.
+        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         #{response_body}
       WARNING
     end

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

@@ -22,7 +22,7 @@ describe Usps::Imis::Mapper do
 
     it 'raises for unmapped updates' do
       expect { api.mapper.update(something: 'anything') }.to raise_error(
-        Usps::Imis::Error::Mapper,
+        Usps::Imis::Error::MapperError,
         'Unrecognized field: "something". ' \
         'Please report what data you are attempting to work with to ITCom leadership.'
       )

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

@@ -19,13 +19,13 @@ 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'
+      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::Api,
+      Usps::Imis::Error::ApiError,
       'Usps::Imis::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
     )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.2
+  version: 1.0.0.pre.rc.3
 platform: ruby
 authors:
 - Julian Fiander
@@ -31,9 +31,9 @@ files:
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/config.rb
-- lib/usps/imis/error/api.rb
-- lib/usps/imis/error/mapper.rb
-- lib/usps/imis/error/response.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/mapper.rb
 - lib/usps/imis/panel/base_panel.rb
 - lib/usps/imis/panel/education.rb
@@ -41,8 +41,8 @@ files:
 - lib/usps/imis/version.rb
 - 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/error/api_error_spec.rb
+- spec/lib/usps/imis/error/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