usi 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.2
+cache:
+  - bundler
+  - apt
+bundler_args: -j4 --quiet
+script:
+  - bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John D'Agostino
+
+MIT License
+
+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,64 @@
+# USI
+
+[![Code Climate](https://codeclimate.com/github/jobready/usi.png)](https://codeclimate.com/github/jobready/usi)
+[![Build Status](https://travis-ci.org/jobready/usi.svg)](https://travis-ci.org/jobready/usi)
+
+A gem for validating USI (Unique Student Identifiers) for VET Students in Australia
+
+From the Department of Industry's website -
+
+    USI is effectively an account or reference number made up of numbers and letters.  The USI will allow all of an individual’s training records, entered in the national vocational education and training (VET) data collection, to be linked.
+    The USI will be available online and at no cost to the student. This USI will stay with the student for life and be recorded with any nationally recognised VET course that is undertaken from when the USI comes into effect.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'usi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install usi
+
+## Usage
+
+```ruby
+require 'usi'
+
+Usi::Validator.new('223456789N').valid?
+
+```
+
+in Rails 3+
+
+```ruby
+class Student < ActiveRecord::Base
+  validates :identifier, usi: true
+end
+```
+
+in Rails 2.3
+
+```ruby
+class Student < ActiveRecord::Base
+  validate :must_be_valid_format_usi
+
+  def must_be_valid_format_usi
+    errors.add_to_base('USI format invalid') unless Usi::Validator.new(usi).valid?
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/jobready/usi/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 new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/usi.rb

@@ -0,0 +1,7 @@
+module Usi
+end
+
+require 'usi/version'
+require 'usi/luhn_check'
+require 'usi/validator'
+require 'usi_validator' if defined?(Rails) && defined?(ActiveModel)

data/lib/usi/luhn_check.rb

@@ -0,0 +1,37 @@
+class Usi::LuhnCheck
+  attr_reader :base_n, :valid_characters
+
+  def initialize(valid_characters)
+    @valid_characters = valid_characters
+    @base_n = valid_characters.length
+  end
+
+  def generate(string)
+    current_factor = 2
+    results = string.reverse.each_char.map do |character|
+      code_point = valid_characters.index(character)
+      addend = calculate_addend(code_point, current_factor)
+      current_factor = alternate_factor(current_factor)
+      express_addend_in_base_n(addend)
+    end
+
+    sum = results.inject(0, &:+)
+    valid_characters[find_check_character_code_point(sum)]
+  end
+
+  def alternate_factor(factor)
+    factor == 2 ? 1 : 2
+  end
+
+  def calculate_addend(code_point, factor)
+    code_point * factor
+  end
+
+  def express_addend_in_base_n(addend)
+    (addend / base_n) + (addend % base_n)
+  end
+
+  def find_check_character_code_point(sum)
+    (base_n - (sum % base_n)) % base_n
+  end
+end

data/lib/usi/validator.rb

@@ -0,0 +1,30 @@
+class Usi::Validator
+  attr_accessor :identifier
+
+  VALID_CHARACTERS = ['2', '3', '4', '5', '6', '7', '8', '9',
+                      'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
+                      'J', 'K','L', 'M', 'N', 'P', 'Q', 'R',
+                      'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'].freeze
+
+  def initialize(identifier)
+    @identifier = identifier
+  end
+
+  def valid?
+    if ten_valid_characters?
+      identifier.split('').last == checker.generate(identifier[0..8])
+    else
+      false
+    end
+  end
+
+  def checker
+    @checker ||= Usi::LuhnCheck.new(VALID_CHARACTERS)
+  end
+
+  private
+
+  def ten_valid_characters?
+    identifier =~ /\A[#{VALID_CHARACTERS.join}]{10}\z/
+  end
+end

data/lib/usi/version.rb

@@ -0,0 +1,3 @@
+module Usi
+  VERSION = '0.0.1'
+end

data/lib/usi_validator.rb

@@ -0,0 +1,6 @@
+class UsiValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    result = Usi::Validator.new(value).valid?
+    record.errors[attribute] << 'is not a valid USI (Unique Student Identifier)' unless result
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+   Coveralls::SimpleCov::Formatter,
+]
+
+SimpleCov.configure do
+  add_filter '/spec/'
+end
+
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding perf: true
+  config.order = 'random'
+end

data/spec/validator_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Usi::Validator do
+  let(:result) { Usi::Validator.new(usi) }
+
+  context 'when USI is not a valid Luhn mod N string' do
+    let(:usi) { '223456789X' }
+    specify { expect(result).to_not be_valid }
+  end
+
+  context 'given the valid 10 digit Luhn mod N string' do
+    ['223456789N',
+     'H2289JJ33U'].each do |x|
+      let(:usi) { x }
+
+      it "#{x.inspect} should be valid" do
+        expect(result).to be_valid
+      end
+    end
+  end
+
+  context 'when USI is a valid Luhn mod N string but not length 10' do
+    ['3495289R',
+     '34952895876V'].each do |x|
+      let(:usi) { x }
+
+      it "#{x.inspect} should not be valid" do
+        expect(result).to_not be_valid
+      end
+    end
+  end
+end

data/usi.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'usi'
+  spec.version       = Usi::VERSION
+  spec.authors       = ["John D'Agostino"]
+  spec.email         = ['john.dagostino@gmail.com']
+  spec.summary       = %q{Validate Australian Government USI}
+  spec.description   = %q{A gem for validating Australian Government Unique Student Identifiers (USI)}
+  spec.homepage      = 'https://github.com/jobready/usi'
+  spec.license       = 'MIT'
+
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'cane', '~> 2.6'
+  spec.add_development_dependency 'byebug', '~> 2.7'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'coveralls', '~> 0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+end
+

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: usi
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- John D'Agostino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2016-07-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 14
+        version: "2.14"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cane
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: byebug
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 10
+        - 1
+        version: "10.1"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: coveralls
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: A gem for validating Australian Government Unique Student Identifiers (USI)
+email: 
+- john.dagostino@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/usi.rb
+- lib/usi/luhn_check.rb
+- lib/usi/validator.rb
+- lib/usi/version.rb
+- lib/usi_validator.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+- usi.gemspec
+homepage: https://github.com/jobready/usi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Validate Australian Government USI
+test_files: 
+- spec/spec_helper.rb
+- spec/validator_spec.rb