@gregoriusrippenstein/node-red-contrib-introspection 0.2.0 → 0.2.1

package/README.md

@@ -71,11 +71,13 @@ A node for inserting an SVG image into the workspace. The image is layered above
 
 ### GetFlows -- Experimental
 
-Node retrieves the current `flows.json` from the server but using the [Node-RED API](https://nodered.org/docs/api/admin/methods/get/flows/) so that it is storage independent. It returns the flows as a `payload` on the message.
+Node retrieves the current `flows.json` from the server but using the [Node-RED API](https://nodered.org/docs/api/admin/methods/get/flows/) so that it is storage independent. It returns the flows as a `payload` of the message.
 
-The intention that this is triggered on a regular basis to backup the flows to a third party storage system. Inspired by the [dsm](https://flows.nodered.org/node/node-red-contrib-dsm) package that has a [backup](https://github.com/cflurin/node-red-contrib-dsm/wiki/Backup) state machine.
+The intention that this is triggered on a regular basis to backup the flows to a third party storage system. Recommended is usage in combination with the [zip](https://flows.nodered.org/node/node-red-contrib-zip) module to make the backups smaller.
 
-Does not set the authentication token, hence experimental.
+GetFlows supports version selection of the flows and it has limited authentication using password `grant_type`.
+
+Inspired by the [dsm](https://flows.nodered.org/node/node-red-contrib-dsm) package that has a [backup](https://github.com/cflurin/node-red-contrib-dsm/wiki/Backup) state machine.
 
 ## Examples
 

package/nodes/45-get-flows.html

@@ -7,6 +7,24 @@
       name: {
         value:"",
       },
+      flowVersion: {
+        value: "v1"
+      },
+      useAuthentication: {
+        value:false
+      },
+      apiUsername: {
+        value: "",
+      },
+      apiUsernameType: {
+        value: "env",
+      },
+      apiPassword: {
+        value: "",
+      },
+      apiPasswordType: {
+        value: "env",
+      },
     },
     inputs:1,
     outputs:1,
@@ -18,6 +36,31 @@
     labelStyle: function() {
       return this.name?"node_label_italic":"";
     },
+    oneditprepare: function() {
+      $("#node-input-apiUsername").typedInput({
+        types:["env", "msg", "flow","global", "cred"],
+        typeField: "#node-input-apiUsernameType"
+      });
+
+      $("#node-input-apiPassword").typedInput({
+        types:["env", "msg", "flow","global", "env", "cred"],
+        typeField: "#node-input-apiPasswordType"
+      });
+
+      if ( $('#node-input-useAuthentication').is(":checked") ) {
+        $('#useAuthentication-input-fields').show();
+      } else {
+        $('#useAuthentication-input-fields').hide()
+      }
+
+      $('#node-input-useAuthentication').on( 'change', function() {
+        if ( $('#node-input-useAuthentication').is(":checked") ) {
+          $('#useAuthentication-input-fields').show();
+        } else {
+          $('#useAuthentication-input-fields').hide()
+        }
+      });
+    },
   });
 </script>
 
@@ -26,6 +69,51 @@
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
+
+    <div class="form-row">
+      <label for="node-input-flowVersion">
+        <i class="fa fa-tag"></i>
+        <span>Flow Version</span>
+      </label>
+
+      <select id="node-input-flowVersion">
+        <option value="v1" selected=selected>Version 1</option>
+        <option value="v2">Version 2</option>
+      </select>
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-useAuthentication">
+        <i class="fa "></i>
+        <span>Use Authentication?</span>
+      </label>
+
+      <input type="checkbox" id="node-input-useAuthentication"
+             style="display:inline-block; width:15px; vertical-align:baseline;">
+    </div>
+
+    <div id="useAuthentication-input-fields" class="hidden">
+      <div class="form-row">
+        <label for="node-input-apiUsername">
+          <i class="fa fa-tag"></i>
+          Username
+        </label>
+        <input type="text" id="node-input-apiUsername">
+        <input type="hidden" id="node-input-apiUsernameType">
+      </div>
+
+      <div class="form-row">
+        <label for="node-input-apiPassword">
+          <i class="fa fa-tag"></i>
+          Password
+        </label>
+        <input type="text" id="node-input-apiPassword">
+        <input type="hidden" id="node-input-apiPasswordType">
+
+      </div>
+    </div>
+
+
 </script>
 
 <script type="text/html" data-help-name="GetFlows">

package/nodes/45-get-flows.js

@@ -13,27 +13,96 @@ module.exports = function(RED) {
       var os = require('os');
       var got = require('got');
 
-      var url = "http://" + os.hostname() + ":" + RED.settings.get("uiPort");
+      var baseUrl = "http://" + os.hostname() + ":" + RED.settings.get("uiPort");
       if ( RED.settings.get("httpAdminRoot") != "/" ) {
-        url += RED.settings.get("httpAdminRoot");
+        baseUrl += RED.settings.get("httpAdminRoot");
       }
-      url += "/flows";
-
-      node.status({fill:"blue",shape:"dot",text:"Requesting..."});
-
-      got.get( url ).then( res => {
-        if ( res.statusCode == 200 ) {
-          send( {
-            ...msg,
-            payload: res.body
-          });
-          node.status({fill:"green",shape:"dot",text:"Good"});
-          setTimeout( function() { node.status({}) }, 450);
-        } else {
-          node.error( res );
+
+      if ( cfg.useAuthentication ) {
+        var username = undefined;
+        var password = undefined;
+
+        node.status({fill:"blue",shape:"dot",text:"Requesting token"});
+
+        RED.util.evaluateNodeProperty(cfg.apiUsername, cfg.apiUsernameType,
+                                      node, msg, (err, result) => {
+          if (err) {
+            node.status({fill:"red",shape:"dot",text:"Failed"});
+            node.error(err)
+          } else {
+            username = result;
+
+            RED.util.evaluateNodeProperty(cfg.apiPassword, cfg.apiPasswordType,
+                                          node, msg, (err, result) => {
+              if (err) {
+                node.status({fill:"red",shape:"dot",text:"Failed"});
+                node.error(err)
+              } else {
+                password = result;
+
+                var data = {
+                      "client_id":  "node-red-admin",
+                      "grant_type": "password",
+                      "scope":      "*",
+                      "username":   username,
+                      "password":   password
+                }
+
+                got.post( baseUrl + "/auth/token", {
+                  json: data
+                }).then( res => {
+                  node.status({fill:"blue",shape:"dot",text:"Requesting flows"});
+
+                  var access_token = JSON.parse(res.body).access_token;
+                  got.get( baseUrl + "/flows", {
+                    headers: {
+                      "Node-RED-API-Version": cfg.flowVersion,
+                      "Authorization": "Bearer " + access_token
+                    }
+                  }).then( res => {
+                    node.status({fill:"green",shape:"dot",text:"Good"});
+                    setTimeout( function() { node.status({}) }, 450);
+                    send( {
+                      ...msg,
+                      payload: res.body
+                    });
+                  }).catch( err => {
+                    node.status({fill:"red",shape:"dot",text:"Failed"});
+                    node.error(err)
+                  });
+                }).catch((err) => {
+                  node.status({fill:"red",shape:"dot",text:"Failed"});
+                  node.error( err );
+                });
+              }
+            })
+          }
+        })
+      } else {
+        /*
+         * Authentication free zone...
+         */
+        node.status({fill:"blue",shape:"dot",text:"Requesting flows"});
+
+        got.get( baseUrl + "/flows",
+                 {headers: {"Node-RED-API-Version": cfg.flowVersion}}
+        ).then( res => {
+          if ( res.statusCode == 200 ) {
+            send( {
+              ...msg,
+              payload: res.body
+            });
+            node.status({fill:"green",shape:"dot",text:"Good"});
+            setTimeout( function() { node.status({}) }, 450);
+          } else {
+            node.error( res );
+            node.status({fill:"red",shape:"dot",text:"Failed"});
+          }
+        }).catch( err => {
           node.status({fill:"red",shape:"dot",text:"Failed"});
-        }
-      });
+          node.error(err)
+        });
+      }
     });
   }
   RED.nodes.registerType("GetFlows", GetFlowsFunctionality);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/node-red-contrib-introspection",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "keywords": [
     "node-red"
   ],