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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 829f39c81242bde99b954d06710ba008290415eb765340be960bad36bd471e0c
-  data.tar.gz: f15146f633cd77744521b14bcd6d196cf05518f6455528a2b2362a4726debfd8
+  metadata.gz: f4e11dc87c8bb7fd70aaa15146afaffa667de0da75cf54117672f42e46a8f4bd
+  data.tar.gz: e9e8abd630971b1151849d17d45196b1ec1f509dcd1abf213840d83e24a1eb07
 SHA512:
-  metadata.gz: 87c7576a9be599cabc7968a5df6484d421b80e933c5dfb3719974584f2ad563b12e2b3294deaa73bd716e5b8ca270e99a95072673440a4b139b6bd358446d826
-  data.tar.gz: b844cc08b4c36ec3702a0e97ce4dd6ec000c2926b1440113624f0071e67689b6ef70e44833051a29091e77ea6cdefedce026f6cf4138f4bc76043b2f00559e72
+  metadata.gz: 0ceaf850a029c05cf002189e286a2d83d83c52a34fe638511dfcc8c18f1e73a620243eccd48ec299459e43813402f379c2d005d0abb01cb4edbc1d55f79652de
+  data.tar.gz: 568a3c2134674c2be717c5653d16b90015c18d699eea58ba2ac6d9c832f8fbe5a4bdd46f3d25ed3dd95fa94413849f369718a98fbe54811cb9bb8fe831ea8109

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.3.3)
+    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,67 +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) }
-        end
-
-        def inspect
-          [
-            "#{self.class.name}: [#{status.to_s.upcase}] #{message}",
-            (metadata.inspect if metadata != {}),
-            body
-          ].compact.join("\n")
+          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

@@ -60,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'
+    VERSION = '0.4.0-2'
   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/{api_spec.rb → response_spec.rb}

@@ -4,10 +4,10 @@ require 'spec_helper'
 
 ApiResponseStub = Struct.new(:code, :body)
 
-describe Usps::Imis::Error::Api do
+describe Usps::Imis::Error::Response do
   let(:warning_text) do
     <<~WARNING.chomp
-      Usps::Imis::Error::Api: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+      Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
       Body of the API response error
     WARNING
   end
@@ -15,6 +15,6 @@ describe Usps::Imis::Error::Api do
   it 'handles an API response correctly' do
     response = ApiResponseStub.new('500', 'Body of the API response error')
 
-    expect(described_class.from(response).inspect).to eq(warning_text)
+    expect(described_class.new(response).message).to eq(warning_text)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0.pre.2
 platform: ruby
 authors:
 - Julian Fiander
@@ -32,13 +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/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