usps-imis-api 0.3.3.pre.1 → 0.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc22f317de0a82cfb40a5083b7db1d9fb86a5d942bb83547dc289f85dafb850a
-  data.tar.gz: ead09b5d23d8bc4caace906d06ed728b8d6eaca16a09b911ba1d7d327847e2c4
+  metadata.gz: 3459419a9ef8f312f60eba3a4fc03c2742fba42e5c9cbda666f91dd74c4caa5e
+  data.tar.gz: 0fd66d1145913d41f07c3d4ca6750b4ec7462f0bfdfbf9987385a06a2ab1c199
 SHA512:
-  metadata.gz: 12edb38028ba33c80cec5445e4516814d9abbbb535a0073dfc565edfb80554175b42e1047c91a31da97a188af9882ed46e77839a8bdaf032043eb993bddb352d
-  data.tar.gz: f4b506cf80210450c215ff7fede0f1b83469b6595e4f21c23cb5eb7ceea186c71371d6404cf64fb285ca88b1d81423d3c5e50b65cb5c6c088a293efd34031d23
+  metadata.gz: 7bbe93c98e47e1169cbae8b5979d365745fbfe9adcfc6a3f0842b9277321add4c0f4f55bd2315ee89378c9ec86771b1135d775bb3383eb5bb3350a11b8c2a294
+  data.tar.gz: 5317c2e4c886e596f2f408e752925c32911319ef74b4cb1fc695c3bdc8284a980e62ff4a4a24f9c946d26795c532f48a777c965d5f81f01c22f8b59f03b66057

data/.rubocop.yml

@@ -45,9 +45,9 @@ Metrics/MethodLength:
   Max: 15
 Metrics/ClassLength:
   Enabled: true
-  Max: 125
+  Max: 150
 Metrics/ModuleLength:
-  Max: 125
+  Max: 150
 Metrics/ParameterLists:
   Enabled: true
 Metrics/CyclomaticComplexity:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.3.3.pre.1)
+    usps-imis-api (0.4.0.pre.1)
 
 GEM
   remote: https://rubygems.org/

data/Readme.md

@@ -41,6 +41,12 @@ Instantiate the API object:
 api = Usps::Imis::Api.new
 ```
 
+If you already have an iMIS ID to work with, you can pass that in immediately:
+
+```ruby
+api = Usps::Imis::Api.new(imis_id: imis_id)
+```
+
 ### Authentication
 
 If a token is not available, this will automatically fetch one when needed. As long as that token
@@ -176,6 +182,12 @@ vsc.update(certificate: 'E136924', year: 2024, count: 43, ordinal: ordinal)
 vsc.destroy(ordinal)
 ```
 
