companies_house_hub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aadf54f56b2835030fcdf7fa69a8764312983f172868c35d17061990a167a803
+  data.tar.gz: 860478b4aef85b6eb82f0ed78da92bbc453100b76ba736d275d8b483bbb6f21c
+SHA512:
+  metadata.gz: cc2b31ee2aacfd3491722f4015b73c110fc997cf784bb5b125546aaa3a068df0809e0a52d59b84984a016e3f3df4a0cce71242a9bbd6a77724633d53251d53d8
+  data.tar.gz: a0a011b2cb750951bdbaa2efe032bbcaf139125baf8b392341173a78f535dca3ea4a3382e4523bd46e0f42658244b5a927dc24d8d03805e90362ea2fa5abac11

data/.env

@@ -0,0 +1 @@
+API_KEY=u4SHQUdhKHqY85Vq79M0zHXsXiwraX92WzOiuHpq

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Metrics/AbcSize:
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/BlockLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 70

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in companies_house_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+# CompaniesHouseHub
+A wrapper around the [Companies House Rest API](https://developer.companieshouse.gov.uk/api/docs/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'companies_house_hub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install companies_house_hub
+
+## Setup
+
+Set up CompaniesHouseHub in a block:
+
+```ruby
+CompaniesHouseHub.configure do |config|
+  config.api_token = <YOUR_TOKEN>
+end
+```
+
+## Usage
+
+Search for company by name:
+
+```ruby
+CompaniesHouseHub::Company.search('NAME')
+```
+
+Find company by company number:
+
+```ruby
+CompaniesHouseHub::Company.find('08846630')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rikas/companies_house_hub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+require 'companies_house_hub'
+require 'dotenv'
+
+Dotenv.load
+
+CompaniesHouseHub.configure do |config|
+  config.api_key = ENV['API_KEY']
+end
+
+# Allow direct access to CompaniesHouseHub classes
+include CompaniesHouseHub
+
+require 'pry'
+Pry.start

data/companies_house_hub.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'companies_house_hub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'companies_house_hub'
+  spec.version       = CompaniesHouseHub::VERSION
+  spec.authors       = ['Ricardo Otero']
+  spec.email         = ['oterosantos@gmail.com']
+  spec.summary       = 'A REST client for the UK Companies House API'
+  spec.description   = 'A REST client for the UK Companies House API, including authentication'
+  spec.homepage      = 'https://github.com/rikas/companies_house_hub'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  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 'rubocop', '~> 0.54.0'
+end

data/lib/companies_house_hub/base_model.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CompaniesHouseHub
+  class BaseModel
+    def self.get(path, params)
+      CompaniesHouseHub.connection.get(path, params)
+    end
+
+    def get(path, params)
+      self.class.get(path, params)
+    end
+
+    def self.format_url(url, params)
+      formatted = url.dup
+
+      params.each { |key, value| formatted.sub!(":#{key}", value) }
+
+      formatted
+    end
+
+    def format_url(url, params)
+      self.class.format_url(url, params)
+    end
+  end
+end

data/lib/companies_house_hub/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CompaniesHouseHub
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = ''
+    end
+  end
+end

data/lib/companies_house_hub/models/address.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'companies_house_hub/base_model'
+
+module CompaniesHouseHub
+  class Address < BaseModel
+    attr_reader :address_line_1, :address_line_2, :postal_code, :locality, :country
+
+    def initialize(json = {})
+      @address_line1 = json.fetch(:address_line_1)
+      @address_line2 = json.fetch(:address_line_2)
+      @country = json.fetch(:country)
+      @postal_code = json.fetch(:postal_code)
+      @locality = json.fetch(:locality)
+    end
+
+    def full
+      [@address_line1, @address_line2, @locality, @postal_code].compact.join(', ')
+    end
+  end
+end

data/lib/companies_house_hub/models/company.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'companies_house_hub/base_model'
+require 'companies_house_hub/models/address'
+require 'companies_house_hub/models/filing_history'
+
+module CompaniesHouseHub
+  class Company < BaseModel
+    SEARCH_PATH = '/search'
+    FIND_PATH = '/company/:company_number'
+
+    attr_reader :number, :name, :created_at, :address
+
+    def self.search(name, per_page:, start:)
+      options = { q: name, items_per_page: per_page, start_index: start }
+
+      result = get(SEARCH_PATH, options)
+
+      result.body.each { |company_json| new(company_json) }
+    end
+
+    def self.find(company_number, params = {})
+      url = format_url(FIND_PATH, company_number: company_number.to_s)
+
+      result = get(url, params)
+
+      new(result.body)
+    end
+
+    def initialize(json = {})
+      @number = json.fetch(:company_number)
+      @has_been_liquidated = json.fetch(:has_been_liquidated)
+      @jurisdiction = json.fetch(:jurisdiction)
+      @name = json.fetch(:company_name)
+      @created_at = json.fetch(:date_of_creation)
+      @address = Address.new(json.fetch(:registered_office_address))
+      @status = json.fetch(:company_status)
+    end
+
+    def filing_histories
+      FilingHistory.all(company_number: @number)
+    end
+
+    def full_address
+      @address.full
+    end
+
+    def active?
+      @status == 'active'
+    end
+  end
+end

data/lib/companies_house_hub/models/filing_history.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CompaniesHouseHub
+  class FilingHistory < BaseModel
+    DOCUMENT_URL = 'https://beta.companieshouse.gov.uk'
+    FIND_PATH = '/company/:company_number/filing-history'
+    DEFAULT_PER_PAGE = 100
+
+    attr_reader :description, :action_date, :date, :type, :barcode, :links
+
+    def self.all(options = {})
+      options[:items_per_page] ||= DEFAULT_PER_PAGE
+
+      number = options.delete(:company_number)
+
+      result = get(format_url(FIND_PATH, company_number: number), options)
+
+      result.body[:items].map { |filing_json| new(filing_json) }
+    end
+
+    def initialize(json = {})
+      @description = json.dig(:description)
+      @action_date = json.dig(:action_date)
+      @date = json.dig(:date)
+      @type = json.dig(:type)
+      @barcode = json.dig(:barcode)
+      @links = json.dig(:links)
+    end
+
+    def url(format = 'pdf')
+      file_path = @links[:self]
+
+      document_path = "#{file_path}/document?format=#{format}"
+
+      URI.join(DOCUMENT_URL, document_path).to_s
+    end
+  end
+end

data/lib/companies_house_hub/version.rb

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

data/lib/companies_house_hub.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'companies_house_hub/configuration'
+require 'companies_house_hub/base_model'
+
+require 'companies_house_hub/models/company'
+
+module CompaniesHouseHub
+  API_URL = 'https://api.companieshouse.gov.uk'
+
+  module_function
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def connection
+    @connection ||= Faraday.new(url: API_URL) do |conn|
+      conn.basic_auth(configuration.api_key, '')
+      conn.use FaradayMiddleware::ParseJson
+      conn.response :json, parser_options: { symbolize_names: true }
+      conn.response :logger
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  def configure
+    yield configuration
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: companies_house_hub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Otero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+description: A REST client for the UK Companies House API, including authentication
+email:
+- oterosantos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- companies_house_hub.gemspec
+- lib/companies_house_hub.rb
+- lib/companies_house_hub/base_model.rb
+- lib/companies_house_hub/configuration.rb
+- 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/version.rb
+homepage: https://github.com/rikas/companies_house_hub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A REST client for the UK Companies House API
+test_files: []