several improvements, including storing new results and testcases (#17)

* create new document base functionality
* initial support for create new result and testcases
* adding more resource related options
* add possibility to track new results
* fixed admin update api payload

Author: jupe

dist/opentmi-client.js

@@ -1,5 +1,6 @@
+const _ = require('lodash');
 const {
-  login, transport, print, logout
+  login, transport, logout
 } = require('./common');
 
 const {Users, Loans} = require('../src');
@@ -11,8 +12,10 @@ login()
       .loadItems().loadResources().loadLoaner()
       .exec()
       .then((items) => {
-      // _.each(items, item => console.log(item.toString()))
-        console.log(JSON.stringify(items[0].toJson(), null, 2));
+        _.each(items, item => console.log(item.toString()));
+        if (items.length>0) {
+          console.log(JSON.stringify(items[0].toJson(), null, 2));
+        }
       });
   })
   .then(() => Users.WHOAMI(transport)

dist/opentmi-client.min.js

@@ -15,11 +15,15 @@ login()
       .then((resource) => {
         console.log(resource.toString());
         return resource
+          .type('dut')
           .name(`${resource.name()}abc`)
           .location.site('oulu')
           .location.country('finland')
+          .hw.sn('12')
+          .hw.firmware.version('12')
+          .hw.firmware.name('test')
           .save()
-          .then(data => console.log(data.toString()));
+          .then(data => console.log(data));
       });
   })
   .then(logout)

sample/loans.js

@@ -1,24 +1,40 @@
 const _ = require('lodash');
 
-const {
-  login, transport, print, logout
-} = require('./common');
-
+const {login, transport, logout} = require('./common');
 const {Results} = require('../src');
 
+const results = new Results(transport);
+
 login()
-  .then(() => {
-    const results = new Results(transport);
-    return results.find()
+  .then(() =>
+    results.find()
       .isHW()
       .limit(5)
       .skip(4)
       .isPass()
       .exec()
-      .then((results) => {
-        _.each(results, r => console.log(r.toString()));
+      .then((docs) => {
+        _.each(docs, r => console.log(r.toString()));
         // console.log(results[0].toJson());
-      });
-  })
+      })
+  )
+  .then(() =>
+    // start listening new result
+    results.connect()
+      .then(() => {
+        results.on('new', (result) => {
+          console.log(result.toString());
+        });
+      })
+  )
+  .then(() =>
+    // upload new result
+    results
+      .create()
+      .tcid('123').verdict('pass')
+      .save()
+      .then(doc => console.log(doc.toString()))
+      .catch(error => console.error(error.message))
+  )
   .then(logout)
   .catch(error => console.error(error.message));

sample/resources.js

