creditsafe 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3f7e899ff7ea1566d2a958e2ebb966971f49af3
-  data.tar.gz: a9eca4831066ac57b6c67199d8d34898c795194c
+  metadata.gz: 573855f9d450030239bbaec2fbd740d8b134a30b
+  data.tar.gz: e0060a5aadda143a49424f4fd0652f14028cfa36
 SHA512:
-  metadata.gz: 39c2f54873c5d70bdc66df50c1c44f9813961b888b5b5ed038ebd3b6e5086a7bf8dc2fd7cb195858e45e7f26a4667d19b5ad914e163465c78d26e7e2cc0abd0f
-  data.tar.gz: 7fc19fcbca0b22f6003f4f44f8f519a93f9ba43b0a67711cccb02dff2dcbadde0d765f1bd654749eef6c75da5cc5ba0156e0007fcde59d06d901e9f9aea52ee6
+  metadata.gz: b18ceca81cde0de58544cf6eb152f7cb74c8d14d1870a63a58684351787f149e769a23956abfb053b8167d9d044fe8a64eae628de24ecdaf1301962b234d3c59
+  data.tar.gz: 9148bfde20fa5555450efe3481970991790aa09c5bfe81df76c60c022b006821c1ed1d6f6df9d422c82766bcdacb85bdfa14c1b88d8ebb4e1ec6f62bd63ff438

data/.rubocop.yml

@@ -16,9 +16,3 @@ Style/DotPosition:
 
 Style/Documentation:
   Enabled: false
-
-Metrics/MethodLength:
-  Max: 15
-
-Metrics/ClassLength:
-  Max: 152

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.3.1, 6 January 2017
+
+- Suppress password when inspecting client
+
+## v0.3.0, 4 August 2016
+
+- Add instrumentation to SOAP requests
+
 ## v0.2.0, 16 March 2016
 
 - Subclass `ApiError` to distinguish between different Creditsafe error types

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    creditsafe (0.2.0)
+    creditsafe (0.3.1)
       activesupport (>= 4.2.0)
       excon (~> 0.45)
       savon (~> 2.8)
@@ -22,6 +22,8 @@ GEM
     builder (3.2.2)
     byebug (9.0.5)
     coderay (1.1.1)
