RubyGems - companies-house-rest - Versions diffs - 0.2.1 → 0.3.0 - Mend

companies-house-rest 0.2.1 → 0.3.0

Files changed (14) hide show

checksums.yaml +4 -4
data/LICENSE +20 -20
data/README.md +154 -148
data/companies-house-rest.gemspec +34 -32
data/lib/companies_house.rb +11 -0
data/lib/companies_house/api_error.rb +18 -18
data/lib/companies_house/authentication_error.rb +10 -10
data/lib/companies_house/client.rb +90 -82
data/lib/companies_house/not_found_error.rb +14 -11
data/lib/companies_house/rate_limit_error.rb +10 -10
data/lib/companies_house/request.rb +93 -94
data/lib/companies_house/version.rb +5 -5
metadata +20 -20
data/lib/companies-house.rb +0 -11

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2f6125bb88bcc461c70066070d82ce8916a7b78
-  data.tar.gz: bc3b40e5dfcbb11c44d234fba11ff0323275d620
+  metadata.gz: 341246c80b5b92f5e8b715d582b4006b561c2477
+  data.tar.gz: 5036e6f1eb1c26203792d203f41ecdbde535be5d
 SHA512:
-  metadata.gz: 57a229e5492865f01f6c688c524379a4db4932e95fb04a7d0bab86f8c64dc73b9d4a1d4fd3bfe186e12487438cfba92fb0ad2a7a3346d0c1fd5567c8cbc02f45
-  data.tar.gz: 7277ccc6c22a96133f8c48975b9724e26ae610c3a97e79430a4335bed2772183e73f6c25a01ccc8974dcbdc127f649010837178393297f4ba45872d990a427e8
+  metadata.gz: 66d5ff4591518013685b9ab7923c8ca70f831fa1e2777bf420ccc3d9bc5e5a6484e795591c11614feef46f567da51a7db39e11f3f0b2ed28088f491ba0e7eed6
+  data.tar.gz: 80c0979bf45534fa8e46bc06d3961528ca5615a26b4ab744f03b665f51502620718c79b2715c120f26248ea27fd93b424e47cf5b8f23d6969d58d06e70cdaab2

data/LICENSE CHANGED Viewed

@@ -1,20 +1,20 @@
-Copyright (c) 2016 GOCARDLESS LTD
-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.
+Copyright (c) 2016 GOCARDLESS LTD
+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 CHANGED Viewed

