Skip to content

Latest commit

 

History

History
156 lines (134 loc) · 4.15 KB

README.md

File metadata and controls

156 lines (134 loc) · 4.15 KB
Raw

ADP Connection Library

Description

The ADP Connection library wraps the authorization (oAuth 2.0) connection steps for connecting to ADPs API gateway.

Version

1.0.10-beta

Installation

$ npm install adp-connection

Usage

Create Client Credentials ADP Connection

var adp = require('adp-connection');
var ConnectionFactory = adp.ADPAPIConnectionFactory;
var ClientCredentialsConnType = adp.ClientCredentialsConnType;
var connType = new ClientCredentialsConnType();
var connectionFactory = new ConnectionFactory();
var initObject = {
	clientId: 'ec762f06-7410-4f6d-aa82-969902c1836a',
	clientSecret: '6daf2cd7-4604-46c0-ab43-a645a6571d34',
	apiUrl: 'https://iat-api.adp.com',
	tokenUrl: 'https://iat-api.adp.com/auth/oauth/v2/token',
	sslKeyPath: 'iatCerts/iat.key',
	sslCertPath: 'iatCerts/iat.pem',
};

connType.init(initObject);

var connection = connectionFactory.createConnection('client_credentials');
connection.init(connType);
connection.connect({keepAlive: true}, function connectCb(err){
	if(err) {
		log.error('Connection failed!');
	} else {
		// Connected!
	}
});

Create Authorization Code ADP Connection

var express = require('express');
var router = express.Router();
var connection;

/**
	1. CREATE CONNECTION CONFIGURAITON OBJECT (AuthorizationCodeConnType)
	2. INITIALIZE CONFIG OBJECT
	3. CREATE CONNECTION OBJECT
	4. INITIALIZE CONNECTION OBJECT WITH CONFIG OBJECT. 
	5. OBTAIN AUTHORIZATION REQUEST URL.
	6. REDIRECT. 
*/
router.get('/authenticate', function login(req, res) {
	var adp = require('adp-connection');
	var ConnectionFactory = adp.ADPAPIConnectionFactory;
	var AuthorizationCodeConnType = adp.AuthorizationCodeConnType;
	var connType = new AuthorizationCodeConnType();
	var connectionFactory = new ConnectionFactory();
	var initObject = {
		clientId: 'ec762f06-7410-4f6d-aa82-969902c1836a',
		clientSecret: '6daf2cd7-4604-46c0-ab43-a645a6571d34',
		apiUrl: 'https://iat-api.adp.com',
		tokenUrl: 'https://iat-api.adp.com/auth/oauth/v2/token',
		authorizationUrl: 'https://iat-accounts.adp.com/auth/oauth/v2/authorize',
		sslKeyPath: 'iatCerts/iat.key',
		sslCertPath: 'iatCerts/iat.pem',
		callbackUrl: 'http://localhost:8889/callback'
	};
	connType.init(initObject);
	connection = connectionFactory.createConnection('authorization_code');
	connection.init(connType);

	var url = connection.getAuthorizationRequest();
	res.redirect(url);
});

/**
	7. AUTHORIZATION RESPONSE RECEIVED.
	8. OBTAIN AUTHORIZATION CODE FROM QUERY PARAM.
	9. OBTAIN STATE FROM QUERY PARAM.
	10. SET AUTHORIZATION CODE IN CONNECTION CONFIGURATION.
	11. CONNECT.
*/
router.get('/callback', function callback(req, res){
	var state = req.query.state;
	var code = req.query.code;
	if(!code) {
		log.error('Error, no authorization code received');
	}

	connection.connType.setAuthorizationCode(code);
	connection.connect(null, function connectCb(err){
		if(err) {
			log.error('Connection failed!');
		} else {
			// Connected!!
		}
	});
});

Contributing

To contribute to the library, please generate a pull request. Before generating the pull request, please insure the following:

  1. Appropriate unit tests have been updated or created.
  2. Code coverage on unit tests must be no less than 95%.
  3. Your code updates have been fully tested and linted with no errors.
  4. Update README and API documentation as appropriate.

Sample Client

A sample client is provided to demonstrate usage of the libraries. The sample client connects to a sandbox environment hosted by ADP, and comes preconfigured with the necessary credentials and certificates to connect to the sandbox server.

Authorization Code Example

$ git clone https://github.com/adplabs/adp-connection-node.git
$ cd adp-connection-node
$ npm install
$ node authorizationCodeExample

Client Credentials Example

$ git clone https://github.com/adplabs/adp-connection-node.git
$ cd adp-connection-node
$ npm install
$ node clientCredentialsExample

API Documentation (JSDoc)

$ npm run docs

Test Execution

$ npm test

Code Coverage

$ npm run coverage

Lint

$ npm run lint

License

Apache 2