[Proposal] Unified Client interface

package.json

@@ -76,7 +76,8 @@
     "form-data": "https://github.com/spark/form-data/archive/v1.0.0-relative-path.tar.gz",
     "stream-http": "https://github.com/spark/stream-http/archive/v2.2.1.tar.gz",
     "superagent": "^2.2.0",
-    "superagent-prefix": "0.0.2"
+    "superagent-prefix": "0.0.2",
+    "verror": "^1.9.0"
   },
   "browser": {
     "http": "stream-http",

src/Client.js

@@ -1,5 +1,5 @@
 import Particle from './Particle';
-import Library from './Library';
+import Library from './models/Library';
 
 export default class Client {
 	constructor({ auth, api = new Particle() }) {

src/collections/Base.js

@@ -0,0 +1,49 @@
+import NotImplementedError from '../errors/NotImplementedError';
+
+/**
+ * @interface
+ */
+export default class Base {
+	/**
+	 * @param {Object} [filter] Predicate used when fetching
+	 * @return {Promise}
+	 */
+	fetch(filter={}) {
+		throw new NotImplementedError();
+	}
+
+	/**
+	 * @property {boolean} hasNextPage Indicates if collection has a next page
+	 */
+	get hasNextPage() {
+		throw new NotImplementedError();
+	}
+
+	/**
+	 * @return {Promise}
+	 */
+	nextPage() {
+		throw new NotImplementedError();
+	}
+
+	/**
+	 * @property {boolean} hasPrevPage Indicates if collection has a previous page
+	 */
+	get hasPrevPage() {
+		throw new NotImplementedError();
+	}
+
+	/**
+	 * @return {Promise}
+	 */
+	prevPage() {
+		throw new NotImplementedError();
+	}
+
+	/**
+	 * @property {number} page Indicates current page number
+	 */
+	get page() {
+		throw new NotImplementedError();
+	}
+}

src/errors/CustomError.js

@@ -0,0 +1,14 @@
+import VError from 'VError';
+
+class CustomError extends VError {
+	constructor() {
+		super(...arguments);
+		this.name = this.constructor.name;
+	}
+
+	static matches(error) {
+		return error.name === this.name;
+	}
+}
+
+export default CustomError;

src/errors/NotImplementedError.js

@@ -0,0 +1,3 @@
+import CustomError from './CustomError';
+
+export default class NotImplementedError extends CustomError {}

src/models/Base.js

@@ -0,0 +1,11 @@
+export default class Base {
+	constructor(client, data) {
+		// Make client non-enumerable so it doesn't show up in Object.keys, JSON.stringify, etc
+		Object.defineProperty(this, 'client', { value: client });
+		this._assignAttributes(data);
+	}
+
+	_assignAttributes(data) {
+		Object.assign(this, data);
+	}
+}

src/models/BuildTarget.js

@@ -0,0 +1,12 @@
+import Base from './Base';
+
+/**
+ * @property {string} version
+ * @property {number} platformId
+ * @property {boolean} featured
+ * @property {boolean} prerelease
+ * @property {string} vendor
+ */
+export default class BuildTarget extends Base {
+
+}

test/Client.spec.js

@@ -2,7 +2,7 @@ import {expect, sinon} from './test-setup';
 
 import Client from '../src/Client';
 import * as fixtures from './fixtures';
-import Library from '../src/Library';
+import Library from '../src/models/Library';
 
 let api;
 const token = 'tok';

test/errors/NotImplementedError.js

@@ -0,0 +1,9 @@
+import {expect} from '../test-setup';
+import NotImplementedError from '../../src/errors/NotImplementedError';
+
+describe('NotImplementedError', () => {
+	it('matches the error', () => {
+		let exception = new NotImplementedError();
+		expect(NotImplementedError.matches(exception)).to.be.true;
+	})
+});

test/Library.spec.js → test/models/Library.spec.js

@@ -1,5 +1,5 @@
 import {expect} from './test-setup';
-import Library from '../src/Library';
+import Library from '../../src/models/Library';
 
 let client = {};
 describe('Library', () => {