@@ -1,148 +1,154 @@
-# CompaniesHouse::Client
-[![CircleCI](https://circleci.com/gh/gocardless/companies-house-rest.svg?style=svg)](https://circleci.com/gh/gocardless/companies-house-rest)
-This Gem implements an API client for the Companies House REST API. It can be
-used to look up information about companies registered in the United Kingdom.
-As of July 2016, this API is described by Companies House as a "beta service."
-More information about this free API can be found
-[on the Companies House API website](https://developer.companieshouse.gov.uk/api/docs/index.html).
-To interact the older [CompaniesHouse XML-based API](http://xmlgw.companieshouse.gov.uk/),
-see the gem [companies-house-gateway](https://github.com/gocardless/companies-house-gateway-ruby).
-(Monthly subscription [fees](http://xmlgw.companieshouse.gov.uk/CHDpriceList.shtml), and other fees, may apply.)
-Quick start:
-* Register an account via the `Sign In / Register` link
-[on the CompaniesHouse Developers website](https://developer.companieshouse.gov.uk/api/docs/)
-* Register an API key at [Your Applications](https://developer.companieshouse.gov.uk/developer/applications)
-* Put your API key in an environment variable (not in your code):
-``` shell
-export COMPANIES_HOUSE_API_KEY=YOUR_API_KEY_HERE
-```
-* Install `companies-house-rest` through [RubyGems](https://rubygems.org/gems/companies-house-rest)
-* Create and use a client:
-``` ruby
-require 'companies_house/client'
-client = CompaniesHouse::Client.new(api_key: ENV['COMPANIES_HOUSE_API_KEY'])
-profile = client.company('07495895')
-```
-## Overview
-This gem is meant to provide a simple synchronous API to look up company profile
-information and company officers. The data returned is parsed JSON.
-This gem provides information on companies by their Companies House company
-number. This "company number" is actually a string and should be treated as such.
-The string may consist solely of digits (including leading 0s) or begin with
-alphabetic characters such as `NI` or `SC`.
-## Authentication
-Using the Companies House REST API requires you to register an account
-[on the CompaniesHouse Developers website](https://developer.companieshouse.gov.uk/api/docs/)
-and [configure an API key](https://developer.companieshouse.gov.uk/developer/applications).
-Developers should read
-[the Companies House developer guidelines](https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/developerGuidelines.html)
-before using this API, and will note that these guidelines contain several
-instructions regarding API keys:
-* Do not embed API keys in your code
-* Do not store API keys in your source tree
-* Restrict API key use by IP address and domain
-* **Regenerate your API keys regularly**
-* Delete API keys when no longer required
-## Client Initialization
-All requests to the API are made through a client object:
-```ruby
-require 'companies_house/client'
-client = CompaniesHouse::Client.new(config)
-```
-The client is configured by passing a hash to the constructor. The supported keys for this
-hash are:
-| Key         | Description |
-| ----------- | ----------- |
-| `:api_key`  | Required. The API key received after registration. |
-| `:endpoint` | Optional. Specifies the base URI for the API (e.g. if using a self-hosted version) |
-## Requests
-Once a client has been initialised, requests can be made to the API.
-Details of the available fields in the response are in the Companies House
-[documentation](https://developer.companieshouse.gov.uk/api/docs/index.html).
-The endpoints currently implemented by the gem are:
-| Client Method               | Endpoint                                | Description |
-| --------------------------- | --------------------------------------- | ----------- |
-| `.company(company_number)`  | `GET /company/:company_number`          | Retrieves a company profile. |
-| `.officers(company_number)` | `GET /company/:company_number/officers` | Retrieves a list of company officers. |
-### .company
-This method implements the [readCompanyProfile](https://developer.companieshouse.gov.uk/api/docs/company/company_number/readCompanyProfile.html)
-API and returns the full [companyProfile](https://developer.companieshouse.gov.uk/api/docs/company/company_number/companyProfile-resource.html)
-resource.
-### .officers
-This method implements the [officersList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/officers/officerList.html)
-API. It will make one or more requests against this API, as necessary, to obtain
-the full list of company officers. It returns only the values under the `items`
-key from the
-[officerList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/officers/officerList-resource.html)
-resource(s) which it reads.
-### Other API Methods
-While there are other resources exposed by the
-[Companies House API](https://developer.companieshouse.gov.uk/api/docs/index.html),
-this gem does not implement access to these resources at this time.
-## Error Handling
-If a request to the Companies House API encounters an HTTP status other than
-`200 OK`, it will raise an instance of `CompaniesHouse::APIError` instead of
-returning response data. The error will have the following fields:
-| Field      | Description |
-| ---------- | ----------- |
-| `response` | The Net::HTTP response object from the failed API call. |
-| `status`   | A string containing the response status code. |
-Certain API responses will raise an instance of a more specific subclass of
-`CompaniesHouse::APIError`:
-| Status | Error                                 | Description |
-| ------ | ------------------------------------- | ----------- |
-| 401    | `CompaniesHouse::AuthenticationError` | Authentication error (invalid API key) |
-| 404    | `CompaniesHouse::NotFoundError`       | Not Found. (No record of the company is available.) |
-| 429    | `CompaniesHouse::RateLimitError`      | Application is being [rate limited](https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/rateLimiting.html) |
-The client will not catch any other errors which may occur, such as
-errors involving  network connections (e.g. `Errno::ECONNRESET`).
-## Development
-This gem is configured for development using a `bundler` workflow.
-Tests are written using RSpec, and Rubocop is used to provide linting.
-Bug reports and pull requests are welcome on this project's
-[GitHub repository](https://github.com/gocardless/companies-house-rest).
-To get started:
-``` shell
-bundle install --path vendor
-```
-To run all tests and Rubocop:
-```shell
-bundle exec rake
-```
+# CompaniesHouse::Client
+[![CircleCI](https://circleci.com/gh/gocardless/companies-house-rest.svg?style=svg)](https://circleci.com/gh/gocardless/companies-house-rest)
+This Gem implements an API client for the Companies House REST API. It can be
+used to look up information about companies registered in the United Kingdom.
+As of July 2016, this API is described by Companies House as a "beta service."
+More information about this free API can be found
+[on the Companies House API website](https://developer.companieshouse.gov.uk/api/docs/index.html).
+To interact the older [CompaniesHouse XML-based API](http://xmlgw.companieshouse.gov.uk/),
+see the gem [companies-house-gateway](https://github.com/gocardless/companies-house-gateway-ruby).
+(Monthly subscription [fees](http://xmlgw.companieshouse.gov.uk/CHDpriceList.shtml), and other fees, may apply.)
+Quick start:
+* Register an account via the `Sign In / Register` link
+[on the CompaniesHouse Developers website](https://developer.companieshouse.gov.uk/api/docs/)
+* Register an API key at [Your Applications](https://developer.companieshouse.gov.uk/developer/applications)
+* Put your API key in an environment variable (not in your code):
+``` shell
+export COMPANIES_HOUSE_API_KEY=YOUR_API_KEY_HERE
+```
+* Install `companies-house-rest` through [RubyGems](https://rubygems.org/gems/companies-house-rest)
+* Create and use a client:
+``` ruby
+require 'companies_house/client'
+client = CompaniesHouse::Client.new(api_key: ENV['COMPANIES_HOUSE_API_KEY'])
+profile = client.company('07495895')
+```
+## Overview
+This gem is meant to provide a simple synchronous API to look up company profile
+information and company officers. The data returned is parsed JSON.
+This gem provides information on companies by their Companies House company
+number. This "company number" is actually a string and should be treated as such.
+The string may consist solely of digits (including leading 0s) or begin with
+alphabetic characters such as `NI` or `SC`.
+## Authentication
+Using the Companies House REST API requires you to register an account
+[on the CompaniesHouse Developers website](https://developer.companieshouse.gov.uk/api/docs/)
+and [configure an API key](https://developer.companieshouse.gov.uk/developer/applications).
+Developers should read
+[the Companies House developer guidelines](https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/developerGuidelines.html)
+before using this API, and will note that these guidelines contain several
+instructions regarding API keys:
+* Do not embed API keys in your code
+* Do not store API keys in your source tree
+* Restrict API key use by IP address and domain
+* **Regenerate your API keys regularly**
+* Delete API keys when no longer required
+## Client Initialization
+All requests to the API are made through a client object:
+```ruby
+require 'companies_house/client'
+client = CompaniesHouse::Client.new(config)
+```
+The client is configured by passing a hash to the constructor. The supported keys for this
+hash are:
+| Key         | Description |
+| ----------- | ----------- |
+| `:api_key`  | Required. The API key received after registration. |
+| `:endpoint` | Optional. Specifies the base URI for the API (e.g. if using a self-hosted version) |
+## Requests
+Once a client has been initialised, requests can be made to the API.
+Details of the available fields in the response are in the Companies House
+[documentation](https://developer.companieshouse.gov.uk/api/docs/index.html).
+The endpoints currently implemented by the gem are:
+| Client Method                                                   | Endpoint                                | Description |
+| --------------------------------------------------------------- | --------------------------------------- | ----------- |
+| `.company(company_number)`                                      | `GET /company/:company_number`          | Retrieves a company profile. |
+| `.officers(company_number)`                                     | `GET /company/:company_number/officers` | Retrieves a list of company officers. |
+| `.company_search(query, items_per_page: nil, start_index: nil)` | `GET /search/companies`                 | Retrieves a list of companies that match the given query. |
+### .company
+This method implements the [readCompanyProfile](https://developer.companieshouse.gov.uk/api/docs/company/company_number/readCompanyProfile.html)
+API and returns the full [companyProfile](https://developer.companieshouse.gov.uk/api/docs/company/company_number/companyProfile-resource.html)
+resource.
+### .officers
+This method implements the [officersList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/officers/officerList.html)
+API. It will make one or more requests against this API, as necessary, to obtain
+the full list of company officers. It returns only the values under the `items`
+key from the
+[officerList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/officers/officerList-resource.html)
+resource(s) which it reads.
+### .company_search
+This method implements the [searchCompanies](https://developer.companieshouse.gov.uk/api/docs/search/companies/companysearch.html)
+API and returns the list of [companySearch](https://developer.companieshouse.gov.uk/api/docs/search-overview/CompanySearch-resource.html)
+resources that match the given query. The `items_per_page` and `start_index` parameters are optional.
+### Other API Methods
+While there are other resources exposed by the
+[Companies House API](https://developer.companieshouse.gov.uk/api/docs/index.html),
+this gem does not implement access to these resources at this time.
+## Error Handling
+If a request to the Companies House API encounters an HTTP status other than
+`200 OK`, it will raise an instance of `CompaniesHouse::APIError` instead of
+returning response data. The error will have the following fields:
+| Field      | Description |
+| ---------- | ----------- |
+| `response` | The Net::HTTP response object from the failed API call. |
+| `status`   | A string containing the response status code. |
+Certain API responses will raise an instance of a more specific subclass of
+`CompaniesHouse::APIError`:
+| Status | Error                                 | Description |
+| ------ | ------------------------------------- | ----------- |
+| 401    | `CompaniesHouse::AuthenticationError` | Authentication error (invalid API key) |
+| 404    | `CompaniesHouse::NotFoundError`       | Not Found. (No record of the company is available.) |
+| 429    | `CompaniesHouse::RateLimitError`      | Application is being [rate limited](https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/rateLimiting.html) |
+The client will not catch any other errors which may occur, such as
+errors involving  network connections (e.g. `Errno::ECONNRESET`).
+## Development
+This gem is configured for development using a `bundler` workflow.
+Tests are written using RSpec, and Rubocop is used to provide linting.
+Bug reports and pull requests are welcome on this project's
+[GitHub repository](https://github.com/gocardless/companies-house-rest).
+To get started:
+``` shell
+bundle install --path vendor
+```
+To run all tests and Rubocop:
+```shell
+bundle exec rake
+```

data/companies-house-rest.gemspec CHANGED Viewed

@@ -1,32 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'companies_house/version'
-Gem::Specification.new do |spec|
-  spec.name          = "companies-house-rest"
-  spec.version       = CompaniesHouse::VERSION
-  spec.authors       = ["GoCardless Engineering"]
-  spec.email         = ["developers@gocardless.com"]
-  spec.license       = "MIT"
-  spec.summary       = %q{Look up UK company registration information}
-  spec.description   = %q{Client for the Companies House REST API. Provides company profiles and officer lists.}
-  spec.homepage      = "https://github.com/gocardless/companies-house-rest"
-  spec.files         = `git ls-files -z lib/ *.gemspec LICENSE README.md`.split("\x0")
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.2'
-  spec.add_runtime_dependency "activesupport", ">= 4.2"
-  spec.add_runtime_dependency "virtus", '~> 1.0', '>= 1.0.5'
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rubocop", "~> 0.41.2"
-  spec.add_development_dependency "webmock", "~> 2.1"
-  spec.add_development_dependency 'timecop', '~> 0.8'
-end
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "companies_house/version"
+Gem::Specification.new do |spec|
+  spec.name          = "companies-house-rest"
+  spec.version       = CompaniesHouse::VERSION
+  spec.authors       = ["GoCardless Engineering"]
+  spec.email         = ["developers@gocardless.com"]
+  spec.license       = "MIT"
+  spec.summary       = "Look up UK company registration information"
+  spec.description   = "Client for the Companies House REST API. Provides company " \
+                       "profiles and officer lists."
+  spec.homepage      = "https://github.com/gocardless/companies-house-rest"
+  spec.files         = `git ls-files -z lib/ *.gemspec LICENSE README.md`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.3"
+  spec.add_runtime_dependency "activesupport", ">= 4.2"
+  spec.add_runtime_dependency "virtus", "~> 1.0", ">= 1.0.5"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "gc_ruboconfig", "~> 2.3.1"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "timecop", "~> 0.8"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/companies_house.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require "companies_house/client"
+require "companies_house/api_error"
+require "companies_house/not_found_error"
+require "companies_house/authentication_error"
+require "companies_house/rate_limit_error"
+module CompaniesHouse
+  # The module that contains all the classes implementing the API client
+end

data/lib/companies_house/api_error.rb CHANGED Viewed

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-module CompaniesHouse
-  # Represents any response from the API which is not a 200 OK
-  class APIError < StandardError
-    attr_reader :status, :response
-    def initialize(msg, response = nil)
-      if response
-        msg = "#{msg} - HTTP #{response.code}"
-        @status = response.code
-      end
-      super(msg)
-      @response = response
-    end
-  end
-end
+# frozen_string_literal: true
+module CompaniesHouse
+  # Represents any response from the API which is not a 200 OK
+  class APIError < StandardError
+    attr_reader :status, :response
+    def initialize(msg, response = nil)
+      if response
+        msg = "#{msg} - HTTP #{response.code}"
+        @status = response.code
+      end
+      super(msg)
+      @response = response
+    end
+  end
+end

data/lib/companies_house/authentication_error.rb CHANGED Viewed

@@ -1,10 +1,10 @@
-# frozen_string_literal: true
-module CompaniesHouse
-  # Specific error class for when an invalid API key is used to access the service
-  class AuthenticationError < APIError
-    def initialize(response = nil)
-      super("Invalid API key", response)
-    end
-  end
-end
+# frozen_string_literal: true
+module CompaniesHouse
+  # Specific error class for when an invalid API key is used to access the service
+  class AuthenticationError < APIError
+    def initialize(response = nil)
+      super("Invalid API key", response)
+    end
+  end
+end

data/lib/companies_house/client.rb CHANGED Viewed

@@ -1,82 +1,90 @@
-# frozen_string_literal: true
-require 'companies_house/request'
-require 'net/http'
-module CompaniesHouse
-  # This class provides an interface to the Companies House API
-  # at https://api.companieshouse.gov.uk
-  # Specifically, it manages the connections and arranges requests.
-  class Client
-    ENDPOINT = 'https://api.companieshouse.gov.uk'
-    attr_reader :api_key, :endpoint
-    def initialize(config)
-      raise ArgumentError, 'Missing API key' unless config[:api_key]
-      @api_key = config[:api_key]
-      @endpoint = URI(config[:endpoint] || ENDPOINT)
-      raise ArgumentError, 'HTTP is not supported' if @endpoint.scheme != 'https'
-    end
-    def end_connection
-      @connection.finish if @connection && @connection.started?
-    end
-    def company(id)
-      request(:company, id)
-    end
-    # The API endpoint for company officers is paginated, and not all of the officers may
-    # be returned in the first request. We deal with this by collating all the pages of
-    # results into one result set before returning them.
-    def officers(id)
-      items = []
-      offset = 0
-      xid = make_transaction_id
-      loop do
-        page = request(:officers, id, '/officers', { start_index: offset }, xid)
-        new_items = page['items']
-        total = page['total_results'] || new_items.count
-        items += new_items
-        offset += new_items.count
-        break if items.count >= total
-      end
-      items
-    end
-    def connection
-      @connection ||= Net::HTTP.new(endpoint.host, endpoint.port).tap do |conn|
-        conn.use_ssl = true
-      end
-    end
-    private
-    def make_transaction_id
-      SecureRandom.hex(10)
-    end
-    def request(resource,
-                company_id,
-                extra_path = '',
-                params = {},
-                transaction_id = make_transaction_id)
-      Request.new(
-        connection: connection,
-        api_key: @api_key,
-        endpoint: @endpoint,
-        path: "company/#{company_id}#{extra_path}",
-        query: params,
-        resource_type: resource,
-        company_id: company_id,
-        transaction_id: transaction_id
-      ).execute
-    end
-  end
-end
+# frozen_string_literal: true
+require "companies_house/request"
+require "net/http"
+module CompaniesHouse
+  # This class provides an interface to the Companies House API
+  # at https://api.companieshouse.gov.uk.
+  # Specifically, it manages the connections and arranges requests.
+  class Client
+    ENDPOINT = "https://api.companieshouse.gov.uk"
+    attr_reader :api_key, :endpoint
+    def initialize(config)
+      raise ArgumentError, "Missing API key" unless config[:api_key]
+      @api_key = config[:api_key]
+      @endpoint = URI(config[:endpoint] || ENDPOINT)
+      raise ArgumentError, "HTTP is not supported" if @endpoint.scheme != "https"
+    end
+    def end_connection
+      @connection.finish if @connection&.started?
+    end
+    def company(id)
+      request(:company, "company/#{id}", {}, make_transaction_id, id)
+    end
+    # The API endpoint for company officers is paginated, and not all of the officers may
+    # be returned in the first request. We deal with this by collating all the pages of
+    # results into one result set before returning them.
+    def officers(id)
+      items = []
+      offset = 0
+      xid = make_transaction_id
+      loop do
+        page = request(:officers, "company/#{id}/officers",
+                       { start_index: offset }, xid, id)
+        new_items = page["items"]
+        total = page["total_results"] || new_items.count
+        items += new_items
+        offset += new_items.count
+        break if items.count >= total
+      end
+      items
+    end
+    def company_search(query, items_per_page: nil, start_index: nil)
+      request(
+        :company_search,
+        "search/companies",
+        { q: query, items_per_page: items_per_page, start_index: start_index }.compact,
+      )
+    end
+    def connection
+      @connection ||= Net::HTTP.new(endpoint.host, endpoint.port).tap do |conn|
+        conn.use_ssl = true
+      end
+    end
+    private
+    def make_transaction_id
+      SecureRandom.hex(10)
+    end
+    def request(resource,
+                path,
+                params = {},
+                transaction_id = make_transaction_id,
+                resource_id = nil)
+      Request.new(
+        connection: connection,
+        api_key: @api_key,
+        endpoint: @endpoint,
+        path: path,
+        query: params,
+        resource_type: resource,
+        resource_id: resource_id,
+        transaction_id: transaction_id,
+      ).execute
+    end
+  end
+end

data/lib/companies_house/not_found_error.rb CHANGED Viewed

@@ -1,11 +1,14 @@
-# frozen_string_literal: true
-module CompaniesHouse
-  # Specific error class for when a company cannot be found (for example, if the company
-  # number given is invaid)
-  class NotFoundError < APIError
-    def initialize(company_id = nil, response = nil)
-      super("Company #{company_id || 'nil'} not found", response)
-    end
-  end
-end
+# frozen_string_literal: true
+module CompaniesHouse
+  # Specific error class for when a company cannot be found (for example, if the company
+  # number given is invaid)
+  class NotFoundError < APIError
+    def initialize(resource_type, resource_id = nil, response = nil)
+      super(
+        "Resource not found - type `#{resource_type}`, id `#{resource_id || 'nil'}`",
+        response,
+      )
+    end
+  end
+end

data/lib/companies_house/rate_limit_error.rb CHANGED Viewed

@@ -1,10 +1,10 @@
-# frozen_string_literal: true
-module CompaniesHouse
-  # Specific error class for when an invalid API key is used to access the service
-  class RateLimitError < APIError
-    def initialize(response = nil)
-      super("Rate limit exceeded", response)
-    end
-  end
-end
+# frozen_string_literal: true
+module CompaniesHouse
+  # Specific error class for when an invalid API key is used to access the service
+  class RateLimitError < APIError
+    def initialize(response = nil)
+      super("Rate limit exceeded", response)
+    end
+  end
+end

data/lib/companies_house/request.rb CHANGED Viewed

@@ -1,94 +1,93 @@
-# frozen_string_literal: true
-require 'companies_house/api_error'
-require 'companies_house/not_found_error'
-require 'companies_house/authentication_error'
-require 'companies_house/rate_limit_error'
-require 'virtus'
-require 'uri'
-require 'json'
-require 'active_support/notifications'
-module CompaniesHouse
-  # This class manages individual requests.
-  # Users of the CompaniesHouse gem should not instantiate this class
-  # and should instead use CompaniesHouse::Client.
-  class Request
-    include Virtus.model
-    # API-level attributes
-    attribute :connection, Net::HTTP, required: true
-    attribute :api_key, String, required: true
-    attribute :endpoint, URI, required: true
-    # Physical request attributes
-    attribute :path, String, required: true
-    attribute :query, Hash, required: true
-    # Logical request attributes
-    attribute :resource_type, Symbol, required: true
-    attribute :company_id, String, required: true
-    attribute :transaction_id, String, required: true
-    def initialize(args)
-      super(args)
-      @uri = URI.join(endpoint, path)
-      @uri.query = URI.encode_www_form(query)
-      @notification_payload = {
-        method: :get,
-        path: path,
-        query: query
-      }
-    end
-    def execute
-      @started = Time.now.utc
-      req = Net::HTTP::Get.new(@uri)
-      req.basic_auth @api_key, ''
-      response = connection.request req
-      @notification_payload[:status] = response.code
-      begin
-        response_body = @notification_payload[:response] = parse(response, company_id)
-      rescue => e
-        @notification_payload[:error] = e
-        raise e
-      ensure
-        publish_notification
-      end
-      response_body
-    end
-    private
-    def publish_notification
-      ActiveSupport::Notifications.publish(
-        "companies_house.#{resource_type}",
-        @started, Time.now.utc,
-        transaction_id,
-        @notification_payload
-      )
-    end
-    def parse(response, company_id)
-      case response.code
-      when '200'
-        return JSON[response.body]
-      when '401'
-        raise CompaniesHouse::AuthenticationError, response
-      when '404'
-        raise CompaniesHouse::NotFoundError.new(company_id, response)
-      when '429'
-        raise CompaniesHouse::RateLimitError, response
-      else
-        raise CompaniesHouse::APIError.new("Unknown API response", response)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require "companies_house/api_error"
+require "companies_house/not_found_error"
+require "companies_house/authentication_error"
+require "companies_house/rate_limit_error"
+require "virtus"
+require "uri"
+require "json"
+require "active_support/notifications"
+module CompaniesHouse
+  # This class manages individual requests.
+  # Users of the CompaniesHouse gem should not instantiate this class
+  # and should instead use CompaniesHouse::Client.
+  class Request
+    include Virtus.model
+    # API-level attributes
+    attribute :connection, Net::HTTP, required: true
+    attribute :api_key, String, required: true
+    attribute :endpoint, URI, required: true
+    # Physical request attributes
+    attribute :path, String, required: true
+    attribute :query, Hash, required: true
+    # Logical request attributes
+    attribute :resource_type, Symbol, required: true
+    attribute :resource_id, String
+    attribute :transaction_id, String, required: true
+    def initialize(args)
+      super(args)
+      @uri = URI.join(endpoint, path)
+      @uri.query = URI.encode_www_form(query)
+      @notification_payload = {
+        method: :get,
+        path: path,
+        query: query,
+      }
+    end
+    def execute
+      @started = Time.now.utc
+      req = Net::HTTP::Get.new(@uri)
+      req.basic_auth @api_key, ""
+      response = connection.request req
+      @notification_payload[:status] = response.code
+      begin
+        @notification_payload[:response] = parse(response, resource_type, resource_id)
+      rescue StandardError => e
+        @notification_payload[:error] = e
+        raise e
+      ensure
+        publish_notification
+      end
+    end
+    private
+    def publish_notification
+      ActiveSupport::Notifications.publish(
+        "companies_house.#{resource_type}",
+        @started, Time.now.utc,
+        transaction_id,
+        @notification_payload
+      )
+    end
+    def parse(response, resource_type, resource_id)
+      case response.code
+      when "200"
+        JSON[response.body]
+      when "401"
+        raise CompaniesHouse::AuthenticationError, response
+      when "404"
+        raise CompaniesHouse::NotFoundError.new(resource_type, resource_id, response)
+      when "429"
+        raise CompaniesHouse::RateLimitError, response
+      else
+        raise CompaniesHouse::APIError.new("Unknown API response", response)
+      end
+    end
+  end
+end

data/lib/companies_house/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-module CompaniesHouse
-  VERSION = '0.2.1'
-end
+# frozen_string_literal: true
+module CompaniesHouse
+  VERSION = "0.3.0"
+end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: companies-house-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,75 +59,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 description: Client for the Companies House REST API. Provides company profiles and
   officer lists.
 email:
@@ -139,7 +139,7 @@ files:
 - LICENSE
 - README.md
 - companies-house-rest.gemspec
-- lib/companies-house.rb
+- lib/companies_house.rb
 - lib/companies_house/api_error.rb
 - lib/companies_house/authentication_error.rb
 - lib/companies_house/client.rb
@@ -159,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Look up UK company registration information

data/lib/companies-house.rb DELETED Viewed

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-require 'companies_house/client'
-require 'companies_house/api_error'
-require 'companies_house/not_found_error'
-require 'companies_house/authentication_error'
-require 'companies_house/rate_limit_error'
-module CompaniesHouse
-  # The module that contains all the classes implementing the API client
-end