companies-house-rest 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbe329349686658408d7b6d6cc2ba267b6a685f01238a56d00a465853f2862b
-  data.tar.gz: 55ad4bcb56c3895963785a1bb173c7095ad5443b9819bb562280d2df67bcb68d
+  metadata.gz: 1eada87d8dfd0ac776c7bdfde3309c6390d68aeaf417d64e6a3c91bb9f5925ee
+  data.tar.gz: bcf2e4a7f1373445f5901442172f470bf79c07bf73e2ed9102dfbecc42dae0da
 SHA512:
-  metadata.gz: a5df96312aae7d77a847b33ad67b916fcfc3ef2ea67c8c333523322389adb79baed76033847c64a4aff29ab30c5b0bc1896ea8b40b6f72365c06fade8ff3ff57
-  data.tar.gz: 05ab11572766fdc6d61fa9d32ed9088297fc3dd399853343a9ad1767ede56ad94ef04f024a92269bbd3fa0641193de24bc05c5b712c02cb11ea2ad85ee292475
+  metadata.gz: be7c1e511e804253ca000b2f2a2850b80a891251dc83ebade648956eb7ca6e7589fa8ffb4cdaed29fc4b3bee3f8300b2afc6d829540b21980e51a3677ff472b0
+  data.tar.gz: af7dca756e367a4da419977f5f402a3ec3c5acfa5c77f26cb44eafa7c5ae90fce14d08276db66a12ab02ee48d630ae3229cb9eb0f117d40b32b350abc1a392ea

data/README.md

@@ -1,6 +1,6 @@
 # CompaniesHouse::Client
 
