creditsafe 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 563fddd54824c02af29e53feb2363d7d727a56b5
-  data.tar.gz: 91d896b3049f05021d46dd053958a4f13f0fdb1e
+  metadata.gz: ef933acd556b7da62f4479c61a255b488980db56
+  data.tar.gz: 0b429f01c58df701cdfab8f917031794c9aaad1c
 SHA512:
-  metadata.gz: c25e9c9607708e08767a1c76a0df85af71dc00c059992c015639a7e4e11e41cb1019fe31cc0bd68e7ddd4c5ea4db65dc9e85227d3821760c4a70d46af9da5520
-  data.tar.gz: cfa40a02a6f38fab8781ceed3d879afab0d27042686bc719c29e56c4d90937887c59d50d562d733965f5f075cd296eb23a1019d81f962db1fe6f5b105035dcf6
+  metadata.gz: e8f6379e8e4f0653a2694723512d8bf519aff20d27b272c7745915f39bfced01176bd6556312867a1709f25eaf75bce2618a80e00e08ef14062d9b5138db4202
+  data.tar.gz: 95d9f34ab1f1f8c0b85e69cfa903a7f377f4d7c27e9000c157fcc51707191f1ba15f70097839fe87206ae2d9e70e646208a5c27cb0a031ab6c1d1bb061da16f4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.4.0, 3 April 2017
+
+- Adds support for including a postal code when searching for German companies by name 
+(@manojapr)
+
 ## v0.3.2, 27 February 2017
 
 - Adds support for using Creditsafe's test environment, specified when instantiating the

data/README.md

@@ -13,7 +13,7 @@ registration number (and name in Germany), and retrieving company online reports
 Install the gem from RubyGems.org by adding the following to your `Gemfile`:
 
 ```ruby
-gem 'creditsafe', '~> 0.3.2'
+gem 'creditsafe', '~> 0.4.0'
 ```
 
 Just run `bundle install` to install the gem and its dependencies.
@@ -31,7 +31,7 @@ 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 country code and a company registration number:
 
 ```ruby
 client.find_company(country_code: "GB", registration_number: "07495895")
@@ -54,10 +54,12 @@ 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.
+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
+further:
 
 ```ruby
-client.find_company(country_code: "DE", company_name: "zalando")
+client.find_company(country_code: "DE", company_name: "zalando", postal_code: "10243")
 => [
   {
     "name": "Zalando Logistics Süd SE & Co. KG",
@@ -120,8 +122,8 @@ client.find_company(country_code: "DE", company_name: "zalando")
 ### Company Report
 
 To download all the information available in an online company report, you will
-need the company's creditsafe identifier (obtainable using
-[find_company](#find_company) above.
+need the company's Creditsafe identifier (obtainable using
+[find_company](#find_company) above):
 
 ```ruby
 client.company_report("GB003/0/07495895")

data/lib/creditsafe/request/find_company.rb

@@ -11,6 +11,7 @@ module Creditsafe
         @registration_number = search_criteria[:registration_number]
         @company_name = search_criteria[:company_name]
         @city = search_criteria[:city]
+        @postal_code = search_criteria[:postal_code]
       end
 
       def message
@@ -30,12 +31,16 @@ module Creditsafe
           "#{Creditsafe::Namespace::DAT}:City" => city
         } unless city.nil?
 
+        search_criteria["#{Creditsafe::Namespace::DAT}:Address"] = {
+          "#{Creditsafe::Namespace::DAT}:PostalCode" => postal_code
+        } unless postal_code.nil?
+
         build_message(search_criteria)
       end
 
       private
 
-      attr_reader :country_code, :registration_number, :city, :company_name
+      attr_reader :country_code, :registration_number, :city, :company_name, :postal_code
 
       def build_message(search_criteria)
         {
@@ -64,6 +69,10 @@ module Creditsafe
         if search_criteria[:city] && search_criteria[:country_code] != 'DE'
           raise ArgumentError, "city is only supported for German searches"
         end
+
+        if search_criteria[:postal_code] && search_criteria[:country_code] != 'DE'
+          raise ArgumentError, "Postal code is only supported for German searches"
+        end
       end
       # rubocop:enable Style/CyclomaticComplexity, Metrics/AbcSize
 

data/lib/creditsafe/version.rb

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

data/spec/creditsafe/client_spec.rb

@@ -127,11 +127,13 @@ RSpec.describe(Creditsafe::Client) do
     let(:country_code) { "GB" }
     let(:registration_number) { "RN123" }
     let(:city) { nil }
+    let(:postal_code) { nil }
     let(:search_criteria) do
       {
         country_code: country_code,
         registration_number: registration_number,
-        city: city
+        city: city,
+        postal_code: postal_code
       }.reject { |_, v| v.nil? }
     end
 
@@ -168,6 +170,16 @@ RSpec.describe(Creditsafe::Client) do
       end
     end
 
+    context "with a postal_code" do
+      let(:postal_code) { "41199" }
+      it { is_expected.to raise_error(ArgumentError) }
+
+      context "in Germany" do
+        let(:country_code) { "DE" }
+        it { is_expected.to_not raise_error }
+      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.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon