nzcoapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc4888d9c8fde256801d0c996ddf0925db98d649
+  data.tar.gz: 5c30f6142e6aa958174cb3c0ba3a049fff3075a9
+SHA512:
+  metadata.gz: bf78125b4086a2c5d70bc17446b94b38d1fe84a24d226ae5f1e14972e32178740c0b5e39742cf331d194f86ca09e0e5e12e3bfaf3567e17a9979c392750b8985
+  data.tar.gz: 6d2841aa57a8c8e80bc2338dfeca4a38b560bdfe8d20175372ce1c950ae8c556985a3f0ec1e3c5043fe0e964a0679a583f8d24985a704ea04b6065d12c4ce473

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,87 @@
+# New Zealand Companies Office API Gem
+
+Simple and fast authenticating API wrapper for the New Zealand Companies Office. Full functionality to search by company name, company number and director. Further functionality can be easily exposed inline with API documentation.
+
+
+## About the Companies Office
+
+The New Zealand Companies Office has an API which can be accessed through registration at: [http://www.business.govt.nz/businessdata](http://www.business.govt.nz/businessdata)
+
+Registration is required in order to obtain unique access keys to use the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nzcoapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nzcoapi
+
+## Configuration
+
+[Figaro](https://github.com/laserlemon/figaro) is a dependency required to securely store your Companies Office access and secret keys.
+
+Execute the following to setup application.yml to store your Companies Office keys with Figaro.
+
+    $ rails generate nzcoapi:install
+
+Alternatively you can manually add your Companies Office keys:
+
+	# config/application.yml
+	$ nzcoapi_access_key: "J5zFrdbg2iw"
+	$ nzcoapi_secret_key: "fin39USzsZGWgL2yUDQ1C0n6NBtv2"
+
+
+## Usage
+
+Three functions have been exposed, as per below.
+
+### Find by Company Number
+	
+	$ NZcoapi.find_company(123566)
+
+Full company details based on a unique 'Company Number' will be returned.
+
+### Find Director
+
+	$ NZcoapi.find_director("Jones, Bob")
+
+All company directorships (active and inactive) of this individual will be returned.
+
+### Search for a Company
+
+	$ NZcoapi.search_for_company("TradeMe")
+
+Search results for this company name will be returned.
+
+
+All output is returned as parsed XML. Within a rails view it can be quickly navigated with [Nokogiri](https://github.com/sparklemotion/nokogiri), for example:
+
+	# In View
+	<%= NZcoapi.find_company(973228).css('companyName').text %>
+
+	# Returns
+	Trade Me Limited
+
+## Queries
+
+> NB: This Gem is not developed or maintained by the New Zealand Companies Office in anyway.
+
+Please don't hesitate to get in touch if you have any queries and I'll try and point you in the right direction!
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nzcoapi/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nzcoapi"
+
+# 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/lib/nzcoapi.rb

@@ -0,0 +1,69 @@
+# Set Version
+VERSION = "0.1.0"
+
+ 
+require 'httparty'
+require 'base64'
+require 'time'
+require 'nokogiri'
+
+module Nzcoapi
+	include HTTParty
+	include Nokogiri
+	base_uri "http://www.businessdata.govt.nz"
+	format :xml
+
+	@@access_key = "J5zFrdfHu5Bbg2iw"
+	@@secret_key = "fin39USzsZGHSJGVUwzkUJWgL2yUDQ1C0n6NBtv2"
+	@@timestamp = Time.now.rfc2822 + " GMT"
+	headers "Timestamp" => Time.now.rfc2822 + " GMT"
+  	headers "Access" => @@access_key
+  	headers 'Accept' => "application/xml"
+
+
+	def self.search_for_company(string)
+		headers "Timestamp" => Time.now.rfc2822 + " GMT"
+		@@timestamp = Time.now.rfc2822 + " GMT"
+
+		stringtosign = "GET" + "\n" + "www.businessdata.govt.nz" + "\n" + "/data/app/ws/rest/companies/entity/search/v2.0/#{string}" + "\n" + @@timestamp + "\n" + @@access_key + "\n" + "application/xml" + "\n"
+
+		headers "Authorization" => @@access_key + ":" + Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', @@secret_key, stringtosign))
+		headers "Timestamp" => Time.now.rfc2822 + " GMT"
+
+		Nokogiri::XML((get("/data/app/ws/rest/companies/entity/search/v2.0/#{string}").body), 'UTF-8')
+	end
+
+	def self.find_director(string)
+		headers "Timestamp" => Time.now.rfc2822 + " GMT"
+		@@timestamp = Time.now.rfc2822 + " GMT"
+
+		stringtosign = "GET" + "\n" + "www.businessdata.govt.nz" + "\n" + "/data/app/ws/rest/companies/role/search/v1.0/size/200/type/DIR/#{string}" + "\n" + @@timestamp + "\n" + @@access_key + "\n" + "application/xml" + "\n"
+
+		headers "Authorization" => @@access_key + ":" + Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', @@secret_key, stringtosign))
+
+		Nokogiri::XML((get("/data/app/ws/rest/companies/role/search/v1.0/size/200/type/DIR/#{string}").body), 'UTF-8')
+
+	end
+
+	def self.find_company(id)
+		headers "Timestamp" => Time.now.rfc2822 + " GMT"
+		@@timestamp = Time.now.rfc2822 + " GMT"
+
+		stringtosign = "GET" + "\n" + "www.businessdata.govt.nz" + "\n" + "/data/app/ws/rest/companies/entity/v2.0/#{id}" + "\n" + @@timestamp + "\n" + @@access_key + "\n" + "application/xml" + "\n"
+
+		headers "Authorization" => @@access_key + ":" + Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', @@secret_key, stringtosign))
+
+		Nokogiri::XML((get("/data/app/ws/rest/companies/entity/v2.0/#{id}").body), 'UTF-8')
+
+	end
+
+
+
+	def self.tagged(tag)
+		retrieve_url get("/#{tag}.json")
+	end
+
+
+
+end
+

data/lib/nzcoapi/version.rb

@@ -0,0 +1,3 @@
+module Nzcoapi
+  VERSION = "0.1.0"
+end

data/nzcoapi.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nzcoapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nzcoapi"
+  spec.version       = Nzcoapi::VERSION
+  spec.authors       = ["T Pearse"]
+  spec.email         = ["t.pearse@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.summary       = %q{Simple and fast authenticating API wrapper for the New Zealand Companies Office}
+  spec.description   = %q{Full functionality to search by company name, company number and director. }
+  spec.homepage      = "https://github.com/t-pearse/nzcoapi"
+  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.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "figaro"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: nzcoapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- T Pearse
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: httparty
+  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: nokogiri
+  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: figaro
+  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: 'Full functionality to search by company name, company number and director. '
+email:
+- t.pearse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nzcoapi.rb
+- lib/nzcoapi/version.rb
+- nzcoapi.gemspec
+homepage: https://github.com/t-pearse/nzcoapi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Simple and fast authenticating API wrapper for the New Zealand Companies
+  Office
+test_files: []