Merge pull request #25 from button/ty/DLC-4556

added Links API

Author: Tyler Nappy

CHANGELOG.md

@@ -1,6 +1,9 @@
 Current Version
  -
 
+2.8.0 December 5, 2017
+  - Add Links API
+
 2.7.0 November 6, 2017
   - Add get orders by button ref
 

README.md

@@ -300,6 +300,32 @@ client.customers.get('customer-1234', function(err, res) {
 });
 ```
 
+### Links
+
+##### Create
+
+```javascript
+client.links.create({
+  url: "https://www.jet.com",
+  experience: {
+    btn_pub_ref: "my-pub-ref",
+    btn_pub_user: "user-id"
+  }
+}, function(err, res) {
+  // ...
+});
+```
+
+##### Get Info
+
+```javascript
+client.links.getInfo({
+  url: "https://www.jet.com"
+}, function(err, res) {
+  // ...
+});
+```
+
 ## Utils
 
 Utils houses generic helpers useful in a Button Integration.

index.js

@@ -67,6 +67,7 @@ function client(apiKey, config) {
   return {
     accounts: resources.accounts(requestOptions, maybePromiseRequest),
     customers: resources.customers(requestOptions, maybePromiseRequest),
+    links: resources.links(requestOptions, maybePromiseRequest),
     merchants: resources.merchants(requestOptions, maybePromiseRequest),
     orders: resources.orders(requestOptions, maybePromiseRequest)
   };

lib/resources/index.js

@@ -3,6 +3,7 @@
 module.exports = {
   accounts: require('./accounts'),
   customers: require('./customers'),
+  links: require('./links'),
   merchants: require('./merchants'),
   orders: require('./orders')
 };

lib/resources/links.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var merge = require('../merge');
+
+function links(requestOptions, maybePromiseRequest) {
+  return {
+    create: function create(link, callback) {
+      //
+      // Creates a link.
+      //
+      // @param {Object} link object of link information
+      // @callback invoked iff config.promise isn't valid
+      // @returns {Object=} a promise or undefined, depending on
+      //   `config.promise`
+      //
+      var options = merge(requestOptions, {
+        method: 'POST',
+        path: '/v1/links'
+      });
+
+      return maybePromiseRequest(options, link, callback);
+    },
+    getInfo: function getInfo(link, callback) {
+      //
+      // Gets information for a link.
+      //
+      // @param {Object} link object of link information
+      // @callback invoked iff config.promise isn't valid
+      // @returns {Object=} a promise or undefined, depending on
+      //   `config.promise`
+      //
+      var options = merge(requestOptions, {
+        method: 'POST',
+        path: '/v1/links/info'
+      });
+
+      return maybePromiseRequest(options, link, callback);
+    }
+  };
+}
+
+module.exports = links;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@button/button-client-node",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "node.js client for the Button Order API",
   "repository": {
     "type": "git",

test/lib/resources/links-test.js

@@ -0,0 +1,124 @@
+'use strict';
+
+var expect = require('expect.js');
+var nock = require('nock');
+var Q = require('q');
+
+var client = require('../../../index');
+
+describe('lib/resources/links', function() {
+
+  before(function() {
+    nock.disableNetConnect();
+
+    var config = {
+      promise: function(resolver) { return Q.Promise(resolver); }
+    };
+
+    this.callbackClient = client('sk-XXX').links;
+    this.promiseClient = client('sk-XXX', config).links;
+  });
+
+  after(function() {
+    nock.enableNetConnect();
+  });
+
+  describe('#create', function() {
+
+    beforeEach(function() {
+      this.url = 'https://www.jet.com/';
+      this.experience = {
+        btn_pub_ref: 'my-pub-ref',
+        btn_pub_user: 'user-id'
+      };
+
+      this.payload = {
+        url: this.url,
+        experience: this.experience
+      };
+
+      this.link = {
+        merchant_id: 'org-XXX',
+        affiliate: null,
+        links: {
+          universal: 'https://r.bttn.io?btn_pub_ref=my-pub-ref&btn_pub_user=user-id&btn_url=https%3A%2F%2Fwww.jet.com&btn_ref=org-XXX'
+        }
+      };
+
+      this.scope = nock('https://api.usebutton.com:443')
+        .post('/v1/links', this.payload)
+        .reply(200, { meta: { status: 'ok' }, 'object': this.link });
+    });
+
+    it('creates a link with a callback', function(done) {
+      this.callbackClient.create(this.payload, function(err, res) {
+        expect(err).to.be(null);
+        expect(res.data).to.eql(this.link);
+        this.scope.done();
+        done();
+      }.bind(this));
+    });
+
+    it('creates a link with a promise', function(done) {
+      this.promiseClient.create(this.payload).then(function(result) {
+        expect(result.data).to.eql(this.link);
+        this.scope.done();
+        done();
+      }.bind(this)).catch(done);
+    });
+
+  });
+
+  describe('#getInfo', function() {
+
+    beforeEach(function() {
+      this.url = 'https://www.jet.com/';
+
+      this.payload = {
+        url: this.url
+      };
+
+      this.link = {
+        organization_id: 'org-XXX',
+        approved: true,
+        ios_support: {
+          app_to_web: true,
+          app_to_app: true,
+          web_to_web: true,
+          web_to_app: false,
+          web_to_app_with_install: false
+        },
+        android_support: {
+          app_to_web: true,
+          app_to_app: true,
+          web_to_web: true,
+          web_to_app: false,
+          web_to_app_with_install: false
+        }
+      };
+
+      this.scope = nock('https://api.usebutton.com:443')
+        .post('/v1/links/info', this.payload)
+        .reply(200, { meta: { status: 'ok' }, 'object': this.link });
+    });
+
+    it('gets information for a link with a callback', function(done) {
+      this.callbackClient.getInfo(this.payload, function(err, res) {
+        expect(err).to.be(null);
+        expect(res.data).to.eql(this.link);
+        this.scope.done();
+        done();
+      }.bind(this));
+    });
+
+    it('gets information for a link with a promise', function(done) {
+      this.promiseClient.getInfo(this.payload).then(function(result) {
+        expect(result.data).to.eql(this.link);
+        this.scope.done();
+        done();
+      }.bind(this)).catch(done);
+    });
+
+  });
+
+});