0.0
No commit activity in last 3 years
No release in over 3 years
This gem handles the HMAC SHA256 request signing required for the NZ Companies Office's API, using Faraday to make the request
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 10.0

Runtime

~> 0.9.1
 Project Readme

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 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:

gem 'companies_nz'

And then execute:

$ bundle

Or install it yourself as:

$ gem install companies_nz

Usage

  # 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