creditsafe 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e29e350fc4b5fe1cd81b1855d7cfc43fa35afc4
-  data.tar.gz: 36bb660af1c51a7e2dde56443cfbba02e2c22b1f
+  metadata.gz: 8da2890acd61ed7db41e62b44682b13cf9963203
+  data.tar.gz: 03bdc4029107f5c89556dd0f44b1892ca1d64dc1
 SHA512:
-  metadata.gz: 81d10c8255127c3f1bad547ea4beaed8573de038b01188846c4e0ed3a7771ce54e446d7e931681d33dc9df2a6be59f9e5825f2602f1ed98423c2a51ae47b2feb
-  data.tar.gz: 7c4c938c09a66213c0267172d1e16c9b169dc8dfff24f3acb342f9ae2998c89d3cc1613b7694714d6848b1bd64fee13985a5d8fe7fad3a5458844c720ec570cd
+  metadata.gz: 90ae7bd7b7dddfc87b7b7868dcae3696e324b0e5d15ac1a5f924f915a8c1b74c60a60ca0a5e1d4a095fbe63a52dd9cfaf1834a84dcf9d6a991bbb3af3894c3c0
+  data.tar.gz: bb9c7e7e14efd24014efc9270a31a788511f1e1fa9f4b4cf9fe26ab89988f74c9da9c0e4dcfb641e7cb0530a0a91c12f65e360f989e61460006f7e389bd09bcb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.2.0, 16 March 2016
+
+- Subclass `ApiError` to distinguish between different Creditsafe error types
+  (patch by [greysteil](https://github.com/greysteil))
+
+
 ## v0.1.1, 15 February 2016
 
 - Allow `city` parameter in `find_company` for German company lookups

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    creditsafe (0.1.1)
+    creditsafe (0.2.0)
       excon (~> 0.45)
       savon (~> 2.8)
 

data/lib/creditsafe/client.rb

@@ -123,7 +123,7 @@ module Creditsafe
         api_error_message = api_message.message
         api_error_message += " (#{message.text})" unless message.text.blank?
 
-        raise ApiError, api_error_message if api_message.error?
+        raise api_message.error_class, api_error_message if api_message.error?
       end
     end
 
@@ -141,12 +141,12 @@ module Creditsafe
     def handle_error(error)
       raise error
     rescue Savon::SOAPFault => error
-      raise ApiError, error.message
+      raise UnknownApiError, error.message
     rescue Savon::HTTPError => error
       if error.to_hash[:code] == 401
-        raise ApiError, 'Unauthorized: invalid credentials'
+        raise AccountError, 'Unauthorized: invalid credentials'
       end
-      raise ApiError, error.message
+      raise UnknownApiError, error.message
     rescue Excon::Errors::Error => err
       raise HttpError, "Error making HTTP request: #{err.message}"
     end

data/lib/creditsafe/errors.rb

@@ -1,6 +1,12 @@
 module Creditsafe
   class Error < StandardError; end
 
-  class ApiError < Error; end
   class HttpError < Error; end
+  class ApiError < Error; end
+
+  class DataError < ApiError; end
+  class AccountError < ApiError; end
+  class RequestError < ApiError; end
+  class ProcessingError < ApiError; end
+  class UnknownApiError < ApiError; end
 end

data/lib/creditsafe/messages.rb

@@ -1,3 +1,5 @@
+require 'creditsafe/errors'
+
 module Creditsafe
   module Messages
     class Message
@@ -12,6 +14,18 @@ module Creditsafe
       end
 
       alias error? error
+
+      def error_class
+        return unless error?
+
+        case code[1].to_i
+        when 1 then Creditsafe::DataError
+        when 2 then Creditsafe::AccountError
+        when 3 then Creditsafe::RequestError
+        when 4 then Creditsafe::ProcessingError
+        else Creditsafe::UnknownApiError
+        end
+      end
     end
 
     # rubocop:disable Metrics/LineLength

data/lib/creditsafe/version.rb

@@ -1,3 +1,3 @@
 module Creditsafe
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/creditsafe/client_spec.rb

@@ -17,14 +17,14 @@ RSpec.describe(Creditsafe::Client) do
         )
       end
 
-      it 'raises an ApiError' do
-        expect { method_call }.to raise_error(Creditsafe::ApiError)
+      it 'raises an AccountError' do
+        expect { method_call }.to raise_error(Creditsafe::AccountError)
       end
 
       it 'gives a useful error message' do
         begin
           method_call
-        rescue Creditsafe::ApiError => err
+        rescue Creditsafe::AccountError => err
           expect(err.message).to include 'invalid credentials'
         end
       end
@@ -36,8 +36,8 @@ RSpec.describe(Creditsafe::Client) do
           to_return(body: load_fixture('error-fault.xml'))
       end
 
-      it 'raises an ApiError' do
-        expect { method_call }.to raise_error(Creditsafe::ApiError)
+      it 'raises an UnknownApiError' do
+        expect { method_call }.to raise_error(Creditsafe::UnknownApiError)
       end
     end
 
@@ -170,7 +170,7 @@ RSpec.describe(Creditsafe::Client) do
       it 'gives a useful error, with the specific error in the response' do
         begin
           method_call
-        rescue Creditsafe::ApiError => err
+        rescue Creditsafe::RequestError => err
           expect(err.message).to eq 'Invalid operation parameters ' \
                                     '(Invalid countries list specified.)'
         end
@@ -187,7 +187,7 @@ RSpec.describe(Creditsafe::Client) do
         it 'gives a useful error, with the specific error in the response' do
           begin
             method_call
-          rescue Creditsafe::ApiError => err
+          rescue Creditsafe::RequestError => err
             expect(err.message).to eq 'Invalid operation parameters'
           end
         end
@@ -221,14 +221,14 @@ RSpec.describe(Creditsafe::Client) do
           to_return(body: load_fixture('company-report-not-found.xml'))
       end
 
-      it 'returns nil' do
-        expect { company_report }.to raise_error(Creditsafe::ApiError)
+      it 'raises an error' do
+        expect { company_report }.to raise_error(Creditsafe::DataError)
       end
 
       it 'gives a useful error message' do
         begin
           company_report
-        rescue Creditsafe::ApiError => err
+        rescue Creditsafe::DataError => err
           expect(err.message).to include 'Report unavailable'
         end
       end

data/spec/creditsafe/messages_spec.rb

@@ -2,25 +2,28 @@ require 'spec_helper'
 require 'creditsafe/messages'
 
 RSpec.describe(Creditsafe::Messages) do
-  describe "#for_code" do
+  describe ".for_code" do
     subject(:message) { described_class.for_code(code) }
 
     context "for a valid code" do
       let(:code) { "020101" }
       its(:code) { is_expected.to eq(code) }
       its(:message) { is_expected.to eq('Invalid credentials') }
+      its(:error_class) { is_expected.to eq(Creditsafe::AccountError) }
     end
 
     context "for a code without leading zero" do
       let(:code) { "20101" }
       its(:code) { is_expected.to eq("0#{code}") }
       its(:message) { is_expected.to eq('Invalid credentials') }
+      its(:error_class) { is_expected.to eq(Creditsafe::AccountError) }
     end
 
     context "for an unknown code" do
       let(:code) { "999999" }
       its(:code) { is_expected.to eq(code) }
       its(:message) { is_expected.to eq('Unknown error') }
+      its(:error_class) { is_expected.to eq(Creditsafe::UnknownApiError) }
     end
 
     context "for an empty code" do
@@ -30,4 +33,36 @@ RSpec.describe(Creditsafe::Messages) do
       end
     end
   end
+
+  describe(Creditsafe::Messages::Message) do
+    subject(:message) do
+      described_class.new(code: code, message: text, error: error)
+    end
+    let(:text) { "Error message" }
+    let(:code) { "020101" }
+    let(:error) { true }
+
+    describe "#error_class" do
+      subject { message.error_class }
+
+      context "when there is no error" do
+        let(:error) { false }
+        it { is_expected.to be_nil }
+      end
+
+      context "when there is an error" do
+        let(:error) { true }
+
+        context "for a processing error code" do
+          let(:code) { "040102" }
+          it { is_expected.to eq(Creditsafe::ProcessingError) }
+        end
+
+        context "for an unknown error code" do
+          let(:code) { "060102" }
+          it { is_expected.to eq(Creditsafe::UnknownApiError) }
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creditsafe
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Pete Hamilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon