Booking creation/update now accepts :name and :description; BookingResponse… (#30)

* adding examples for use of Body and Response helper objects

* Booking creation/update now accepts :name and :description; BookingResponse now includes :name, :description, :external_link, :collaborative_link [finishes #146990687]

Author: alexagranov

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.1.3] - 2017-06-18 ##
+### Added
+- [#30](https://github.com/gonebusy/gonebusy-nodejs-client/pull/30) - Booking creation/update now accept optional :name and :description
+- [#30](https://github.com/gonebusy/gonebusy-nodejs-client/pull/30) - Booking item response now contains :name, :description, :external_link, :collaborative_link
+
+### Changed
+- [#30](https://github.com/gonebusy/gonebusy-nodejs-client/pull/30) - Booking :user_message has been replaced by separate :name and :description
+
 ## [0.1.2] - 2017-06-14 ##
 ### Added
 - [#28](https://github.com/gonebusy/gonebusy-nodejs-client/pull/28) - Booking item response now includes :resource_id and :service_id corresponding to Resource providing the Booking and the Service being performed.

lib/Models/CreateBookingBody.js

@@ -31,6 +31,8 @@ class CreateBookingBody extends BaseModel {
         this.days = this.constructor.getValue(obj.days);
         this.occurrence = this.constructor.getValue(obj.occurrence);
         this.dateRecursBy = this.constructor.getValue(obj.dateRecursBy || obj.date_recurs_by);
+        this.name = this.constructor.getValue(obj.name);
+        this.description = this.constructor.getValue(obj.description);
     }
 
     /**
@@ -51,6 +53,8 @@ class CreateBookingBody extends BaseModel {
             { name: 'days', realName: 'days' },
             { name: 'occurrence', realName: 'occurrence' },
             { name: 'dateRecursBy', realName: 'date_recurs_by' },
+            { name: 'name', realName: 'name' },
+            { name: 'description', realName: 'description' },
         ]);
     }
 }

lib/Models/EntitiesBookingResponse.js

@@ -22,10 +22,15 @@ class EntitiesBookingResponse extends BaseModel {
         this.id = this.constructor.getValue(obj.id);
         this.ownerId = this.constructor.getValue(obj.ownerId || obj.owner_id);
         this.workflowState = this.constructor.getValue(obj.workflowState || obj.workflow_state);
-        this.userMessage = this.constructor.getValue(obj.userMessage || obj.user_message);
+        this.name = this.constructor.getValue(obj.name);
         this.timeWindow = this.constructor.getValue(obj.timeWindow || obj.time_window);
         this.resourceId = this.constructor.getValue(obj.resourceId || obj.resource_id);
         this.serviceId = this.constructor.getValue(obj.serviceId || obj.service_id);
+        this.description = this.constructor.getValue(obj.description);
+        this.externalLink = this.constructor.getValue(obj.externalLink || obj.external_link);
+        this.collaborativeLink =
+          this.constructor.getValue(obj.collaborativeLink
+     || obj.collaborative_link);
     }
 
     /**
@@ -37,10 +42,13 @@ class EntitiesBookingResponse extends BaseModel {
             { name: 'id', realName: 'id' },
             { name: 'ownerId', realName: 'owner_id' },
             { name: 'workflowState', realName: 'workflow_state' },
-            { name: 'userMessage', realName: 'user_message' },
+            { name: 'name', realName: 'name' },
             { name: 'timeWindow', realName: 'time_window', type: 'EntitiesTimeWindowResponse' },
             { name: 'resourceId', realName: 'resource_id' },
             { name: 'serviceId', realName: 'service_id' },
+            { name: 'description', realName: 'description' },
+            { name: 'externalLink', realName: 'external_link' },
+            { name: 'collaborativeLink', realName: 'collaborative_link' },
         ]);
     }
 }

lib/Models/UpdateBookingByIdBody.js

@@ -31,6 +31,8 @@ class UpdateBookingByIdBody extends BaseModel {
         this.updateRecurring =
           this.constructor.getValue(obj.updateRecurring
      || obj.update_recurring);
+        this.name = this.constructor.getValue(obj.name);
+        this.description = this.constructor.getValue(obj.description);
     }
 
     /**
@@ -49,6 +51,8 @@ class UpdateBookingByIdBody extends BaseModel {
             { name: 'occurrence', realName: 'occurrence' },
             { name: 'dateRecursBy', realName: 'date_recurs_by' },
             { name: 'updateRecurring', realName: 'update_recurring' },
+            { name: 'name', realName: 'name' },
+            { name: 'description', realName: 'description' },
         ]);
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gonebusy-nodejs-client",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "This is a Node JS client for communicating with the full GoneBusy API",
   "main": "./lib/index.js",
   "scripts": {

test/fixtures/bookings/index.json

@@ -4,7 +4,7 @@
       "id": 123,
       "owner_id": 0,
       "workflow_state": "string",
-      "user_message": "string",
+      "name": "string",
       "time_window": {
         "id": 456,
         "start_date": "2016-12-19",
@@ -20,7 +20,12 @@
           "string"
         ],
         "unavailable": true
-      }
+      },
+      "resource_id": 0,
+      "service_id": 0,
+      "description": "string",
+      "external_link": "string",
+      "collaborative_link": "string"
     }
   ]
 }

test/fixtures/bookings/show.json

@@ -3,7 +3,7 @@
     "id": 123,
     "owner_id": 0,
     "workflow_state": "string",
-    "user_message": "string",
+    "name": "string",
     "time_window": {
       "id": 456,
       "start_date": "2016-12-19",
@@ -21,6 +21,9 @@
       "unavailable": true
     },
     "resource_id": 0,
-    "service_id": 0
+    "service_id": 0,
+    "description": "string",
+    "external_link": "string",
+    "collaborative_link": "string"
   }
 }

test/support/controllers/bookings.js

@@ -72,7 +72,9 @@ const createParams = {
     frequency: 'single',
     days: 'string',
     occurrence: '4th_to_last',
-    date_recurs_by: 'day_in_month'
+    date_recurs_by: 'day_in_month',
+    name: 'my booking',
+    description: 'my description'
 };
 
 const createBooking = {