creditsafe 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d36d2af4798e1c4a5a8561cb308fd24b2fd046f9
-  data.tar.gz: 9824207f9b7024aa3590cede22f46ad242f1abc1
+  metadata.gz: d7e9dc737539af843ce3a9b181fdb7d08bdcd7c1
+  data.tar.gz: b05479c1bd360574152a8d2e2d73f975248da52e
 SHA512:
-  metadata.gz: 8bb9d9a0e26b2564fb4b0b18b10d246b76148de7d3e8390b96ed8a8d05b56ad724da94f20aa0909ccc4302dde619510cc044dfde44d1dff3b3af20a417374e5f
-  data.tar.gz: 58508f3069cf2c216774ef633ec2f80c94439ff1b0bf63c34594035e5d5260ba6c206c55a2c4d080be21353e9925ea538f2780030ce4bd76d393418189786ddd
+  metadata.gz: bcee6d9fb09ce4ece19f833031437f6ccd721f13456cdb0278a434f1f05ed86dc9ba364fd79924c74f4e08b975c620d0919998165ddc35416962635fc45dde01
+  data.tar.gz: 14da6df79c7baf7de5ca7989311a5deafee3efd36b060cad04d9ec3fc5b4cb9bb626f2a17574c2a9e0197ffbdec1a5ae583ac83aa8129312f0aa680caba54bf1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.6.0, 25 September 2018
+
+- Add searching by VAT number
+
 ## v0.5.2, 29 March 2018
 
 - Raise `Creditsafe::TimeoutError` when a request times out

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    creditsafe (0.5.2)
+    creditsafe (0.6.0)
       activesupport (>= 4.2.0)
       excon (~> 0.45)
       savon (~> 2.8)
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -22,16 +22,16 @@ GEM
     ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
-    compare-xml (0.65)
+    compare-xml (0.66)
       nokogiri (~> 1.8)
     concurrent-ruby (1.0.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     excon (0.62.0)
-    gc_ruboconfig (2.3.5)
-      rubocop (~> 0.54.0)
-      rubocop-rspec (~> 1.24)
+    gc_ruboconfig (2.3.11)
+      rubocop (>= 0.57, < 0.59)
+      rubocop-rspec (~> 1.25)
     gyoku (1.3.1)
       builder (>= 2.1.2)
     hashdiff (0.3.7)
@@ -40,50 +40,52 @@ GEM
       socksify
     i18n (1.0.0)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nokogiri (1.8.2)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     nori (2.6.0)
     parallel (1.12.1)
-    parser (2.5.0.5)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.2)
     rack (2.0.4)
     rainbow (3.0.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)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
+      rspec-support (~> 3.8.0)
     rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.7.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rspec_junit_formatter (0.3.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.54.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.24.0)
-      rubocop (>= 0.53.0)
-    ruby-progressbar (1.9.0)
+    rubocop-rspec (1.27.0)
+      rubocop (>= 0.56.0)
+    ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
     savon (2.12.0)
       akami (~> 1.2)
@@ -98,11 +100,11 @@ GEM
     timecop (0.9.1)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.4.0)
     wasabi (3.5.0)
       httpi (~> 2.0)
       nokogiri (>= 1.4.2)
-    webmock (3.3.0)
+    webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -124,4 +126,4 @@ DEPENDENCIES
   webmock (~> 3.3)
 
 BUNDLED WITH
-   1.16.1
+   1.16.5

data/README.md

