nforce

nforce

nforce is node.js a REST API wrapper for force.com, database.com, and salesforce.com.

Features

• Simple api
• Connection object to manage multiple force.com connections in a single app
• Helper oauth methods
• Express middleware

Installation

$ npm install nforce

Usage

Require nforce in your app and create a connection to an org.

var nforce = require('nforce');

var org = nforce.createConnection({
  clientId: 'SOME_OAUTH_CLIENT_ID',
  clientSecret: 'SOME_OAUTH_CLIENT_SECRET',
  redirectUri: 'http://localhost:3000/oauth/_callback',
  apiVersion: 'v24.0',  // optional, defaults to v24.0
  environment: 'production'  // optional, sandbox or production, production default
});

Now we just need to authenticate and get our OAuth credentials. Here is one way...

var oauth;

org.authenticate({ username: '[e-mail]', password: 'mypassword'}, function(err, resp){
  if(!err) oauth = resp;
});

Now we can go nuts. Inserting a record...

var record = {
  type: 'Account',
  fieldValues: {
    Name: 'Spiffy Cleaners',
    Custom__c: 234
  }
}

org.insert(record, oauth, function(err, resp){
  if(!err) console.log('It worked!');
});

Authentication

nforce supports two OAuth 2.0 flows, username/password and authorization code.

Username/Password flow

To request an access token and other oauth information using the username and password flow, use the authenticate() method and pass in your username and password in the options

var oauth;

org.authenticate({ username: '[e-mail]', password: 'mypassword'}, function(err, resp){
  if(!err) {
    console.log('Access Token: ' + resp.access_token);
    oauth = resp;
  } else {
    console.log('Error: ' + err.message);
  }
});

Authorization Code Flow

To perform an authorization code flow, first redirect users to the Authorization URI. nforce provides a helper function to build this url for you.

org.getAuthUri()

Once you get a callback at the Redirect URI that you specify, you need to request your access token and other important oauth information by calling authenticate() and passing in the "code" that you received.

var oauth;

org.authenticate({ code: 'SOMEOAUTHAUTHORIZATIONCODE' }, function(err, resp){
  if(!err) {
    console.log('Access Token: ' + resp.access_token);
    oauth = resp;
  } else {
    console.log('Error: ' + err.message);
  }
});

OAuth Object

At the end of a successful authorization, you a returned an OAuth object for the user. Cache this object as it will be used for subsequent requests. This object contains your access token, endpoint, id, and other information.

Express Middleware

nforce has built-in support for express using the express/connect middleware system. The middleware handles the oauth callbacks for you. To use the middleware you must have sessions enabled in your express configuration.

app.configure(function(){
  app.set('views', __dirname + '/views');
  app.set('view engine', 'jade');
  app.use(express.bodyParser());
  app.use(express.methodOverride());
  app.use(express.cookieParser());
  app.use(express.session({ secret: 'nforce testing baby' }));
  app.use(org.expressOAuth({onSuccess: '/home', onError: '/oauth/error'}));  // <--- nforce middleware
  app.use(app.router);
  app.use(express.static(__dirname + '/public'));
});

API

Callbacks

Callbacks will always pass an optional error object, and a response object.

callback(err, resp);

createConnection(opts)

The createConnection method creates an nforce connection object. You need to supply some arguments including oauth information and some optional arguments for version and environment.

• clientId: Required. This is the OAuth client id
• clientSecret: Required. This is the OAuth client secret
• redirectUri: Required. This is the redirect URI for OAuth callbacks
• apiVersion: Optional. This is a number or string representing a valid REST API version. Default is v24.0.
• environment: Optional. Values can be 'production' or 'sandbox'. Default is production.

The following list of methods are available for an nforce connection object:

getAuthUri()

This is a helper method to build the authentication uri for a authorization code OAuth 2.0 flow.

authenticate(opts, callback)

This method requests the OAuth access token and instance information from Salesforce. This method either requires that you pass in the authorization code (authorization code flow) or username and password (username/password flow).

• code: (String) An OAuth authorization code

-- OR --

• username: (String) Your salesforce/force.com/database.com username
• password: (String) Your salesforce/force.com/database.com password

getVersions(callback)

Gets the salesforce versions. Note: Does not require authentication.

getResources(oauth, callback)

Gets the available resources

getSObjects(oauth, callback)

Get all sObjects for an org

getMetadata(type, oauth, callback)

Get metadata for a single sObject. type is a required String for the sObject type

getDescribe(type, oauth, callback)

Get describe information for a single sObject. type is a required String for the sObject type

insert(data, oauth, callback)

Insert a record. data is an object with the following properties:

• type: (String) sObject type
• fieldValues: (Object) contains field names and values

update(data, oauth, callback)

Update a record. data is an object with the following properties:

• type: (String) sObject type
• id: (String) the id of the record
• fieldValues: (Object) contains field names and values

upsert(data, oauth, callback)

Update a record. data is an object with the following properties:

• type: (String) sObject type
• externalId: (String) the external id of the record
• externalIdField: (String) the external id field to be used for upserting
• fieldValues: (Object) contains field names and values

delete(data, oauth, callback)

Delete a record. data is an object with the following properties:

• type: (String) sObject type
• id: (String) the id of the record

getRecord(data, oauth, callback)

Get a single record. data is an object with the following properties:

• type: (String) sObject type
• id: (String) the id of the record

query(query, oauth, callback)

Execute a SOQL query for records. query should be a SOQL string.

search(search, oauth, callback)

Execute a SOSL search for records. search should be a SOSL string.

getUrl(url, oauth, callback)

Get a REST API resource by its url. url should be a REST API resource.

Todo

• Blob data support
• User password management
• Implement tests
• Continue with caching capabilities for describe/metadata calls
• Chatter support

Changelog

• v0.0.1: Initial release. OAuth, CRUD, describes