Update petstore for 2019

Author: hannah-bulmer

.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  'extends': 'airbnb-base',
+  'env': {
+    'mocha': true,
+    'node': true,
+  }
+};

component.json

@@ -9,36 +9,34 @@
         "label": "API key",
         "required": true,
         "viewClass": "TextFieldWithNoteView",
-        "note": "Please use <b>elasticio</b> as API key. For more details see <a href='https://petstore.elastic.io/docs/' target='_blank'>Petstore API docs</a>."
+        "note": "Please use <b>secret</b> as API key. For more details see <a href='https://petstore.elastic.io/docs/' target='_blank'>Petstore API docs</a>."
       }
     }
   },
   "triggers": {
-    "getPetsByStatusWithGenerators": {
-      "main": "./lib/triggers/getPetsByStatusWithGenerators.js",
+    "getPetsByStatus": {
+      "main": "./lib/triggers/getPetsByStatus.js",
       "type": "polling",
-      "title": "Get Pets By Status With Generators",
+      "title": "Get Pets By Status (Dynamic Data Example)",
+      "description": "Get pets by status, with the available statuses pulled dynamically from API",
       "fields": {
         "status": {
           "label": "Pet Status",
           "required": true,
           "viewClass": "SelectView",
-          "model": {
-            "available": "Available",
-            "pending": "Pending",
-            "sold": "Sold"
-          },
+          "model": "getStatusModel",
           "prompt": "Select Pet Status"
         }
       },
       "metadata": {
         "out": "./lib/schemas/getPetsByStatus.out.json"
       }
     },
-    "getPetsByStatusWithPromises": {
-      "main": "./lib/triggers/getPetsByStatusWithPromises.js",
+    "getPetsByStatusWithStaticData": {
+      "main": "./lib/triggers/getPetsByStatusWithStaticData.js",
       "type": "polling",
-      "title": "Get Pets By Status With Promises",
+      "title": "Get Pets By Status (Static Data Example)",
+      "description": "Get pets by status, with the available statuses statically typed to the component.json",
       "fields": {
         "status": {
           "label": "Pet Status",
@@ -55,37 +53,13 @@
       "metadata": {
         "out": "./lib/schemas/getPetsByStatus.out.json"
       }
-    },
-    "getPetsByStatusWithDynamicSelectModel": {
-      "main": "./lib/triggers/getPetsByStatusWithDynamicSelectModel.js",
-      "type": "polling",
-      "title": "Get Pets By Status With Dynamic Select Model",
-      "fields": {
-        "status": {
-          "label": "Pet Status",
-          "required": true,
-          "viewClass": "SelectView",
-          "model": "getStatusModel",
-          "prompt": "Select Pet Status"
-        }
-      },
-      "metadata": {
-        "out": "./lib/schemas/getPetsByStatus.out.json"
-      }
     }
   },
   "actions": {
-    "createPetWithPromise": {
-      "main": "./lib/actions/createPetWithPromise.js",
-      "title": "Create a Pet With Promise",
-      "metadata": {
-        "in": "./lib/schemas/createPet.in.json",
-        "out": "./lib/schemas/createPet.out.json"
-      }
-    },
-    "createPetWithGenerators": {
-      "main": "./lib/actions/createPetWithGenerators.js",
-      "title": "Create a Pet With Generators",
+    "createPet": {
+      "main": "./lib/actions/createPet.js",
+      "title": "Creates a new pet",
+      "description": "Creates a pet and adds it to the shop",
       "metadata": {
         "in": "./lib/schemas/createPet.in.json",
         "out": "./lib/schemas/createPet.out.json"

lib/actions/createPet.js

@@ -0,0 +1,62 @@
+const { messages } = require('elasticio-node');
+const PetstoreClient = require('../petstoreClient');
+
+/**
+ * Executes the action's logic by sending a request to the Petstore API and emitting response to the platform.
+ * The function returns a Promise sending a request and resolving the response as platform message.
+ *
+ * @param msg incoming messages which is empty for triggers
+ * @param cfg object to retrieve triggers configuration values, such as apiKey and pet status
+ * Emits results as a message to the platform
+ */
+exports.process = async function process(msg, cfg) {
+  // create a client object that has methods to make a request available to us
+  const client = new PetstoreClient(this, cfg);
+
+  /**
+   * The format of a message coming into the function is
+   * msg: {
+   *  body: {
+   *      name:
+   *      status:
+   *   }
+   * }
+   * So we deconstruct the object accordingly
+   */
+  const { name } = msg.body;
+
+  const statuses = {
+    Available: 'available',
+    Pending: 'pending',
+    Sold: 'sold',
+  };
+
+  // map the status value from the readable value to the internal camel case one
+  const status = statuses[msg.body.status];
+
+  if (!name) {
+    throw new Error('Name is required');
+  }
+
+  if (!status) {
+    throw new Error('Status is required');
+  }
+
+  // create pet object to post
+  const pet = {
+    name,
+    status,
+  };
+
+  // make a request using the client and save the result to a parameter =>
+  // makeRequest takes an object with the necessary fields to complete the request
+  const result = await client.makeRequest({
+    url: '/pet',
+    method: 'POST',
+    body: pet,
+  });
+
+  // this.emit is a function provided by sailor - we use it to emit messages to
+  // our platform
+  await this.emit('data', messages.newMessageWithBody(result));
+};

lib/actions/createPetWithGenerators.js

@@ -0,0 +1,20 @@
+const { ApiKeyRestClient } = require('@elastic.io/component-commons-library');
+
+const API_BASE_URI = 'https://petstore.elastic.io/v2';
+
+// various standard rest clients have been created that handle creating requests and some
+// authentication for us. They are found in @elastic.io/component-commons-library
+module.exports = class PetstoreClient extends ApiKeyRestClient {
+  constructor(emitter, cfg) {
+    // this first line is a hack for a small sailor bug
+    if (!emitter.logger) emitter.logger = { trace: () => {} };
+
+    // begin constructor
+    super(emitter, cfg);
+    this.cfg = cfg;
+    this.cfg.resourceServerUrl = API_BASE_URI;
+    this.apiKeyHeaderName = 'api-key';
+    this.apiKeyHeaderValue = cfg.apiKey;
+    this.authRestClient = new ApiKeyRestClient(emitter, cfg);
+  }
+};

lib/actions/createPetWithPromise.js

@@ -9,6 +9,7 @@
     "status": {
       "type": "string",
       "required": true,
+      "enum": ["Available", "Pending", "Sold"],
       "title": "Status"
     }
   }

lib/petstoreClient.js

@@ -0,0 +1,54 @@
+const { messages } = require('elasticio-node');
+const PetstoreClient = require('../petstoreClient');
+
+/**
+ * Executes the trigger's logic by sending a request to the Petstore API and emitting response to the platform.
+ * The function returns a Promise sending a request and resolving the response as platform message.
+ *
+ * @param msg incoming messages which is empty for triggers
+ * @param cfg object to retrieve triggers configuration values, such as apiKey and pet status
+ * @returns promise resolving a message to be emitted to the platform
+ */
+exports.process = async function getPetsByStatus(msg, cfg) {
+  const client = new PetstoreClient(this, cfg);
+
+  // access the value of the status field defined in credentials section of component.json
+  const { status } = cfg;
+
+  if (!status) {
+    throw new Error('Status field is required');
+  }
+
+  // make a request using the client and save the result to a parameter
+  const result = await client.makeRequest({
+    url: `/pet/findByStatus?status=${status}`,
+    method: 'GET',
+  });
+
+  // emit result using supplied emit function
+  await this.emit('data', messages.newMessageWithBody(result));
+};
+
+
+/**
+ * getStatusModel is supplied in component.json as the model for credential statuses
+ * The results of this function will dynamicaly provide the statuses from the API
+ * to be displayd on the platform
+ */
+exports.getStatusModel = async function getStatusModel(cfg) {
+  const client = new PetstoreClient(this, cfg);
+
+  const result = await client.makeRequest({
+    url: '/pet/statuses',
+    method: 'GET',
+  });
+
+  const statuses = {};
+
+  // map the statuses to a human readable form
+  result.forEach((status) => {
+    statuses[status] = status.charAt(0).toUpperCase() + status.substring(1);
+  });
+
+  return statuses;
+};