nzbn 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ac6e8983ce3a663bb3a50efaed76468fc11419d
+  data.tar.gz: 7c503bd4f5f3d3786ebd0441821c463db32cf524
+SHA512:
+  metadata.gz: b5a816702782e3d35beb5997a972b86e07b1275725f2dbf23526bc18174ddf054084268aff374406f5307e8d0c230159c0761dbe913176795e39118ce6660994
+  data.tar.gz: 6bf182ab6c2302f8eb53bc85d00421e54fc8a7b0484c0d642630bb55002375921b75541c1476e911a5ad31a89b647741f011fa265e60801b4a526e2d1c828810

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nzbn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 T Pearse
+
+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,78 @@
+# NZBN Gem
+
+Simple and fast authenticating API wrapper for the New Zealand Companies Office. Search by company and retrieve company details. Further functionality can easily be exposed.
+
+
+## About the Companies Office
+
+The New Zealand Companies Office has an API which can be accessed through registration at: [https://api.business.govt.nz/api/](https://api.business.govt.nz/api/)
+
+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 'nzbn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nzbn
+
+You will also need to set the following ENV variables, in order to access the API. These can be gound on the business.govt.nz website under your login.
+
+$ NZBN_ID=
+
+$ NZBN_SECRET=
+
+
+## Usage
+
+Two functions have been exposed, as per below.
+
+### Company details by NZBN
+
+	$ NZBN.entity(nzbn)
+  * where nzbn is the entity nzbn
+
+Full company details based on a unique 'Company Number' will be returned.
+
+### Search for a Company
+
+	$ NZBZN.entites(search_term, entity_status, page_length)
+  * entity_status = "registered" to filter the search for registered entities only (defaults to registered)*
+  * page_length = 50 to return the top 50 results only (max of 200, defaults to 50)*
+
+All output is returned as parsed JSON. Within a rails view it can be quickly navigated with [Nokogiri](https://github.com/sparklemotion/nokogiri) or similar.
+
+
+## Pull requests welcome!
+
+Pull requests welcome to build out further functionality including:
+- Entity filings
+- Subscriptions
+- Users
+- Authorities
+- Organisations
+- Documents
+
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tpearse/nzbn.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nzbn"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/nzbn.rb

@@ -0,0 +1,49 @@
+require "nzbn/version"
+
+module NZBN
+  require 'rubygems'
+  require 'time'
+  require 'curb'
+  require 'base64'
+
+
+    def self.entities(search_term, entity_status, page_size)
+      entity_status = "registered" if entity_status.blank?
+      page_size = 50 if page_size.blank?
+      r = Curl::Easy.new("https://api.business.govt.nz/services/v3/nzbn/entities?search-term=#{search_term}&entity-status=#{entity_status}&page-size=#{page_size}") do |curl|
+        curl.headers['Authorization'] = 'Bearer ' + access_token
+        curl.http_auth_types = :basic
+        curl.verbose = true
+      end
+      r.perform
+      return JSON.parse(r.body_str)
+    end
+
+    def self.entity(nzbn)
+      r = Curl::Easy.new("https://api.business.govt.nz/services/v3/nzbn/entities/#{nzbn}") do |curl|
+        curl.headers['Authorization'] = 'Bearer ' + access_token
+        curl.http_auth_types = :basic
+        curl.verbose = true
+      end
+      r.perform
+      return JSON.parse(r.body_str)
+    end
+
+
+
+  private
+
+
+    def self.access_token
+        c = Curl::Easy.http_post("https://api.business.govt.nz/services/token", "grant_type=client_credentials") do |curl|
+          curl.headers['grant_type'] = 'client_credentials'
+          curl.headers['Authorization'] = 'Basic ' + Base64.strict_encode64(ENV["NZBN_ID"] + ":" + ENV["NZBN_SECRET"])
+          curl.http_auth_types = :basic
+          curl.verbose = true
+        end
+        c.perform
+        return JSON.parse(c.body_str)["access_token"]
+    end
+
+
+end

data/lib/nzbn/version.rb

@@ -0,0 +1,3 @@
+module Nzbn
+  VERSION = "0.1.1"
+end

data/nzbn.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nzbn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nzbn"
+  spec.version       = Nzbn::VERSION
+  spec.authors       = ["T Pearse"]
+  spec.email         = ["t.pearse@gmail.com"]
+
+  spec.summary       = %q{Simple and fast authenticating ruby API wrapper for the NZBN API}
+  spec.description   = %q{Search, update details and manage New Zealand companies through the NZBN register.}
+  spec.homepage      = "https://github.com/t-pearse/nzbn"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: nzbn
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- T Pearse
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Search, update details and manage New Zealand companies through the NZBN
+  register.
+email:
+- t.pearse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nzbn.rb
+- lib/nzbn/version.rb
+- nzbn.gemspec
+homepage: https://github.com/t-pearse/nzbn
+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 ruby API wrapper for the NZBN API
+test_files: []