companies_house_hub 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ae5b2dfde24b07b5e99ce919e39d6685655e83bbf1addf94c4834eafd5e735
-  data.tar.gz: 823ca7613fee36bb79ce3c22ddab39631fda621e4b3a7aa0400f103b25689d21
+  metadata.gz: 29c2c6ef2a7320dce0f29392bc87d82a6458c67eeb8637ecc4e3abf3b493e223
+  data.tar.gz: 961885964947c2a58fc6ed08342af17cd0c113873f2484b4150580496573c71e
 SHA512:
-  metadata.gz: f92b9a1ed0c4aaf8fe7644049e0000f7f6fffed8edcff522a7671203c85a3a02522e9b770aaff16befbacd05cccf021f0ef6f93633232d8f9d13423bad6cb7a8
-  data.tar.gz: 88e8ae8c30f849b8eaebda00fac7d389fe4cb99ed96b0424c0afbcad08aa6946c91bce7d0e68431395aadcb00ed92141c570d689e3e8f2fffbaa7cbd3dd414c8
+  metadata.gz: d319f8a46e9d1187a34b5f69b04098b6de552013a549501598018f060f970faa10fd6cbc0098ec161f43cebe25f45e4bf7de099df75371b890b1f1b98ad6d98e
+  data.tar.gz: bee69f4ce39a230a3a66399cbd4ef53787ebe2d77c1b0823d6d1c2e51c002f0e553b2471497f25dce7cce3ab11398c18524cbe7f8b6999ddb55667c35e363d66

data/.rubocop.yml

@@ -3,10 +3,7 @@ require: rubocop-rspec
 Style/Documentation:
   Enabled: false
 
-Style/MixinUsage:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Metrics/MethodLength:

data/README.md

@@ -23,7 +23,7 @@ Set up CompaniesHouseHub in a block:
 
 ```ruby
 CompaniesHouseHub.configure do |config|
-  config.api_token = <YOUR_TOKEN>
+  config.api_key = <YOUR_TOKEN>
 end
 ```
 

data/bin/console

@@ -14,10 +14,11 @@ Dotenv.load
 
 CompaniesHouseHub.configure do |config|
   config.api_key = ENV['API_KEY']
+  config.debug = true
 end
 
 # Allow direct access to CompaniesHouseHub classes
-include CompaniesHouseHub
+send(:include, CompaniesHouseHub)
 
 require 'pry'
 Pry.start

data/companies_house_hub.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'dotenv', '~> 2.4.0'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'

data/lib/companies_house_hub/models/address.rb

@@ -4,7 +4,11 @@ require 'companies_house_hub/base_model'
 
 module CompaniesHouseHub
   class Address < BaseModel
-    attr_reader :address_line1, :address_line2, :postal_code, :locality, :country
+    attr_reader :address_line1, :address_line2, :postal_code, :locality, :country, :care_of
+    attr_reader :premises
+
+    alias line1 address_line1
+    alias line2 address_line2
 
     def initialize(json = {})
       @address_line1 = json.dig(:address_line_1)
@@ -12,6 +16,8 @@ module CompaniesHouseHub
       @country = json.dig(:country)
       @postal_code = json.dig(:postal_code)
       @locality = json.dig(:locality)
+      @care_of = json.dig(:care_of)
+      @premises = json.dig(:premises)
     end
 
     def full

data/lib/companies_house_hub/models/company.rb

@@ -3,6 +3,7 @@
 require 'companies_house_hub/base_model'
 require 'companies_house_hub/models/address'
 require 'companies_house_hub/models/filing_history'
+require 'companies_house_hub/models/person'
 
 module CompaniesHouseHub
   class Company < BaseModel
@@ -10,7 +11,7 @@ module CompaniesHouseHub
     FIND_PATH = '/company/:company_number'
 
     attr_reader :number, :name, :created_at, :address, :type, :jurisdiction, :has_been_liquidated
