gofer-blog

cached-call.js

var entityId = 'xy';
var loadEntity = cached.deferred(_.partial(myService.fetch, '/entity/' + entityId));
cached('myService').getOrElse(entityId, loadEntity, function(err, entity) {
  // 80% of time this works every time
});

calling-cats.js

// will be logged with serviceName=myService, endpointName=cats, methodName=index
myService.cats.index(cb);
// will be logged with serviceName=myService, endpointName=cats, methodName=put
myService.cats.save('kitty', { fur: 'fluffy' }, cb);

cats-endpoint.js

var goferFor = require('gofer');
var MyService = goferFor('myService'); // serviceName = myService
MyService.registerEndpoints({
  // endpointName = cats
  cats: function(request) {
    return {
      index: function(cb) {
        return request({ uri: '/cats', methodName: 'index' }, cb);
      },
      show: function(id, cb) {
        return request({ uri: '/cats/' + id, methodName: 'show' }, cb);
      },
      save: function(id, data, cb) {
        return request({ uri: '/cats/' + id, json: data }, cb);
      }
    };
  }
});

configuration.cson

globalDefaults:
  connectTimeout: 100
  timeout: 2000
myApi:
  baseUrl: "https://my-api"
  qs:
    client_id: "SOME_CLIENT_ID"
github:
  baseUrl: "https://api.github.com/v3"
  clientId: "XXX"
  clientSecret: "XYZ"

hub-instrumentation.js

var http = require('http');
var Hub = require('gofer/hub');
var MyService = require('my-service-gofer');
var OtherService = require('other-service-gofer');

var hub = new Hub();

hub.on('success', function() {});
hub.on('socketQueueing', function() {});
// ...

http.createServer(function(req, res) {
  var requestId = req.headers['x-request-id'] || generateUUID();
  var config = { globalDefaults: { requestId: requestId } };

  var myService = new MyService(config, hub);
  var otherService = new OtherService(config, hub);

  myService.fetch('/some-url').pipe(res);
}).listen(process.env.PORT || 3000);

my-api-fetch.js

myApi.fetch({ uri: '/cats' });

my-api-verbose.js

request({
  connectTimeout: 100, // from globalDefaults
  timeout: 2000,
  baseUrl: 'https://my-api', // from service defaults
  qs: { client_id: 'SOME_CLIENT_ID' },
  uri: '/cats' // explicit options
});

oauth-mapper.js

function addOAuth2Token(options) {
  if (options.accessToken) {
    options.headers = options.headers || {};
    options.headers.authorization = 'token ' + options.accessToken;
    delete options.accessToken;
  }
  return options;
}