creditsafe 0.5.1 → 0.5.2

data/lib/creditsafe.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
-
-require "creditsafe/errors"
-require "creditsafe/client"
+# frozen_string_literal: true
+
+require "creditsafe/errors"
+require "creditsafe/client"

data/lib/creditsafe/client.rb

@@ -1,156 +1,158 @@
-# frozen_string_literal: true
-
-require "securerandom"
-require "savon"
-require "excon"
-
-require "creditsafe/errors"
-require "creditsafe/messages"
-require "creditsafe/namespace"
-
-require "creditsafe/request/company_report"
-require "creditsafe/request/find_company"
-
-require "active_support/notifications"
-
-module Creditsafe
-  class Client
-    ENVIRONMENTS = %i[live test].freeze
-
-    def initialize(username: nil, password: nil, savon_opts: {},
-                   environment: :live, log_level: :warn)
-      raise ArgumentError, "Username must be provided" if username.nil?
-      raise ArgumentError, "Password must be provided" if password.nil?
-
-      unless ENVIRONMENTS.include?(environment.to_sym)
-        raise ArgumentError, "Environment needs to be one of #{ENVIRONMENTS.join('/')}"
-      end
-
-      @environment = environment.to_s
-      @log_level = log_level
-      @username = username
-      @password = password
-      @savon_opts = savon_opts
-    end
-
-    def find_company(search_criteria = {})
-      request = Creditsafe::Request::FindCompany.new(search_criteria)
-      response = invoke_soap(:find_companies, request.message)
-
-      companies = response.
-        fetch(:find_companies_response).
-        fetch(:find_companies_result).
-        fetch(:companies)
-
-      companies.nil? ? nil : companies.fetch(:company)
-    end
-
-    def company_report(creditsafe_id, custom_data: nil)
-      request =
-        Creditsafe::Request::CompanyReport.new(creditsafe_id, custom_data)
-      response = invoke_soap(:retrieve_company_online_report, request.message)
-
-      response.
-        fetch(:retrieve_company_online_report_response).
-        fetch(:retrieve_company_online_report_result).
-        fetch(:reports).
-        fetch(:report)
-    end
-
-    def inspect
-      "#<#{self.class} @username='#{@username}'>"
-    end
-
-    private
-
-    def handle_message_for_response(response)
-      [
-        *response.xpath("//q1:Message"),
-        *response.xpath("//xmlns:Message"),
-      ].each do |message|
-        api_message = Creditsafe::Messages.for_code(message.attributes["Code"].value)
-
-        api_error_message = api_message.message
-        api_error_message += " (#{message.text})" unless message.text.blank?
-
-        raise api_message.error_class, api_error_message if api_message.error?
-      end
-    end
-
-    # rubocop:disable Style/RescueStandardError
-    # rubocop:disable Metrics/MethodLength
-    def invoke_soap(message_type, message)
-      started = Time.now
-      notification_payload = { request: message }
-
-      response = client.call(message_type, message: message)
-      handle_message_for_response(response)
-      notification_payload[:response] = response.body
-    rescue => raw_error
-      processed_error = handle_error(raw_error)
-      notification_payload[:error] = processed_error
-      raise processed_error
-    ensure
-      publish("creditsafe.#{message_type}", started, Time.now,
-              SecureRandom.hex(10), notification_payload)
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Style/RescueStandardError
-
-    def publish(*args)
-      ActiveSupport::Notifications.publish(*args)
-    end
-
-    # There's a potential bug in the creditsafe API where they actually return
-    # an HTTP 401 if you're unauthorized, hence the sad special case below
-    #
-    # rubocop:disable Metrics/MethodLength
-    def handle_error(error)
-      case error
-      when Savon::SOAPFault
-        return UnknownApiError.new(error.message)
-      when Savon::HTTPError
-        if error.to_hash[:code] == 401
-          return AccountError.new("Unauthorized: invalid credentials")
-        end
-        return UnknownApiError.new(error.message)
-      when Excon::Errors::Error
-        return HttpError.new("Error making HTTP request: #{error.message}")
-      end
-      error
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def client
-      @client ||= build_savon_client
-    end
-
-    def auth_header
-      auth_value = "Basic " + Base64.encode64("#{@username}:#{@password}").chomp
-      { "Authorization" => auth_value }
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def build_savon_client
-      options = {
-        env_namespace: "soapenv",
-        namespace_identifier: Creditsafe::Namespace::OPER,
-        namespaces: Creditsafe::Namespace::ALL,
-        wsdl: wsdl_path,
-        headers: auth_header,
-        convert_request_keys_to: :none,
-        adapter: :excon,
-        log: true,
-        log_level: @log_level,
-        pretty_print_xml: true,
-      }
-      Savon.client(options.merge(@savon_opts))
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def wsdl_path
-      root_dir = File.join(File.dirname(__FILE__), "..", "..")
-      File.join(root_dir, "data", "creditsafe-#{@environment}.xml")
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "securerandom"
+require "savon"
+require "excon"
+
+require "creditsafe/errors"
+require "creditsafe/messages"
+require "creditsafe/namespace"
+
+require "creditsafe/request/company_report"
+require "creditsafe/request/find_company"
+
+require "active_support/notifications"
+
+module Creditsafe
+  class Client
+    ENVIRONMENTS = %i[live test].freeze
+
+    def initialize(username: nil, password: nil, savon_opts: {},
+                   environment: :live, log_level: :warn)
+      raise ArgumentError, "Username must be provided" if username.nil?
+      raise ArgumentError, "Password must be provided" if password.nil?
+
+      unless ENVIRONMENTS.include?(environment.to_sym)
+        raise ArgumentError, "Environment needs to be one of #{ENVIRONMENTS.join('/')}"
+      end
+
+      @environment = environment.to_s
+      @log_level = log_level
+      @username = username
+      @password = password
+      @savon_opts = savon_opts
+    end
+
+    def find_company(search_criteria = {})
+      request = Creditsafe::Request::FindCompany.new(search_criteria)
+      response = invoke_soap(:find_companies, request.message)
+
+      companies = response.
+        fetch(:find_companies_response).
+        fetch(:find_companies_result).
+        fetch(:companies)
+
+      companies.nil? ? nil : companies.fetch(:company)
+    end
+
+    def company_report(creditsafe_id, custom_data: nil)
+      request =
+        Creditsafe::Request::CompanyReport.new(creditsafe_id, custom_data)
+      response = invoke_soap(:retrieve_company_online_report, request.message)
+
+      response.
+        fetch(:retrieve_company_online_report_response).
+        fetch(:retrieve_company_online_report_result).
+        fetch(:reports).
+        fetch(:report)
+    end
+
+    def inspect
+      "#<#{self.class} @username='#{@username}'>"
+    end
+
+    private
+
+    def handle_message_for_response(response)
+      [
+        *response.xpath("//q1:Message"),
+        *response.xpath("//xmlns:Message"),
+      ].each do |message|
+        api_message = Creditsafe::Messages.for_code(message.attributes["Code"].value)
+
+        api_error_message = api_message.message
+        api_error_message += " (#{message.text})" unless message.text.blank?
+
+        raise api_message.error_class, api_error_message if api_message.error?
+      end
+    end
+
+    # rubocop:disable Style/RescueStandardError
+    # rubocop:disable Metrics/MethodLength
+    def invoke_soap(message_type, message)
+      started = Time.now
+      notification_payload = { request: message }
+
+      response = client.call(message_type, message: message)
+      handle_message_for_response(response)
+      notification_payload[:response] = response.body
+    rescue Excon::Errors::Timeout
+      raise TimeoutError
+    rescue => raw_error
+      processed_error = handle_error(raw_error)
+      notification_payload[:error] = processed_error
+      raise processed_error
+    ensure
+      publish("creditsafe.#{message_type}", started, Time.now,
+              SecureRandom.hex(10), notification_payload)
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Style/RescueStandardError
+
+    def publish(*args)
+      ActiveSupport::Notifications.publish(*args)
+    end
+
+    # There's a potential bug in the creditsafe API where they actually return
+    # an HTTP 401 if you're unauthorized, hence the sad special case below
+    #
+    # rubocop:disable Metrics/MethodLength
+    def handle_error(error)
+      case error
+      when Savon::SOAPFault
+        return UnknownApiError.new(error.message)
+      when Savon::HTTPError
+        if error.to_hash[:code] == 401
+          return AccountError.new("Unauthorized: invalid credentials")
+        end
+        return UnknownApiError.new(error.message)
+      when Excon::Errors::Error
+        return HttpError.new("Error making HTTP request: #{error.message}")
+      end
+      error
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def client
+      @client ||= build_savon_client
+    end
+
+    def auth_header
+      auth_value = "Basic " + Base64.encode64("#{@username}:#{@password}").chomp
+      { "Authorization" => auth_value }
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def build_savon_client
+      options = {
+        env_namespace: "soapenv",
+        namespace_identifier: Creditsafe::Namespace::OPER,
+        namespaces: Creditsafe::Namespace::ALL,
+        wsdl: wsdl_path,
+        headers: auth_header,
+        convert_request_keys_to: :none,
+        adapter: :excon,
+        log: true,
+        log_level: @log_level,
+        pretty_print_xml: true,
+      }
+      Savon.client(options.merge(@savon_opts))
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def wsdl_path
+      root_dir = File.join(File.dirname(__FILE__), "..", "..")
+      File.join(root_dir, "data", "creditsafe-#{@environment}.xml")
+    end
+  end
+end

