companies-house-rest 0.4.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 697c77825563338b4cad1b54eb4f359fe248d877b8067adbbf6f85e8d43da776
-  data.tar.gz: 5ac0d3a4ba4003c3db8bea57765136e9356a40a5ee9cfe453b558ccc3358963a
+  metadata.gz: 52bdd785678f5c27983569bd6392900dc4f26f939e1f228ed6c955b1146d32ff
+  data.tar.gz: ad9d77152c5c44548c2c43f5f398be1aa3fd85d3eef8947917667fd16164fc72
 SHA512:
-  metadata.gz: 29473c610f9dd6f2274d2d63eb0b773e7ad03ef4d1a1cfb90ef129d2ec9f63f787eec9e063de3e3060adea0dfda192cba3df8ae8105f03fb9b7c7dd38f912373
-  data.tar.gz: b0b1978ee8f169d18f1ac8d12b7bcc075744b55e0330d8fb21c690408c7b2cabb16cc13666877b881e7630c397b6c0a891c2c3a08bd7af8a6d4d86a0605cc5a2
+  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/companies-house-rest.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.5.5"
 
-  spec.add_runtime_dependency "activesupport", ">= 4.2", "< 6"
-  spec.add_runtime_dependency "virtus", "~> 1.0", ">= 1.0.5"
+  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 "rake", "~> 12.0"
+  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"

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/instrumentation/active_support.rb

@@ -3,7 +3,7 @@
 module Instrumentation
   class ActiveSupport
     def self.publish(*args)
-      ::ActiveSupport::Notifications.publish(**args)
+      ::ActiveSupport::Notifications.publish(*args)
     end
   end
 end

data/lib/companies_house/request.rb

@@ -7,31 +7,32 @@ require "companies_house/rate_limit_error"
 require "companies_house/timeout_error"
 require "companies_house/bad_gateway_error"
 
-require "virtus"
+require "net/http"
 require "uri"
 require "json"
+require "dry-struct"
 
 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
+  class Request < Dry::Struct
     # API-level attributes
-    attribute :connection, Net::HTTP, required: true
-    attribute :api_key, String, required: true
-    attribute :endpoint, URI, required: true
+    attribute :connection, Dry.Types.Instance(Net::HTTP)
+    attribute :api_key, Dry.Types::String
+    attribute :endpoint, Dry.Types.Instance(URI)
 
     # Physical request attributes
-    attribute :path, String, required: true
-    attribute :query, Hash, required: true
+    attribute :path, Dry.Types::String
+    attribute :query, Dry.Types::Hash
+    attribute :headers, Dry.Types::Hash
 
     # Logical request attributes
-    attribute :resource_type, Symbol, required: true
-    attribute :resource_id, String
+    attribute :resource_type, Dry.Types::Symbol
+    attribute :resource_id, Dry.Types.Nominal(Integer)
 
-    attribute :transaction_id, String, required: true
-    attribute :instrumentation
+    attribute :transaction_id, Dry.Types::String
+    attribute :instrumentation, Dry.Types.Interface(:publish)
 
     def initialize(args)
       super(args)
@@ -48,11 +49,7 @@ module CompaniesHouse
 
     def execute
       @started = Time.now.utc
-
-      req = Net::HTTP::Get.new(@uri)
-      req.basic_auth @api_key, ""
-
-      response = connection.request req
+      response = request_resource(@uri)
       @notification_payload[:status] = response.code
 
       begin
@@ -69,6 +66,13 @@ module CompaniesHouse
 
     private
 
+    def request_resource(uri)
+      req = Net::HTTP::Get.new(uri)
+      req.basic_auth api_key, ""
+
+      connection.request req
+    end
+
     def publish_notification
       instrumentation.publish(
         "companies_house.#{resource_type}",
@@ -79,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"
@@ -95,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.4.5"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,55 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: companies-house-rest
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.6.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: virtus
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
-  type: :runtime
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -161,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
@@ -176,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Look up UK company registration information
 test_files: []