@@ -5,11 +5,12 @@ const {
 const {Schemas} = require('../src');
 
 const schema = new Schemas(transport);
+//schema.updateSchemas = schema.updateSchemas.bind(schema);
+schema.collections = schema.collections.bind(schema);
 
 login()
-  // .then(print('updateSchemas').then(schema.updateSchemas.bind(schema)))
-  .then(print('get collections')().then(schema.collections.bind(schema)))
-  .then(print('get Result schema')().then(() => schema.schema('Result')))
-  .then(print('get Result schema')().then(() => schema.schema('Result')))
+  // .then(print('updateSchemas').then(schema.updateSchemas)
+  .then(print('get collections')).then(schema.collections).then(cols => console.log(cols))
+  .then(print('get Result schema')).then(() => schema.schema('Result').then(sch => console.log(sch)))
   .then(logout)
   .catch(error => console.error(error.message));

sample/results.js

@@ -5,16 +5,23 @@ const {
 } = require('./common');
 
 const {Testcases} = require('../src');
+const testcases = new Testcases(transport);
 
 login()
   .then(() => {
-    const testcases = new Testcases(transport);
     return testcases.find()
       .limit(5)
       .exec()
       .then((tcs) => {
         _.each(tcs, tc => console.log(tc.toString()));
       });
   })
+  .then(() => {
+    return testcases.create()
+      .tcid('12345')
+      .save()
+      .then(doc => console.log(doc.toString()))
+      .catch(error => console.log(error.message));
+  })
   .then(logout)
   .catch(error => console.error(error.message));

sample/schema.js

@@ -26,14 +26,14 @@ class Admin {
 
   /**
    * Update opentmi server which are connected through Transport
-   * @param {string} version - tag/commitId to be deployed
+   * @param {string} revision - tag/commitId to be deployed
    * @return {Promise} resolves when upgrade is ready
    */
-  upgrade(version) {
+  upgrade(revision) {
     invariant(this._transport.isLoggedIn, 'Transport should be connected');
     debug('request opentmi version');
     return this._transport
-      .post('/api/v0/version', {version})
+      .post('/api/v0/version', {revision})
       .then(response => response.data);
   }
 }

sample/testcases.js

@@ -10,7 +10,7 @@ class Group extends Document {
    * @param {Object}groupJson - group as plain json
    */
   constructor(transport, groupJson) {
-    super(transport, `/api/v0/groups/${groupJson._id}`, groupJson);
+    super(transport, '/api/v0/groups', groupJson);
   }
 
   static fromId(transport, id) {

src/admin.js

@@ -9,7 +9,7 @@ class Item extends Document {
    * @param {object} resourceJson - plain json object
    */
   constructor(transport, resourceJson) {
-    super(transport, `/api/v0/items/${resourceJson.id}`, resourceJson);
+    super(transport, '/api/v0/items', resourceJson);
   }
 
   /**
@@ -50,9 +50,17 @@ class Item extends Document {
    * @return {Promise<buffer>} image buffer
    */
   getImage() {
-    return this._transport.get(`/api/v0/items/${this.id}/image`)
+    return this._transport.get(`${this.path}/image`)
       .then(response => response.data);
   }
+
+  barcode(value) { return this.getOrSet('barcode', value); }
+
+  imageSrc(value) { return this.getOrSet('image_src', value); }
+
+  description(value) { return this.getOrSet('text_description', value); }
+
+  reference(value) { return this.getOrSet('external_reference', value); }
 }
 
 module.exports = Item;

src/group.js

@@ -52,7 +52,7 @@ class Loan extends Document {
    * @param {object} resourceJson - plain json object
    */
   constructor(transport, resourceJson) {
-    super(transport, `/api/v0/loans/${resourceJson.id}`, resourceJson);
+    super(transport, '/api/v0/loans', resourceJson);
   }
 
   /**

src/item.js

@@ -9,7 +9,7 @@ class Resource extends Document {
    * @param {object} resourceJson - plain json object
    */
   constructor(transport, resourceJson) {
-    super(transport, `/api/v0/resources/${resourceJson.id}`, resourceJson);
+    super(transport, '/api/v0/resources', resourceJson);
   }
 
   /**
@@ -27,26 +27,48 @@ class Resource extends Document {
    */
   name(value) { return this.getOrSet('name', value); }
 
-  barcode(value) { return this.getOrSet('barcode', value); }
-
-  imageSrc(value) { return this.getOrSet('image_src', value); }
-
-  description(value) { return this.getOrSet('text_description', value); }
-
-  reference(value) { return this.getOrSet('external_reference', value); }
-
+  /**
+   * Get resource type of set it
+   * @param {String}value resource type
+   * @return {Resource|String} resource type of Resource object
+   */
+  type(value) { return this.getOrSet('type', value); }
 
+  /**
+   * Manage hw informations
+   * @example
+   * doc
+   *  .hw.sn('123')
+   *  .hw.imei('12334')
+   *  .hw.firmware.name('aa')
+   *  .hw.firmware.version('1.0.0')
+   * @return {Object} hardware object
+   */
+  get hw() {
+    const self = this;
+    const hw = {
+      get firmware() {
+        return {
+          name: function name(value) { return this.getOrSet('hw.firmware.name', value); }.bind(self),
+          version: function version(value) {
+            return this.getOrSet('hw.firmware.version', value);
+          }.bind(self)
+        };
+      },
+      sn: function sn(value) { return this.getOrSet('hw.sn', value); }.bind(this),
+      imei: function imei(value) { return this.getOrSet('hw.imei', value); }.bind(this),
+      id: function id(value) { return this.getOrSet('hw.id', value); }.bind(this)
+    };
+    return hw;
+  }
   /**
    * Manage location information
    * @example
    *   // set site and country
    *   doc
    *    .location.site('oulu')
    *    .location.country('finland')
-   *  @return {{site: (function(this:Resource)), country: (function(this:Resource)),
-   *  city: (function(this:Resource)), address: (function(this:Resource)), postcode:
-   * (function(this:Resource)), room: (function(this:Resource)), subRoom:
-   * (function(this:Resource)), geo: (function(this:Resource))}} Location object
+   *  @return {Object} Location object
    */
   get location() {
     const loc = {

src/loan.js

@@ -12,18 +12,38 @@ const {QueryBase, Collection, notImplemented} = require('./utils');
  */
 class ResourcesQuery extends QueryBase {
   /* Find resources by id
-   * @param {string} type
-   * @return {Query}
+   * @param {string} id
+   * @return {MongooseQueryClient} returns this
    */
   id(id) {
     invariant(_.isString(id), 'id should be a string');
     return this.has({_id: id});
   }
 
+  /**
+   * Find resources by hwid
+   * @param {String} id hardware id as a string
+   * @return {ResourcesQuery} returns this
+   */
+  hwid(id) {
+    invariant(_.isString(id), 'id should be a string');
+    return this.has({'hw.id': id});
+  }
+
+  /**
+   * Find resources by serial number
+   * @param {String}sn hardware serial number as a string
+   * @return {ResourcesQuery} returns this
+   */
+  hwsn(sn) {
+    invariant(_.isString(sn), 'sn should be a string');
+    return this.has({'hw.sn': sn});
+  }
+
   /**
    * Resource has parent
    * @param {String} id - optional parent resource id
-   * @return {MongooseQueryClient} returns this
+   * @return {ResourcesQuery} returns this
    */
   hasParent(id = undefined) {
     if (_.isUndefined(id)) {
@@ -34,7 +54,7 @@ class ResourcesQuery extends QueryBase {
 
   /**
    * Resource doesn't have parent
-   * @return {MongooseQueryClient} returns this
+   * @return {ResourcesQuery} returns this
    */
   hasNoParent() {
     return this.has({parent: {$exists: false}});
@@ -43,16 +63,17 @@ class ResourcesQuery extends QueryBase {
   /**
    * Find resources with name
    * @param {string} name resource name
-   * @return {Query} returns this
+   * @return {ResourcesQuery} returns this
    */
   name(name) {
     invariant(_.isString(name), 'type should be a string');
     return this.has({name});
   }
+
   /**
    * Find resources by type
    * @param {string} type resource type
-   * @return {Query} returns this
+   * @return {ResourcesQuery} returns this
    */
   type(type) {
     invariant(_.isString(type), 'type should be a string');
@@ -62,7 +83,7 @@ class ResourcesQuery extends QueryBase {
   /**
    * Find resources by status
    * @param {string} status resource status. One of 'active', 'maintenance', 'broken'
-   * @return {Query} returns this
+   * @return {ResourcesQuery} returns this
    */
   status(status) {
     const STATUS = ['active', 'maintenance', 'broken'];
@@ -73,7 +94,7 @@ class ResourcesQuery extends QueryBase {
   /**
    * Find resources by usage type
    * @param {String} usageType resource usage type
-   * @return {MongooseQueryClient} returns this
+   * @return {ResourcesQuery} returns this
    */
   usageType(usageType) {
     invariant(_.isString(usageType), 'usageType should be a string');
@@ -84,7 +105,7 @@ class ResourcesQuery extends QueryBase {
    * Find resources by a tag
    * @param {string} tag tag name
    * @param {bool} isTrue tag value, optional. default: true
-   * @return {Query} returns this
+   * @return {ResourcesQuery} returns this
    */
   haveTag(tag, isTrue = true) {
     invariant(_.isBoolean(isTrue), 'isTrue should be a boolean');
@@ -96,7 +117,7 @@ class ResourcesQuery extends QueryBase {
   /**
    * Find resources by multiple tags
    * @param {array<String>} tags array of tag names
-   * @return {Query} returns this
+   * @return {ResourcesQuery} returns this
    */
   haveTags(tags) {
     invariant(_.isArray(tags), 'tags should be an array');