@@ -31,10 +31,11 @@ client = Creditsafe::Client.new(username: "foo", password: "bar", environment: :
 
 ### Company Search
 
-To perform a search for a company, you need to provide a country code and a company registration number:
+To perform a search for a company, you need to provide a valid search criteria, including
+the country code and a company registration number or company name:
 
 ```ruby
-client.find_company(country_code: "GB", registration_number: "07495895")
+client.find_company({ country_code: "GB", registration_number: "07495895" })
 => {
     name: "GOCARDLESS LTD",
     type: "Ltd",
@@ -55,11 +56,11 @@ client.find_company(country_code: "GB", registration_number: "07495895")
 ```
 
 In Germany you can also perform a name search. For this you need to provide a country code
-and a company name, and can optionally provided a postal code to filter the results
+and a company name, and can optionally provide a postal code or city to filter the results
 further:
 
 ```ruby
-client.find_company(country_code: "DE", company_name: "zalando", postal_code: "10243")
+client.find_company({ country_code: "DE", company_name: "zalando", postal_code: "10243" })
 => [
   {
     "name": "Zalando Logistics Süd SE & Co. KG",
@@ -119,6 +120,42 @@ client.find_company(country_code: "DE", company_name: "zalando", postal_code: "1
 ]
 ```
 
+In some countries you can also perform a VAT number search. For this, you need to provide
+a country code and a VAT number:
+
+```ruby
+client.find_company({ country_code: "US", vat_number: "201665019" })
+=> [
+  {
+    "name": "FACEBOOK, INCORPORATED",
+    "officeType": "HeadOffice",
+    "status": "Active",
+    "registration_number": "0883875",
+    "vat_number": "201665019",
+    "address": {
+      "simple_value": "1601 WILLOW ROAD , MENLO PARK, CA, 94025",
+      "street": "1601 WILLOW ROAD ",
+      "city": "MENLO PARK",
+      "postal_code": "94025",
+      "province": "CA"
+    },
+    "phone_number": "6505434800",
+    "available_report_types": {
+      "available_report_type": "Full"
+    },
+    "available_languages": {
+      "available_language": "EN"
+    },
+    "@online_reports": "true",
+    "@monitoring": "false",
+    "@country": "US",
+    "@id": "US023/X/US22964593",
+    "@safe_number": "US22964593"
+  },
+  ...
+]
+```
+
 ### Company Report
 
 To download all the information available in an online company report, you will

data/lib/creditsafe/constants.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Constants
+  module Country
+    AUSTRALIA                 = "AU"
+    AUSTRIA                   = "AT"
+    BELGIUM                   = "BE"
+    BULGARIA                  = "BG"
+    CANADA                    = "CA"
+    CROATIA                   = "HR"
+    CZECH_REPUBLIC            = "CZ"
+    DENMARK                   = "DK"
+    ESTONIA                   = "EE"
+    FINLAND                   = "FI"
+    FRANCE                    = "FR"
+    GERMANY                   = "DE"
+    GREAT_BRITAIN             = "GB"
+    GREECE                    = "GR"
+    HUNGARY                   = "HU"
+    ICELAND                   = "IS"
+    IRELAND                   = "IE"
+    ITALY                     = "IT"
+    LATVIA                    = "LV"
+    LIECHTENSTEIN             = "LI"
+    LITHUANIA                 = "LT"
+    LUXEMBOURG                = "LU"
+    MALTA                     = "MT"
+    MOLDOVA                   = "MD"
+    NETHERLANDS               = "NL"
+    NEW_ZEALAND               = "NZ"
+    NORWAY                    = "NO"
+    POLAND                    = "PL"
+    PORTUGAL                  = "PT"
+    ROMANIA                   = "RO"
+    SLOVAKIA                  = "SK"
+    SLOVENIA                  = "SI"
+    SPAIN                     = "ES"
+    SWEDEN                    = "SE"
+    SWITZERLAND               = "CH"
+    UK                        = "GB"
+    UNITED_STATES             = "US"
+
+    VAT_NUMBER_SUPPORTED = [
+      GERMANY, FRANCE, CZECH_REPUBLIC, SLOVAKIA, BELGIUM, POLAND, PORTUGAL, SPAIN,
+      UNITED_STATES, SLOVENIA, CROATIA, BULGARIA, ROMANIA, LATVIA, ESTONIA, MOLDOVA,
+      AUSTRIA, ITALY, HUNGARY, FINLAND, DENMARK, AUSTRALIA, GREECE
+    ].freeze
+  end
+end

data/lib/creditsafe/request/find_company.rb

@@ -2,6 +2,7 @@
 
 require "creditsafe/match_type"
 require "creditsafe/namespace"
+require "creditsafe/constants"
 
 module Creditsafe
   module Request
@@ -11,6 +12,7 @@ module Creditsafe
         @country_code = search_criteria[:country_code]
         @registration_number = search_criteria[:registration_number]
         @company_name = search_criteria[:company_name]
+        @vat_number = search_criteria[:vat_number]
         @city = search_criteria[:city]
         @postal_code = search_criteria[:postal_code]
       end
@@ -32,6 +34,11 @@ module Creditsafe
             registration_number
         end
 
+        unless vat_number.nil?
+          search_criteria["#{Creditsafe::Namespace::DAT}:VatNumber"] =
+            vat_number
+        end
+
         unless city.nil?
           search_criteria["#{Creditsafe::Namespace::DAT}:Address"] = {
             "#{Creditsafe::Namespace::DAT}:City" => city,
@@ -51,7 +58,8 @@ module Creditsafe
 
       private
 
-      attr_reader :country_code, :registration_number, :city, :company_name, :postal_code
+      attr_reader :country_code, :registration_number, :city, :company_name, :postal_code,
+                  :vat_number
 
       def match_type
         Creditsafe::MatchType::ALLOWED[country_code.upcase.to_sym]&.first ||
@@ -69,14 +77,16 @@ module Creditsafe
 
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize
       def check_search_criteria(search_criteria)
         if search_criteria[:country_code].nil?
           raise ArgumentError, "country_code is a required search criteria"
         end
 
-        unless only_registration_number_or_company_name_provided?(search_criteria)
-          raise ArgumentError, "registration_number or company_name (not both) are " \
-                               "required search criteria"
+        unless only_one_required_criteria?(search_criteria)
+          raise ArgumentError, "only one of registration_number, company_name or " \
+                               "vat number is required search criteria"
         end
 
         if search_criteria[:city] && search_criteria[:country_code] != "DE"
@@ -86,12 +96,24 @@ module Creditsafe
         if search_criteria[:postal_code] && search_criteria[:country_code] != "DE"
           raise ArgumentError, "Postal code is only supported for German searches"
         end
+
+        if search_criteria[:vat_number] && !Constants::Country::VAT_NUMBER_SUPPORTED.
+            include?(search_criteria[:country_code])
+          raise ArgumentError, "VAT number is not supported in this country"
+        end
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/PerceivedComplexity
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity
 
-      def only_registration_number_or_company_name_provided?(search_criteria)
-        search_criteria[:registration_number].nil? ^ search_criteria[:company_name].nil?
+      def only_one_required_criteria?(search_criteria)
+        by_registration_number = !search_criteria[:registration_number].nil?
+        by_company_name = !search_criteria[:company_name].nil?
+        by_vat_number = !search_criteria[:vat_number].nil?
+
+        (by_registration_number ^ by_company_name ^ by_vat_number) &&
+          !(by_registration_number && by_company_name && by_vat_number)
       end
     end
   end

data/lib/creditsafe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Creditsafe
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/creditsafe/client_spec.rb

@@ -136,10 +136,14 @@ RSpec.describe(Creditsafe::Client) do
     let(:registration_number) { "RN123" }
     let(:city) { nil }
     let(:postal_code) { nil }
+    let(:company_name) { nil }
+    let(:vat_number) { nil }
     let(:search_criteria) do
       {
         country_code: country_code,
         registration_number: registration_number,
+        company_name: company_name,
+        vat_number: vat_number,
         city: city,
         postal_code: postal_code,
       }.reject { |_, v| v.nil? }
@@ -194,7 +198,9 @@ RSpec.describe(Creditsafe::Client) do
     end
 
     context "with a company name" do
-      let(:search_criteria) { { country_code: "FR", company_name: "Mimes Inc" } }
+      let(:country_code) { "FR" }
+      let(:registration_number) { nil }
+      let(:company_name) { "Mimes Inc" }
 
       it { is_expected.to_not raise_error }
 
@@ -211,6 +217,54 @@ RSpec.describe(Creditsafe::Client) do
       end
     end
 
+    context "with a vat_number" do
+      let(:vat_number) { "942404110" }
+      let(:registration_number) { nil }
+
+      it { is_expected.to raise_error(ArgumentError) }
+
+      context "in US" do
+        let(:country_code) { "US" }
+
+        it { is_expected.to_not raise_error }
+      end
+    end
+
+    context "with different invalid required criteria combinations used" do
+      context "with registration number and company name" do
+        let(:company_name) { "Mimes Inc" }
+
+        it { is_expected.to raise_error(ArgumentError) }
+      end
+
+      context "with registration number and vat_number" do
+        let(:vat_number) { "942404110" }
+
+        it { is_expected.to raise_error(ArgumentError) }
+      end
+
+      context "with company name and vat_number" do
+        let(:registration_number) { nil }
+        let(:company_name) { "Mimes Inc" }
+        let(:vat_number) { "942404110" }
+
+        it { is_expected.to raise_error(ArgumentError) }
+      end
+
+      context "with all three required criteria" do
+        let(:company_name) { "Mimes Inc" }
+        let(:vat_number) { "942404110" }
+
+        it { is_expected.to raise_error(ArgumentError) }
+      end
+
+      context "with no required criteria" do
+        let(:registration_number) { nil }
+
+        it { is_expected.to raise_error(ArgumentError) }
+      end
+    end
+
     it "requests the company deatils" do
       find_company
       expect(a_request(:post, URL).with do |req|
@@ -218,7 +272,7 @@ RSpec.describe(Creditsafe::Client) do
                         Nokogiri::XML(req.body),
                         load_xml_fixture("find-companies-request.xml"),
                         verbose: true,
-               )).to eq([])
+                      )).to eq([])
              end).to have_been_made
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creditsafe
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -214,6 +214,7 @@ files:
 - data/creditsafe-test.xml
 - lib/creditsafe.rb
 - lib/creditsafe/client.rb
+- lib/creditsafe/constants.rb
 - lib/creditsafe/errors.rb
 - lib/creditsafe/match_type.rb
 - lib/creditsafe/messages.rb