data/lib/creditsafe/errors.rb

@@ -1,14 +1,16 @@
-# frozen_string_literal: true
-
-module Creditsafe
-  class Error < StandardError; 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
+# frozen_string_literal: true
+
+module Creditsafe
+  class Error < StandardError; end
+
+  class HttpError < Error; end
+  class ApiError < Error; end
+
+  class TimeoutError < HttpError; 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/match_type.rb

@@ -1,115 +1,115 @@
-# frozen_string_literal: true
-
-module Creditsafe
-  module MatchType
-    MATCH_BEGINNING = "MatchBeginning"
-    MATCH_BLOCK = "MatchBlock"
-    EXACT_VALUE = "ExactValue"
-    MATCH_WORDS = "MatchWords"
-    CLOSEST_KEYWORDS = "ClosestKeywords"
-    MATCH_BLOCK_OR_WORDS = "MatchBlockOrWords"
-    MATCH_ANY_PARTS = "MatchAnyParts"
-
-    ALLOWED = {
-      DE: [MATCH_BEGINNING, MATCH_BLOCK, EXACT_VALUE, MATCH_WORDS],
-      FR: [MATCH_BEGINNING, CLOSEST_KEYWORDS, EXACT_VALUE],
-      GB: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, EXACT_VALUE],
-      IE: [MATCH_BEGINNING, MATCH_BLOCK, MATCH_WORDS],
-      GL: [MATCH_BEGINNING],
-      CH: [CLOSEST_KEYWORDS],
-      LI: [CLOSEST_KEYWORDS],
-      NL: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, MATCH_WORDS],
-      CZ: [MATCH_BLOCK_OR_WORDS],
-      IS: [MATCH_BEGINNING],
-      LT: [MATCH_ANY_PARTS],
-      MT: [MATCH_BEGINNING, MATCH_BLOCK],
-      SK: [MATCH_BLOCK_OR_WORDS],
-      BE: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, MATCH_WORDS],
-      SE: [MATCH_BLOCK_OR_WORDS, CLOSEST_KEYWORDS],
-      PL: [CLOSEST_KEYWORDS],
-      NO: [CLOSEST_KEYWORDS],
-      PT: [MATCH_BEGINNING],
-      LU: [MATCH_BEGINNING, MATCH_BLOCK, EXACT_VALUE],
-      CA: [MATCH_BEGINNING],
-      ES: [EXACT_VALUE, CLOSEST_KEYWORDS],
-      US: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      PR: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      AS: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      FM: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      GU: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      MH: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      MP: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      PW: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      VI: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
-      SI: [MATCH_BLOCK_OR_WORDS],
-      AL: [MATCH_BLOCK_OR_WORDS],
-      BA: [MATCH_BLOCK_OR_WORDS],
-      HR: [MATCH_BLOCK_OR_WORDS],
-      MK: [MATCH_BLOCK_OR_WORDS],
-      BG: [MATCH_BLOCK_OR_WORDS],
-      RO: [MATCH_BLOCK_OR_WORDS],
-      ME: [MATCH_BLOCK_OR_WORDS],
-      RS: [MATCH_BLOCK_OR_WORDS],
-      LV: [MATCH_BLOCK_OR_WORDS],
-      EE: [MATCH_BLOCK_OR_WORDS],
-      UA: [MATCH_BLOCK_OR_WORDS],
-      MD: [MATCH_BLOCK_OR_WORDS],
-      RU: [MATCH_BLOCK_OR_WORDS],
-      AM: [MATCH_BLOCK_OR_WORDS],
-      AZ: [MATCH_BLOCK_OR_WORDS],
-      BY: [MATCH_BLOCK_OR_WORDS],
-      GE: [MATCH_BLOCK_OR_WORDS],
-      KZ: [MATCH_BLOCK_OR_WORDS],
-      UZ: [MATCH_BLOCK_OR_WORDS],
-      TJ: [MATCH_BLOCK_OR_WORDS],
-      TM: [MATCH_BLOCK_OR_WORDS],
-      KG: [MATCH_BLOCK_OR_WORDS],
-      KM: [MATCH_BLOCK_OR_WORDS],
-      HK: [MATCH_BLOCK_OR_WORDS],
-      AT: [MATCH_WORDS],
-      IT: [CLOSEST_KEYWORDS, EXACT_VALUE],
-      BR: [CLOSEST_KEYWORDS],
-      HU: [MATCH_BEGINNING],
-      TW: [MATCH_BEGINNING],
-      KR: [MATCH_BLOCK_OR_WORDS],
-      FI: [CLOSEST_KEYWORDS],
-      MX: [CLOSEST_KEYWORDS],
-      DK: [MATCH_BEGINNING],
-      AU: [CLOSEST_KEYWORDS],
-      CN: [CLOSEST_KEYWORDS],
-      IN: [CLOSEST_KEYWORDS],
-      BD: [CLOSEST_KEYWORDS],
-      LK: [CLOSEST_KEYWORDS],
-      PK: [CLOSEST_KEYWORDS],
-      NP: [CLOSEST_KEYWORDS],
-      TH: [CLOSEST_KEYWORDS],
-      MY: [CLOSEST_KEYWORDS],
-      VN: [CLOSEST_KEYWORDS],
-      KH: [CLOSEST_KEYWORDS],
-      MM: [CLOSEST_KEYWORDS],
-      LA: [CLOSEST_KEYWORDS],
-      AF: [CLOSEST_KEYWORDS],
-      ID: [CLOSEST_KEYWORDS],
-      NZ: [CLOSEST_KEYWORDS],
-      SG: [CLOSEST_KEYWORDS],
-      BH: [CLOSEST_KEYWORDS],
-      BJ: [CLOSEST_KEYWORDS],
-      BF: [CLOSEST_KEYWORDS],
-      CD: [CLOSEST_KEYWORDS],
-      EG: [CLOSEST_KEYWORDS],
-      JO: [CLOSEST_KEYWORDS],
-      KW: [CLOSEST_KEYWORDS],
-      LB: [CLOSEST_KEYWORDS],
-      OM: [CLOSEST_KEYWORDS],
-      PS: [CLOSEST_KEYWORDS],
-      QA: [CLOSEST_KEYWORDS],
-      SA: [CLOSEST_KEYWORDS],
-      SD: [CLOSEST_KEYWORDS],
-      SY: [CLOSEST_KEYWORDS],
-      AE: [CLOSEST_KEYWORDS],
-      EH: [CLOSEST_KEYWORDS],
-      YE: [CLOSEST_KEYWORDS],
-      GR: [MATCH_BLOCK_OR_WORDS, CLOSEST_KEYWORDS],
-    }.freeze
-  end
-end
+# frozen_string_literal: true
+
+module Creditsafe
+  module MatchType
+    MATCH_BEGINNING = "MatchBeginning"
+    MATCH_BLOCK = "MatchBlock"
+    EXACT_VALUE = "ExactValue"
+    MATCH_WORDS = "MatchWords"
+    CLOSEST_KEYWORDS = "ClosestKeywords"
+    MATCH_BLOCK_OR_WORDS = "MatchBlockOrWords"
+    MATCH_ANY_PARTS = "MatchAnyParts"
+
+    ALLOWED = {
+      DE: [MATCH_BEGINNING, MATCH_BLOCK, EXACT_VALUE, MATCH_WORDS],
+      FR: [MATCH_BEGINNING, CLOSEST_KEYWORDS, EXACT_VALUE],
+      GB: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, EXACT_VALUE],
+      IE: [MATCH_BEGINNING, MATCH_BLOCK, MATCH_WORDS],
+      GL: [MATCH_BEGINNING],
+      CH: [CLOSEST_KEYWORDS],
+      LI: [CLOSEST_KEYWORDS],
+      NL: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, MATCH_WORDS],
+      CZ: [MATCH_BLOCK_OR_WORDS],
+      IS: [MATCH_BEGINNING],
+      LT: [MATCH_ANY_PARTS],
+      MT: [MATCH_BEGINNING, MATCH_BLOCK],
+      SK: [MATCH_BLOCK_OR_WORDS],
+      BE: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, MATCH_WORDS],
+      SE: [MATCH_BLOCK_OR_WORDS, CLOSEST_KEYWORDS],
+      PL: [CLOSEST_KEYWORDS],
+      NO: [CLOSEST_KEYWORDS],
+      PT: [MATCH_BEGINNING],
+      LU: [MATCH_BEGINNING, MATCH_BLOCK, EXACT_VALUE],
+      CA: [MATCH_BEGINNING],
+      ES: [EXACT_VALUE, CLOSEST_KEYWORDS],
+      US: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      PR: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      AS: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      FM: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      GU: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      MH: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      MP: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      PW: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      VI: [MATCH_BEGINNING, CLOSEST_KEYWORDS],
+      SI: [MATCH_BLOCK_OR_WORDS],
+      AL: [MATCH_BLOCK_OR_WORDS],
+      BA: [MATCH_BLOCK_OR_WORDS],
+      HR: [MATCH_BLOCK_OR_WORDS],
+      MK: [MATCH_BLOCK_OR_WORDS],
+      BG: [MATCH_BLOCK_OR_WORDS],
+      RO: [MATCH_BLOCK_OR_WORDS],
+      ME: [MATCH_BLOCK_OR_WORDS],
+      RS: [MATCH_BLOCK_OR_WORDS],
+      LV: [MATCH_BLOCK_OR_WORDS],
+      EE: [MATCH_BLOCK_OR_WORDS],
+      UA: [MATCH_BLOCK_OR_WORDS],
+      MD: [MATCH_BLOCK_OR_WORDS],
+      RU: [MATCH_BLOCK_OR_WORDS],
+      AM: [MATCH_BLOCK_OR_WORDS],
+      AZ: [MATCH_BLOCK_OR_WORDS],
+      BY: [MATCH_BLOCK_OR_WORDS],
+      GE: [MATCH_BLOCK_OR_WORDS],
+      KZ: [MATCH_BLOCK_OR_WORDS],
+      UZ: [MATCH_BLOCK_OR_WORDS],
+      TJ: [MATCH_BLOCK_OR_WORDS],
+      TM: [MATCH_BLOCK_OR_WORDS],
+      KG: [MATCH_BLOCK_OR_WORDS],
+      KM: [MATCH_BLOCK_OR_WORDS],
+      HK: [MATCH_BLOCK_OR_WORDS],
+      AT: [MATCH_WORDS],
+      IT: [CLOSEST_KEYWORDS, EXACT_VALUE],
+      BR: [CLOSEST_KEYWORDS],
+      HU: [MATCH_BEGINNING],
+      TW: [MATCH_BEGINNING],
+      KR: [MATCH_BLOCK_OR_WORDS],
+      FI: [CLOSEST_KEYWORDS],
+      MX: [CLOSEST_KEYWORDS],
+      DK: [MATCH_BEGINNING],
+      AU: [CLOSEST_KEYWORDS],
+      CN: [CLOSEST_KEYWORDS],
+      IN: [CLOSEST_KEYWORDS],
+      BD: [CLOSEST_KEYWORDS],
+      LK: [CLOSEST_KEYWORDS],
+      PK: [CLOSEST_KEYWORDS],
+      NP: [CLOSEST_KEYWORDS],
+      TH: [CLOSEST_KEYWORDS],
+      MY: [CLOSEST_KEYWORDS],
+      VN: [CLOSEST_KEYWORDS],
+      KH: [CLOSEST_KEYWORDS],
+      MM: [CLOSEST_KEYWORDS],
+      LA: [CLOSEST_KEYWORDS],
+      AF: [CLOSEST_KEYWORDS],
+      ID: [CLOSEST_KEYWORDS],
+      NZ: [CLOSEST_KEYWORDS],
+      SG: [CLOSEST_KEYWORDS],
+      BH: [CLOSEST_KEYWORDS],
+      BJ: [CLOSEST_KEYWORDS],
+      BF: [CLOSEST_KEYWORDS],
+      CD: [CLOSEST_KEYWORDS],
+      EG: [CLOSEST_KEYWORDS],
+      JO: [CLOSEST_KEYWORDS],
+      KW: [CLOSEST_KEYWORDS],
+      LB: [CLOSEST_KEYWORDS],
+      OM: [CLOSEST_KEYWORDS],
+      PS: [CLOSEST_KEYWORDS],
+      QA: [CLOSEST_KEYWORDS],
+      SA: [CLOSEST_KEYWORDS],
+      SD: [CLOSEST_KEYWORDS],
+      SY: [CLOSEST_KEYWORDS],
+      AE: [CLOSEST_KEYWORDS],
+      EH: [CLOSEST_KEYWORDS],
+      YE: [CLOSEST_KEYWORDS],
+      GR: [MATCH_BLOCK_OR_WORDS, CLOSEST_KEYWORDS],
+    }.freeze
+  end
+end