companies_nz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81b6ff240c7dd6ca7f15dc9aabb4674fb6cd2879
+  data.tar.gz: 0c4db57dcf69aadb63ef08fef1a5f4d9a2edca26
+SHA512:
+  metadata.gz: accf65c788656e72dc56eb3d027399133eb7db0f4f2218d83e4bba765dd6a6cbc8bd3800670bca1ca65b30d23df6d3c41053ae4020d4b2fb84734aa0518ced20
+  data.tar.gz: eb7e9bdeff98f963550c8df74603ff1bd953ecd10564b80d62b579c220e790cabddd1cea6ec5aaaf895b909dff8321e92a8b0a62fe2c62e1597934466a88193c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Caleb
+
+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,67 @@
+# CompaniesNZ
+
+This gem is designed for working with the New Zealand Companies Office
+API.
+
+To use this gem you will need:
+
+A BusinessData account with the Companies Office, which will provide you
+with:
+
+1. An authentication key id (`key_id`)
+
+2. A secret key (`secret_key`)
+
+This gem also assumes that you are using the latest (v2.0) versions of
+the entity search and entity details endpoints (the default
+at the time of writing).
+
+Visit the [BusinessData](http://www.business.govt.nz/businessdata) site
+for more information, or contact the very helpful Companies Office team.
+
+For now this gem only covers the authorization header HMAC SHA 256
+signing and just returns the JSON for you to make of what you will.
+Future versions may structure the data in Structs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'companies_nz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install companies_nz
+
+## Usage
+
+```ruby
+
+  # to use the test environment (www.eat.businessdata.govt.nz)
+  client = CompaniesNZ::Client.new(key_id: YOUR_KEY_ID, secret_key: YOUR_SECRET_KEY, test: true)
+  # to use the live environment
+  client = CompaniesNZ::Client.new(key_id: YOUR_KEY_ID, secret_key: YOUR_SECRET_KEY))
+
+  # to search for entities with 'Mega' in the name
+  resp = client.search_entities 'Mega'    # returns a JSON parsed as a Ruby hash
+
+  # to search for roles by an individual's name
+  resp = client.search_roles 'John Archibald Banks'
+
+  # to get company details by company number
+  resp = client.entity_details 1947574
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nzherald/companies_nz/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,2 @@
+require "bundler/gem_tasks"
+

data/companies_nz.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'companies_nz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'companies_nz'
+  spec.version       = CompaniesNZ::VERSION
+  spec.authors       = ['Caleb']
+  spec.email         = ['caleb.tutty@nzherald.co.nz']
+  spec.summary       = %q{New Zealand Companies Office API wrapper}
+  spec.description   = %q{This gem handles the HMAC SHA256 request signing required for the NZ Companies Office's API, using Faraday to make the request}
+  spec.homepage      = 'http://github.com/nzherald/companies_nz'
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.9.1'
+end

data/lib/companies_nz.rb

@@ -0,0 +1,10 @@
+require 'companies_nz/version'
+require 'faraday'
+
+%w[client hmac_signer].each { |f| require "companies_nz/#{f}" }
+
+module CompaniesNZ
+  URL = 'http://www.businessdata.govt.nz'
+  TEST_URL = 'http://www.eat.business.govt.nz'
+end
+

data/lib/companies_nz/client.rb

@@ -0,0 +1,44 @@
+require 'uri'
+require 'json'
+
+module CompaniesNZ
+  class Client
+    attr_reader :signer, :http_client
+
+    def initialize(options = {})
+      @base_url = options.fetch(:test, false) ? TEST_URL : URL
+      @signer = HMACSigner.new(key_id: options.fetch(:key_id),
+                               secret_key: options.fetch(:secret_key),
+                               base_url: @base_url)
+      @http_client = Faraday.new(url: @base_url)
+    end
+
+    def search_entities(query)
+      query = URI.encode(query)
+      response = perform_request "/data/app/ws/rest/companies/entity/search/v2.0/#{query}"
+      JSON.parse(response.body)
+    end
+
+    def search_roles(query)
+      query = URI.encode(query)
+      response = perform_request "/data/app/ws/rest/companies/role/search/v1.0/#{query}"
+      JSON.parse(response.body)
+    end
+
+    def entity_details(company_number)
+      query = URI.encode(company_number.to_s)
+      response = perform_request "/data/app/ws/rest/companies/entity/v2.0/#{query}"
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def perform_request(url)
+      http_client.get(url) do |req|
+        req.headers['Accept'] = 'application/json'
+        req.headers['Date'] = signer.formatted_time
+        req.headers['Authorization'] = signer.generate_header(http_method: 'GET', url: url)
+      end
+    end
+  end
+end

data/lib/companies_nz/hmac_signer.rb

@@ -0,0 +1,35 @@
+require 'base64'
+require 'openssl'
+require 'uri'
+
+module CompaniesNZ
+  class HMACSigner
+    attr_reader :key_id, :base_url
+
+    def initialize(options = {})
+      @key_id = options.fetch(:key_id)
+      @secret_key = options.fetch(:secret_key)
+      @base_url = URI.parse(options.fetch(:base_url))
+    end
+
+    def generate_header(options)
+      key_id + ':' + sign(template(options))
+    end
+
+    def sign(data)
+      digest = OpenSSL::Digest.new('sha256')
+      result = OpenSSL::HMAC.digest(digest, @secret_key, data)
+      Base64.encode64 result
+    end
+
+    def template(options)
+      http_method, url = options.fetch(:http_method), options.fetch(:url)
+      "#{http_method}\n#{base_url.host}\n#{url}\n#{formatted_time}\n#{key_id}\napplication/json\n"
+    end
+
+    def formatted_time
+      # Spec states time should be in RFC1123 format
+      Time.now.gmtime.strftime('%a, %e %b %Y %H:%M:%S %z').sub(/ \+0000$/, ' GMT')
+    end
+  end
+end

data/lib/companies_nz/version.rb

@@ -0,0 +1,3 @@
+module CompaniesNZ
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: companies_nz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caleb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: This gem handles the HMAC SHA256 request signing required for the NZ
+  Companies Office's API, using Faraday to make the request
+email:
+- caleb.tutty@nzherald.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- companies_nz.gemspec
+- lib/companies_nz.rb
+- lib/companies_nz/client.rb
+- lib/companies_nz/hmac_signer.rb
+- lib/companies_nz/version.rb
+homepage: http://github.com/nzherald/companies_nz
+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: New Zealand Companies Office API wrapper
+test_files: []