creditsafe 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef933acd556b7da62f4479c61a255b488980db56
-  data.tar.gz: 0b429f01c58df701cdfab8f917031794c9aaad1c
+  metadata.gz: 8efad9c046062a13533c0b1d9b6952e8bc3322d4
+  data.tar.gz: 4e3c8602dbeda52622424508c17fe77b85680df3
 SHA512:
-  metadata.gz: e8f6379e8e4f0653a2694723512d8bf519aff20d27b272c7745915f39bfced01176bd6556312867a1709f25eaf75bce2618a80e00e08ef14062d9b5138db4202
-  data.tar.gz: 95d9f34ab1f1f8c0b85e69cfa903a7f377f4d7c27e9000c157fcc51707191f1ba15f70097839fe87206ae2d9e70e646208a5c27cb0a031ab6c1d1bb061da16f4
+  metadata.gz: e05840b5d34c6952eff251ca34c57fcb5587197a212780a9e55d52d4dd99a9927d0c855b4021b9a8772ad800850df59a482397add073ea3a815a796bfd769bad
+  data.tar.gz: a1e3ce8720cae12415215fa4affdee2864f873267077d84fd4b98ddc591236b02ea16eb78f28367b12bc39f302c9bd790b8cbea043aa8080876be28b42809b28

data/.circleci/config.yml

@@ -0,0 +1,17 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/creditsafe-ruby
+    docker:
+      - image: ruby:2.5.0
+    steps:
+      - checkout
+      - restore_cache:
+          key: gemfile-{{ checksum "Gemfile" }}
+      - run: bundle install --path vendor/bundle
+      - save_cache:
+          key: gemfile-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+      - run: bundle exec rubocop
+      - run: bundle exec rspec --format RspecJunitFormatter

data/.rubocop.yml

@@ -18,4 +18,7 @@ Style/Documentation:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 90
+  Max: 90
+
+Metrics/ModuleLength:
+  Max: 120

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.5.0, 27 February 2018
+
+- Automatically chooses a valid MatchType when searching for companies by name
+
 ## v0.4.0, 3 April 2017
 
 - Adds support for including a postal code when searching for German companies by name 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    creditsafe (0.3.2)
+    creditsafe (0.5.0)
       activesupport (>= 4.2.0)
       excon (~> 0.45)
       savon (~> 2.8)
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.1)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -22,13 +22,13 @@ GEM
     builder (3.2.3)
     byebug (9.0.5)
     coderay (1.1.1)
-    compare-xml (0.62)
-      nokogiri (~> 1.6)
+    compare-xml (0.65)
+      nokogiri (~> 1.8)
     concurrent-ruby (1.0.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    excon (0.55.0)
+    diff-lcs (1.3)
+    excon (0.60.0)
     ffi (1.9.14)
     formatador (0.2.5)
     guard (2.14.0)
@@ -51,29 +51,28 @@ GEM
     gyoku (1.3.1)
       builder (>= 2.1.2)
     hashdiff (0.3.0)
-    httpi (2.4.2)
+    httpi (2.4.3)
       rack
       socksify
-    i18n (0.8.1)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.10)
     method_source (0.8.2)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
     nenv (0.3.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
     nori (2.6.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parser (2.3.1.2)
       ast (~> 2.2)
-    pkg-config (1.1.7)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
@@ -82,27 +81,29 @@ GEM
     pry-byebug (3.4.0)
       byebug (~> 9.0)
       pry (~> 0.10)
-    rack (2.0.1)
+    rack (2.0.4)
     rainbow (2.1.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
+      rspec-support (~> 3.7.0)
     rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.5.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.42.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
@@ -112,12 +113,12 @@ GEM
     ruby-progressbar (1.8.1)
     ruby_dep (1.4.0)
     safe_yaml (1.0.4)
-    savon (2.11.1)
+    savon (2.12.0)
       akami (~> 1.2)
       builder (>= 2.1.2)
       gyoku (~> 1.2)
       httpi (~> 2.3)
-      nokogiri (>= 1.4.0)
+      nokogiri (>= 1.8.1)
       nori (~> 2.4)
       wasabi (~> 3.4)
     shellany (0.0.1)
@@ -126,7 +127,7 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.6)
     timecop (0.8.1)
-    tzinfo (1.2.2)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.1.0)
     wasabi (3.5.0)
@@ -150,9 +151,10 @@ DEPENDENCIES
   pry-byebug
   rspec (~> 3.1)
   rspec-its (~> 1.2)
+  rspec_junit_formatter (~> 0.3)
   rubocop (~> 0.37)
   timecop (~> 0.8)
   webmock (~> 1.20)
 
 BUNDLED WITH
-   1.13.7
+   1.16.1

data/creditsafe.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'

data/lib/creditsafe/match_type.rb

@@ -0,0 +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_OR_WORDS, MATCH_WORDS],
+      GL: [MATCH_BEGINNING],
+      CH: [CLOSEST_KEYWORDS],
+      LI: [CLOSEST_KEYWORDS],
+      NL: [MATCH_BEGINNING, MATCH_BLOCK_OR_WORDS, MATCH_WORDS],
+      CZ: [MATCH_BEGINNING, MATCH_BLOCK],
+      IS: [MATCH_BEGINNING],
+      LT: [MATCH_ANY_PARTS],
+      MT: [MATCH_BEGINNING, MATCH_BLOCK],
+      SK: [MATCH_BEGINNING, MATCH_BLOCK],
+      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: [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],
+      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

