usps-imis-api 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e49829b6dee8973f1de4b275516060ced7b426cedd00fe7e4ccaba5e29efc52
-  data.tar.gz: 8558346d33b416f3d58f9fa5047b925f580c8d8d5123463c6fe137335ddd93d7
+  metadata.gz: 62e3948cb55d98465788a509e531d293e7d4b6c4120bd7d9fc5c91e902285a9c
+  data.tar.gz: b31b47b360f74ec720b9acc9b1b63251c24c8a0546d83f91da7d92f7f4fc8c60
 SHA512:
-  metadata.gz: 89f31684df0cb6001fa31966eec99bf8ec9e9dbdab86ae8213a43200f23bf306b204bc9ecb61d9f6ac066869387e4ba048923af1a77b4c7dd1dec59a9cb9b215
-  data.tar.gz: 376cc34e675f9caadd5c985733b28ea2e93d4ba3752de8d9fd843d3a15866280f3075138a275be47dfd77d06bb24f2ba81cad8527308060a1e8893befbe5381e
+  metadata.gz: 5ed6d327340268f29d595c0942f1836b7ca168a137e59d9533afd3011de3b22c2976640ef43c2f843793b012a9d57f1456e6e2996b898adb1fb50af671216311
+  data.tar.gz: 76a41b9150dfcf11bcbc43d6e6986b65396718a86067497d6a944d93fbe15cb4c3f3e4cdac105fd0dd20d1fc8cab28ebe4d86d3eee18926a16e8150e5697abfe

data/.simplecov

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  enable_coverage :branch
+  primary_coverage :branch
+
+  add_filter '/spec'
+end

data/Gemfile.lock

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

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

@@ -9,18 +9,16 @@ module Usps
         def initialize(message, metadata = {})
           super(message)
           @metadata = metadata
-
-          warn inspect if ENV.fetch('IMIS_ERROR_LOG_TO_STDERR', 'false') == 'true'
         end
 
         def bugsnag_meta_data
-          metadata == {} ? {} : { api: metadata }
+          metadata == {} ? {} : base_metadata
         end
 
       private
 
         def base_metadata
-          { api: {} }
+          { api: metadata }
         end
       end
     end

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

@@ -47,6 +47,8 @@ module Usps
               :unprocessable_entity # validation error
             when /^50\d$/
               :internal_server_error # error within iMIS
+            else
+              response.code
             end
         end
 

data/lib/usps/imis/mapper.rb

@@ -52,11 +52,13 @@ module Usps
 
       def missing_mapping(field_name)
         unless ENV['TESTING']
+          # :nocov:
           warn(
             "Mapper does not know how to handle field \"#{field_name}\".\n\n" \
             'You can use api.put_fields(business_object_name, { field_name => value })  ' \
             "if you know the business object and iMIS-specific field name.\n\n"
           )
+          # :nocov:
         end
 
         raise(

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.4.3'
+    VERSION = '0.4.4'
   end
 end

data/lib/usps/imis.rb

@@ -7,7 +7,9 @@ require 'time'
 require 'cgi'
 
 # Extensions
+# :nocov:
 require 'ext/hash' unless defined?(Rails)
+# :nocov:
 
 # Internal requires
 require_relative 'imis/config'

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

@@ -5,10 +5,36 @@ require 'spec_helper'
 describe Usps::Imis::Api do
   let(:api) { described_class.new }
 
+  describe '#initialize' do
+    it 'skips authentication' do
+      # rubocop:disable RSpec/AnyInstance
+      expect_any_instance_of(described_class).not_to receive(:authenticate)
+      # rubocop:enable RSpec/AnyInstance
+
+      described_class.new(skip_authentication: true)
+    end
+
+    it 'stores the initial imis_id' do
+      api = described_class.new(imis_id: 42)
+
+      expect(api.imis_id).to eq('42')
+    end
+  end
+
   describe '#imis_id_for' do
     it 'gets the iMIS ID' do
       expect(api.imis_id_for('E231625')).to eq('31092')
     end
+
+    context 'with a query error' do
+      before { allow(api).to receive(:query).and_raise('Stub') }
+
+      it 'wraps errors' do
+        expect { api.imis_id_for('E231625') }.to raise_error(
+          Usps::Imis::Error::Api, 'Member not found'
+        )
+      end
+    end
   end
 
   describe '#put' do
@@ -17,6 +43,29 @@ describe Usps::Imis::Api do
     it 'sends an update' do
       expect(api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })).to be_a(Hash)
     end
