za_id_number 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5a9409a4cbf5d9fecfd49c0f75a5edc20927d27
+  data.tar.gz: 8d8a5ccd8bdd39e1badb5d9a20ae75e222d20cdd
+SHA512:
+  metadata.gz: 35008d2b1410cf41fb9b8d870c67f71b3088be38013d03f7f14ec269459f1de56c9920051bc941c69b01e507f8a122568fe619ec82175db530400b6831f51f26
+  data.tar.gz: 6cbca82db59d804a7edf81a1e1f3aec60e2a0ee94e053e0e0f38cb6937e7055fa047f99d6915df5347834643d27ff83a95cf7abffa92533af92eb6043b409ac9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gabriel@zero-one.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gabriel Fortuna
+
+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,97 @@
+ZAIDNumber
+==========
+
+A simple gem for working with South African ID numbers.
+
+Details
+=======
+
+South African ID numbers have a fair amount of information serialized into them, including an all important checksum number. The below information is taken from a page deep within [The Western Cape Government's website](https://www.westerncape.gov.za/general-publication/decoding-your-south-african-id-number-0).
+
+A South African ID number is a 13-digit number which is defined by the following format: `YYMMDDSSSSCAZ`.
+
+-	The first 6 digits (`YYMMDD`) are based on your date of birth. **20 February 1992** is displayed as `920220`.
+-	The next 4 digits (`SSSS`) are used to define your gender. Females are assigned numbers in the range 0000-4999 and males from 5000-9999.
+-	The next digit (`C`) shows if you're a ZA citizen status, with 0 denoting that you were born a ZA citizen and 1 denoting that you're a permanent resident.
+-	The last digit (`Z`) is a checksum digit – used to check that the number sequence is accurate using a set formula called the [Luhn algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm).
+
+The graphic below details the different sections of an ID number, based on the fictitious sequence `9202204720082`
+
+![ZA ID Number Infographic](za-id-number.png)
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'za_id_number'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install za_id_number
+```
+
+Usage
+-----
+
+Given a valid ZA ID Number, `7501151234085`, the following interface is available:
+
+```ruby
+id_number = ZAIDNumber.new('7501151234085') # => #<ZAIDNumber:0x00d40 @id_number="75011...
+```
+
+### Validation checks
+
+```ruby
+id_num.has_valid_length?      # => true
+id_num.has_only_digits?       # => true
+id_num.has_valid_date?        # => true
+id_num.has_valid_citizenship? # => true
+id_num.has_valid_checksum?    # => true
+```
+
+Or, roll up all those validation checks into one call:
+
+```ruby
+id_number.valid? # => true
+```
+
+### Information about the data embedded in the ID Number
+
+You can also use this gem to extract information embedded in the ID number as per the infographic above.
+
+```ruby
+id_num.date_of_birth       # => #<Date: 1975-01-15 ((2442428j,0s,0n),+0s,2299161j)>
+id_num.gender              # => :f
+id_num.female?             # => true
+id_num.male?               # => false
+id_num.citizenship         # => :za_citizen
+id_num.za_citizen?         # => true
+id_num.permanent_resident? # => false
+```
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/zero-one-software/za_id_number. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "za_id_number"
+require "awesome_print"
+
+def reload!
+  files = $LOADED_FEATURES.select { |feat| feat =~ /za_id_number/ }
+  files.each { |file| load file }
+  "reloaded."
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

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/za_id_number.rb

@@ -0,0 +1,75 @@
+require 'za_id_number/version'
+require 'luhn'
+
+class ZAIDNumber
+  REQUIRED_ID_LENGTH = 13
+  FEMALE_RANGE       = (0..4999)
+  MALE_RANGE         = (5000..9999)
+  CITIZENSHIP_RANGE  = (0..1)
+  ZA_CITIZEN         = 0
+  PERMANENT_RESIDENT = 1
+
+  attr_reader :id_number
+
+  def initialize(id_num)
+    @id_number = id_num.to_s
+  end
+
+  def valid?
+    has_valid_length?      &&
+    has_only_digits?       &&
+    has_valid_date?        &&
+    has_valid_citizenship? &&
+    has_valid_checksum?
+  end
+
+  def has_valid_checksum?
+    Luhn.valid? @id_number
+  end
+
+  def has_valid_length?
+    @id_number.length == REQUIRED_ID_LENGTH
+  end
+
+  def has_only_digits?
+    @id_number.to_s.gsub(/\D*/, '') == @id_number.to_s
+  end
+
+  def has_valid_date?
+    date_of_birth ? true : false
+  end
+
+  def has_valid_citizenship?
+    CITIZENSHIP_RANGE.include? @id_number[10].to_i
+  end
+
+  def date_of_birth
+    Date.parse("#{@id_number[0..1]}-#{@id_number[2..3]}-#{@id_number[4..5]}")
+  rescue ArgumentError
+    nil
+  end
+
+  def gender
+    female? ? :f : :m
+  end
+
+  def female?
+    FEMALE_RANGE.include? @id_number[6..9].to_i
+  end
+
+  def male?
+    !female?
+  end
+
+  def citizenship
+    za_citizen? ? :za_citizen : :permanent_resident
+  end
+
+  def za_citizen?
+    @id_number[10].to_i == ZA_CITIZEN
+  end
+
+  def permanent_resident?
+    !za_citizen?
+  end
+end

data/lib/za_id_number/version.rb

@@ -0,0 +1,5 @@
+class ZAIDNumber
+  class Version
+    VERSION = '1.0.0'
+  end
+end

data/za_id_number.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'za_id_number/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "za_id_number"
+  spec.version       = ZAIDNumber::Version::VERSION
+  spec.authors       = ["Gabriel Fortuna"]
+  spec.email         = ["gabriel@zero-one.io"]
+
+  spec.summary       = "A small library for parsing South African ID numbers"
+  spec.description   = "A small library for parsing, validating, and providing information on South African ID numbers"
+  spec.homepage      = "http://www.zero-one.io"
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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.13'
+  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rspec',         '~> 3.0'
+  spec.add_development_dependency 'pry',           '~> 0.11.3'
+  spec.add_development_dependency 'awesome_print', '~> 1.8'
+
+  spec.add_dependency 'luhn', '~> 1.0', '>= 1.0.2'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: za_id_number
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Fortuna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: luhn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: A small library for parsing, validating, and providing information on
+  South African ID numbers
+email:
+- gabriel@zero-one.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/za_id_number.rb
+- lib/za_id_number/version.rb
+- za-id-number.png
+- za_id_number.gemspec
+homepage: http://www.zero-one.io
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A small library for parsing South African ID numbers
+test_files: []