nhi-validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b45ff678c45fe33622f4355de416f07e0b38325fe84c18056107729ed46d59fa
+  data.tar.gz: dce34e1274982d07e97bef1a664ab16f0f6e7f9739461af3aa8caf5382757b90
+SHA512:
+  metadata.gz: f57ffa71783100cc092c62c8313628d3b85878277c729cacfe8edd543789191bfbcf9d094a2b8b3a58150545466c024f4404a80571d7b05562e6b521c74f2ddd
+  data.tar.gz: 71ea7c16d4fa28e560178af00d896146c761e9564962b428e4617b8d62aa118004bac054108f7bc7817fe3b5cf52b8ada0bc1148204c3ba588cc370403f9b259

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    nhi-validator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  nhi-validator!
+  rake (~> 10.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Merrin Macleod
+
+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,43 @@
+# NZ National Health Index Validator
+
+The National Health Index (NHI) number is the unique person identifier used within the New Zealand health system. It uses a checksum for validation. This is a library to do that validation.
+
+References:
+
+[Document from health.govt.nz](https://www.health.govt.nz/system/files/documents/pages/nhi_validation_routine_march_2017.doc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nhi-validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nhi-validator
+
+## Usage
+
+To check if an NHI number is valid: `NHIValidator.valid?(nhi_number)`
+
+That's it! That's the whole thing.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mermop/nhi-validator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nhi-validator'
+
+# 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/nhi_validator.rb

@@ -0,0 +1,57 @@
+require 'nhi-validator/version'
+
+# From https://www.health.govt.nz/system/files/documents/pages/nhi_validation_routine_march_2017.doc:
+
+# The National Health Index (NHI) number is used by many national and local
+# systems to provide a safe and secure reference key for patient data.
+# Because of its importance, the NHI number has a built-in validation routine
+# that has been designed to allow systems to minimise typographical errors
+# as NHI numbers are keyed in.
+# NHI number structure
+# The NHI number is a unique 7-character identifier
+# (3 alphabetical characters followed by 4 numeric characters)
+# assigned to a healthcare user by the NHI.
+# The first 3 characters of an NHI number must be alphabetic,
+# but not 'I' or 'O', to avoid confusion with one and zero.
+# The 4th to 6th characters must be numeric.
+# The 7th character is also numeric, and is a check digit based on modulus 11.
+class NHIValidator
+  class Error < StandardError; end
+  class << self
+    PATTERN = /[a-hj-np-zA-HJ-NP-Z]{3}[0-9]{4}/ # alphabet without I and O
+    ALPHABET_OMITTING_I_AND_O = 'abcdefghjklmnpqrstuvwxyz'.freeze
+
+    def valid?(nhi)
+      return false unless nhi =~ PATTERN # steps 1-2
+
+      cs = checksum(nhi[0..5]) # steps 3-10
+      return false if cs.zero? # step 11
+
+      cs = 11 - cs # step 12
+      cs = 0 if cs == 10 # step 13
+
+      nhi[6].to_i == cs
+    end
+
+    private
+
+    def checksum(characters)
+      total = 0
+      characters.each_char.with_index do |character, index|
+        total += multiply(character, index)
+      end
+      total % 11
+    end
+
+    def position_in_alphabet(character)
+      ALPHABET_OMITTING_I_AND_O.index(character.downcase) + 1
+    end
+
+    def multiply(character, position)
+      multiplier = (7 - position)
+      return character.to_i * multiplier if character =~ /[0-9]/
+
+      position_in_alphabet(character) * multiplier
+    end
+  end
+end

data/lib/nhi_validator/version.rb

@@ -0,0 +1,3 @@
+class NHIValidator
+  VERSION = '0.1.0'.freeze
+end

data/nhi_validator.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nhi_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nhi-validator'
+  spec.version       = NHIValidator::VERSION
+  spec.authors       = ['Merrin Macleod']
+  spec.email         = ['merrin.macleod@gmail.com']
+
+  spec.summary       = 'A validator for the New Zealand National Health Index.'
+  spec.description   = 'A validator for the New Zealand National Health Index.'
+  spec.homepage      = 'https://github.com/mermop/nz-health-index-validator'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mermop/nhi-validator'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have
+  # been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nhi-validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Merrin Macleod
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A validator for the New Zealand National Health Index.
+email:
+- merrin.macleod@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nhi_validator.rb
+- lib/nhi_validator/version.rb
+- nhi_validator.gemspec
+homepage: https://github.com/mermop/nz-health-index-validator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mermop/nz-health-index-validator
+  source_code_uri: https://github.com/mermop/nhi-validator
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A validator for the New Zealand National Health Index.
+test_files: []