+    compare-xml (0.62)
+      nokogiri (~> 1.6)
     concurrent-ruby (1.0.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -80,7 +82,7 @@ GEM
     pry-byebug (3.4.0)
       byebug (~> 9.0)
       pry (~> 0.10)
-    rack (1.6.4)
+    rack (2.0.1)
     rainbow (2.1.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
@@ -140,6 +142,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  compare-xml (~> 0.5)
   creditsafe!
   guard-rspec (~> 4.5)
   guard-rubocop (~> 1.2)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 GoCardless
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -8,6 +8,16 @@ A ruby library for interacting with the
 Currently, it only partially implements the API to support finding companies by
 registration number and retrieving company online reports.
 
+# Installation
+
+Install the gem from RubyGems.org by adding the following to your `Gemfile`:
+
+```ruby
+gem 'creditsafe', '~> 0.3.1'
+```
+
+Just run `bundle install` to install the gem and its dependencies.
+
 # Usage
 
 Initialise the client with your `username` and `password`.
@@ -53,3 +63,8 @@ client.company_report(creditsafe_id: "GB003/0/07495895")
     ...
    }
 ```
+
+
+---
+
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).

data/creditsafe.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.37'
   spec.add_development_dependency 'webmock', '~> 1.20'
   spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'compare-xml', '~> 0.5'
 end

data/lib/creditsafe/client.rb

@@ -5,21 +5,15 @@ 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
-    XMLNS_OPER = 'oper'
-    XMLNS_OPER_VAL = 'http://www.creditsafe.com/globaldata/operations'
-
-    XMLNS_DAT = 'dat'
-    XMLNS_DAT_VAL = 'http://www.creditsafe.com/globaldata/datatypes'
-
-    XMLNS_CRED = 'cred'
-    XMLNS_CRED_VAL =
-      'http://schemas.datacontract.org/2004/07/Creditsafe.GlobalData'
-
     def initialize(username: nil, password: nil, savon_opts: {})
       raise ArgumentError, "Username must be provided" if username.nil?
       raise ArgumentError, "Password must be provided" if password.nil?
@@ -30,10 +24,9 @@ module Creditsafe
     end
 
     def find_company(search_criteria = {})
-      check_search_criteria(search_criteria)
+      request = Creditsafe::Request::FindCompany.new(search_criteria)
+      response = invoke_soap(:find_companies, request.message)
 
-      response = invoke_soap(:find_companies,
-                             find_company_message(search_criteria))
       companies = response.
                   fetch(:find_companies_response).
                   fetch(:find_companies_result).
@@ -43,10 +36,9 @@ module Creditsafe
     end
 
     def company_report(creditsafe_id, custom_data: nil)
-      response = invoke_soap(
-        :retrieve_company_online_report,
-        retrieve_company_report_message(creditsafe_id, custom_data)
-      )
+      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).
@@ -55,62 +47,11 @@ module Creditsafe
         fetch(:report)
     end
 
-    private
-
-    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[:registration_number].nil?
-        raise ArgumentError, "registration_number is a required search criteria"
-      end
-
-      if search_criteria[:city] && search_criteria[:country_code] != 'DE'
-        raise ArgumentError, "city is only supported for German searches"
-      end
-    end
-
-    def find_company_message(provided_criteria)
-      search_criteria = {
-        "#{XMLNS_DAT}:RegistrationNumber" =>
-          provided_criteria[:registration_number]
-      }
-
-      unless provided_criteria[:city].nil?
-        search_criteria["#{XMLNS_DAT}:Address"] =
-          { "#{XMLNS_DAT}:City" => provided_criteria[:city] }
-      end
-
-      {
-        "#{XMLNS_OPER}:countries" => {
-          "#{XMLNS_CRED}:CountryCode" => provided_criteria[:country_code]
-        },
-        "#{XMLNS_OPER}:searchCriteria" => search_criteria
-      }
+    def inspect
+      "#<#{self.class} @username='#{@username}'>"
     end
 
-    def retrieve_company_report_message(company_id, custom_data)
-      message = {
-        "#{XMLNS_OPER}:companyId" => company_id.to_s,
-        "#{XMLNS_OPER}:reportType" => 'Full',
-        "#{XMLNS_OPER}:language" => "EN"
-      }
-
-      unless custom_data.nil?
-        message["#{XMLNS_OPER}:customData"] = {
-          "#{XMLNS_DAT}:Entries" => {
-            "#{XMLNS_DAT}:Entry" => custom_data_entries(custom_data)
-          }
-        }
-      end
-
-      message
-    end
-
-    def custom_data_entries(custom_data)
-      custom_data.map { |key, value| { :@key => key, :content! => value } }
-    end
+    private
 
     def handle_message_for_response(response)
       [
@@ -176,12 +117,8 @@ module Creditsafe
     def build_savon_client
       options = {
         env_namespace: 'soapenv',
-        namespace_identifier: XMLNS_OPER,
-        namespaces: {
-          "xmlns:#{XMLNS_OPER}" => XMLNS_OPER_VAL,
-          "xmlns:#{XMLNS_DAT}" => XMLNS_DAT_VAL,
-          "xmlns:#{XMLNS_CRED}" => XMLNS_CRED_VAL
-        },
+        namespace_identifier: Creditsafe::Namespace::OPER,
+        namespaces: Creditsafe::Namespace::ALL,
         wsdl: wsdl_path,
         headers: auth_header,
         convert_request_keys_to: :none,

data/lib/creditsafe/namespace.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Creditsafe
+  module Namespace
+    OPER = 'oper'
+    OPER_VAL = 'http://www.creditsafe.com/globaldata/operations'
+
+    DAT = 'dat'
+    DAT_VAL = 'http://www.creditsafe.com/globaldata/datatypes'
+
+    CRED = 'cred'
+    CRED_VAL = 'http://schemas.datacontract.org/2004/07/Creditsafe.GlobalData'
+
+    ALL = {
+      "xmlns:#{Creditsafe::Namespace::OPER}" => Creditsafe::Namespace::OPER_VAL,
+      "xmlns:#{Creditsafe::Namespace::DAT}" => Creditsafe::Namespace::DAT_VAL,
+      "xmlns:#{Creditsafe::Namespace::CRED}" => Creditsafe::Namespace::CRED_VAL
+    }.freeze
+  end
+end

data/lib/creditsafe/request/company_report.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'creditsafe/namespace'
+
+module Creditsafe
+  module Request
+    class CompanyReport
+      def initialize(company_id, custom_data)
+        @company_id = company_id
+        @custom_data = custom_data
+      end
+
+      def message
+        message = {
+          "#{Creditsafe::Namespace::OPER}:companyId" => company_id.to_s,
+          "#{Creditsafe::Namespace::OPER}:reportType" => 'Full',
+          "#{Creditsafe::Namespace::OPER}:language" => "EN"
+        }
+
+        unless custom_data.nil?
+          message["#{Creditsafe::Namespace::OPER}:customData"] = {
+            "#{Creditsafe::Namespace::DAT}:Entries" => {
+              "#{Creditsafe::Namespace::DAT}:Entry" => custom_data_entries
+            }
+          }
+        end
+
+        message
+      end
+
+      private
+
+      def custom_data_entries
+        custom_data.map { |key, value| { :@key => key, :content! => value } }
+      end
+
+      attr_reader :company_id, :custom_data
+    end
+  end
+end

data/lib/creditsafe/request/find_company.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'creditsafe/namespace'
+
+module Creditsafe
+  module Request
+    class FindCompany
+      def initialize(search_criteria)
+        check_search_criteria(search_criteria)
+
+        @country_code = search_criteria[:country_code]
+        @registration_number = search_criteria[:registration_number]
+        @city = search_criteria[:city]
+      end
+
+      def message
+        search_criteria = {
+          "#{Creditsafe::Namespace::DAT}:RegistrationNumber" =>
+            registration_number
+        }
+
+        unless city.nil?
+          search_criteria["#{Creditsafe::Namespace::DAT}:Address"] =
+            { "#{Creditsafe::Namespace::DAT}:City" => city }
+        end
+
+        {
+          "#{Creditsafe::Namespace::OPER}:countries" => {
+            "#{Creditsafe::Namespace::CRED}:CountryCode" => country_code
+          },
+          "#{Creditsafe::Namespace::OPER}:searchCriteria" => search_criteria
+        }
+      end
+
+      private
+
+      attr_reader :country_code, :registration_number, :city
+
+      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[:registration_number].nil?
+          raise ArgumentError,
+                "registration_number is a required search criteria"
+        end
+
+        if search_criteria[:city] && search_criteria[:country_code] != 'DE'
+          raise ArgumentError, "city is only supported for German searches"
+        end
+      end
+    end
+  end
+end

data/lib/creditsafe/version.rb

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

data/spec/creditsafe/client_spec.rb

@@ -8,8 +8,8 @@ URL = 'https://webservices.creditsafe.com/GlobalData/1.3/'\
 
 RSpec.describe(Creditsafe::Client) do
   notifications = []
-  let(:username) { "b" }
-  let(:password) { "c" }
+  let(:username) { "AzureDiamond" }
+  let(:password) { "hunter2" }
   before(:all) do
     ActiveSupport::Notifications.subscribe do |*args|
       notifications << ActiveSupport::Notifications::Event.new(*args)
@@ -105,8 +105,6 @@ RSpec.describe(Creditsafe::Client) do
     subject do
       -> { described_class.new(username: username, password: password) }
     end
-    let(:username) { "foo" }
-    let(:password) { "bar" }
 
     it { is_expected.to_not raise_error }
 
@@ -114,11 +112,13 @@ RSpec.describe(Creditsafe::Client) do
       let(:username) { nil }
       it { is_expected.to raise_error(ArgumentError) }
     end
+  end
 
-    context "without a password" do
-      let(:password) { nil }
-      it { is_expected.to raise_error(ArgumentError) }
-    end
+  describe "#inspect" do
+    let(:client) { described_class.new(username: username, password: password) }
+    subject { client.inspect }
+
+    it { is_expected.to_not include(password) }
   end
 
   describe '#find_company' do
@@ -134,8 +134,10 @@ RSpec.describe(Creditsafe::Client) do
         city: city
       }.reject { |_, v| v.nil? }
     end
-    let(:find_company) { client.find_company(search_criteria) }
-    let(:method_call) { find_company }
+
+    subject(:find_company) { client.find_company(search_criteria) }
+    subject(:method_call) { find_company }
+
     before do
       stub_request(:post, URL).to_return(
         body: load_fixture('find-companies-successful.xml'),
@@ -166,6 +168,17 @@ RSpec.describe(Creditsafe::Client) do
       end
     end
 
+    it 'requests the company deatils' do
+      find_company
+      expect(a_request(:post, URL).with do |req|
+               expect(CompareXML.equivalent?(
+                        Nokogiri::XML(req.body),
+                        load_xml_fixture('find-companies-request.xml'),
+                        verbose: true
+               )).to eq([])
+             end).to have_been_made
+    end
+
     it 'returns the company details' do
       expect(find_company).
         to eq(:name => 'GOCARDLESS LTD',
@@ -265,10 +278,21 @@ RSpec.describe(Creditsafe::Client) do
     end
     let(:client) { described_class.new(username: username, password: password) }
     let(:custom_data) { { foo: "bar", bar: "baz" } }
-    let(:company_report) do
+    subject(:company_report) do
       client.company_report('GB003/0/07495895', custom_data: custom_data)
     end
-    let(:method_call) { company_report }
+    subject(:method_call) { company_report }
+
+    it 'requests the company details' do
+      company_report
+      expect(a_request(:post, URL).with do |req|
+               expect(CompareXML.equivalent?(
+                        Nokogiri::XML(req.body),
+                        load_xml_fixture('company-report-request.xml'),
+                        verbose: true
+               )).to eq([])
+             end).to have_been_made
+    end
 
     it 'returns the company details' do
       expect(company_report).to include(:company_summary)

data/spec/fixtures/company-report-request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:oper="http://www.creditsafe.com/globaldata/operations" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dat="http://www.creditsafe.com/globaldata/datatypes" xmlns:cred="http://schemas.datacontract.org/2004/07/Creditsafe.GlobalData"><soapenv:Body><oper:RetrieveCompanyOnlineReport><oper:companyId>GB003/0/07495895</oper:companyId><oper:reportType>Full</oper:reportType><oper:language>EN</oper:language><oper:customData><dat:Entries><dat:Entry key="foo">bar</dat:Entry><dat:Entry key="bar">baz</dat:Entry></dat:Entries></oper:customData></oper:RetrieveCompanyOnlineReport></soapenv:Body></soapenv:Envelope>

data/spec/fixtures/find-companies-request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:oper="http://www.creditsafe.com/globaldata/operations" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dat="http://www.creditsafe.com/globaldata/datatypes" xmlns:cred="http://schemas.datacontract.org/2004/07/Creditsafe.GlobalData"><soapenv:Body><oper:FindCompanies><oper:countries><cred:CountryCode>GB</cred:CountryCode></oper:countries><oper:searchCriteria><dat:RegistrationNumber>RN123</dat:RegistrationNumber></oper:searchCriteria></oper:FindCompanies></soapenv:Body></soapenv:Envelope>

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 require 'webmock/rspec'
 require 'nokogiri'
 require 'rspec/its'
+require 'compare-xml'
 
 def load_fixture(name)
   File.read(File.join(File.dirname(__FILE__), 'fixtures', name))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creditsafe
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: compare-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: Ruby client for the Creditsafe SOAP API
 email:
 - engineering@gocardless.com
@@ -180,6 +194,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- LICENSE.txt
 - README.md
 - circle.yml
 - creditsafe.gemspec
@@ -188,16 +203,21 @@ files:
 - lib/creditsafe/client.rb
 - lib/creditsafe/errors.rb
 - lib/creditsafe/messages.rb
+- lib/creditsafe/namespace.rb
+- lib/creditsafe/request/company_report.rb
+- lib/creditsafe/request/find_company.rb
 - lib/creditsafe/version.rb
 - spec/creditsafe/client_spec.rb
 - spec/creditsafe/messages_spec.rb
 - spec/fixtures/company-report-not-found.xml
+- spec/fixtures/company-report-request.xml
 - spec/fixtures/company-report-successful.xml
 - spec/fixtures/error-fault.xml
 - spec/fixtures/error-invalid-credentials.html
 - spec/fixtures/find-companies-error-no-text.xml
 - spec/fixtures/find-companies-error.xml
 - spec/fixtures/find-companies-none-found.xml
+- spec/fixtures/find-companies-request.xml
 - spec/fixtures/find-companies-successful-multi.xml
 - spec/fixtures/find-companies-successful.xml
 - spec/spec_helper.rb
@@ -228,12 +248,14 @@ test_files:
 - spec/creditsafe/client_spec.rb
 - spec/creditsafe/messages_spec.rb
 - spec/fixtures/company-report-not-found.xml
+- spec/fixtures/company-report-request.xml
 - spec/fixtures/company-report-successful.xml
 - spec/fixtures/error-fault.xml
 - spec/fixtures/error-invalid-credentials.html
 - spec/fixtures/find-companies-error-no-text.xml
 - spec/fixtures/find-companies-error.xml
 - spec/fixtures/find-companies-none-found.xml
+- spec/fixtures/find-companies-request.xml
 - spec/fixtures/find-companies-successful-multi.xml
 - spec/fixtures/find-companies-successful.xml
 - spec/spec_helper.rb