Merge pull request #66 from seegno/enhancement/add-taxpayer-identification-number-asse

Add Taxpayer Identification Number assert

Author: ruimarinho

README.md

@@ -45,6 +45,7 @@ The following set of extra asserts are provided by this package:
 - [NullOrString](#nullorstring)
 - [Phone](#phone) (requires `google-libphonenumber`)
 - [PlainObject](#plainobject)
+- [TaxpayerIdentificationNumber](#taxpayeridentificationnumber) (_TIN_, requires `tin-validator`)
 - [UkModulusChecking](#ukmoduluschecking) (requires `uk-modulus-checking`)
 - [Uri](#uri) (requires `urijs`)
 - [UsSubdivision](#ussubdivision)
@@ -166,6 +167,9 @@ Tests if the phone is valid and optionally if it belongs to the given country. T
 ### PlainObject
 Tests if the value is a plain object.
 
+### TaxpayerIdentificationNumber
+Tests if the value is a valid Taxpayer Identification Number (_TIN_) as defined by the [U.S. IRS](http://www.irs.gov/Individuals/International-Taxpayers/Taxpayer-Identification-Numbers-TIN).
+
 ### UkModulusChecking
 Tests if the given `accountNumber` and `sortCode` represent a valid `Faster Payment Account`.
 

package.json

@@ -70,6 +70,7 @@
     "moment": "^2.12.0",
     "should": "^8.3.0",
     "sinon": "^1.15.4",
+    "tin-validator": "^1.0.0",
     "uk-modulus-checking": "0.0.2",
     "urijs": "^1.17.1",
     "validator": "^5.2.0"
@@ -82,6 +83,7 @@
     "iban": ">=0.0.6 <1.0.0",
     "isoc": ">=0.0.1 <1.0.0",
     "moment": ">=2 <3",
+    "tin-validator": ">=1.0.0 <2.0.0",
     "uk-modulus-checking": "0.0.2",
     "urijs": ">=1 <2",
     "validator": ">=3 <6"

src/asserts/taxpayer-identification-number-assert.js

@@ -0,0 +1,43 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+import { Validator, Violation } from 'validator.js';
+
+/**
+ * Export `TaxpayerIdentificationNumberAssert`.
+ */
+
+export default function() {
+  /**
+   * Optional peer dependency.
+   */
+
+  const tin = require('tin-validator');
+
+  /**
+   * Class name.
+   */
+
+  this.__class__ = 'TaxpayerIdentificationNumber';
+
+  /**
+   * Validation algorithm.
+   */
+
+  this.validate = function(value) {
+    if (typeof value !== 'string') {
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+    }
+
+    if (!tin.isValid(value)) {
+      throw new Violation(this, value);
+    }
+
+    return true;
+  };
+
+  return this;
+}

src/index.js

@@ -29,6 +29,7 @@ import NullOrString from './asserts/null-or-string-assert.js';
 import Phone from './asserts/phone-assert.js';
 import PlainObject from './asserts/plain-object-assert.js';
 import UkModulusChecking from './asserts/uk-modulus-checking-assert.js';
+import TaxpayerIdentificationNumber from './asserts/taxpayer-identification-number-assert.js';
 import Uri from './asserts/uri-assert.js';
 import UsSubdivision from './asserts/us-subdivision-assert.js';
 import UsZipCode from './asserts/us-zip-code-assert.js';
@@ -65,6 +66,7 @@ export default {
   Phone,
   PlainObject,
   UkModulusChecking,
+  TaxpayerIdentificationNumber,
   Uri,
   UsSubdivision,
   UsZipCode,

test/asserts/taxpayer-identification-number-assert_test.js

@@ -0,0 +1,75 @@
+
+/**
+ * Module dependencies.
+ */
+
+import { Assert as BaseAssert, Violation } from 'validator.js';
+import TaxpayerIdentificationNumberAssert from '../../src/asserts/taxpayer-identification-number-assert';
+import should from 'should';
+
+/**
+ * Extend `Assert` with `TaxpayerIdentificationNumberAssert`.
+ */
+
+const Assert = BaseAssert.extend({
+  TaxpayerIdentificationNumber: TaxpayerIdentificationNumberAssert
+});
+
+/**
+ * Test `TaxpayerIdentificationNumberAssert`.
+ */
+
+describe('TaxpayerIdentificationNumberAssert', () => {
+  it('should throw an error if the input value is not a string', () => {
+    [{}, []].forEach((choice) => {
+      try {
+        new Assert().TaxpayerIdentificationNumber().validate(choice);
+
+        should.fail();
+      } catch (e) {
+        e.should.be.instanceOf(Violation);
+        e.violation.value.should.equal('must_be_a_string');
+      }
+    });
+  });
+
+  it('should throw an error if the input value is not a valid `tin`', () => {
+    try {
+      new Assert().TaxpayerIdentificationNumber().validate('foobar');
+
+      should.fail();
+    } catch (e) {
+      e.should.be.instanceOf(Violation);
+      e.show().value.should.equal('foobar');
+    }
+  });
+
+  it('should throw an error if the input value is not a correctly formatted `tin`', () => {
+    try {
+      new Assert().TaxpayerIdentificationNumber().validate('1-2-3456 789');
+
+      should.fail();
+    } catch (e) {
+      e.should.be.instanceOf(Violation);
+      e.show().value.should.equal('1-2-3456 789');
+    }
+  });
+
+  it('should expose `assert` equal to `TaxpayerIdentificationNumber`', () => {
+    try {
+      new Assert().TaxpayerIdentificationNumber().validate('1-2-3456 789');
+
+      should.fail();
+    } catch (e) {
+      e.show().assert.should.equal('TaxpayerIdentificationNumber');
+    }
+  });
+
+  it('should accept a valid `tin`', () => {
+    new Assert().TaxpayerIdentificationNumber().validate('123456789');
+  });
+
+  it('should accept a correctly formatted `tin`', () => {
+    new Assert().TaxpayerIdentificationNumber().validate('123-45-6789');
+  });
+});

test/index_test.js

@@ -38,6 +38,7 @@ describe('validator.js-asserts', () => {
       'Phone',
       'PlainObject',
       'UkModulusChecking',
+      'TaxpayerIdentificationNumber',
       'Uri',
       'UsSubdivision',
       'UsZipCode',