feat(rooms): create adapter interface

Author: akoushke

src/adapters/RoomsAdapter.js

@@ -0,0 +1,66 @@
+import {throwError} from 'rxjs';
+
+import WebexAdapter from './WebexAdapter';
+
+/**
+ * Enum for room type values.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const RoomType = {
+  GROUP: 'group',
+  DIRECT: 'direct',
+};
+
+/**
+ * This is a base class that defines the interface that maps room data.
+ * Developers that want to extend `RoomsAdapter` must implement all of its methods,
+ * adhering to the exact parameters and structure of the returned objects.
+ */
+export default class RoomsAdapter extends WebexAdapter {
+  /**
+   * A Room object with details about the room.
+   *
+   * @typedef {Object} Room
+   * @property {string}    ID      The room identifier.
+   * @property {string}    title   The room title.
+   * @property {RoomType}  type    The type of the room. @see RoomType enum
+   */
+
+  /**
+   * Returns an observable that emits room data of the given ID.
+   *
+   * @param {string} ID  ID of the room to get.
+   * @returns {Observable.<Room>}
+   * @memberof RoomsAdapter
+   */
+  // eslint-disable-next-line no-unused-vars
+  getRoom(ID) {
+    return throwError(new Error('getRoom(ID) must be defined in RoomsAdapter'));
+  }
+
+  /**
+   * Returns an observable that emits an array of previous activity IDs of the given roomID.
+   *
+   * @param {string} ID  ID of the room to get.
+   * @returns {Observable.<Array.<string>>}
+   * @memberof RoomsAdapter
+   */
+  // eslint-disable-next-line no-unused-vars
+  getPreviousRoomActivities(ID) {
+    return throwError(new Error('getPreviousRoomActivities(ID) must be defined in RoomsAdapter'));
+  }
+
+  /**
+   * Returns an observable that emits an array of current activity IDs of the given roomID.
+   *
+   * @param {string} ID  ID of the room to get.
+   * @returns {Observable.<Array.<string>>}
+   * @memberof RoomsAdapter
+   */
+  // eslint-disable-next-line no-unused-vars
+  getRoomActivities(ID) {
+    return throwError(new Error('getRoomActivities(ID) must be defined in RoomsAdapter'));
+  }
+}

src/adapters/RoomsAdapter.test.js

@@ -0,0 +1,55 @@
+import RoomsAdapter from './RoomsAdapter';
+
+describe('Rooms Adapter Interface', () => {
+  let roomsAdapter;
+
+  beforeEach(() => {
+    roomsAdapter = new RoomsAdapter();
+  });
+
+  test('getRoom() returns an observable', () => {
+    expect(rxjs.isObservable(roomsAdapter.getRoom())).toBeTruthy();
+  });
+
+  test('getRoom() throws a proper error message', (done) => {
+    roomsAdapter.getRoom('id').subscribe(
+      () => {},
+      (error) => {
+        expect(error.message).toBe('getRoom(ID) must be defined in RoomsAdapter');
+        done();
+      }
+    );
+  });
+
+  test('getPreviousRoomActivities() returns an observable', () => {
+    expect(rxjs.isObservable(roomsAdapter.getPreviousRoomActivities())).toBeTruthy();
+  });
+
+  test('getPreviousRoomActivities() throws a proper error message', (done) => {
+    roomsAdapter.getPreviousRoomActivities('id').subscribe(
+      () => {},
+      (error) => {
+        expect(error.message).toBe('getPreviousRoomActivities(ID) must be defined in RoomsAdapter');
+        done();
+      }
+    );
+  });
+
+  test('getRoomActivities() returns an observable', () => {
+    expect(rxjs.isObservable(roomsAdapter.getRoomActivities())).toBeTruthy();
+  });
+
+  test('getRoomActivities() throws a proper error message', (done) => {
+    roomsAdapter.getRoomActivities('id').subscribe(
+      () => {},
+      (error) => {
+        expect(error.message).toBe('getRoomActivities(ID) must be defined in RoomsAdapter');
+        done();
+      }
+    );
+  });
+
+  afterEach(() => {
+    roomsAdapter = null;
+  });
+});

src/adapters/index.js

@@ -3,3 +3,4 @@ export {default as PeopleAdapter} from './PeopleAdapter';
 export {default as PeopleJSONAdapter} from './PeopleJSONAdapter';
 export {default as ActivitiesAdapter} from './ActivitiesAdapter';
 export {default as ActivitiesJSONAdapter} from './ActivitiesJSONAdapter';
+export {default as RoomsAdapter} from './RoomsAdapter';