+If you already have an iMIS ID to work with, you can pass that in immediately:
+
+```ruby
+vsc = Usps::Imis::Panel::Vsc.new(imis_id: imis_id)
+```
+
 Panels are also accessible directly from the API object:
 
 ```ruby
@@ -210,6 +222,9 @@ end
 
 Exception and error response handling will be added later.
 
+To print exception information to STDERR when raising, set the environment
+variable `IMIS_ERROR_LOG_TO_STDERR=true`.
+
 ## Automated Testing and Linting
 
 Testing is available by running:

data/lib/usps/imis/api.rb

@@ -149,7 +149,7 @@ module Usps
 
       def submit(uri, request)
         client(uri).request(request).tap do |result|
-          raise Error::Api.from(result) unless result.is_a?(Net::HTTPSuccess)
+          raise Error::Response.new(result) unless result.is_a?(Net::HTTPSuccess)
         end
       end
 

data/lib/usps/imis/config.rb

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

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

@@ -4,57 +4,23 @@ module Usps
   module Imis
     module Error
       class Api < StandardError
-        attr_reader :response
         attr_accessor :metadata
 
-        def self.from(response)
-          new('The iMIS API returned an error.', response)
-        end
-
-        def initialize(message, response, metadata = {})
+        def initialize(message, metadata = {})
           super(message)
           @metadata = metadata
-          @response = response
+
+          warn inspect if ENV.fetch('IMIS_ERROR_LOG_TO_STDERR', 'false') == 'true'
         end
 
         def bugsnag_meta_data
-          { api: { status: status, body: body }.merge!(metadata) }
+          metadata != {} ? { api: metadata } : {}
         end
 
       private
 
-        def status
-          @status ||=
-            case response.code
-            when '400'
-              :bad_request
-            when '401'
-              :unauthorized # RequestVerificationToken invalid
-            when '404'
-              :not_found
-            when '422'
-              :unprocessable_entity # validation error
-            when /^50\d$/
-              :internal_server_error # error within iMIS
-            end
-        end
-
-        def response_body
-          @response_body ||= JSON.parse(response.body)
-        rescue StandardError
-          @response_body ||= response.body
-        end
-
-        def body
-          return response_body unless response_body.is_a?(Hash)
-
-          case response_body['error']
-          when 'invalid_grant'
-            response_body['error_description']
-          else
-            # Unknown error type: just use the raw response
-            response.body
-          end
+        def base_metadata
+          { api: {} }
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Usps
   module Imis
     module Error
-      class Mapper < StandardError; end
+      class Mapper < Api; end
     end
   end
 end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Error
+      class Response < Api
+        attr_reader :response
+        attr_accessor :metadata
+
+        def initialize(response, metadata = {})
+          @response = response
+          super(message, metadata)
+        end
+
+        def bugsnag_meta_data
+          base_metadata.tap { |m| m[:api].merge!(metadata) }
+        end
+
+        def message
+          [
+            "#{self.class.name}: [#{status.to_s.upcase}] The iMIS API returned an error.",
+            (metadata.inspect if metadata != {}),
+            body
+          ].compact.join("\n")
+        end
+
+      private
+
+        def base_metadata
+          { api: { status: status, body: body } }
+        end
+
+        def status
+          @status ||=
+            case response.code
+            when '400'
+              :bad_request
+            when '401'
+              :unauthorized # RequestVerificationToken invalid
+            when '404'
+              :not_found
+            when '422'
+              :unprocessable_entity # validation error
+            when /^50\d$/
+              :internal_server_error # error within iMIS
+            end
+        end
+
+        def response_body
+          @response_body ||= JSON.parse(response.body)
+        rescue StandardError
+          @response_body ||= response.body
+        end
+
+        def body
+          return response_body unless response_body.is_a?(Hash)
+
+          case response_body['error']
+          when 'invalid_grant'
+            response_body['error_description']
+          else
+            # Unknown error type: just use the raw response
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/mapper.rb

@@ -14,8 +14,9 @@ module Usps
 
       attr_reader :api
 
-      def initialize(api = nil)
+      def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
+        api.imis_id = imis_id if imis_id
       end
 
       # Update a member's data on multiple affected business objects by arbitrary field names
@@ -59,7 +60,7 @@ module Usps
         end
 
         raise(
-          Imis::Error::Mapper,
+          Error::Mapper,
           "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

@@ -30,11 +30,11 @@ module Usps
       private
 
         def business_object
-          raise "#{self.class.name} must implement #business_object"
+          raise Error::Api, "#{self.class.name} must implement #business_object"
         end
 
         def payload(_data)
-          raise "#{self.class.name} must implement #payload(data)"
+          raise Error::Api, "#{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 = '0.3.3-1'
+    VERSION = '0.4.0-1'
   end
 end

data/lib/usps/imis.rb

@@ -13,6 +13,7 @@ require 'ext/hash' unless defined?(Rails)
 require_relative 'imis/config'
 require_relative 'imis/error/api'
 require_relative 'imis/error/mapper'
+require_relative 'imis/error/response'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/panel/base_panel'

data/spec/lib/usps/imis/error/response_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+ApiResponseStub = Struct.new(:code, :body)
+
+describe Usps::Imis::Error::Response do
+  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 'handles an API response correctly' do
+    response = ApiResponseStub.new('500', 'Body of the API response error')
+
+    expect(described_class.new(response).message).to eq(warning_text)
+  end
+end

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

@@ -30,7 +30,7 @@ describe Usps::Imis::Panel::Education do
     new_record = education.create(details)
     expect(new_record).to be_a(Hash)
 
-    ordinal = new_record['Properties']['$values'][1]['Value']['$value']
+    ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
     update_result =
       education.update(details.merge(source: 'Online Exams System - Modified', ordinal: ordinal))

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

@@ -26,7 +26,7 @@ describe Usps::Imis::Panel::Vsc do
     new_record = vsc.create(details)
     expect(new_record).to be_a(Hash)
 
-    ordinal = new_record['Properties']['$values'][1]['Value']['$value']
+    ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
     update_result = vsc.update(details.merge(count: 43, ordinal: ordinal))
     updated = update_result['Properties']['$values'].find { |v| v['Name'] == 'Quantity' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.3.3.pre.1
+  version: 0.4.0.pre.1
 platform: ruby
 authors:
 - Julian Fiander
@@ -32,12 +32,14 @@ files:
 - 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/mapper.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/lib/usps/imis/api_spec.rb
+- spec/lib/usps/imis/error/response_spec.rb
 - spec/lib/usps/imis/mapper_spec.rb
 - spec/lib/usps/imis/panel/education_spec.rb
 - spec/lib/usps/imis/panel/vsc_spec.rb