cdds 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c245773fe5edc4d0eac458a32ee3eb1c37e8738b50f3c5e63af52ab02752857
+  data.tar.gz: f526a83b23c2e5f79f01debc7f24a4c2cdeaf16cf7741253dbc1790b0e1c3083
+SHA512:
+  metadata.gz: c598a558da614ba912c4b10a098b8c4b94583b53c3276699398cd4979c8ffda69f8c36a0ef48e1966f777683101d4ff445b44b71747b04a7500bf5bbaae1b8cd
+  data.tar.gz: 66a466d5d348273a45a44dcb62450199e2916c1178d4e0c281919cda08e0c71cfd7a9a610a618fbc1b83412332a3fc854e3dd53dfd054ff3d5bfdb26ab49606b

data/.gitignore

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

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 cdds.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Theo Morra
+
+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,55 @@
+# CDDS Gem
+
+A Ruby interface for searching disqualified company directors and senior managers
+
+## 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 'cdds'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cdds
+
+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.
+
+    $ MBIE_ID=
+
+    $ MBIE_SECRET=
+
+
+## Usage
+
+One function is exposed, as per below.
+
+### Search for a disqualified person
+
+	$ CDDS::DisqualifiedPersons.search(name)
+  * where name is the name of the person you wish to search for on the register
+
+## Queries
+
+> NB: This Gem is not developed or maintained by the New Zealand Companies Office in any way, shape, or form.
+
+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/td512/cdds.
+
+## 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 "cdds"
+
+# 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/cdds.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cdds/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cdds"
+  spec.version       = Cdds::VERSION
+  spec.authors       = ["Theo Morra"]
+  spec.email         = ["git@theom.nz"]
+
+  spec.summary       = %q{Simple and fast authenticating ruby API wrapper for the Companies-Disqualified-DirectorSearch API}
+  spec.description   = %q{A Ruby interface for searching disqualified company directors and senior managers}
+  spec.homepage      = "https://github.com/td512/cdds"
+  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"
+  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
+
+end

data/lib/cdds/version.rb

@@ -0,0 +1,3 @@
+module Cdds
+  VERSION = "1.0.0"
+end

data/lib/cdds.rb

@@ -0,0 +1,38 @@
+require "cdds/version"
+
+module CDDS
+  require 'rubygems'
+  require 'time'
+  require 'rest-client'
+  require 'base64'
+
+  class DataError < StandardError; end
+  class AuthError < StandardError; end
+  class DisqualifiedPersons
+    API_VERSION="v2"
+    def self.search(search_term, page_size)
+      page_size = 50 if page_size.blank?
+      response = RestClient.get("https://api.business.govt.nz/services/#{API_VERSION}/companies-office/disqualified-directors/search?name=#{search_term}&page-size=#{page_size}",
+                                { authorization: "Bearer #{access_token}", accept: 'application/json' })
+      begin
+        JSON.parse(response.body).with_indifferent_access
+      rescue JSON::ParserError
+        raise CDDS::DataError, "CDDS API returned bad data"
+      end
+    end
+
+    private
+
+    def self.access_token
+      begin
+        response = RestClient.post("https://api.business.govt.nz/services/token", { grant_type: "client_credentials" },
+                                   { grant_type: "client_credentials", authorization: "Basic #{Base64.strict_encode64(ENV["MBIE_ID"] + ":" + ENV["MBIE_SECRET"])}" })
+
+        JSON.parse(response.body)["access_token"]
+      rescue JSON::ParserError, NoMethodError
+        raise CDDS::AuthError, "Authentication failed! Are you missing MBIE_ID or MBIE_SECRET?"
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cdds
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Theo Morra
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-22 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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A Ruby interface for searching disqualified company directors and senior
+  managers
+email:
+- git@theom.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cdds.gemspec
+- lib/cdds.rb
+- lib/cdds/version.rb
+homepage: https://github.com/td512/cdds
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Simple and fast authenticating ruby API wrapper for the Companies-Disqualified-DirectorSearch
+  API
+test_files: []