-[![CircleCI](https://circleci.com/gh/gocardless/companies-house-rest.svg?style=svg)](https://circleci.com/gh/gocardless/companies-house-rest)
+[![GH Actions](https://github.com/gocardless/companies-house-rest/actions/workflows/main.yml/badge.svg)](https://github.com/gocardless/companies-house-rest/actions)
 
 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.
@@ -13,6 +13,7 @@ see the gem [companies-house-gateway](https://github.com/gocardless/companies-ho
 (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)
@@ -20,8 +21,8 @@ Quick start:
 
 ``` 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:
 
@@ -31,8 +32,8 @@ 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.
 
@@ -76,6 +77,7 @@ hash are:
 | `:instrumentation` | Optional. Instruments the request/response (see Instrumentation for details) |
 
 ## Instrumentation
+
 By default, no instrumentation is being applied.
 If you are using Rails or the `ActiveSupport` gem, instrumentation will happen automatically via ![ActiveSupport::Notifications](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html)
 
@@ -93,11 +95,13 @@ The endpoints currently implemented by the gem are:
 | `.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`
@@ -106,16 +110,28 @@ key from the
 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.
 
+### .filing_history_list
+
+This method implements the [filingHistoryList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/filing-history/getFilingHistoryList.html) API and returns the full [filingHistoryList](https://developer.companieshouse.gov.uk/api/docs/company/company_number/filing-history/filingHistoryList-resource.html) resource.
+
+### .filing_history_item
+
+This method implements the [filingHistoryItem](https://developer.companieshouse.gov.uk/api/docs/company/company_number/filing-history/transaction_id/getFilingHistoryItem.html) API and returns the full
+[filingHistoryItem](https://developer.companieshouse.gov.uk/api/docs/company/company_number/filing-history/filingHistoryItem-resource.html) resource.
+
 ### 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:
@@ -125,7 +141,6 @@ returning response data. The error will have the following fields:
 | `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`:
 
@@ -151,7 +166,6 @@ To get started:
 bundle install --path vendor
 ```
 
-
 To run all tests and Rubocop:
 
 ```shell

data/companies-house-rest.gemspec

@@ -20,15 +20,16 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.5.5"
+  spec.required_ruby_version = ">= 3.0.2"
 
   spec.add_runtime_dependency "dry-struct", "~> 1"
 
   spec.add_development_dependency "activesupport", ">= 4.2", "< 7"
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.4"
+  spec.add_development_dependency "gc_ruboconfig", "~> 3.6"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
   spec.add_development_dependency "timecop", "~> 0.8"
   spec.add_development_dependency "webmock", "~> 3.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/companies_house/client.rb

@@ -24,14 +24,27 @@ module CompaniesHouse
       @read_timeout = config[:read_timeout] || 60
       @instrumentation = configure_instrumentation(config[:instrumentation])
       raise ArgumentError, "HTTP is not supported" if @endpoint.scheme != "https"
+
+      # Clear stale thread-local connection object if necessary - its lifetime should
+      # match the lifetime of the client object
+      Thread.current[:companies_house_client_connection] = nil
     end
 
     def end_connection
-      @connection.finish if @connection&.started?
+      return if Thread.current[:companies_house_client_connection].nil?
+      return unless Thread.current[:companies_house_client_connection].started?
+
+      Thread.current[:companies_house_client_connection].finish
+      Thread.current[:companies_house_client_connection] = nil
     end
 
     def company(id)
-      request(:company, "company/#{id}", {}, make_transaction_id, id)
+      request(
+        resource: :company,
+        path: "company/#{id}",
+        params: {},
+        resource_id: id,
+      )
     end
 
     def officers(id)
@@ -47,24 +60,67 @@ module CompaniesHouse
       )
     end
 
+    def persons_with_significant_control_statements(id, register_view: false)
+      get_all_pages(
+        :persons_with_significant_control_statements,
+        "company/#{id}/persons-with-significant-control-statements",
+        id,
+        register_view: register_view,
+      )
+    end
+
+    def filing_history_list(id)
+      get_all_pages(:filing_history_list, "company/#{id}/filing-history", id)
+    end
+
+    def filing_history_item(id, transaction_id)
+      request(
+        resource: :filing_history_item,
+        path: "company/#{id}/filing-history/#{transaction_id}",
+      )
+    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,
+        resource: :company_search,
+        path: "search/companies",
+        params: {
+          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
-        conn.open_timeout = @open_timeout
-        conn.read_timeout = @read_timeout
-      end
+      Thread.current[:companies_house_client_connection] ||=
+        Net::HTTP.new(endpoint.host, endpoint.port).tap do |conn|
+          conn.use_ssl = true
+          conn.open_timeout = @open_timeout
+          conn.read_timeout = @read_timeout
+        end
     end
 
     private
 
+    def request(resource:,
+                path:,
+                params: {},
+                transaction_id: make_transaction_id,
+                resource_id: nil,
+                headers: {})
+      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,
+        instrumentation: instrumentation,
+        headers: headers,
+      ).execute
+    end
+
     # Fetch and combine all pages of a paginated API call
     def get_all_pages(resource, path, id, query = {})
       items = []
@@ -72,7 +128,13 @@ module CompaniesHouse
       xid = make_transaction_id
 
       loop do
-        page = request(resource, path, query.merge(start_index: offset), xid, id)
+        page = request(
+          resource: resource,
+          path: path,
+          params: query.merge(start_index: offset),
+          transaction_id: xid,
+          resource_id: id,
+        )
         new_items = page["items"]
         total = page["total_results"] || new_items.count
 
@@ -89,24 +151,6 @@ module CompaniesHouse
       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,
-        instrumentation: instrumentation,
-      ).execute
-    end
-
     def configure_instrumentation(instrumentation)
       return instrumentation unless instrumentation.nil?
 

data/lib/companies_house/request.rb

@@ -25,6 +25,7 @@ module CompaniesHouse
     # Physical request attributes
     attribute :path, Dry.Types::String
     attribute :query, Dry.Types::Hash
+    attribute :headers, Dry.Types::Hash
 
     # Logical request attributes
     attribute :resource_type, Dry.Types::Symbol
@@ -86,6 +87,7 @@ module CompaniesHouse
       case response.code
       when "200"
         JSON[response.body]
+      when "302" then { location: response["location"] }
       when "401"
         raise CompaniesHouse::AuthenticationError, response
       when "404"

data/lib/companies_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouse
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: companies-house-rest
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -154,8 +154,9 @@ files:
 homepage: https://github.com/gocardless/companies-house-rest
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,15 +164,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.5
+      version: 3.0.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Look up UK company registration information
 test_files: []