data/lib/creditsafe/request/find_company.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'creditsafe/namespace'
+require 'creditsafe/match_type'
 
 module Creditsafe
   module Request
@@ -14,11 +15,13 @@ module Creditsafe
         @postal_code = search_criteria[:postal_code]
       end
 
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
       def message
         search_criteria = {}
 
         search_criteria["#{Creditsafe::Namespace::DAT}:Name"] = {
-          '@MatchType' => 'MatchBlock',
+          '@MatchType' => match_type,
           :content! => company_name
         } unless company_name.nil?
 
@@ -37,11 +40,18 @@ module Creditsafe
 
         build_message(search_criteria)
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
 
       private
 
       attr_reader :country_code, :registration_number, :city, :company_name, :postal_code
 
+      def match_type
+        Creditsafe::MatchType::ALLOWED[country_code.upcase.to_sym]&.first ||
+          Creditsafe::MatchType::MATCH_BLOCK
+      end
+
       def build_message(search_criteria)
         {
           "#{Creditsafe::Namespace::OPER}:countries" => {
@@ -51,16 +61,12 @@ module Creditsafe
         }
       end
 
-      # rubocop:disable Style/CyclomaticComplexity, Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
       def check_search_criteria(search_criteria)
         if search_criteria[:country_code].nil?
           raise ArgumentError, "country_code is a required search criteria"
         end
 
-        if search_criteria[:country_code] != 'DE' && !search_criteria[:company_name].nil?
-          raise ArgumentError, "company name search is only possible for German searches"
-        end
-
         unless only_registration_number_or_company_name_provided?(search_criteria)
           raise ArgumentError, "registration_number or company_name (not both) are " \
                                "required search criteria"
@@ -74,7 +80,7 @@ module Creditsafe
           raise ArgumentError, "Postal code is only supported for German searches"
         end
       end
-      # rubocop:enable Style/CyclomaticComplexity, Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def only_registration_number_or_company_name_provided?(search_criteria)
         search_criteria[:registration_number].nil? ^ search_criteria[:company_name].nil?

data/lib/creditsafe/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Creditsafe
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/creditsafe/client_spec.rb

@@ -180,6 +180,24 @@ RSpec.describe(Creditsafe::Client) do
       end
     end
 
+    context "with a company name" do
+      let(:search_criteria) { { country_code: "FR", company_name: "Mimes Inc" } }
+
+      it { is_expected.to_not raise_error }
+
+      it "selects a valid match type for the country code" do
+        find_company
+
+        request = a_request(:post, URL).with do |req|
+          body = Nokogiri::XML(req.body)
+          expect(body.xpath("//dat:Name").first.attributes["MatchType"].value).
+            to eq("MatchBeginning")
+        end
+
+        expect(request).to have_been_made
+      end
+    end
+
     it 'requests the company deatils' do
       find_company
       expect(a_request(:post, URL).with do |req|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creditsafe
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +199,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -196,13 +211,13 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
-- circle.yml
 - creditsafe.gemspec
 - data/creditsafe-live.xml
 - data/creditsafe-test.xml
 - lib/creditsafe.rb
 - lib/creditsafe/client.rb
 - lib/creditsafe/errors.rb
+- lib/creditsafe/match_type.rb
 - lib/creditsafe/messages.rb
 - lib/creditsafe/namespace.rb
 - lib/creditsafe/request/company_report.rb
@@ -241,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Creditsafe SOAP API

data/circle.yml

@@ -1,8 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.1
-test:
-  pre:
-    - bundle exec rubocop
-  post:
-    - bundle exec rspec