+
+    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.
+          Something went wrong
+        WARNING
+      end
+
+      before do
+        error = Struct.new(:code, :body).new('500', 'Something went wrong')
+
+        # rubocop:disable RSpec/AnyInstance
+        allow_any_instance_of(Net::HTTP).to receive(:request).and_return(error)
+        # rubocop:enable RSpec/AnyInstance
+      end
+
+      it 'wraps the error' do
+        expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
+          Usps::Imis::Error::Api, warning_text
+        )
+      end
+    end
   end
 
   describe '#with' do
@@ -46,4 +95,49 @@ describe Usps::Imis::Api do
       expect(api.inspect).not_to match(/ @token="/)
     end
   end
+
+  describe '#authorize' do
+    before { allow(api).to receive(:authenticate) }
+
+    it 'automatically refreshes an expired token' do
+      api.instance_variable_set(:@token_expiration, Time.now - 60)
+
+      request = Net::HTTP::Put.new('/')
+      api.send(:authorize, request)
+
+      expect(api).to have_received(:authenticate)
+    end
+  end
+
+  describe '#filter_fields' do
+    let(:expected) do
+      {
+        'Properties' => {
+          '$values' => [
+            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+            { 'Name' => 'Stub String', 'Value' => 'other' }
+          ]
+        }
+      }
+    end
+
+    before do
+      allow(api).to receive(:get).and_return({
+        'Properties' => {
+          '$values' => [
+            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+            { 'Name' => 'Stub String', 'Value' => 'something' }
+          ]
+        }
+      })
+    end
+
+    it 'formats fields correctly' do
+      updated = api.send(:filter_fields, 'Stub', { 'Stub Integer' => 43, 'Stub String' => 'other' })
+
+      expect(updated).to eq(expected)
+    end
+  end
 end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Config do
+  let(:config) { described_class.new }
+
+  it 'sets values on initialize' do
+    config = described_class.new { |c| c.environment = 'test' }
+
+    expect(config.environment).to eq('test')
+  end
+
+  describe '#hostname' do
+    context 'with production environment' do
+      before { config.environment = 'production' }
+
+      it 'returns the production hostname' do
+        expect(config.hostname).to eq(described_class::IMIS_ROOT_URL_PROD)
+      end
+    end
+
+    context 'with unrecognized environment' do
+      before { config.environment = 'nothing' }
+
+      it 'raises an error' do
+        expect { config.hostname }.to raise_error(
+          Usps::Imis::Error::Api, 'Unexpected API environment: nothing'
+        )
+      end
+    end
+  end
+end

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

@@ -5,15 +5,103 @@ require 'spec_helper'
 ApiResponseStub = Struct.new(:code, :body)
 
 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.
-      Body of the API response error
-    WARNING
+  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
 
-  it 'handles an API response correctly' do
-    expect(described_class.from(response).message).to eq(warning_text)
+  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

@@ -5,6 +5,14 @@ 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 }
 

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_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

@@ -3,10 +3,7 @@
 require 'bundler/setup'
 Bundler.setup
 require 'simplecov'
-SimpleCov.start do
-  add_filter '/spec'
-end
-# SimpleCov.minimum_coverage(100)
+SimpleCov.minimum_coverage(line: 100, branch: 100)
 
 require 'dotenv/load'
 require 'usps/imis'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Julian Fiander
@@ -20,6 +20,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".simplecov"
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -39,10 +40,14 @@ files:
 - lib/usps/imis/panel/vsc.rb
 - 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/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