Merge pull request #91 from syncromatics/feature/EN-6322-add-bike-rack-slots

feat(bikeRackSlots): EN-6322 add bike rack slots

Author: mprzygoc

package-lock.json

@@ -0,0 +1,36 @@
+const bikeRackSlots = {
+  list: [
+    {
+      vehicle: {
+        href: '/1/SYNC/vehicles/1',
+      },
+      bike_rack_slot: 'Front',
+      is_occupied: true,
+      event_time: '2017-01-01T00:00:00.000-07:00',
+      latitude: 123.456789,
+      longitude: 12.345678,
+    },
+    {
+      vehicle: {
+        href: '/1/SYNC/vehicles/1',
+      },
+      bike_rack_slot: 'Middle',
+      is_occupied: false,
+      event_time: '2017-01-01T00:00:00.000-07:00',
+      latitude: 123.456789,
+      longitude: 12.345678,
+    },
+    {
+      vehicle: {
+        href: '/1/SYNC/vehicles/1',
+      },
+      bike_rack_slot: 'Rear',
+      is_occupied: true,
+      event_time: '2017-01-01T00:00:00.000-07:00',
+      latitude: 123.456789,
+      longitude: 12.345678,
+    },
+  ],
+};
+
+export default bikeRackSlots;

src/mocks/bikeRackSlots.js

@@ -3,6 +3,7 @@ import { Server } from 'mock-socket';
 import * as messages from '../subscriptions/messages';
 import areas from './areas';
 import callStates from './callStates';
+import bikeRackSlots from './bikeRackSlots';
 import dispatchMessages from './dispatchMessages';
 import dispatchMessageStatus from './dispatchMessageStatus';
 import enplugDetails from './enplugDetails';
