creditsafe 0.6.0 → 0.7.0

data/README.md

@@ -1,175 +1,175 @@
-# creditsafe-ruby
-
-*Build status: [![Circle CI](https://circleci.com/gh/gocardless/creditsafe-ruby.svg?style=svg&circle-token=3f6e9b24fcc6a57abac110c59395b36032f156a5)](https://circleci.com/gh/gocardless/creditsafe-ruby)*
-
-A ruby library for interacting with the
-[Creditsafe](http://www.creditsafeuk.com/) API.
-
-Currently, it only partially implements the API to support finding companies by
-registration number (and name in Germany), and retrieving company online reports.
-
-# Installation
-
-Install the gem from RubyGems.org by adding the following to your `Gemfile`:
-
-```ruby
-gem 'creditsafe', '~> 0.4.0'
-```
-
-Just run `bundle install` to install the gem and its dependencies.
-
-# Usage
-
-Initialise the client with your `username` and `password`.
-
-```ruby
-client = Creditsafe::Client.new(username: "foo", password: "bar")
-
-# optionally with environment (live is default) and or log level
-client = Creditsafe::Client.new(username: "foo", password: "bar", environment: :test, log_level: :debug)
-```
-
-### Company Search
-
-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" })
-=> {
-    name: "GOCARDLESS LTD",
-    type: "Ltd",
-    status: "Active",
-    registration_number: "07495895",
-    address: {
-        simple_value: "338-346, GOSWELL, LONDON",
-        postal_code: "EC1V7LQ"
-    },
-    available_report_types: { available_report_type: "Full" },
-    available_languages: { available_language: "EN" },
-    @date_of_latest_accounts: "2014-01-31T00:00:00Z",
-    @online_reports: "true",
-    @monitoring: "false",
-    @country: "GB",
-    @id: "GB003/0/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 provide a postal code or city to filter the results
-further:
-
-```ruby
-client.find_company({ country_code: "DE", company_name: "zalando", postal_code: "10243" })
-=> [
-  {
-    "name": "Zalando Logistics Süd SE & Co. KG",
-    "type": "NonLtd",
-    "status": "Active",
-    "address": {
-      "street": "Tamara-Danz-Str. 1",
-      "city": "Berlin",
-      "postal_code": "10243"
-    },
-    "available_report_types": {
-      "available_report_type": [
-        "Full",
-        "Basic"
-      ]
-    },
-    "available_languages": {
-      "available_language": [
-        "EN",
-        "DE"
-      ]
-    },
-    "@online_reports": "true",
-    "@monitoring": "true",
-    "@country": "DE",
-    "@id": "DE001/1/DE20316785",
-    "@safe_number": "DE20316785"
-  },
-  {
-    "name": "Zalando Outlet Store Berlin",
-    "type": "NonLtd",
-    "status": "Active",
-    "address": {
-      "street": "Köpenicker Str. 20",
-      "city": "Berlin",
-      "postal_code": "10997"
-    },
-    "available_report_types": {
-      "available_report_type": [
-        "Full",
-        "Basic"
-      ]
-    },
-    "available_languages": {
-      "available_language": [
-        "EN",
-        "DE"
-      ]
-    },
-    "@online_reports": "true",
-    "@monitoring": "true",
-    "@country": "DE",
-    "@id": "DE001/1/DE16031795",
-    "@safe_number": "DE16031795"
-  },
-  ...
-]
-```
-
-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
-need the company's Creditsafe identifier (obtainable using
-[find_company](#find_company) above):
-
-```ruby
-client.company_report("GB003/0/07495895")
-=> {
-    ...
-   }
-```
-
-
----
-
-GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).
+# creditsafe-ruby
+
+*Build status: [![Circle CI](https://circleci.com/gh/gocardless/creditsafe-ruby.svg?style=svg&circle-token=3f6e9b24fcc6a57abac110c59395b36032f156a5)](https://circleci.com/gh/gocardless/creditsafe-ruby)*
+
+A ruby library for interacting with the
+[Creditsafe](http://www.creditsafeuk.com/) API.
+
+Currently, it only partially implements the API to support finding companies by
+registration number (and name in Germany), and retrieving company online reports.
+
+# Installation
+
+Install the gem from RubyGems.org by adding the following to your `Gemfile`:
+
+```ruby
+gem 'creditsafe', '~> 0.4.0'
+```
+
+Just run `bundle install` to install the gem and its dependencies.
+
+# Usage
+
+Initialise the client with your `username` and `password`.
+
+```ruby
+client = Creditsafe::Client.new(username: "foo", password: "bar")
+
+# optionally with environment (live is default) and or log level
+client = Creditsafe::Client.new(username: "foo", password: "bar", environment: :test, log_level: :debug)
+```
+
+### Company Search
+
+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" })
+=> {
+    name: "GOCARDLESS LTD",
+    type: "Ltd",
+    status: "Active",
+    registration_number: "07495895",
+    address: {
+        simple_value: "338-346, GOSWELL, LONDON",
+        postal_code: "EC1V7LQ"
+    },
+    available_report_types: { available_report_type: "Full" },
+    available_languages: { available_language: "EN" },
+    @date_of_latest_accounts: "2014-01-31T00:00:00Z",
+    @online_reports: "true",
+    @monitoring: "false",
+    @country: "GB",
+    @id: "GB003/0/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 provide a postal code or city to filter the results
+further:
+
+```ruby
+client.find_company({ country_code: "DE", company_name: "zalando", postal_code: "10243" })
+=> [
+  {
+    "name": "Zalando Logistics Süd SE & Co. KG",
+    "type": "NonLtd",
+    "status": "Active",
+    "address": {
+      "street": "Tamara-Danz-Str. 1",
+      "city": "Berlin",
+      "postal_code": "10243"
+    },
+    "available_report_types": {
+      "available_report_type": [
+        "Full",
+        "Basic"
+      ]
+    },
+    "available_languages": {
+      "available_language": [
+        "EN",
+        "DE"
+      ]
+    },
+    "@online_reports": "true",
+    "@monitoring": "true",
+    "@country": "DE",
+    "@id": "DE001/1/DE20316785",
+    "@safe_number": "DE20316785"
+  },
+  {
+    "name": "Zalando Outlet Store Berlin",
+    "type": "NonLtd",
+    "status": "Active",
+    "address": {
+      "street": "Köpenicker Str. 20",
+      "city": "Berlin",
+      "postal_code": "10997"
+    },
+    "available_report_types": {
+      "available_report_type": [
+        "Full",
+        "Basic"
+      ]
+    },
+    "available_languages": {
+      "available_language": [
+        "EN",
+        "DE"
+      ]
+    },
+    "@online_reports": "true",
+    "@monitoring": "true",
+    "@country": "DE",
+    "@id": "DE001/1/DE16031795",
+    "@safe_number": "DE16031795"
+  },
+  ...
+]
+```
+
+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
+need the company's Creditsafe identifier (obtainable using
+[find_company](#find_company) above):
+
+```ruby
+client.company_report("GB003/0/07495895")
+=> {
+    ...
+   }
+```
+
+
+---
+
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).

data/creditsafe.gemspec

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "creditsafe/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "creditsafe"
-  spec.version       = Creditsafe::VERSION
-  spec.authors       = ["GoCardless Engineering"]
-  spec.email         = ["engineering@gocardless.com"]
-  spec.summary       = "Ruby client for the Creditsafe SOAP API"
-  spec.description   = "Ruby client for the Creditsafe SOAP API"
-  spec.homepage      = "https://github.com/gocardless/creditsafe-ruby"
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "activesupport", ">= 4.2.0"
-  spec.add_runtime_dependency "excon", "~> 0.45"
-  spec.add_runtime_dependency "savon", "~> 2.8"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "compare-xml", "~> 0.5"
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.3"
-  spec.add_development_dependency "pry", "~> 0.11"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rspec-its", "~> 1.2"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
-  spec.add_development_dependency "rubocop", "~> 0.52"
-  spec.add_development_dependency "timecop", "~> 0.8"
-  spec.add_development_dependency "webmock", "~> 3.3"
-end
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "creditsafe/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "creditsafe"
+  spec.version       = Creditsafe::VERSION
+  spec.authors       = ["GoCardless Engineering"]
+  spec.email         = ["engineering@gocardless.com"]
+  spec.summary       = "Ruby client for the Creditsafe SOAP API"
+  spec.homepage      = "https://github.com/gocardless/creditsafe-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "excon", "~> 0.85"
+  spec.add_runtime_dependency "savon", "~> 2.11"
+
+  spec.add_development_dependency "compare-xml", "~> 0.66"
+  spec.add_development_dependency "gc_ruboconfig", "~> 2.28"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rspec-its", "~> 1.3"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
+  spec.add_development_dependency "rubocop", "~> 1.20"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.4"
+  spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "webmock", "~> 3.14"
+end