-    attr_reader :status, :accounts, :full_address
+    attr_reader :status, :accounts, :confirmation_statement, :full_address, :raw_json
 
     alias company_number number
     alias company_name name
@@ -45,6 +46,7 @@ module CompaniesHouseHub
     end
 
     def initialize(json = {})
+      @raw_json = json
       @number = json.dig(:company_number)
       @has_been_liquidated = json.dig(:has_been_liquidated)
       @jurisdiction = json.dig(:jurisdiction)
@@ -54,6 +56,7 @@ module CompaniesHouseHub
       @status = json.dig(:company_status)
       @type = json.dig(:type) || json.dig(:company_type)
       @accounts = json.dig(:accounts)
+      @confirmation_statement = json.dig(:confirmation_statement)
       @full_address = json.fetch(:address_snippet, @address.full)
     end
 
@@ -61,6 +64,10 @@ module CompaniesHouseHub
       FilingHistory.all(company_number: @number)
     end
 
+    def persons
+      Person.all(company_number: @number)
+    end
+
     def active?
       @status == 'active'
     end

data/lib/companies_house_hub/models/filing_history.rb

@@ -20,11 +20,13 @@ module CompaniesHouseHub
 
       result = get(format_url(FIND_PATH, company_number: company_number), options)
 
-      return [] unless result.body[:items].any?
+      items = result.body.dig(:items) || []
+
+      return [] unless items.any?
 
       # Get all items and create a new history. If the description is 'legacy' then we can safely
       # ignore that document.
-      filing_histories = result.body[:items].map do |filing_json|
+      filing_histories = items.map do |filing_json|
         next if filing_json.dig(:description) == LEGACY_DOC_DESCRIPTION
 
         new(filing_json, company_number)
@@ -50,6 +52,8 @@ module CompaniesHouseHub
     end
 
     def url(format = 'pdf')
+      return unless @links[:document_metadata]
+
       file_path = @links[:self] || build_file_path
 
       return unless file_path

data/lib/companies_house_hub/models/person.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CompaniesHouseHub
+  class Person < BaseModel
+    FIND_PATH = "/company/:company_number/persons-with-significant-control"
+    DEFAULT_PER_PAGE = 90
+
+    attr_reader :name, :nationality, :kind, :country_of_residence, :forename, :middle_name, :title
+    attr_reader :surname, :address, :raw_json
+
+    def self.all(options = {})
+      options[:items_per_page] ||= DEFAULT_PER_PAGE
+
+      company_number = options.delete(:company_number)
+
+      result = get(format_url(FIND_PATH, company_number: company_number), options)
+
+      # For some companies, for some reason, this endpoint returns an error, like this:
+      # {
+      #   "errors": [
+      #     {
+      #       "error": "company-psc-not-found",
+      #       "type": "ch:service"
+      #     }
+      #   ]
+      # }
+      items = result.body.dig(:items) || []
+
+      return [] unless items.any?
+
+      items.map { |person_json| new(person_json) }
+    end
+
+    def initialize(json = {})
+      @raw_json = json
+      @name = json.dig(:name)
+      @nationality = json.dig(:nationality)
+      @address = Address.new(json.dig(:address))
+      @forename = json.dig(:name_elements, :forename)
+      @middle_name = json.dig(:name_elements, :middle_name)
+      @title = json.dig(:name_elements, :title)
+      @surname = json.dig(:name_elements, :surname)
+    end
+  end
+end

data/lib/companies_house_hub/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouseHub
-  VERSION = '0.1.4'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: companies_house_hub
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,16 +84,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/companies_house_hub/models/address.rb
 - lib/companies_house_hub/models/company.rb
 - lib/companies_house_hub/models/filing_history.rb
+- lib/companies_house_hub/models/person.rb
 - lib/companies_house_hub/version.rb
 homepage: https://github.com/rikas/companies_house_hub
 licenses: