open-companies-house 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 GoCardless
+
+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,83 @@
+Open Companies House
+====================
+
+Simple ruby wrapper around Companies House Open API
+
+Usage:
+=====
+
+    company = CompaniesHouse.lookup "07495895"
+    => #<CompaniesHouse:0x00000100932870 @registration_number="07495895"... >
+
+    company["CompanyName"]
+    => "GOCARDLESS LTD"
+
+    company.sic_code # convenience method
+    => "62090"
+
+Specs
+=====
+
+    rspec spec
+
+
+Available Data
+==============
+
+The following data is currently available on the `company` object returned by
+`CompaniesHouse.lookup`
+
+
+Call it like this:
+
+    company["RegAddress"]["AddressLine1"]
+    => "22-25 FINSBURY SQUARE"
+
+All data:
+
+    {
+      "CompanyName" : "GOCARDLESS LTD",
+      "CompanyNumber" : "07495895",
+      "RegAddress" : {
+         "AddressLine1" : "22-25 FINSBURY SQUARE",
+         "PostTown" : "LONDON",
+         "Country" : "UNITED KINGDOM",
+         "Postcode" : "EC2A 1DX"
+      },
+      "CompanyCategory" : "Private Limited Company",
+      "CompanyStatus" : "Active",
+      "CountryOfOrigin" : "United Kingdom",
+      "IncorporationDate" : "17/01/2011",
+      "PreviousNames" : [
+         {
+            "CONDate" : "25/08/2011",
+            "CompanyName" : "GROUPAY LIMITED"
+         }
+      ],
+      "Accounts" : {
+         "AccountRefDay" : "31",
+         "AccountRefMonth" : "01",
+         "NextDueDate" : "31/10/2013",
+         "LastMadeUpDate" : "31/01/2012",
+         "AccountCategory" : "TOTAL EXEMPTION SMALL"
+      },
+      "Returns" : {
+         "NextDueDate" : "14/02/2013",
+         "LastMadeUpDate" : "17/01/2012"
+      },
+      "Mortgages" : {
+         "NumMortCharges" : "1",
+         "NumMortOutstanding" : "1",
+         "NumMortPartSatisfied" : "0",
+         "NumMortSatisfied" : "0"
+      },
+      "SICCodes" : {
+         "SicText" : [
+            "62090 - Other information technology service activities"
+         ]
+      }
+    }
+
+
+TODO: Use some funky metaprogramming to make these available as human-readable
+method calls, eg `company.name` or `company.registered_address.line_1`.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(--color --format doc)
+end
+
+task :default => :spec

data/lib/companies_house/companies_house.rb

@@ -0,0 +1,95 @@
+class CompaniesHouse
+
+  class CompanyNotFound < StandardError
+  end
+
+  class InvalidRegistration < StandardError
+  end
+
+  class ServerError < StandardError
+  end
+
+  BASE_URI = 'http://data.companieshouse.gov.uk/doc/company/'
+
+  # Public API
+  #
+  # Usage:
+  # company = CompaniesHouse.lookup "07495895"
+  # => #<CompaniesHouse:0x00000100932870 @registration_number="07495895"... >
+  #
+  # company["CompanyName"]
+  # => "GOCARDLESS LTD"
+  #
+  def self.lookup(registration_number)
+    obj = self.new(registration_number)
+    obj.lookup
+    obj
+  end
+
+  # Return a SIC code from the ugly hash
+  #
+  # company.sic_code
+  # => "62090"
+  #
+  def sic_code
+    if self["SICCodes"] && self["SICCodes"]["SicText"]
+      self["SICCodes"]["SicText"].first.split[0]
+    end
+  end
+
+  # So that you can call attributes on the companies house object:
+  # company["CompanyName"]
+  def [](key)
+    @attributes[key]
+  end
+
+  attr_accessor :registration_number
+
+  # Don't call this directly. Instead, use CompaniesHouse.lookup "01234567"
+  def initialize(registration_number)
+    @registration_number = check_registration(registration_number)
+    @attributes = {}
+  end
+
+  # perform the HTTP request
+  def lookup
+    url = BASE_URI + @registration_number + ".json"
+    response = Faraday.get(url)
+    check_for_errors(response)
+    parse_response(response)
+  end
+
+  private
+
+  def check_registration(number)
+    number = number.to_s.strip # remove whitespace
+
+    number = "0" + number if number.length == 7 # 0-pad for luck
+
+    msg = "#{number} is not a valid UK company registration number"
+    raise InvalidRegistration.new(msg) unless number =~ /\A[0-9]{8}\z/
+
+    number
+  end
+
+  def check_for_errors(response)
+    if response.status == 404
+      msg = "Company not found with registration #{@registration_number}"
+      raise CompanyNotFound.new(msg)
+    end
+
+    unless response.status == 200
+      msg = "Companies House Responded with status #{response.status}"
+      raise ServerError.new(msg)
+    end
+  end
+
+  def parse_response(response)
+    # The response uses HTTP default Latin-1 encoding. Convert it to
+    # valid UTF8 as storing this in Mongo (for example) can cause
+    # problems.
+    body = response.body.encode("UTF-8", "ISO-8859-1")
+    data = JSON.parse(body)
+    @attributes = data["primaryTopic"]
+  end
+end

data/lib/companies_house/version.rb

@@ -0,0 +1,3 @@
+class CompaniesHouse
+  VERSION = '0.1.1'.freeze
+end

data/lib/companies_house.rb

@@ -0,0 +1,4 @@
+# require 'rubygems'
+require 'faraday'
+require 'json'
+require File.join(File.dirname(__FILE__), 'companies_house/companies_house')

