Salesforce.js

/*
  model.js

  This file is required. It must export a class with at least one public function called `getData`

  Documentation: http://koopjs.github.io/docs/specs/provider/
*/
const request = require('request').defaults({ gzip: true, json: true })
const config = require('config')

function Salesforce (koop) {}

// Public function to return data from the
// Return: GeoJSON FeatureCollection
//
// Config parameters (config/default.json)
// req.
//
// URL path parameters:
// req.params.host (if index.js:hosts true)
// req.params.id  (if index.js:disableIdParam false)
// req.params.layer
// req.params.method
Salesforce.prototype.getData = function (req, callback) {
  // Grab all the config data
  const clientSecret = config.Salesforce.clientSecret
  const clientId = config.Salesforce.clientId
  const securityToken = config.Salesforce.securityToken
  const url = config.Salesforce.url
  const username = (req.query && req.query.username) ? req.query.username : config.Salesforce.username
  const password = (req.query && req.query.password) ? req.query.password : config.Salesforce.password
  const accountFields = config.Salesforce.accountFields

  // Make the auth request
  request.post({
    url: url + '/services/oauth2/token',
    form: {
      grant_type: 'password',
      client_id: clientId,
      client_secret: clientSecret,
      username: username,
      password: password + securityToken // append security token to password
    }
  }, function (err, httpResponse, body) {
    if (err) {
      console.log('auth request failed: ' + err)
      return
    }

    var accessToken = body.access_token
    var requestOptions = {
      url: url + '/services/data/v30.0/query',
      auth: {
        bearer: accessToken
      }
    }

    // build Account data request
    requestOptions.url += '?q=SELECT'
    accountFields.forEach(function (field, index) {
      requestOptions.url += `+${field}`
      if (index < accountFields.length - 1) requestOptions.url += ','
    })
    requestOptions.url += '+FROM+Account'
    if (req.query && req.query.where && req.query.where !== '1=1') {
      req.query.where = req.query.where.replace(' AND (1=1)', '')
      requestOptions.url += '+WHERE+' + req.query.where
    }

    // Make the Account data request
    request.get(requestOptions, (err, httpResponse, body) => {
      if (err) return callback(err)

      // Translate geojson
      const geojson = translate(body)
      geojson.metadata = {
        title: 'Koop Salesforce Provider',
        name: 'Salesforce accounts',
        description: `Generated from ${url}`,
        displayField: 'Name',
        idField: 'OBJECTID',
        maxRecordCount: 10000,
        geometryType: 'Point' // Default is automatic detection in Koop
      }

      // Return result for serving to ArcGIS
      callback(null, geojson)
    })
  })
}

// TODO:
// Allow filtering
// URL to go back to Salesforce
// Work for large datasets

function translate (input) {
  return {
    type: 'FeatureCollection',
    features: input.records ? input.records.reduce(formatFeature, [], 0) : []
  }
}

function formatFeature (sum, inputFeature, index) {
  // Most of what we need to do here is extract the longitude and latitude
  const url = config.Salesforce.url

  // Delete this property because it's a JSON object
  if (inputFeature.attributes) {
    delete inputFeature.attributes
  }

  if (inputFeature.Id) {
    inputFeature.url = url + '/lightning/r/Account/' + inputFeature.Id + '/view'
  }

  // Make an objectID the index of the reduce function
  inputFeature.OBJECTID = index + 1

  if (inputFeature.BillingLongitude && inputFeature.BillingLatitude) {
    const feature = {
      type: 'Feature',
      properties: inputFeature,
      geometry: {
        type: 'Point',
        coordinates: [inputFeature.BillingLongitude, inputFeature.BillingLatitude]
      }
    }
    sum.push(feature)
  }
  return sum
}

module.exports = Salesforce

/* Example provider API:
   - needs to be converted to GeoJSON Feature Collection
{
  "resultSet": {
  "queryTime": 1488465776220,
  "vehicle": [
    {
      "tripID": "7144393",
      "signMessage": "Red Line to Beaverton",
      "expires": 1488466246000,
      "serviceDate": 1488441600000,
      "time": 1488465767051,
      "latitude": 45.5873117,
      "longitude": -122.5927705,
    }
  ]
}

Converted to GeoJSON:

{
  "type": "FeatureCollection",
  "features": [
    "type": "Feature",
    "properties": {
      "tripID": "7144393",
      "signMessage": "Red Line to Beaverton",
      "expires": "2017-03-02T14:50:46.000Z",
      "serviceDate": "2017-03-02T08:00:00.000Z",
      "time": "2017-03-02T14:42:47.051Z",
    },
    "geometry": {
      "type": "Point",
      "coordinates": [-122.5927705, 45.5873117]
    }
  ]
}
*/