Add RecordProxy class

Similar to CollectionProxy, this acts as a container for a record
retrieved by `Model.find(id)` and future similar methods.

Author: wadetandy

src/model.ts

@@ -5,6 +5,7 @@ import Config from './configuration';
 import Attribute from './attribute';
 import deserialize from './util/deserialize';
 import CollectionProxy from './collection-proxy';
+import RecordProxy from './record-proxy';
 import _extend from './util/extend';
 import { camelize } from './util/string';
 
@@ -46,7 +47,7 @@ export default class Model {
     return this.scope().all();
   }
 
-  static find(id : string | number) : Promise<Model> {
+  static find(id : string | number) : Promise<RecordProxy<Model>> {
     return this.scope().find(id);
   }
 

src/record-proxy.ts

@@ -0,0 +1,33 @@
+import Model from './model';
+
+class RecordProxy<T> {
+  private _raw_json : japiDoc;
+  private _model : T;
+
+  constructor (raw_json : japiDoc = { data: [] }) {
+    this.setRaw(raw_json);
+  }
+
+  get raw () : japiDoc {
+    return this._raw_json;
+  }
+
+  get data () : T {
+    return this._model;
+  }
+
+  get meta () : Object {
+    return this.raw.meta || {};
+  }
+
+  private setRaw = (json_payload : japiDoc) => {
+    this._raw_json = json_payload;
+
+
+    if (this.raw.data) {
+      this._model = Model.fromJsonapi(this.raw.data, this.raw);
+    }
+  }
+}
+
+export default RecordProxy;

src/scope.ts

@@ -3,6 +3,7 @@ import Config from './configuration';
 import parameterize from './util/parameterize';
 import IncludeDirective from './util/include-directive';
 import CollectionProxy from './collection-proxy';
+import RecordProxy from './record-proxy';
 import Request from './request';
 import colorize from './util/colorize';
 
@@ -28,9 +29,9 @@ export default class Scope {
     });
   }
 
-  find(id : string | number) : Promise<Model> {
+  find(id : string | number) : Promise<RecordProxy<Model>> {
     return this._fetch(this.model.url(id)).then((json : japiDoc) => {
-      return Model.fromJsonapi(json.data, json);
+      return new RecordProxy(json)
     });
   }
 

test/integration/finders-test.ts

@@ -8,8 +8,8 @@ after(function () {
 });
 
 let resultData = function(promise) {
-  return promise.then(function(collection) {
-    return collection.data
+  return promise.then(function(proxyObject) {
+    return proxyObject.data
   })
 }
 
@@ -28,13 +28,13 @@ describe('Model finders', function() {
     });
 
     it('returns a promise that resolves the correct instance', function() {
-      return expect(Person.find(1)).to.eventually
+      return expect(resultData(Person.find(1))).to.eventually
         .be.instanceof(Person).and
         .have.property('id', '1');
     });
 
     it('assigns attributes correctly', function() {
-      return expect(Person.find(1)).to.eventually
+      return expect(resultData(Person.find(1))).to.eventually
         .have.property('name', 'John')
     });
 
@@ -50,7 +50,7 @@ describe('Model finders', function() {
       });
 
       it('resolves to the correct class', function() {
-        return expect(Person.find(1)).to.eventually
+        return expect(resultData(Person.find(1))).to.eventually
           .be.instanceof(Author);
       });
     });

test/unit/collection-proxy-test.ts

@@ -1,4 +1,3 @@
-import { sinon } from '../../test/test-helper';
 import { Person } from '../fixtures';
 
 import CollectionProxy from '../../src/collection-proxy'
@@ -15,7 +14,6 @@ describe('CollectionProxy', function() {
         },
       }
     ],
-    included: [],
     meta: {
       stats: {
         total: {
@@ -43,7 +41,7 @@ describe('CollectionProxy', function() {
   describe('#meta', function() {
     it('should get meta field from raw response', function() {
       let collection = new CollectionProxy(personData)
-      expect(collection.meta).to.eq(personData.meta)
+      expect(collection.meta).to.deep.eq(personData.meta)
     })
 
     describe('meta is null', function() {

test/unit/record-proxy-test.ts

@@ -0,0 +1,64 @@
+import { Person } from '../fixtures';
+
+import RecordProxy from '../../src/record-proxy'
+
+describe('RecordProxy', function() {
+  let personData = {
+    data: {
+      id: '1',
+      type: 'people',
+      attributes: {
+        firstName: 'Donald',
+        lastName: 'Budge'
+      },
+    },
+    meta: {
+      stats: {
+        total: {
+          count: 3
+        },
+        average: {
+          salary: "$100k"
+        }
+      }
+    }
+  }
+
+  describe('initialization', function() {
+    it('should assign the response correctly', function() {
+      let record = new RecordProxy(personData)
+      expect(record.raw).to.deep.equal(personData)
+    })
+
+    it('should assign the correct models to the data array', function() {
+      let record = new RecordProxy(personData)
+      expect(record.data).to.be.instanceof(Person)
+    })
+  })
+
+  describe('#meta', function() {
+    it('should get meta field from raw response', function() {
+      let record = new RecordProxy(personData)
+      expect(record.meta).to.deep.eq(personData.meta)
+    })
+
+    describe('meta is null', function() {
+      let personData = {
+        data: {
+          id: '1',
+          type: 'people',
+          attributes: {
+            firstName: 'Donald',
+            lastName: 'Budge'
+          },
+        },
+      }
+
+      it('should return an empty object', function() {
+        let record = new RecordProxy(personData)
+        expect(record.meta).to.deep.eq({})
+      })
+    })
+  })
+})
+