Merge commit '644f73f6cbc178c8027352bead29eeff38154cfc'

Author: Jenkins User

examples/deal-updates.js

@@ -0,0 +1,34 @@
+/*!
+ * This basic example shows how to fetch updates to
+ * a deal
+ *
+ * It starts by fetching the first deal from the
+ * account, it then fetches 10 updates of this deal.
+ *
+ * Usage:
+ * node deal-updates.js APITOKEN
+**/
+
+if (!process.argv[2]) {
+	process.stderr.write('Please provide API token!' + "\n");
+	process.exit();
+}
+
+var Pipedrive = require(__dirname + '/../index');
+var pipedrive = new Pipedrive.Client(process.argv[2]);
+var _ = require('lodash');
+
+pipedrive.Deals.getAll({ start: 0, limit: 1 }, function(dealsListErr, dealsList) {
+	if (dealsListErr) console.log(dealsListErr);
+	var deal = _.first(dealsList);
+
+	console.log('Deal '+ deal.title + ' (' + deal.value + ' ' + deal.currency + ')')
+
+	deal.getUpdates(function(err, updates) {
+		if (err) console.log(err);
+		_.each(updates, function(update) {
+			console.log(update.object + ' from ' + update.timestamp.split(' ')[0] + ':');
+			console.log(JSON.stringify(update.data) + '\n');
+		});
+	});
+});

lib/CollectionItem.js

@@ -102,7 +102,20 @@
 				methodSuffix = inflection.singularize(methodSuffix);
 			}
 
-			var objectKey = kind + '/' + currentItem.id + '/' + relatedObject;
+			// All sub-objects are fetched from URLs using their real names.
+			var relatedObjectEndpoint = relatedObject;
+
+			// However, there are a couple of exceptions...
+			var relatedObjectEndpointMapping = {
+				'updates': 'flow'
+			};
+
+			// ...which will be used instead of their real names.
+			if (relatedObjectEndpointMapping.hasOwnProperty(relatedObject)) {
+				relatedObjectEndpoint = relatedObjectEndpointMapping[relatedObject];
+			}
+
+			var objectKey = kind + '/' + currentItem.id + '/' + relatedObjectEndpoint;
 
 			currentItem[methodType + methodSuffix] = function(params, callback) {
 
@@ -112,8 +125,13 @@
 					callback = function() {};
 				}
 
+				// The assumption here is that the related object is managed under the main object in terms of API URLs.
+				// e.g. GET and POST both use /v1/deals/:id/products as the API URL.
 				var relatedObjectPath = relatedObject;
 
+				// However, self-managed related objects refers to a list of objects that are fetched as sub-objects
+				// (e.g. /v1/mainObjects/:id/subObjectName) but then modified as main objects (/v1/subObjectName) when
+				// it comes to API URL mapping.
 				if (blueprint.selfManagedRelatedObjects.indexOf(relatedObject) !== -1) {
 					relatedObjectPath = objectKey;
 				}

package.json

@@ -35,6 +35,8 @@
   },
   "devDependencies": {
     "chai": "^4.1.2",
-    "mocha": "^3.2.0"
+    "mocha": "^3.2.0",
+    "proxyquire": "^2.0.1",
+    "sinon": "^3.2.0"
   }
 }

test/integration/client.js

@@ -1,5 +1,6 @@
 var Pipedrive = require('./../..');
 var assert = require('chai').assert;