data/open_companies_house.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('../lib/companies_house/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+  gem.add_development_dependency 'mocha', '~> 0.10.5'
+  gem.add_development_dependency 'webmock', '~> 1.8.8'
+
+  gem.add_dependency "faraday", "~> 0.8.4"
+  gem.add_dependency "json"
+
+  gem.name = 'open-companies-house'
+  gem.summary = "A wrapper around Companies House Open API"
+  gem.version = CompaniesHouse::VERSION.dup
+  gem.authors = ['Tom Blomfield']
+  gem.email = ['tom@gocardless.com']
+  gem.homepage = 'https://github.com/gocardless/open-companies-house'
+  gem.require_paths = ['lib']
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- spec/*`.split("\n")
+end

data/spec/companies_house/companies_house_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe CompaniesHouse do
+
+  let(:subject) { CompaniesHouse }
+
+  describe ".lookup" do
+
+    context "throws an exception" do
+      it "with a number that's too short" do
+        expect {
+          subject.lookup "123456"
+        }.to raise_exception CompaniesHouse::InvalidRegistration
+      end
+
+      it "that's too long" do
+        expect {
+          subject.lookup "123456789"
+        }.to raise_exception CompaniesHouse::InvalidRegistration
+      end
+
+      it "that's not numeric" do
+        expect {
+          subject.lookup "abcdefgh"
+        }.to raise_exception CompaniesHouse::InvalidRegistration
+      end
+
+      it "that's nil" do
+        expect {
+          subject.lookup nil
+        }.to raise_exception CompaniesHouse::InvalidRegistration
+      end
+    end
+
+    context "with a valid request" do
+      before do
+        url = "http://data.companieshouse.gov.uk/doc/company/07495895.json"
+        stub_request(:get, url).to_return(
+          :body => load_fixture("gocardless.json"),
+          :status => 200
+        )
+      end
+
+      it "0-pads 7 digit registration numbers" do
+        company = subject.lookup "7495895"
+        company.registration_number.should == "07495895"
+      end
+
+      it "loads attributes into the object body" do
+        company = subject.lookup "07495895"
+        company["CompanyName"].should == "GOCARDLESS LTD"
+      end
+
+      it "makes SIC code available as a convenience method" do
+        company = subject.lookup "07495895"
+        company.sic_code.should == "62090"
+      end
+    end
+
+    context "with a company that doesn't exist" do
+      before do
+        url = "http://data.companieshouse.gov.uk/doc/company/12345678.json"
+        stub_request(:get, url).to_return(
+          :body => "Some bullshit HTML response :-(",
+          :status => 404
+        )
+      end
+
+      it "raises an exception" do
+        expect {
+          company = subject.lookup "12345678"
+        }.to raise_exception CompaniesHouse::CompanyNotFound
+      end
+    end
+
+    context "when the server is down" do
+      before do
+        url = "http://data.companieshouse.gov.uk/doc/company/12345678.json"
+        stub_request(:get, url).to_return(
+          :body => "Oh noes",
+          :status => 500
+        )
+      end
+
+      it "raises an exception" do
+        expect {
+          company = subject.lookup "12345678"
+        }.to raise_exception CompaniesHouse::ServerError
+      end
+    end
+  end
+end

data/spec/data/gocardless.json

@@ -0,0 +1,44 @@
+{
+   "primaryTopic" : {
+      "CompanyName" : "GOCARDLESS LTD",
+      "CompanyNumber" : "07495895",
+      "RegAddress" : {
+         "AddressLine1" : "22-25 FINSBURY SQUARE",
+         "PostTown" : "LONDON",
+         "Country" : "UNITED KINGDOM",
+         "Postcode" : "EC2A 1DX"
+      },
+      "CompanyCategory" : "Private Limited Company",
+      "CompanyStatus" : "Active",
+      "CountryOfOrigin" : "United Kingdom",
+      "IncorporationDate" : "17/01/2011",
+      "PreviousNames" : [
+         {
+            "CONDate" : "25/08/2011",
+            "CompanyName" : "GROUPAY LIMITED"
+         }
+      ],
+      "Accounts" : {
+         "AccountRefDay" : "31",
+         "AccountRefMonth" : "01",
+         "NextDueDate" : "31/10/2013",
+         "LastMadeUpDate" : "31/01/2012",
+         "AccountCategory" : "TOTAL EXEMPTION SMALL"
+      },
+      "Returns" : {
+         "NextDueDate" : "14/02/2013",
+         "LastMadeUpDate" : "17/01/2012"
+      },
+      "Mortgages" : {
+         "NumMortCharges" : "1",
+         "NumMortOutstanding" : "1",
+         "NumMortPartSatisfied" : "0",
+         "NumMortSatisfied" : "0"
+      },
+      "SICCodes" : {
+         "SicText" : [
+            "62090 - Other information technology service activities"
+         ]
+      }
+   }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'mocha'
+require 'companies_house'
+require 'json'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    # Disable all live HTTP requests
+    WebMock.disable_net_connect!(allow_localhost: true)
+  end
+
+  config.mock_with :mocha
+end
+
+def load_fixture(*filename)
+  File.open(File.join('spec', 'data', *filename)).read
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: open-companies-house
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Blomfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tom@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/companies_house.rb
+- lib/companies_house/companies_house.rb
+- lib/companies_house/version.rb
+- open_companies_house.gemspec
+- spec/companies_house/companies_house_spec.rb
+- spec/data/gocardless.json
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/open-companies-house
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A wrapper around Companies House Open API
+test_files:
+- spec/companies_house/companies_house_spec.rb
+- spec/data/gocardless.json
+- spec/spec_helper.rb