companies-house-rest 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbe329349686658408d7b6d6cc2ba267b6a685f01238a56d00a465853f2862b
-  data.tar.gz: 55ad4bcb56c3895963785a1bb173c7095ad5443b9819bb562280d2df67bcb68d
+  metadata.gz: 52bdd785678f5c27983569bd6392900dc4f26f939e1f228ed6c955b1146d32ff
+  data.tar.gz: ad9d77152c5c44548c2c43f5f398be1aa3fd85d3eef8947917667fd16164fc72
 SHA512:
-  metadata.gz: a5df96312aae7d77a847b33ad67b916fcfc3ef2ea67c8c333523322389adb79baed76033847c64a4aff29ab30c5b0bc1896ea8b40b6f72365c06fade8ff3ff57
-  data.tar.gz: 05ab11572766fdc6d61fa9d32ed9088297fc3dd399853343a9ad1767ede56ad94ef04f024a92269bbd3fa0641193de24bc05c5b712c02cb11ea2ad85ee292475
+  metadata.gz: b38b76b8e985cbd5dd9e2e0da8812a504d88bcb0c26a84276a923778fda5fb3cce6b2401afd49b0cfa58ab1e15d17aa82d5636362fd6e5b6ff1d1bd5fa4524b9
+  data.tar.gz: c1cf8db5f63af5ced3d1bf9809730d7a833b3453bb7f7bf7231654c00d71efda8bf1cacd1333def031b1239047eca14bbf5d553c8e35167688aedbb9f0cf9f19

data/README.md

@@ -110,6 +110,13 @@ This method implements the [searchCompanies](https://developer.companieshouse.go
 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),

data/lib/companies_house/client.rb

@@ -47,6 +47,17 @@ module CompaniesHouse
       )
     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(
+        :filing_history_item,
+        "company/#{id}/filing-history/#{transaction_id}",
+      )
+    end
+
     def company_search(query, items_per_page: nil, start_index: nil)
       request(
         :company_search,
@@ -63,6 +74,26 @@ module CompaniesHouse
       end
     end
 
+    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
+
     private
 
     # Fetch and combine all pages of a paginated API call
@@ -89,24 +120,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
@@ -82,10 +83,12 @@ module CompaniesHouse
       )
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def parse(response, resource_type, resource_id)
       case response.code
       when "200"
         JSON[response.body]
+      when "302" then { 'location': response["location"] }
       when "401"
         raise CompaniesHouse::AuthenticationError, response
       when "404"
@@ -98,5 +101,6 @@ module CompaniesHouse
         raise CompaniesHouse::APIError.new("Unknown API response", response)
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
   end
 end

data/lib/companies_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouse
-  VERSION = "0.5.0"
+  VERSION = "0.6.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: 0.6.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -155,7 +155,7 @@ homepage: https://github.com/gocardless/companies-house-rest
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Look up UK company registration information
 test_files: []