+var _ = require('lodash');
 
 var API_TOKEN = process.env.API_TOKEN;
 if (!API_TOKEN) {
@@ -16,7 +17,35 @@ describe('client', function () {
 		strictClient = new Pipedrive.Client(API_TOKEN, {strictMode: true});
 	});
 
-	describe('.getAll()', function () {
+
+	describe('client.on()', function () {
+		it('should allow event binding to connect and deal adding', function (done) {
+			this.timeout(10000);
+
+			var deal = {title: 'Client-nodejs - .on() test', value: 10000, currency: 'EUR'};
+
+			strictClient.on('connect', function () {
+				strictClient.Deals.add(deal, function (error, result) {
+					deal.id = result.id;
+				});
+			});
+
+			strictClient.on('deal.added', function (event, data) {
+				assert.equal(data.current.title, deal.title);
+				assert.equal(data.current.value, deal.value);
+				assert.equal(data.current.currency, deal.currency);
+
+				strictClient.removeAllListeners();
+
+				//cleanup
+				strictClient.Deals.remove(deal.id, function () {
+					done();
+				});
+			});
+		});
+	});
+
+	describe('collection.getAll()', function () {
 		it('should list filters and deals', function (done) {
 			client.Filters.getAll({type: 'deals'}, function (filtersListErr, filtersList) {
 
@@ -37,7 +66,7 @@ describe('client', function () {
 		});
 	});
 
-	describe('.add() & .getItem()', function () {
+	describe('collection.add() & collection.getItem()', function () {
 		it('should create and get deal', function (done) {
 
 			var payloadDeal = {
@@ -66,34 +95,7 @@ describe('client', function () {
 		});
 	});
 
-	describe('.on()', function () {
-		it('should allow event binding to connect and deal adding', function (done) {
-			this.timeout(10000);
-
-			var deal = {title: 'Client-nodejs - .on() test', value: 10000, currency: 'EUR'};
-
-			strictClient.on('connect', function () {
-				strictClient.Deals.add(deal, function (error, result) {
-					deal.id = result.id;
-				});
-			});
-
-			strictClient.on('deal.added', function (event, data) {
-				assert.equal(data.current.title, deal.title);
-				assert.equal(data.current.value, deal.value);
-				assert.equal(data.current.currency, deal.currency);
-
-				strictClient.removeAllListeners();
-
-				//cleanup
-				strictClient.Deals.remove(deal.id, function () {
-					done();
-				});
-			});
-		});
-	});
-
-	describe('.find()', function () {
+	describe('сollection.find()', function () {
 		it('should find first person by name', function (done) {
 			client.Persons.getAll(function (err, listedPersons) {
 				assert.isTrue(listedPersons.length > 0);
@@ -108,5 +110,21 @@ describe('client', function () {
 				});
 			});
 		})
+	});
+
+	describe('item.getUpdates()', function () {
+		it('should get changes deal had', function (done) {
+			client.Deals.getAll({start: 0, limit: 1}, function (dealsListErr, dealsList) {
+				if (dealsListErr) console.log(dealsListErr);
+				var deal = _.first(dealsList);
+
+				deal.getUpdates(function (err, updates) {
+					assert.isTrue(updates.length > 0);
+					assert.equal(updates[0].object, 'dealChange');
+
+					done();
+				});
+			});
+		});
 	})
 });

test/unit/CollectionItem.js

@@ -0,0 +1,67 @@
+var assert = require('chai').assert,
+	path = require('path'),
+	proxyquire = require('proxyquire'),
+	sinon = require('sinon');
+
+describe('CollectionItem', function () {
+
+	var item;
+
+	var restHandlersPath = path.normalize(__dirname + '/../../lib/restHandlers');
+
+	var restHandlerMock = {
+		editItem: sinon.spy(),
+		listItems: sinon.spy()
+	};
+
+	var initWithMocks = function () {
+		var stubs = {};
+		stubs[restHandlersPath] = function () {
+			return restHandlerMock
+		};
+
+		var CollectionItem = proxyquire('./../../lib/CollectionItem', stubs);
+
+		item = new CollectionItem('deals', {
+			title: 'Deal title'
+		}, 1);
+
+		return item;
+	};
+
+	beforeEach(function () {
+		item = initWithMocks(restHandlerMock);
+	});
+
+	it('should return object', function () {
+		console.log(item);
+		assert.isObject(item);
+		assert.isFunction(item.getUpdates);
+	});
+
+	describe('subMethods', function () {
+		it('should be generated for deal products', function () {
+			assert.isFunction(item.addProduct);
+			assert.isFunction(item.updateProduct);
+			assert.isFunction(item.deleteProduct);
+		});
+
+		it('.getUpdates() should call restHandler.editItem()', function () {
+			item.getUpdates({
+				id: 3
+			});
+
+			sinon.assert.calledOnce(restHandlerMock.listItems);
+			sinon.assert.calledWith(restHandlerMock.listItems, 'deals/1/flow', {id: 3});
+		});
+
+		it('.updateProduct() should call restHandler.editItem()', function () {
+			item.updateProduct({
+				id: 2
+			});
+
+			sinon.assert.calledOnce(restHandlerMock.editItem);
+			sinon.assert.calledWith(restHandlerMock.editItem, 2, 'deals/1/products', {id: 2});
+		});
+	});
+});