edgegrid - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "edgegrid",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Authorisation process and API helper for Akamai OPEN APIs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -53,2 +53,29 @@ # EdgeGrid for Node.js
 
+In addition passing the credentials manually as above, you may also authenticate using a `.edgerc` file, specifying its path and the group name (default is 'default'):
+
+```javascript
+var eg = new EdgeGrid({
+  path: '/path/to/.edgerc',
+  group: 'mygroup'
+});
+```
+
+An `.edgerc` file contains groups of credentials and is usually hosted in your home directory:
+
+```plaintext
+[default]
+host = akaa-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.luna.akamaiapis.net/
+client_token = akab-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX
+client_secret = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+access_token = akab-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX
+max-body = 131072
+
+[mygroup]
+host = akaa-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.luna.akamaiapis.net/
+client_token = akab-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX
+client_secret = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+access_token = akab-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX
+max-body = 131072
+```
+
 Calls using the edgegrid client can also be chained as per the following;
@@ -55,0 +82,0 @@

src/api.js

@@ -5,2 +5,3 @@ // Node modules
   url = require('url');
+  fs = require('fs');
 // EdgeGrid Auth Module
@@ -15,23 +16,76 @@ var auth = require('./auth.js');
 
+function parseEdgerc(path, conf) {
+  var edgerc = fs.readFileSync(path).toString().split("\n");
+  var confData = [];
+  for(var i=0;i<edgerc.length;i++) {
+    var matchConf = edgerc[i].match(/\[(.*)\]/);
+    // if we found our matching config, push the next 4 lines into a temp array
+    if (matchConf && matchConf[1] === conf) {
+      confData.push(edgerc[i+1]);
+      confData.push(edgerc[i+2]);
+      confData.push(edgerc[i+3]);
+      confData.push(edgerc[i+4]);
+      // convert the array to a descriptive object
+      confData = confData.map(function(el) {
+        var ret = {}
+        var key = el.split(' = ')[0].trim();
+        var val = el.split(' = ')[1].trim();
+        if (key === 'host') {
+          val = 'https://' + val;
+        }
+        ret[key] = val;
+        return ret;
+      });
+      // turn the array of objects into a single object
+      var result = {};
+      for (var i = 0, length = confData.length; i < length; i++) {
+        result[Object.keys(confData[i])[0]] = confData[i][Object.keys(confData[i])[0]];
+      }
+      return result;
+    }
+  }
+  // if we escaped the parse loop without returning, something is wrong
+  throw('An error occurred parsing the .edgerc file. You probably specified an invalid group name.');
+} 
+
 var EdgeGrid = function(client_token, client_secret, access_token, base_uri) {
+  // accepting an object containing a path to .edgerc and a config group
+  if (typeof arguments[0] === 'object') {
+    var path = arguments[0].path;
+    var group = arguments[0].group;
+    if (path === undefined) {
+      console.log("No .edgerc path");
+      return false;
+    }
+    if (group === undefined) {
+      console.log("No .edgerc group provided, using 'default'");
+      group = 'default';
+    }
+    var config = parseEdgerc(path, group);
+    _client_token = config.client_token;
+    _client_secret = config.client_secret;
+    _access_token = config.access_token;
+    _base_uri = config.host;
+  }
+  else {
+    if (client_token === undefined || client_token === null) {
+      console.log("No client token");
+      return false;
+    } else if (client_secret === undefined || client_secret === null) {
+      console.log("No client secret");
+      return false;
+    } else if (access_token === undefined || access_token === null) {
+      console.log("No access token");
+      return false;
+    } else if (base_uri === undefined || base_uri === null) {
+      console.log("No base uri");
+      return false;
+    }
 
-  if (client_token === undefined || client_token === null) {
-    console.log("No client token");
-    return false;
-  } else if (client_secret === undefined || client_secret === null) {
-    console.log("No client secret");
-    return false;
-  } else if (access_token === undefined || access_token === null) {
-    console.log("No access token");
-    return false;
-  } else if (base_uri === undefined || base_uri === null) {
-    console.log("No base uri");
-    return false;
+    _client_token = client_token;
+    _client_secret = client_secret;
+    _access_token = access_token;
+    _base_uri = base_uri;
   }
 
-  _client_token = client_token;
-  _client_secret = client_secret;
-  _access_token = access_token;
-  _base_uri = base_uri;
-
   return this;
@@ -38,0 +92,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43252

increased by7.01%

Lines of code

652

increased by9.03%

Number of lines in readme file

105

increased by34.62%

Worsened metrics

Number of low supply chain risk alerts

3

increased by50%

No dependency changes