nforce plugin system example

myplugin.js

// example nforce plugin

module.exports = function(nforce) {

  // throws if the plugin already exists
  var plugin = nforce.plugin('myplugin');
  
  // simple example
  plugin.fn('foo', function() {
    return 'bar'
  });
  
  // using a callback
  plugin.fn('getApiVersion', function(cb) {
    if(!this.apiVersion) {
      return cb(new Error('No API version specified'));
    } else {
      cb(null, 'The current ApiVersion is ' + this.apiVersion);
    }
  });

  // using exposed util functions
  plugin.fn('doValidateOAuth', function(oauth) {
    return plugin.util.validateOAuth(oauth);
  });

}

usage.js

var nforce       = require('nforce');
var sfuser       = process.env.SFUSER;
var sfpass       = process.env.SFPASS;
var clientId     = process.env.CLIENT_ID;
var clientSecret = process.env.CLIENT_SECRET;

// load the plugin
require('myplugin')(nforce);

var org = nforce.createConnection({
  clientId:     clientId,
  clientSecret: clientSecret,
  redirectUri: 'http://localhost:3000/oauth/_callback',
  plugins:     ['myplugin'] // make sure you enable it when creating a connection
});

console.log(org.myplugin.foo()); // => 'bar'

org.myplugin.getApiVersion(function(err, msg) {
  if(err) throw err;
  console.log(msg); // => current api version
});

console.log(org.myplugin.doValidateOAuth({ invalid: 'oauth' })); // => 'false'