companies_house_hub 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c5ac91a16eae0a80a8197622ed6280bb6ee4918015e9dc34ae77523f408725b
-  data.tar.gz: 45348b4b15c96ab7c51f6d74641fd376f4bfaf69db4afaccb7c464da08ee84c3
+  metadata.gz: d0674550a52a10c0f5cc3213fc68b1f2de77eb0c855c4dd461e4cb2ee5abaa90
+  data.tar.gz: f10d683fde4a56667b020fe5eab40174d4eea7caccb609efe71d1c781b4cd648
 SHA512:
-  metadata.gz: 107dd08400be3d337732c5525673087dec42ef7c74a1b5547e300f91d8c5791989fbf198d11b9714064a8db47625c82a2a82c9107ac4751a821fe9dbdee3653d
-  data.tar.gz: 28d07c7ff36a4f945f9df6c0009d5e0b378ae27eefcf4a479c21f258a76fdaeb65ae43eed8243ca45804fe6fffe9fedf607505b1a73bc549305f09e183f71504
+  metadata.gz: c701167997705f15cfa20dd41110011aa17a8cc780e72b83d26127160e3d08a5d0484efb651f6c69b4416b2a3d2eadd3377a81691716a58d7efdc0d807ebc139
+  data.tar.gz: af55ae20564e2abc7f2337fab7e7c83410f26fc49264be4e00298f15306771d68bd3aa6095cae27084a415bcc685e02ed3eb7c9b1e21d55f4d0721eb80103f5b

data/.rubocop.yml

@@ -1,15 +1,9 @@
 require: rubocop-rspec
 
-Metrics/AbcSize:
-  Max: 30
-
 Style/Documentation:
   Enabled: false
 
-Style/MixinUsage:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Metrics/MethodLength:
@@ -31,9 +25,5 @@ Lint/UselessAssignment:
 RSpec/ExampleLength:
   Max: 100
 
-# To be compatible with older versions of ruby
-Performance/RegexpMatch:
-  Enabled: false
-
 RSpec/MultipleExpectations:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.6.5

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

@@ -17,7 +17,7 @@ CompaniesHouseHub.configure do |config|
 end
 
 # Allow direct access to CompaniesHouseHub classes
-include CompaniesHouseHub
+send(:include, CompaniesHouseHub)
 
 require 'pry'
 Pry.start

data/companies_house_hub.gemspec

@@ -27,12 +27,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_middleware'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  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', '~> 0.54.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'

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,13 +56,18 @@ module CompaniesHouseHub
       @status = json.dig(:company_status)
       @type = json.dig(:type) || json.dig(:company_type)
       @accounts = json.dig(:accounts)
-      @full_address = json.dig(:address_snippet) || @address.full
+      @confirmation_statement = json.dig(:confirmation_statement)
+      @full_address = json.fetch(:address_snippet, @address.full)
     end
 
     def filing_histories
       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

@@ -16,9 +16,9 @@ module CompaniesHouseHub
     def self.all(options = {})
       options[:items_per_page] ||= DEFAULT_PER_PAGE
 
-      number = options.delete(:company_number)
+      company_number = options.delete(:company_number)
 
-      result = get(format_url(FIND_PATH, company_number: number), options)
+      result = get(format_url(FIND_PATH, company_number: company_number), options)
 
       return [] unless result.body[:items].any?
 
@@ -27,13 +27,13 @@ module CompaniesHouseHub
       filing_histories = result.body[:items].map do |filing_json|
         next if filing_json.dig(:description) == LEGACY_DOC_DESCRIPTION
 
-        new(filing_json)
+        new(filing_json, company_number)
       end
 
       filing_histories.compact
     end
 
-    def initialize(json = {})
+    def initialize(json = {}, company_number = nil)
       @description = json.dig(:description)
       @action_date = json.dig(:action_date)
       @date = json.dig(:date)
@@ -42,6 +42,7 @@ module CompaniesHouseHub
       @transaction_id = json.dig(:transaction_id) # helps on barcode generation
       @barcode = json.dig(:barcode) || generate_barcode
       @description_values = json.dig(:description_values)
+      @company_number = company_number
     end
 
     def formatted_name
@@ -49,7 +50,11 @@ module CompaniesHouseHub
     end
 
     def url(format = 'pdf')
-      file_path = @links[:self]
+      return unless @links[:document_metadata]
+
+      file_path = @links[:self] || build_file_path
+
+      return unless file_path
 
       document_path = "#{file_path}/document?format=#{format}"
 
@@ -66,5 +71,11 @@ module CompaniesHouseHub
 
       Digest::SHA1.hexdigest(string)[0..6].upcase
     end
+
+    def build_file_path
+      required = [@company_number, @transaction_id].all? { |val| val && !val.empty? }
+
+      "/company/#{@company_number}/filing-history/#{@transaction_id}" if required
+    end
   end
 end

data/lib/companies_house_hub/models/person.rb

@@ -0,0 +1,36 @@
+# 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)
+
+      return [] unless result.body[:items].any?
+
+      result.body[:items].map do |person_json|
+        new(person_json)
+      end
+    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.3'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: companies_house_hub
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -112,16 +112,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-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:
@@ -223,8 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A REST client for the UK Companies House API