companies_house_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50896e2d1da28f734cbd6c8a6cbae9859ab196db
+  data.tar.gz: b8f80f042bf138cdc979bef786fff4b10d1f7352
+SHA512:
+  metadata.gz: 92d4f8a1d54a754e296d156891a5048c386ee3236687b59273b6f223635de0164e4227c876a8579bdd0540426eedc3f9d2133a938b5225bd08d6ba39d56b6b49
+  data.tar.gz: 303c9aa305fd9bdd6d8092cf717a686882e9534353fd242a2497ea9e098221c0c581b29a1ba6477dc96a835569a178d095511b56b92866120b1efc1a20d43641

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/.ruby-gemset

@@ -0,0 +1 @@
+companies_house_client

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Error Ltd.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# CompaniesHouseClient
+A wrapper around the [Companies House Rest API](https://developer.companieshouse.gov.uk/api/docs/).
+
+There is another gem which does this, [open-companies-house](https://github.com/tomblomfield/open-companies-house) but it doesn't include authentication.
+
+## Installation
+
+Install with [Bundler](http://bundler.io) like this:
+
+```
+gem 'companies_house_client'
+```
+
+Or manually:
+
+```
+gem install companies_house_client
+```
+
+## Setup
+
+Set up CompaniesHouseClient in a block:
+
+```
+CompaniesHouseClient.configure do |config|
+    config.api_token #your token from https://developer.companieshouse.gov.uk/developer/applications
+    config.ssl_settings #this gem uses Faraday; you need to point it at the appropriate CA bundle for your platform
+end
+
+```
+
+### SSL Setup
+SSL is a bit of a faff, because you need a [CA bundle for Faraday](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates).
+ 
+The configuration setting `ssl_settings` is a hash. You need to pass `ca_path` into it, with the appropriate location for your bundle.
+
+## Use
+
+### Getting a company by Company Number
+Note that the leading zero in a company number is important so you have to pass `find()` a string.
+```
+c = CompaniesHouseClient::Company.find("company number")
+c #returns a company.
+```
+
+### Searching for a company by name
+You can search for a company like this:
+
+```
+companies = CompaniesHouseClient::Company.search("your search", per_page: 10, page: 2)
+companies #returns a collection of Companies which match your search.
+```
+
+`per_page` and `page` are optional.
+
+### Company Officers
+Companies have many officers. You can retrieve them like this:
+
+```
+c = CompaniesHouseClient::Company.find("company number")
+c.officers #returns a collection of Officer objects.
+```
+
+
+## To do
+
+* We should be able to get a history of accounts.
+
+# Licence
+This gem is MIT licenced. Have fun!

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/companies_house_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'companies_house_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "companies_house_client"
+  spec.version       = CompaniesHouseClient::VERSION
+  spec.authors       = ["Ed Jones"]
+  spec.email         = ["ed@errorstudio.co.uk"]
+  spec.summary       = %q{A REST client for the UK Companies House API}
+  spec.description   = %q{A REST client for the UK Companies House API, including authentication}
+  spec.homepage      = "https://github.com/errorstudio/companies_house_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "require_all"
+  spec.add_dependency "her"
+
+end

data/lib/companies_house_client.rb

@@ -0,0 +1,53 @@
+require 'require_all'
+require 'her'
+require_rel "."
+
+
+module CompaniesHouseClient
+  API_URL = "https://api.companieshouse.gov.uk"
+  class << self
+
+    #access the configuration class
+    attr_accessor :configuration
+
+    #block for configuration.
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.configuration.configure_connection
+    end
+  end
+
+  class Configuration
+    attr_accessor :api_key, :url, :ssl_options, :proxy
+    attr_reader :connection
+
+    def initialize
+      @connection ||= Her::API.new
+      @api_key = ""
+      @url = CompaniesHouseClient::API_URL
+      @ssl_options = {
+        ca_path: CompaniesHouseClient::CAPath.platform_path
+      }
+      @proxy
+    end
+
+    def configure_connection
+
+      @connection.setup url: @url, ssl: @ssl_options, proxy: @proxy do |c|
+
+        #Auth
+        c.use Faraday::Request::BasicAuthentication, @api_key, ''
+
+        # Request
+        c.use Faraday::Request::UrlEncoded
+
+        # Parse collections
+        c.use CompaniesHouseClient::CollectionParser
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/companies_house_client/base.rb

@@ -0,0 +1,6 @@
+module CompaniesHouseClient
+  class Base
+    include Her::Model
+    use_api -> {CompaniesHouseClient.configuration.connection}
+  end
+end

data/lib/companies_house_client/ca_path.rb

@@ -0,0 +1,15 @@
+require 'rbconfig'
+module CompaniesHouseClient
+  class CAPath
+    class << self
+      def platform_path
+        case RbConfig::CONFIG['host_os']
+          when /linux|arch/i
+            "/usr/lib/ssl"
+          when /darwin/i
+            "/System/Library/OpenSSL"
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_client/collection_parser.rb

@@ -0,0 +1,19 @@
+module CompaniesHouseClient
+
+  # Clean up collections, which look like this:
+  # {
+  #   "total_results": 4,
+  #   "items": [
+  #     { }, #some item
+  #     { }, #some item
+  #   ]
+  # }
+  class CollectionParser < Faraday::Response::Middleware
+    def on_complete(env)
+      json = MultiJson.load(env[:body], symbolize_keys: true)
+      env[:body] = {
+        data: json.has_key?(:items) ? json[:items] : json
+      }
+    end
+  end
+end

data/lib/companies_house_client/models/company.rb

@@ -0,0 +1,27 @@
+module CompaniesHouseClient
+  class Company < Base
+    has_many :officers
+    collection_path "/company"
+    primary_key :company_number
+
+    def self.search(term, per_page: nil, start: nil)
+      get("/search",{q: term, items_per_page: per_page, start_index: start})
+    end
+
+    def name
+      company_name
+    end
+
+    def number
+      company_number
+    end
+
+    def active?
+      company_status == "active"
+    end
+
+    def dissolved?
+      !active?
+    end
+  end
+end

data/lib/companies_house_client/models/officer.rb

@@ -0,0 +1,5 @@
+module CompaniesHouseClient
+  class Officer < Base
+    belongs_to :company
+  end
+end

data/lib/companies_house_client/version.rb

@@ -0,0 +1,3 @@
+module CompaniesHouseClient
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: companies_house_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: require_all
+  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: her
+  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'
+description: A REST client for the UK Companies House API, including authentication
+email:
+- ed@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- companies_house_client.gemspec
+- lib/companies_house_client.rb
+- lib/companies_house_client/base.rb
+- lib/companies_house_client/ca_path.rb
+- lib/companies_house_client/collection_parser.rb
+- lib/companies_house_client/models/company.rb
+- lib/companies_house_client/models/officer.rb
+- lib/companies_house_client/version.rb
+homepage: https://github.com/errorstudio/companies_house_client
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A REST client for the UK Companies House API
+test_files: []