productid is no longer required field for revenue logged via logrevenuev2

djih · djih · commit 581167bd77ca · 2016-07-05T16:42:03.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 ## Unreleased
 
+* `productId` is no longer a required field for `Revenue` logged via `logRevenueV2`.
+
 ### 3.0.1 (June 22, 2016)
 
 * Update README with link to our [Google Tag Manager integration demo app](https://github.com/amplitude/GTM-Web-Demo).
diff --git a/README.md b/README.md
@@ -270,7 +270,7 @@ var revenue = new amplitude.Revenue().setProductId('com.company.productId').setP
 amplitude.getInstance().logRevenueV2(revenue);
 ```
 
-`productId` and `price` are required fields. `quantity` defaults to 1 if not specified. Each field has a corresponding `set` method (for example `setProductId`, `setQuantity`, etc). This table describes the different fields available:
+`price` is a required field. `quantity` defaults to 1 if not specified. Each field has a corresponding `set` method (for example `setProductId`, `setQuantity`, etc). This table describes the different fields available:
 
 | Name               | Type       | Description                                                                                              | default |
 |--------------------|------------|----------------------------------------------------------------------------------------------------------|---------|
diff --git a/amplitude.js b/amplitude.js
@@ -3813,14 +3813,14 @@ var utils = require('./utils');
 
 /*
  * Wrapper for logging Revenue data. Revenue objects get passed to amplitude.logRevenueV2 to send to Amplitude servers.
- * Note: productId and price are required fields. If quantity is not specified, then defaults to 1.
+ * Note: price is the only required field. If quantity is not specified, then defaults to 1.
  */
 
 /**
  * Revenue API - instance constructor. Revenue objects are a wrapper for revenue data.
  * Each method updates a revenue property in the Revenue object, and returns the same Revenue object,
  * allowing you to chain multiple method calls together.
- * Note: productId and price are required fields to log revenue events.
+ * Note: price is a required field to log revenue events.
  * If quantity is not specified then defaults to 1.
  * See [Readme]{@link https://github.com/amplitude/Amplitude-Javascript#tracking-revenue} for more information
  * about logging Revenue.
@@ -3830,17 +3830,17 @@ var utils = require('./utils');
  */
 var Revenue = function Revenue() {
   // required fields
-  this._productId = null;
-  this._quantity = 1;
   this._price = null;
 
   // optional fields
+  this._productId = null;
+  this._quantity = 1;
   this._revenueType = null;
   this._properties = null;
 };
 
 /**
- * Set a value for the product identifer. This field is required for all revenue being logged.
+ * Set a value for the product identifer.
  * @public
  * @param {string} productId - The value for the product identifier. Empty and invalid strings are ignored.
  * @return {Revenue} Returns the same Revenue object, allowing you to chain multiple method calls together.
@@ -3932,10 +3932,6 @@ Revenue.prototype.setEventProperties = function setEventProperties(eventProperti
  * @private
  */
 Revenue.prototype._isValidRevenue = function _isValidRevenue() {
-  if (type(this._productId) !== 'string' || utils.isEmptyString(this._productId)) {
-    utils.log('Invalid revenue, need to set productId field');
-    return false;
-  }
   if (type(this._price) !== 'number') {
     utils.log('Invalid revenue, need to set price field');
     return false;
diff --git a/amplitude.min.js b/amplitude.min.js
diff --git a/documentation/Amplitude.html b/documentation/Amplitude.html
@@ -3137,7 +3137,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/AmplitudeClient.html b/documentation/AmplitudeClient.html
@@ -2791,7 +2791,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/Identify.html b/documentation/Identify.html
@@ -1295,7 +1295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/Revenue.html b/documentation/Revenue.html
@@ -50,7 +50,7 @@ <h4 class="name" id="Revenue"><span class="type-signature"></span>new Revenue<sp
     Revenue API - instance constructor. Revenue objects are a wrapper for revenue data.
 Each method updates a revenue property in the Revenue object, and returns the same Revenue object,
 allowing you to chain multiple method calls together.
-Note: productId and price are required fields to log revenue events.
+Note: price is a required field to log revenue events.
 If quantity is not specified then defaults to 1.
 See <a href="https://github.com/amplitude/Amplitude-Javascript#tracking-revenue">Readme</a> for more information
 about logging Revenue.
@@ -478,7 +478,7 @@ <h4 class="name" id="setProductId"><span class="type-signature"></span>setProduc
 
 
 <div class="description">
-    Set a value for the product identifer. This field is required for all revenue being logged.
+    Set a value for the product identifer.
 </div>
 
 
@@ -965,7 +965,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/amplitude-client.js.html b/documentation/amplitude-client.js.html
@@ -1170,7 +1170,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/amplitude.js.html b/documentation/amplitude.js.html
@@ -409,7 +409,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/identify.js.html b/documentation/identify.js.html
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/index.html b/documentation/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/revenue.js.html b/documentation/revenue.js.html
@@ -32,14 +32,14 @@ <h1 class="page-title">Source: revenue.js</h1>
 
 /*
  * Wrapper for logging Revenue data. Revenue objects get passed to amplitude.logRevenueV2 to send to Amplitude servers.
- * Note: productId and price are required fields. If quantity is not specified, then defaults to 1.
+ * Note: price is the only required field. If quantity is not specified, then defaults to 1.
  */
 
 /**
  * Revenue API - instance constructor. Revenue objects are a wrapper for revenue data.
  * Each method updates a revenue property in the Revenue object, and returns the same Revenue object,
  * allowing you to chain multiple method calls together.
- * Note: productId and price are required fields to log revenue events.
+ * Note: price is a required field to log revenue events.
  * If quantity is not specified then defaults to 1.
  * See [Readme]{@link https://github.com/amplitude/Amplitude-Javascript#tracking-revenue} for more information
  * about logging Revenue.
@@ -49,17 +49,17 @@ <h1 class="page-title">Source: revenue.js</h1>
  */
 var Revenue = function Revenue() {
   // required fields
-  this._productId = null;
-  this._quantity = 1;
   this._price = null;
 
   // optional fields
+  this._productId = null;
+  this._quantity = 1;
   this._revenueType = null;
   this._properties = null;
 };
 
 /**
- * Set a value for the product identifer. This field is required for all revenue being logged.
+ * Set a value for the product identifer.
  * @public
  * @param {string} productId - The value for the product identifier. Empty and invalid strings are ignored.
  * @return {Revenue} Returns the same Revenue object, allowing you to chain multiple method calls together.
@@ -151,10 +151,6 @@ <h1 class="page-title">Source: revenue.js</h1>
  * @private
  */
 Revenue.prototype._isValidRevenue = function _isValidRevenue() {
-  if (type(this._productId) !== 'string' || utils.isEmptyString(this._productId)) {
-    utils.log('Invalid revenue, need to set productId field');
-    return false;
-  }
   if (type(this._price) !== 'number') {
     utils.log('Invalid revenue, need to set price field');
     return false;
@@ -200,7 +196,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Jun 22 2016 14:19:08 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jul 05 2016 16:41:28 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/src/revenue.js b/src/revenue.js
@@ -4,14 +4,14 @@ var utils = require('./utils');
 
 /*
  * Wrapper for logging Revenue data. Revenue objects get passed to amplitude.logRevenueV2 to send to Amplitude servers.
- * Note: productId and price are required fields. If quantity is not specified, then defaults to 1.
+ * Note: price is the only required field. If quantity is not specified, then defaults to 1.
  */
 
 /**
  * Revenue API - instance constructor. Revenue objects are a wrapper for revenue data.
  * Each method updates a revenue property in the Revenue object, and returns the same Revenue object,
  * allowing you to chain multiple method calls together.
- * Note: productId and price are required fields to log revenue events.
+ * Note: price is a required field to log revenue events.
  * If quantity is not specified then defaults to 1.
  * See [Readme]{@link https://github.com/amplitude/Amplitude-Javascript#tracking-revenue} for more information
  * about logging Revenue.
@@ -21,17 +21,17 @@ var utils = require('./utils');
  */
 var Revenue = function Revenue() {
   // required fields
-  this._productId = null;
-  this._quantity = 1;
   this._price = null;
 
   // optional fields
+  this._productId = null;
+  this._quantity = 1;
   this._revenueType = null;
   this._properties = null;
 };
 
 /**
- * Set a value for the product identifer. This field is required for all revenue being logged.
+ * Set a value for the product identifer.
  * @public
  * @param {string} productId - The value for the product identifier. Empty and invalid strings are ignored.
  * @return {Revenue} Returns the same Revenue object, allowing you to chain multiple method calls together.
@@ -123,10 +123,6 @@ Revenue.prototype.setEventProperties = function setEventProperties(eventProperti
  * @private
  */
 Revenue.prototype._isValidRevenue = function _isValidRevenue() {
-  if (type(this._productId) !== 'string' || utils.isEmptyString(this._productId)) {
-    utils.log('Invalid revenue, need to set productId field');
-    return false;
-  }
   if (type(this._price) !== 'number') {
     utils.log('Invalid revenue, need to set price field');
     return false;
diff --git a/test/revenue.js b/test/revenue.js
@@ -98,7 +98,7 @@ describe('Revenue', function() {
     assert.isFalse(revenue2._isValidRevenue());
     revenue2.setPrice(10.99);
     revenue2.setQuantity(15);
-    assert.isFalse(revenue2._isValidRevenue());
+    assert.isTrue(revenue2._isValidRevenue());
     revenue2.setProductId('testProductId');
     assert.isTrue(revenue2._isValidRevenue());
   });
