Merge pull request #1 from intercom/BL/users

Create/update/list users

Author: bobjflong

.eslintrc

@@ -145,7 +145,7 @@
         "args": "after-used"
       }
     ],
-    "camelcase": 2,
+    "camelcase": 0,
     "comma-spacing": 2,
     "new-cap": 2,
     "new-parens": 2,

README.md

@@ -7,6 +7,67 @@
 npm test
 ```
 
+## Running the code locally
+
+Compile using babel:
+
+```
+gulp babel
+```
+
+Start a repl:
+
+```
+node
+```
+
+Require Intercom:
+
+```node
+var Intercom = require('./dist/index');
+```
+
+Create a client:
+
+```node
+var client = new Intercom.Client("app_id", "app_api_key");
+```
+
+## Users
+
+```node
+// Create/update a user
+client.users.create({ email: "[email protected]" }, function (r) {
+  console.log(r);
+});
+```
+
+```node
+// List users
+client.users.list(function (d) { console.log(d.body.users.length) });
+```
+
+```node
+// List users by tag or segment
+client.users.listBy({ tag_id: 'haven' }, function (d) {
+  console.log(d.body.users.length)
+});
+```
+
+```node
+// Find user by id
+client.users.find({ id: '1234' }, function (d) {
+  console.log(d.body)
+});
+```
+
+```node
+// Delete user by id
+client.users.delete({ id: '1234' }, function (d) {
+  console.log(d.body)
+});
+```
+
 ## License
 
 Apache-2.0

lib/client.js

@@ -1,14 +1,41 @@
 var unirest = require('unirest');
+import {User} from './user';
 
 export class Client {
   constructor(appId, appApiKey) {
     this.appId = appId;
     this.appApiKey = appApiKey;
+    this.users = new User(this);
   }
   ping(f) {
     unirest.get('https://api.intercom.io/admins')
+    .auth(this.appId, this.appApiKey)
+    .type('json')
     .header('Accept', 'application/json')
-    .header('Content-Type', 'application/json')
     .end(r => f(r.status));
   }
+  post(endpoint, data, f) {
+    unirest.post(`https://api.intercom.io${endpoint}`)
+    .auth(this.appId, this.appApiKey)
+    .type('json')
+    .send(data)
+    .header('Accept', 'application/json')
+    .end(r => f(r));
+  }
+  get(endpoint, data, f) {
+    unirest.get(`https://api.intercom.io${endpoint}`)
+    .auth(this.appId, this.appApiKey)
+    .type('json')
+    .query(data)
+    .header('Accept', 'application/json')
+    .end(r => f(r));
+  }
+  delete(endpoint, data, f) {
+    unirest.delete(`https://api.intercom.io${endpoint}`)
+    .auth(this.appId, this.appApiKey)
+    .type('json')
+    .query(data)
+    .header('Accept', 'application/json')
+    .end(r => f(r));
+  }
 }

lib/index.js

@@ -1 +1,2 @@
-export * from '../lib/client';
+export * from './client';
+export * from './user';

lib/user.js

@@ -0,0 +1,20 @@
+export class User {
+  constructor(client) {
+    this.client = client;
+  }
+  create(data, f) {
+    this.client.post('/users', data, f);
+  }
+  list(f) {
+    this.client.get('/users', {}, f);
+  }
+  listBy(params, f) {
+    this.client.get('/users', params, f);
+  }
+  find(params, f) {
+    this.client.get(`/users/${params.id}`, {}, f);
+  }
+  delete(params, f) {
+    this.client.delete(`/users/${params.id}`, {}, f);
+  }
+}

package.json

@@ -30,7 +30,8 @@
     "gulp-nsp": "^0.4.5",
     "gulp-babel": "^5.1.0",
     "babel-core": "^5.5.0",
-    "nock" : "*"
+    "nock" : "*",
+    "locus" : "*"
   },
   "scripts": {
     "prepublish": "gulp prepublish",

test/user.js

@@ -0,0 +1,46 @@
+import assert from 'assert';
+import {Client} from '../lib';
+var nock = require('nock');
+
+describe('users', function () {
+  it('should be created', function (done) {
+    nock('https://api.intercom.io').post('/users', { email: '[email protected]' }).reply(200, {});
+    let client = new Client('foo', 'bar');
+    client.users.create({ email: '[email protected]' }, function (r) {
+      assert.equal(200, r.status);
+      done();
+    });
+  });
+  it('should list', function (done) {
+    nock('https://api.intercom.io').get('/users').reply(200, {});
+    let client = new Client('foo', 'bar');
+    client.users.list(function (r) {
+      assert.equal(200, r.status);
+      done();
+    });
+  });
+  it('should list by params', function (done) {
+    nock('https://api.intercom.io').get('/users').query({ tag_id: '1234' }).reply(200, {});
+    let client = new Client('foo', 'bar');
+    client.users.listBy({ tag_id: '1234' }, function (r) {
+      assert.equal(200, r.status);
+      done();
+    });
+  });
+  it('find users by id', function (done) {
+    nock('https://api.intercom.io').get('/users/baz').reply(200, {});
+    let client = new Client('foo', 'bar');
+    client.users.find({ id: 'baz' }, function (r) {
+      assert.equal(200, r.status);
+      done();
+    });
+  });
+  it('deletes users by id', function (done) {
+    nock('https://api.intercom.io').delete('/users/baz').reply(200, {});
+    let client = new Client('foo', 'bar');
+    client.users.delete({ id: 'baz' }, function (r) {
+      assert.equal(200, r.status);
+      done();
+    });
+  });
+});