path-proxy

Given an group of paths (say, from an API schema), you might need to create a set of proxy objects for interacting with those paths. This is the situation I found myself in while working on the Node client for the Heroku API.

Given a set of paths and a base constructor function, path-proxy will create a network of logical proxy objects based on the paths and attach it to the constructor's prototype.

Install

1npm install path-proxy --save

Usage

1var pathProxy = require('path-proxy');
2
3function ApiClient() {}
4
5pathProxy.proxy(ApiClient, [
6  "/foo",
7  "/foo/{id}/bar"
8]);
9
10var client = new ApiClient();
11client.foo("qux").bar();

This may not appear all that useful—they're mostly just empty functions—until you start mucking around with their prototypes:

1var BarProxy = pathProxy.pathProxy(ApiClient, "/foo/{id}/bar");
2BarProxy.prototype.sayHello = function () {
3  console.log("hello");
4};
5
6client.foo("qux").bar().sayHello(); // Logs "hello".

They also have access to a few useful attributes:

1var baz = client.foo("qux").bar("baz");
2baz.params;       // ["qux", "baz"]
3baz.pathSegments; // ["foo", "qux", "bar", "baz"]
4baz.path;         // "/foo/qux/bar/baz"

And can access the instance of the base constructor they're based off of:

1ApiClient.prototype.delete = function (path, callback) {
2  var message = this.name + " deleted at " + path;
3  callback(message);
4};
5
6var client = new ApiClient();
7client.name = "Jonathan";
8
9BarProxy.prototype.delete = function (callback) {
10  this.base.delete(this.path, callback);
11};
12
13// This:
14client.foo("qux").bar("baz").delete(function (message) {
15  // message == "Jonathan deleted at /foo/qux/bar/baz"
16});
17
18// Is equivalent to this:
19client.delete("/foo/qux/bar/baz", function (message) {
20  // message == "Jonathan deleted at /foo/qux/bar/baz"
21});

Tests

path-proxy uses jasmine-node for tests. To run them:

1$ npm install
2$ npm test