multiple changes

- add support for hex output of decryption
- add coveralls support to generate automatic test coverage information
- add documentation

Author: Deepal Jayasekara

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+test/
+gulpfile.js

.eslintrc

@@ -0,0 +1,33 @@
+{
+  "extends": "eslint-config-airbnb",
+  "globals": {
+    "Buffer": true,
+    "global": true,
+    "__dirname": true,
+    "process": true,
+    "it": true,
+    "module": true,
+    "describe": true,
+    "require": true
+  },
+  "rules": {
+    "indent": [
+      "error",
+      4
+    ],
+    "comma-dangle": [
+      "error",
+      "never"
+    ],
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true,
+        "optionalDependencies": false,
+        "peerDependencies": false
+      }
+    ],
+    "no-underscore-dangle": 0,
+    "no-bitwise": 0
+  }
+}

README.md

@@ -1,7 +1,106 @@
 # node-dukpt
 
-Node Library to provide Derived Unique Key Per Transaction (DUKPT) Encryption 
+[![npm version](https://badge.fury.io/js/dukpt.svg)](https://badge.fury.io/js/dukpt) ![alt tag](https://api.travis-ci.org/dpjayasekara/node-dukpt.svg?branch=master) ![alt dependencies](https://david-dm.org/dpjayasekara/node-dukpt.svg) ![alt dev-dependencies](https://david-dm.org/dpjayasekara/node-dukpt/dev-status.svg) [![Coverage Status](https://coveralls.io/repos/github/dpjayasekara/node-dukpt/badge.svg)](https://coveralls.io/github/dpjayasekara/node-dukpt) [![Code Climate](https://codeclimate.com/github/dpjayasekara/node-dukpt/badges/gpa.svg)](https://codeclimate.com/github/dpjayasekara/node-dukpt)
+
+
+##Derived Unique Key Per Transaction (DUKPT) Encryption with NodeJS
+
+This the NodeJS implementation of DUKPT based on the vanilla javascript implementation of **IDTech** DUKPT encryption/decryption. Don't hesitate to report any bugs in the [Github Repository!](https://github.com/dpjayasekara/node-dukpt).
+
+Many thanks to @jamiesoncj for providing resources.
+
+### Installing
+
+```
+npm install dukpt --save
+```
+### Using DUKPT
+
+Initialize DUKPT by providing BDK and KSN:
+
+```
+const Dukpt = require('dukpt');
+
+const encryptionBDK = '0123456789ABCDEFFEDCBA9876543210;
+const ksn = 'FFFF9876543210E00008';
+const encryptedCardData = '411D405D7DEDB9D84797F04<redacted_for_brevity>050509277E5F80BE67A2C324900A7E3';
+const plainTextCardData = '%B5452310551227189^DOE/JOHN      ^08043210000000725000000?';
+
+const dukpt = new Dukpt(encryptionBDK, ksn);
+```
+After initializing, you can use `dukptEncrypt` and `dukptDecrypt` methods to encrypt/decrypt data using DUKPT. 
+
+#### Encrypting `ascii` data
+
+```
+const options = {
+	inputEncoding: 'ascii', 
+	outputEncoding: 'hex',
+	encryptionMode: '3DES'
+};
+const encryptedCardData = dukpt.dukptEncrypt(plainTextCardData, options);
+```
+
+#### Encrypting `hex` data
+
+```
+const options = {
+	inputEncoding: 'hex',
+	outputEncoding: 'hex',
+	encryptionMode: '3DES'
+};
+const encryptedCardData = dukpt.dukptEncrypt(plainTextCardData, options);
+```
+
+#### Decrypting data with `ascii` output encoding
+
+```
+const options = {
+	outputEncoding: 'ascii',
+	decryptionMode: '3DES',
+	trimOutput: true
+};
+
+const decryptedCardData = dukpt.dukptDecrypt(encryptedCardData, options);
+```
+#### Decrypting data with `hex` output encoding
+
+```
+const options = {
+	outputEncoding: 'hex',
+	decryptionMode: '3DES',
+	trimOutput: true
+};
+
+const decryptedCardData = dukpt.dukptDecrypt(encryptedCardData, options);
+```
+
+###Options
+
+You can use options object to provide additional options for the DUKPT encryption/decryption. This object is **optional** and, if you don't provide it, encryption/decryption will use the default values shipped with it. 
+
+Following listed are the available options.
+
+Option | Possible Values | Default Value | Description
+------------ | ------- | ------------- | --------------
+`outputEncoding` | `ascii`, `hex` | For encryption `hex`, for decryption `ascii` | Specify output encoding of encryption/decryption
+`inputEncoding` | `ascii`, `hex` | For encryption `ascii`, for decryption `hex` | Specify encoding of the input data for encryption/decryption
+`trimOutput` (for decryption only) | `true`, `false` | `false` | Specify whether to strip out null characters from the decrypted output
+`encryptionMode` (for encryption only) | `3DES` | `3DES` | Specify encryption scheme for dukpt
+`decryptionMode` (for decryption only) | `3DES` | `3DES` | Specify decryption scheme for dukpt
+
+* Support for AES encryption/decryption mode will be added soon!
+
+###Tests
+Tests can be run using gulp as follows:
+
+```
+gulp test
+```
+
+####Roadmap
+
+- [x] Support for DUKPT Encryption/Decryption with 3DES
+- [ ] Support for DUKPT Encryption/Decryption with AES
 
-![alt tag](https://api.travis-ci.org/dpjayasekara/node-dukpt.png?branch=master) ![alt dependencies](https://david-dm.org/dpjayasekara/node-dukpt.svg) ![alt dev-dependencies](https://david-dm.org/dpjayasekara/node-dukpt/dev-status.svg) [![Coverage Status](https://coveralls.io/repos/github/dpjayasekara/node-dukpt/badge.svg)](https://coveralls.io/github/dpjayasekara/node-dukpt)
 
-Coming Soon...

dist/gulpfile.js

@@ -2,6 +2,7 @@ const gulp = require('gulp');
 const eslint = require('gulp-eslint');
 const mocha = require('gulp-mocha');
 const istanbul = require('gulp-istanbul');
+const coveralls = require('gulp-coveralls');
 
 function lint() {
     return gulp.src(['./index.js', './lib/*.js'])
@@ -17,7 +18,7 @@ function pretest() {
 }
 
 function test() {
-    return gulp.src(['./test/**/*.js'], { read: false })
+    gulp.src(['./test/**/*.js'], { read: false })
         .pipe(mocha())
         .pipe(istanbul.writeReports({
             dir: 'test-coverage/',
@@ -27,6 +28,8 @@ function test() {
             reporters: ['lcov', 'text', 'text-summary', 'cobertura']
         }))
         .pipe(istanbul.enforceThresholds({ thresholds: { global: 1 } }));
+    return gulp.src('test-coverage/lcov.info')
+        .pipe(coveralls());
 }
 
 function watch() {

dist/gulpfile.js.map

@@ -235,6 +235,17 @@ class Dukpt {
             return DataOperations.removeNullCharsFromAscii(decryptedOutput);
         }
 
+        switch (options.outputEncoding.toLowerCase()){
+            case 'ascii':
+                // do nothing
+                break;
+            case 'hex':
+                decryptedOutput = DataOperations.dataToHexstring(decryptedOutput);
+                break;
+            default:
+                throw new Error('unsupported output encoding for dukpt decrypt');
+        }
+
         return decryptedOutput;
     }
 

dist/lib/dukpt.lib.js

@@ -31,6 +31,7 @@
     "eslint-plugin-jsx-a11y": "2.2.3",
     "eslint-plugin-react": "6.8.0",
     "gulp": "3.9.1",
+    "gulp-coveralls": "0.1.4",
     "gulp-eslint": "3.0.1",
     "gulp-istanbul": "1.1.1",
     "gulp-mocha": "3.0.1",