From ac711cfeb0501da332e2355ed341aca776b722d4 Mon Sep 17 00:00:00 2001 From: Justin Worthe Date: Sun, 12 Feb 2017 05:54:21 +0200 Subject: Renamed main file to better fit browser use --- README.md | 25 +++++++++ index.js | 129 --------------------------------------------- package.json | 2 +- south-african-id-parser.js | 129 +++++++++++++++++++++++++++++++++++++++++++++ test/test.js | 2 +- 5 files changed, 156 insertions(+), 131 deletions(-) delete mode 100644 index.js create mode 100644 south-african-id-parser.js diff --git a/README.md b/README.md index de3e46f..b8c80f3 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,31 @@ and [here](http://knowles.co.za/generating-south-african-id-numbers/). Usage ----- +Download the library from NPM using the following command in a terminal: + +``` +npm install --save south-african-id-parser +``` + +### Usage In NodeJS + +``` +var saIdParser = require('south-african-id-parser'); +var info = saIdParser.parse('9001049818080'); +``` + +### Usage In the Browser + +When used in the browser, the library will add the `saIdParser` object +to the window for you to use. + +``` + + +``` + ### Parse Everything The package exposes the `.parse(idNumber)` method for calling all of diff --git a/index.js b/index.js deleted file mode 100644 index 1405a5a..0000000 --- a/index.js +++ /dev/null @@ -1,129 +0,0 @@ -(function (global, factory) { - typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : - typeof define === 'function' && define.amd ? define(factory) : - global.saIdParser = factory(); -}(this, (function () { - 'use strict'; - - return { - parse: parse, - validate: validate, - parseDateOfBirth: parseDateOfBirth, - parseIsMale: parseIsMale, - parseIsFemale: parseIsFemale, - parseIsSouthAfricanCitizen: parseIsSouthAfricanCitizen - }; - - function parse(idNumber) { - var isValid = validate(idNumber); - if (!isValid) { - return { - isValid: false - }; - } - - return { - isValid: isValid, - dateOfBirth: parseDateOfBirth(idNumber), - isMale: parseIsMale(idNumber), - isFemale: parseIsFemale(idNumber), - isSouthAfricanCitizen: parseIsSouthAfricanCitizen(idNumber) - }; - } - - function validate(idNumber) { - if (!regexpValidate(idNumber) || !datePartValidate(idNumber) || !controlDigitValidate(idNumber)) { - return false; - } - - return true; - } - - function regexpValidate(idNumber) { - if (typeof(idNumber) !== 'string') { - return false; - } - var regexp = /^[0-9]{13}$/; - return regexp.test(idNumber); - } - - function datePartValidate(idNumber) { - var dateOfBirth = parseDateOfBirth(idNumber); - return !!dateOfBirth; - } - - function controlDigitValidate(idNumber) { - var checkDigit = parseInt(idNumber[12], 10); - - var oddDigitsSum = 0; - - for (var i = 0; i < idNumber.length - 1; i+=2) { - oddDigitsSum += parseInt(idNumber[i], 10); - } - var evenDigits = ''; - for (var j = 1; j < idNumber.length - 1; j+=2) { - evenDigits += idNumber[j]; - } - evenDigits = parseInt(evenDigits, 10); - evenDigits *= 2; - evenDigits = '' + evenDigits; - - var sumOfEvenDigits = 0; - for (var k = 0; k < evenDigits.length; k++) { - sumOfEvenDigits += parseInt(evenDigits[k], 10); - } - var total = sumOfEvenDigits + oddDigitsSum; - var computedCheckDigit = 10 - (total % 10); - - if (computedCheckDigit === 10) { - computedCheckDigit = 0; - } - return computedCheckDigit === checkDigit; - } - - function parseDateOfBirth(idNumber) { - if (!regexpValidate(idNumber)) { - return undefined; - } - - //get year, and assume century - var currentYear = new Date().getFullYear(); - var currentCentury = Math.floor(currentYear/100)*100; - var yearPart = currentCentury + parseInt(idNumber.substring(0,2), 10); - if (yearPart > currentYear) { - yearPart -= 100; //must be last century - } - - //In Javascript, Jan=0. In ID Numbers, Jan=1. - var monthPart = parseInt(idNumber.substring(2,4), 10)-1; - - var dayPart = parseInt(idNumber.substring(4,6), 10); - - var dateOfBirth = new Date(yearPart, monthPart, dayPart); - - //validate that date is in a valid range by making sure that it wasn't 'corrected' during construction - if (!dateOfBirth || dateOfBirth.getFullYear() !== yearPart || dateOfBirth.getMonth() !== monthPart || dateOfBirth.getDate() !== dayPart) { - return undefined; - } - - return dateOfBirth; - } - - function parseIsMale(idNumber) { - return !parseIsFemale(idNumber); - } - - function parseIsFemale(idNumber) { - if (!regexpValidate(idNumber)) { - return undefined; - } - return parseInt(idNumber[6], 10) <= 4; - } - - function parseIsSouthAfricanCitizen(idNumber) { - if (!regexpValidate(idNumber)) { - return undefined; - } - return parseInt(idNumber[10], 10) === 0; - } -}))); diff --git a/package.json b/package.json index 59a885f..c430b4d 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "south-african-id-parser", "version": "0.0.2", "description": "A library for parsing and validating South African ID Numbers.", - "main": "index.js", + "main": "south-african-id-parser.js", "scripts": { "test": "mocha" }, diff --git a/south-african-id-parser.js b/south-african-id-parser.js new file mode 100644 index 0000000..1405a5a --- /dev/null +++ b/south-african-id-parser.js @@ -0,0 +1,129 @@ +(function (global, factory) { + typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : + typeof define === 'function' && define.amd ? define(factory) : + global.saIdParser = factory(); +}(this, (function () { + 'use strict'; + + return { + parse: parse, + validate: validate, + parseDateOfBirth: parseDateOfBirth, + parseIsMale: parseIsMale, + parseIsFemale: parseIsFemale, + parseIsSouthAfricanCitizen: parseIsSouthAfricanCitizen + }; + + function parse(idNumber) { + var isValid = validate(idNumber); + if (!isValid) { + return { + isValid: false + }; + } + + return { + isValid: isValid, + dateOfBirth: parseDateOfBirth(idNumber), + isMale: parseIsMale(idNumber), + isFemale: parseIsFemale(idNumber), + isSouthAfricanCitizen: parseIsSouthAfricanCitizen(idNumber) + }; + } + + function validate(idNumber) { + if (!regexpValidate(idNumber) || !datePartValidate(idNumber) || !controlDigitValidate(idNumber)) { + return false; + } + + return true; + } + + function regexpValidate(idNumber) { + if (typeof(idNumber) !== 'string') { + return false; + } + var regexp = /^[0-9]{13}$/; + return regexp.test(idNumber); + } + + function datePartValidate(idNumber) { + var dateOfBirth = parseDateOfBirth(idNumber); + return !!dateOfBirth; + } + + function controlDigitValidate(idNumber) { + var checkDigit = parseInt(idNumber[12], 10); + + var oddDigitsSum = 0; + + for (var i = 0; i < idNumber.length - 1; i+=2) { + oddDigitsSum += parseInt(idNumber[i], 10); + } + var evenDigits = ''; + for (var j = 1; j < idNumber.length - 1; j+=2) { + evenDigits += idNumber[j]; + } + evenDigits = parseInt(evenDigits, 10); + evenDigits *= 2; + evenDigits = '' + evenDigits; + + var sumOfEvenDigits = 0; + for (var k = 0; k < evenDigits.length; k++) { + sumOfEvenDigits += parseInt(evenDigits[k], 10); + } + var total = sumOfEvenDigits + oddDigitsSum; + var computedCheckDigit = 10 - (total % 10); + + if (computedCheckDigit === 10) { + computedCheckDigit = 0; + } + return computedCheckDigit === checkDigit; + } + + function parseDateOfBirth(idNumber) { + if (!regexpValidate(idNumber)) { + return undefined; + } + + //get year, and assume century + var currentYear = new Date().getFullYear(); + var currentCentury = Math.floor(currentYear/100)*100; + var yearPart = currentCentury + parseInt(idNumber.substring(0,2), 10); + if (yearPart > currentYear) { + yearPart -= 100; //must be last century + } + + //In Javascript, Jan=0. In ID Numbers, Jan=1. + var monthPart = parseInt(idNumber.substring(2,4), 10)-1; + + var dayPart = parseInt(idNumber.substring(4,6), 10); + + var dateOfBirth = new Date(yearPart, monthPart, dayPart); + + //validate that date is in a valid range by making sure that it wasn't 'corrected' during construction + if (!dateOfBirth || dateOfBirth.getFullYear() !== yearPart || dateOfBirth.getMonth() !== monthPart || dateOfBirth.getDate() !== dayPart) { + return undefined; + } + + return dateOfBirth; + } + + function parseIsMale(idNumber) { + return !parseIsFemale(idNumber); + } + + function parseIsFemale(idNumber) { + if (!regexpValidate(idNumber)) { + return undefined; + } + return parseInt(idNumber[6], 10) <= 4; + } + + function parseIsSouthAfricanCitizen(idNumber) { + if (!regexpValidate(idNumber)) { + return undefined; + } + return parseInt(idNumber[10], 10) === 0; + } +}))); diff --git a/test/test.js b/test/test.js index f0417ab..01fe3fd 100644 --- a/test/test.js +++ b/test/test.js @@ -1,5 +1,5 @@ var expect = require('chai').expect; -var saIdParser = require('../index.js'); +var saIdParser = require('../south-african-id-parser.js'); describe('South African ID Number Parsing', function() { var validIdNumbers = [{ -- cgit v1.2.3