@@ -134,6 +135,9 @@ const realTime = {
           case 'ASSIGNMENTS':
             data = vehicles.list.map((v) => v.assignment);
             break;
+          case 'BIKE_RACK_SLOTS':
+            data = bikeRackSlots.list;
+            break;
           case 'CALL_STATES':
             data = callStates.list;
             break;

src/mocks/realTime.js

@@ -0,0 +1,42 @@
+import RealTimeContext from './RealTimeContext';
+
+/**
+ * A real time context that can be used to generate subscriptions to Bike Rack Slot entities.
+ */
+class BikeRackSlotsRealTimeContext extends RealTimeContext {
+  /**
+   * Creates a context that can subscribe to Bike Rack Slot updates.
+   * @param {RealTimeClient} realTimeClient Pre-configured instance of RealTimeClient.
+   * @param {string} customerCode The customer code to query for updates.
+   */
+  constructor(realTimeClient, customerCode) {
+    const entityName = 'BIKE_RACK_SLOTS';
+    super(realTimeClient, entityName, customerCode);
+    this.filters = {
+      vehicles: [],
+    };
+  }
+
+  /**
+   * Restrict subscriptions created by this context to a single vehicle.
+   * @param {Resource|string} vehicle Href or resource representation of a Vehicle.
+   * @returns {BikeRackSlotsRealTimeContext} Context with filter applied.
+   */
+  forVehicle(vehicle) {
+    return this.forVehicles([vehicle]);
+  }
+
+  /**
+   * Restrict subscriptions created by this context to a set of vehicles.
+   * @param {Array.<Resource|string>} vehicles Array of href or resource representations of
+   * Vehicles.
+   * @returns {BikeRackSlotsRealTimeContext} Context with filter applied.
+   */
+  forVehicles(vehicles) {
+    this.assertSubscriptionNotStarted();
+    this.filters.vehicles = vehicles.map(RealTimeContext.resolveHref);
+    return this;
+  }
+}
+
+export default BikeRackSlotsRealTimeContext;

src/resources/BikeRackSlotsRealTimeContext.js

@@ -0,0 +1,56 @@
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import BikeRackSlotsRealTimeContext from './BikeRackSlotsRealTimeContext';
+import RealTimeClient from '../RealTimeClient';
+import { realTime as mock } from '../mocks';
+
+chai.should();
+chai.use(chaiAsPromised);
+
+describe('When creating a subscription for Bike Rack Slots', () => {
+  const entity = 'BIKE_RACK_SLOTS';
+  const customerCode = 'SYNC';
+
+  it('can add filters for a single vehicle', () => {
+    const server = mock.getServer();
+    const realTimeClient = new RealTimeClient(mock.authenticatedClient, mock.options);
+    const subject = new BikeRackSlotsRealTimeContext(realTimeClient, customerCode);
+
+    const vehicleHref = '123';
+    const expectedFilters = { vehicles: [vehicleHref] };
+    subject.forVehicle(vehicleHref).on('update', () => {});
+
+    const options = { closeConnection: true, realTimeClient };
+    return server.verifySubscription(entity, options).should.eventually.become(expectedFilters);
+  });
+
+  it('can add filters for multiple vehicles', () => {
+    const server = mock.getServer();
+    const realTimeClient = new RealTimeClient(mock.authenticatedClient, mock.options);
+    const subject = new BikeRackSlotsRealTimeContext(realTimeClient, customerCode);
+
+    const vehicleHrefs = ['123', '456', '489'];
+    const expectedFilters = { vehicles: vehicleHrefs };
+
+    subject.forVehicles(vehicleHrefs).on('update', () => {});
+
+    const options = { closeConnection: true, realTimeClient };
+    return server.verifySubscription(entity, options).should.eventually.become(expectedFilters);
+  });
+
+  it('should handle entity updates', () => {
+    const server = mock.getServer();
+    const realTimeClient = new RealTimeClient(mock.authenticatedClient, mock.options);
+    const subject = new BikeRackSlotsRealTimeContext(realTimeClient, customerCode);
+
+    let resolver;
+    const updateReceived = new Promise((resolve) => {
+      resolver = resolve;
+    });
+    const connectionClosed = updateReceived.then(() => server.closeConnection(realTimeClient));
+
+    const subscription = subject.forVehicle('/1/SYNC/vehicles/1').on('update', resolver);
+
+    return Promise.all([subscription, updateReceived, connectionClosed]);
+  });
+});

src/resources/BikeRackSlotsRealTimeContext.test.js

@@ -1,5 +1,6 @@
 import AreasRealTimeContext from './AreasRealTimeContext';
 import AssignmentsRealTimeContext from './AssignmentsRealTimeContext';
+import BikeRackSlotsRealTimeContext from './BikeRackSlotsRealTimeContext';
 import CallStatesRealTimeContext from './CallStatesRealTimeContext';
 import DispatchMessagesRealTimeContext from './DispatchMessagesRealTimeContext';
 import DispatchMessageStatusRealTimeContext from './DispatchMessageStatusRealTimeContext';
@@ -80,6 +81,14 @@ class RealTimeContextFactory {
     return new AssignmentsRealTimeContext(this.realTimeClient, this.customerCode);
   }
 
+  /**
+   * Creates a RealTimeContext for querying Bike Rack Slot updates.
+   * @returns {BikeRackSlotsRealTimeContext} The newly created context.
+   */
+  bikeRackSlots() {
+    return new BikeRackSlotsRealTimeContext(this.realTimeClient, this.customerCode);
+  }
+
   /**
    * Creates a RealTimeContext for querying Call State updates.
    * @returns {CallStatesRealTimeContext} The newly created context.

src/resources/RealTimeContextFactory.js

@@ -23,6 +23,11 @@ describe('When creating a RealTimeContext', () => {
     result.realTimeClient.should.equal(realTimeClient);
   });
 
+  it('should reuse its RealTimeClient when creating an BikeRackSlotsRealTimeContext', () => {
+    const result = factory.bikeRackSlots();
+    result.realTimeClient.should.equal(realTimeClient);
+  });
+
   it('should reuse its RealTimeClient when creating an CallStatesRealTimeContext', () => {
     const result = factory.callStates();
     result.realTimeClient.should.equal(realTimeClient);
@@ -63,9 +68,11 @@ describe('When attaching disconnect and reconnect handlers', () => {
   const customerCode = 'SYNC';
 
   it('should attach disconnect handlers to the realTimeClient', () => {
-    const disconnectHandler = () => { };
+    const disconnectHandler = () => {};
     let verifyCallback;
-    const didVerifyCallback = new Promise((resolve) => { verifyCallback = resolve; });
+    const didVerifyCallback = new Promise((resolve) => {
+      verifyCallback = resolve;
+    });
     const realTimeClientMock = {
       addEventListener: (event, handler) => {
         if (event === 'disconnect' && handler === disconnectHandler) {
@@ -80,11 +87,13 @@ describe('When attaching disconnect and reconnect handlers', () => {
   });
 
   it('should remove disconnect handlers', () => {
-    const disconnectHandler = () => { };
+    const disconnectHandler = () => {};
     let verifyCallback;
-    const didVerifyCallback = new Promise((resolve) => { verifyCallback = resolve; });
+    const didVerifyCallback = new Promise((resolve) => {
+      verifyCallback = resolve;
+    });
     const realTimeClientMock = {
-      addEventListener: () => { },
+      addEventListener: () => {},
       removeEventListener: (event, handler) => {
         if (event === 'disconnect' && handler === disconnectHandler) {
           verifyCallback(true);
@@ -99,9 +108,11 @@ describe('When attaching disconnect and reconnect handlers', () => {
   });
 
   it('should fire reconnect handlers', () => {
-    const reconnectHandler = () => { };
+    const reconnectHandler = () => {};
     let verifyCallback;
-    const didVerifyCallback = new Promise((resolve) => { verifyCallback = resolve; });
+    const didVerifyCallback = new Promise((resolve) => {
+      verifyCallback = resolve;
+    });
     const realTimeClientMock = {
       addEventListener: (event, handler) => {
         if (event === 'reconnect' && handler === reconnectHandler) {
@@ -116,11 +127,13 @@ describe('When attaching disconnect and reconnect handlers', () => {
   });
 
   it('should remove reconnect handlers', () => {
-    const reconnectHandler = () => { };
+    const reconnectHandler = () => {};
     let verifyCallback;
-    const didVerifyCallback = new Promise((resolve) => { verifyCallback = resolve; });
+    const didVerifyCallback = new Promise((resolve) => {
+      verifyCallback = resolve;
+    });
     const realTimeClientMock = {
-      addEventListener: () => { },
+      addEventListener: () => {},
       removeEventListener: (event, handler) => {
         if (event === 'reconnect' && handler === reconnectHandler) {
           verifyCallback(true);