companies_house_api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdcf097862f3405032d89f74165de56710aa2463
+  data.tar.gz: 38ced24922179e233896e275499b22a03aef4c50
+SHA512:
+  metadata.gz: aeed0bfd26ea51948654234ecaf67f38e9883325b17eff464cd140e72c36f90e03fde888267b53fd7dc72b65efe47a15ea5ae52166bef46cb19b08d0a07ee62f
+  data.tar.gz: b455e7a6e1640e08d22a1332d6e4395b09581ac9def31102114a15177ff6ca9847bd1008c43057072efc2d710832a48a20fe3afbb2803c175996cd8c61b23c28

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+api_key_tmp.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robin Fisher
+
+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,59 @@
+# CompaniesHouse
+
+The CompaniesHouse gem provides a wrapper around the Companies House API. Two methods are currently provided. One to search the Companies House database against a given string. The second to retrieve company information given a company number.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'companies_house_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install companies_house_api
+
+## Usage
+
+An API key is required which can be obtained by registering with [Companies House](https://developer.companieshouse.gov.uk/api/docs/index/gettingStarted/apikey_authorisation.html).
+
+Configure the gem using a block in an initializer:
+
+```ruby
+CompaniesHouse.configure do |config|
+  config.api_key = "your_api_key_here"
+end
+```
+
+Planning ahead for future development, there are two classes, `Search` and `Company Information`.
+
+To search for company information, configure as above and then instantiate a new instance of the `Search` class.
+
+```ruby
+ch = CompaniesHouse::Search.new
+ch.search_companies("captured sparks")
+```
+
+This returns a plain ruby object with two attributes: a count of how many results are returned for the search and an array of those results.
+
+To retrieve company information:
+
+```ruby
+ch = CompaniesHouse::CompanyInformation.new
+ch.company_profile("07577596")
+```
+
+Again, this return a plain ruby object with attributes as shown in the API documentation e.g. `company_name`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/companies_house_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "companies_house_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/companies_house_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'companies_house/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "companies_house_api"
+  spec.version       = CompaniesHouse::VERSION
+  spec.authors       = ["Robin Fisher"]
+  spec.email         = ["robinjfisher@gmail.com"]
+
+  spec.summary       = %q{Ruby library for interacting with Companies House API}
+  spec.homepage      = "https://github.com/robinjfisher/companies_house_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "faraday", "~> 0.9.2"
+  spec.add_development_dependency "mocha", "~> 1.1.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+end

data/lib/companies_house/base.rb

@@ -0,0 +1,24 @@
+module CompaniesHouse
+
+  class Base
+
+    API_URL = "https://api.companieshouse.gov.uk/"
+
+    attr_accessor :api_key
+
+    def initialize
+      if CompaniesHouse.configuration.nil?
+        raise ApiKeyError.new("You have not set an API key")
+      end
+      self.api_key = CompaniesHouse.configuration.api_key
+      @@conn = Faraday.new(:url => API_URL) do |faraday|
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+      @@conn.headers[:authorization] = "#{@api_key}"
+      @@conn.basic_auth("#{api_key}","")
+    end
+
+  end
+
+end

data/lib/companies_house/company_information.rb

@@ -0,0 +1,25 @@
+module CompaniesHouse
+
+  class CompanyInformation < Base
+
+    def initialize
+      super
+    end
+
+    def company_profile(company_number)
+      # GET /company/company_number
+      url = "company/#{company_number}"
+      response = @@conn.get url
+      result = JSON.parse(response.body, object_class: OpenStruct)
+      if result.respond_to?(:errors)
+        if result.errors[0][:error] == "company-profile-not-found"
+          raise CompanyNotFoundError.new("A company with that registration number could not be found")
+        end
+      else
+        return result
+      end
+    end
+
+  end
+
+end

data/lib/companies_house/configuration.rb

@@ -0,0 +1,26 @@
+module CompaniesHouse
+
+#   CompaniesHouse.configure do |config|
+#     config.api_key = '837432u32hlfkwjhkljehw'
+#   end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = "example_api_key"
+    end
+
+  end
+
+end

data/lib/companies_house/search.rb

@@ -0,0 +1,34 @@
+module CompaniesHouse
+
+  class Search < Base
+
+    # request = CompaniesHouse::Search.new
+
+    def initialize
+      super
+    end
+
+    # search_companies
+    # https://developer.companieshouse.gov.uk/api/docs/search/companies/companysearch.html
+    # response = request.search_companies(query_string,items_per_page,start_index)
+    # query_string is a string to be searched for
+    # items_per_page is a string setting how many items to return per page
+    # start_index is a string representing the index of the first result item to return
+    # response.companies_count returns the number of companies found for the given query string
+    # response.companies returns an array of OpenStruct objects representing the company information found for the given query string
+
+    def search_companies(q="captured sparks",items_per_page="50",start_index="0")
+      # GET /search/companies
+      query_string = "?q=#{q}&items_per_page=#{items_per_page}"
+      unless start_index.nil?
+        query_string << "&start_index=#{start_index}"
+      end
+      url = "search/companies#{query_string}"
+      response = @@conn.get(url)
+      result = JSON.parse(response.body, object_class: OpenStruct)
+      return OpenStruct.new({companies_count: result.items.count, companies: result.items})
+    end
+
+  end
+
+end

data/lib/companies_house/version.rb

@@ -0,0 +1,3 @@
+module CompaniesHouse
+  VERSION = "0.1.2"
+end

data/lib/companies_house.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+require 'json'
+require 'faraday'
+require "companies_house/version"
+require 'companies_house/base'
+require 'companies_house/configuration'
+require 'companies_house/search'
+require 'companies_house/company_information'
+
+module CompaniesHouse
+
+  class ApiKeyError < StandardError
+  end
+
+  class CompanyNotFoundError < StandardError
+  end
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: companies_house_api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Robin Fisher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: 
+email:
+- robinjfisher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- companies_house_api.gemspec
+- lib/companies_house.rb
+- lib/companies_house/base.rb
+- lib/companies_house/company_information.rb
+- lib/companies_house/configuration.rb
+- lib/companies_house/search.rb
+- lib/companies_house/version.rb
+homepage: https://github.com/robinjfisher/companies_house_api
+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
+signing_key: 
+specification_version: 4
+summary: Ruby library for interacting with Companies House API
+test_files: []