DXE-2065 Merge pull request #134 from akamai/release/v3.4.0

DXE-2065 Release/v3.4.0

.gitignore

@@ -31,3 +31,5 @@ node_modules
 .DS_Store
 .AppleDouble
 .LSOverride
+/.nyc_output/
+/.idea/

CHANGELOG.md

@@ -1,5 +1,16 @@
 # RELEASE NOTES
 
+## 3.4.0 (Jan 26, 2023)
+
+#### IMPROVEMENTS:
+* Reads 'max_body' (alias 'max-body') field from `.edgerc` config file with default value of `131072` ([PR#1](https://github.com/akamai/AkamaiOPEN-edgegrid-node/pull/1))
+* Add default Accept header (related to [PR#43](https://github.com/akamai/AkamaiOPEN-edgegrid-node/pull/43)
+    and [I#33](https://github.com/akamai/AkamaiOPEN-edgegrid-node/issues/33))
+* Add README section explaining how to use proxy (related to [PR#35](https://github.com/akamai/AkamaiOPEN-edgegrid-node/pull/35)
+    and [I#59](https://github.com/akamai/AkamaiOPEN-edgegrid-node/issues/59))
+* Add README section explaining how to change request encoding (related to [PR#58](https://github.com/akamai/AkamaiOPEN-edgegrid-node/pull/58))
+* Update various dependencies
+
 ## 3.3.0 (Nov 08, 2022)
 
 #### IMPROVEMENTS:

README.md

@@ -150,6 +150,62 @@ eg.auth({
 // https://akaa-baseurl-xxxxxxxxxxx-xxxxxxxxxxxxx.luna.akamaiapis.net/papi/v1/cpcodes?contractId=ctr_1234&groupId=grp_1234
 ```
 
+### Encoding
+
+When interacting with binary data, such as during retrieval of PDF invoices, `responseType` should be specified as `arraybuffer` during the `auth` method call. Omission of `responseType` will cause an unreadable or blank response.
+
+```javascript
+const fs = require('fs');
+
+eg.auth({
+  path : `/invoicing-api/v2/contracts/${contractId}/invoices/${invoiceNumber}/files/${fileName}`,
+  method: 'GET',
+  responseType: 'arraybuffer', // Important
+}).send((err, response) => {
+  if (err) {
+    return console.log(err);
+  }
+  fs.writeFile(`./${fileName}`, response.data, 'binary', (err) => {
+    if (err){
+      return console.log(err);
+    }
+    console.log('File was saved!');
+  });
+});
+```
+
+### Proxy
+To use edgegrid with proxy, you can configure it with `proxy` field:
+
+```javascript
+eg.auth({
+  path : `/papi/v1/cpcodes`,
+  method: 'GET',
+  proxy: {
+    host: 'my.proxy.com',
+    protocol: "https",
+    port: 3128,
+    auth: {
+      username: 'my-user',
+      password: 'my-password'
+    }
+  }
+}).send((err, response) => {
+  if (err) {
+    return console.log(err);
+  }
+  console.log('Success!');
+  // Do something with response
+});
+```
+
+or use environment variable:
+
+```shell
+$ export https_proxy=https://username:password@host:port
+$ node myapp.js
+```
+
 ### Debug
 
 With EdgeGrid you can enable debugging either as part of the EdgeGrid instantiation object

package.json

@@ -1,6 +1,6 @@
 {
   "name": "akamai-edgegrid",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Authentication handler for the Akamai OPEN EdgeGrid Authentication scheme in Node.js",
   "main": "index.js",
   "scripts": {

src/api.js

@@ -57,9 +57,10 @@ EdgeGrid.prototype.auth = function (req) {
         body: ''
     });
 
-    req.headers = helpers.extendHeaders(req.headers)
+    req.headers = helpers.extendHeaders(req.headers);
 
-    let isTarball = req.body instanceof Uint8Array && req.headers['Content-Type'] === 'application/gzip';
+    let isTarball = req.body instanceof Uint8Array &&
+        (req.headers['Content-Type'] === 'application/gzip' || req.headers['Content-Type'] === 'application/tar+gzip');
 
     // Convert body object to properly formatted string
     if (req.body) {
@@ -77,7 +78,7 @@ EdgeGrid.prototype.auth = function (req) {
         this.config.access_token,
         this.config.host
     );
-    if (req.headers['Accept'] === 'application/gzip') {
+    if (req.headers['Accept'] === 'application/gzip' || req.headers['Accept'] === 'application/tar+gzip') {
         this.request["responseType"] = 'arraybuffer';
     }
     return this;

src/auth.js

@@ -59,7 +59,6 @@ function makeURL(host, path, queryStringObj) {
 
 module.exports = {
     generateAuth: function (request, clientToken, clientSecret, accessToken, host, maxBody, guid, timestamp) {
-        maxBody = maxBody || 131072;
         guid = guid || uuid.v4();
         timestamp = timestamp || helpers.createTimestamp();
 

src/edgerc.js

@@ -41,6 +41,8 @@ function getSection(lines, sectionName) {
 
 function validatedConfig(config) {
 
+    config.max_body = config.max_body || 131072
+
     if (!(config.host && config.access_token &&
         config.client_secret && config.client_token)) {
         let errorMessage = "";
@@ -78,6 +80,9 @@ function buildObj(configs) {
         index = config.indexOf('=');
         if (index > -1 && !isComment) {
             key = config.substr(0, index);
+            if (key.startsWith("max-body")) {
+                key = key.replace('-', '_')
+            }
             val = config.substring(index + 1);
             // remove inline comments
             parsedValue = val.replace(/^\s*(['"])((?:\\\1|.)*?)\1\s*(?:;.*)?$/, "$2");

src/helpers.js

@@ -108,7 +108,7 @@ module.exports = {
         return dataToSignStr;
     },
 
-     extend: function (a, b) {
+    extend: function (a, b) {
         let key;
 
         for (key in b) {
@@ -124,6 +124,9 @@ module.exports = {
         if (!headers.hasOwnProperty('Content-Type')) {
             headers['Content-Type'] = "application/json";
         }
+        if (!headers.hasOwnProperty('Accept')) {
+            headers['Accept'] = "application/json";
+        }
 
         let userAgents = [headers['User-Agent']];
         if (process.env['AKAMAI_CLI'] && process.env['AKAMAI_CLI_VERSION']) {