Merge branch 'dev'

* dev:
  Updating Readme file.
  National code validation has been added into the library.
  Updating main variable name to match the library name.
  Postal code validation has been added into the library.

Author: jmosawy

README.md

@@ -16,11 +16,15 @@ Then you can use the available methods for different available validators:
 ```javascript
 IRCheck.Phone.checkType('02191001848'); //returns 'LANDLINE'
 IRCheck.Phone.normalizeMobile('+989121234567'); // returns '9121234567'
+IRCheck.Postal.isPostalCodeValid('7634598734'); // returns 'TRUE'
+IRCheck.National.isNationalCodeValid('4721016352'); // returns 'TRUE'
 ```
 
 ## Validators Availability
 Currently, the following validators are available:
 * [Iran Phone Numbers](#phone)
+* [Iran Postal](#postal)
+* [Iran National Codes](#national)
 
 ### Phone
 Here’s a list of available methods:
@@ -29,10 +33,25 @@ Here’s a list of available methods:
 * `isLandline(number)` Verify the input number is a type of landline
 * `normalizeMobile(number)`  Normalize a mobile number as 9121234567
 * `normalizeLandline(number)` Normalize a landline number as 2191001848
-* `getProvinceData(number)` Get province info from its area code or code name
+* `getProvinceData(province {String|Number})` Get province info from its area code or code name
 * `getProvincesFromLandline(number)` Extract province data from a landline numbers
 
+### Postal
+Here’s a list of available methods:
+* `isPostalCodeValid(postalCode {String})` Check if the entered postal code is valid
+
+### National
+Here’s a list of available methods:
+* `isNationalCodeValid(nationalCode {String})` Check if the entered Iranian national code is valid
+
+
 ## History
+### 0.3.0
+* Postal code validation has been added into the library.
+* National code validation has been added into the library.
+* Updating README.md file.
+* A few changes in the main file.
+
 ### 0.1.1
 * Fixing typo errors in README.md file.
 

index.js

@@ -1,7 +1,11 @@
 const Phone = require('./phone');
+const Postal = require('./postal');
+const National = require('./national');
 
-const Verifier = function () {};
+const IRCheck = function () {};
 
-Verifier.prototype.Phone = Phone;
+IRCheck.prototype.Phone = Phone;
+IRCheck.prototype.Postal = Postal;
+IRCheck.prototype.National = National;
 
-module.exports = new Verifier();
+module.exports = new IRCheck();

national/index.js

@@ -0,0 +1,26 @@
+const National = function () {};
+
+/**
+ * Check if the entered Iranian national code is valid.
+ * @param {string} nationalCode
+ * @returns {boolean}
+ */
+National.prototype.isNationalCodeValid = function (nationalCode) {
+  if (nationalCode.length !== 10) {
+    return false;
+  }
+  let sumOfMultipliedNumber = 0;
+  for (i = 10; i > 1; i -= 1) {
+    sumOfMultipliedNumber += nationalCode.charAt(10 - i) * i;
+  }
+
+  const r = sumOfMultipliedNumber % 11;
+
+  if (r < 2) {
+    return Number(nationalCode.charAt(9)) === r;
+  }
+
+  return Number(nationalCode.charAt(9)) === (11 - r);
+}
+
+module.exports = new National();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ircheck",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Node.js validation library for Iranian developers",
   "main": "index.js",
   "scripts": {

postal/index.js

@@ -0,0 +1,14 @@
+const PostalCodeRegex = /^[13-9]{10}$/;
+
+const Postal = function () {};
+
+/**
+ * Check if the entered postal code is valid.
+ * @param {string} postalCode
+ * @returns {boolean}
+ */
+Postal.prototype.isPostalCodeValid = function (postalCode) {
+  return new RegExp(PostalCodeRegex).test(postalCode);
+};
+
+module.exports = new Postal();

test/national-test.js

@@ -0,0 +1,18 @@
+const { describe, it } = require('mocha');
+const { expect } = require('chai');
+const { National } = require('../index');
+
+describe('National Tools', () => {
+  describe('isNationalCodeValid', () => {
+    it('should be valid national code', () => {
+      expect(National.isNationalCodeValid('0939092001')).to.be.equal(true);
+      expect(National.isNationalCodeValid('4721016352')).to.be.equal(true);
+      expect(National.isNationalCodeValid('4120128431')).to.be.equal(true);
+    });
+    it('should not be a valid national code', () => {
+      expect(National.isNationalCodeValid('0939092002')).to.be.equal(false);
+      expect(National.isNationalCodeValid('472016352')).to.be.equal(false);
+      expect(National.isNationalCodeValid('04120128431')).to.be.equal(false);
+    });
+  });
+});

test/postal-test.js

@@ -0,0 +1,18 @@
+const { describe, it } = require('mocha');
+const { expect } = require('chai');
+const { Postal } = require('../index');
+
+describe('Postal Tools', () => {
+  describe('isPostalCodeValid', () => {
+    it('should be valid postal codes', () => {
+      expect(Postal.isPostalCodeValid('1834556784')).to.equal(true);
+      expect(Postal.isPostalCodeValid('7634598734')).to.equal(true);
+      expect(Postal.isPostalCodeValid('3813187764')).to.equal(true);
+    });
+    it('should be not a valid postal code', () => {
+      expect(Postal.isPostalCodeValid('76654543')).to.equal(false);
+      expect(Postal.isPostalCodeValid('1898875423')).to.equal(false);
+      expect(Postal.isPostalCodeValid('1890875413')).to.equal(false);
+    });
+  });
+});