mongodb-atlas-api-client 2.31.0 → 3.1.0

package/src/projectWhitelist.js

@@ -1,3 +1,5 @@
+const {getQueryStringFromOptions} = require("./helper");
+
 class ProjectWhitelist {
 
   constructor(client, baseUrl, projectId) {
@@ -6,56 +8,59 @@ class ProjectWhitelist {
     this.projectId_ = projectId;
   }
 
-  async get(whitelistentry, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async get(whitelistentry, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
-      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist/${whitelistentry}?${queryString}`)
-    ).json();
+      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist/${whitelistentry}?${queryString}`, httpOptions)
+    );
     return response;
   }
 
-  async getAll(options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async getAll(options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
-      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist?${queryString}`)
-    ).json();
+      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist?${queryString}`, httpOptions)
+    );
     return response;
   }
 
-  async delete(whitelistentry, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async delete(whitelistentry, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist/${whitelistentry}?${queryString}`, {
-      "method": "DELETE"
+      "method": "DELETE",
+      ...httpOptions
     });
     return true;
   }
 
-  async update(body, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async update(body, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
       await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist?${queryString}`, {
         "method": "POST",
-        "body": JSON.stringify(body),
-        "headers": {"Content-Type": "application/json"}
+        "data": body,
+        "headers": {"Content-Type": "application/json"},
+        ...httpOptions
       })
-    ).json();
+    );
     return response;
   }
 
-  async create(body, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async create(body, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
       await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/whitelist?${queryString}`, {
         "method": "POST",
-        "body": JSON.stringify(body),
-        "headers": {"Content-Type": "application/json"}
+        "data": body,
+        "headers": {"Content-Type": "application/json"},
+        ...httpOptions
       })
-    ).json();
+    );
     return response;
   }
 }

package/src/user.js

@@ -1,3 +1,5 @@
+const {getQueryStringFromOptions} = require("./helper");
+
 class User {
 
   constructor(client, baseUrl, projectId) {
@@ -6,56 +8,59 @@ class User {
     this.projectId_ = projectId;
   }
 
-  async get(username, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async get(username, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
-      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers/admin/${username}?${queryString}`)
-    ).json();
+      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers/admin/${username}?${queryString}`, httpOptions)
+    );
     return response;
   }
 
-  async getAll(options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async getAll(options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
-      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers?${queryString}`)
-    ).json();
+      await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers?${queryString}`, httpOptions)
+    );
     return response;
   }
 
-  async delete(username, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async delete(username, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers/admin/${username}?${queryString}`, {
-      "method": "DELETE"
+      "method": "DELETE",
+      ...httpOptions
     });
     return true;
   }
 
-  async update(username, body, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async update(username, body, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
       await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers/admin/${username}?${queryString}`, {
         "method": "PATCH",
-        "body": JSON.stringify(body),
-        "headers": {"Content-Type": "application/json"}
+        "data": body,
+        "headers": {"Content-Type": "application/json"},
+        ...httpOptions
       })
-    ).json();
+    );
     return response;
   }
 
-  async create(body, options) {
-    const urlparams = new URLSearchParams(options);
-    const queryString = urlparams.toString();
+  async create(body, options = {}) {
+    const queryString = getQueryStringFromOptions(options);
+    const httpOptions = options.httpOptions;
     const response = (
       await this.client_.fetch(`${this.baseUrl_}/groups/${this.projectId_}/databaseUsers?${queryString}`, {
         "method": "POST",
-        "body": JSON.stringify(body),
-        "headers": {"Content-Type": "application/json"}
+        "data": body,
+        "headers": {"Content-Type": "application/json"},
+        ...httpOptions
       })
-    ).json();
+    );
     return response;
   }
 }

package/test/alert.test.js

@@ -2,6 +2,9 @@ const {describe, it} = exports.lab = require("@hapi/lab").script();
 const {expect} = require("@hapi/code");
 const nock = require("nock");
 const getClient = require("../src");
+const Alert = require("../src/alert");
+const HttpClient = require("../src/httpClient");
+const sinon = require("sinon");
 
 const baseUrl = "http://dummyBaseUrl";
 const projectId = "dummyProjectId";
@@ -56,3 +59,43 @@ describe("Mongo Atlas Api Client - Alert", () => {
     });
   });
 });
+
+describe("Alert Class", () => {
+
+  const mockRequest = {
+    "request": sinon.stub().returns(new Promise(resolve => resolve({"data": "some test data"})))
+  };
+  const mockHttpClient = new HttpClient(mockRequest, "dummyPublicKey", "dummyPrivateKey");
+
+  const alert = new Alert(mockHttpClient, "dummyBaseUrl", "dummyProjectId");
+
+  describe("When GetAll method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await alert.getAll({"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/alerts?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When Get method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await alert.get("alertId", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/alerts/alertId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When Acknowledge method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "PATCH",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}};
+      await alert.acknowledge("alertId", {"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/alerts/alertId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+});

package/test/atlasSearch.test.js

@@ -2,6 +2,9 @@ const {describe, it} = exports.lab = require("@hapi/lab").script();
 const {expect} = require("@hapi/code");
 const nock = require("nock");
 const getClient = require("../src");
+const AtlasSearch = require("../src/atlasSearch");
+const HttpClient = require("../src/httpClient");
+const sinon = require("sinon");
 
 const baseUrl = "http://dummyBaseUrl";
 const projectId = "dummyProjectId";
@@ -104,3 +107,91 @@ describe("Mongo Atlas Api Client - atlasSearch", () => {
     });
   });
 });
+
+describe("AtlasSearch Class", () => {
+
+  const mockRequest = {
+    "request": sinon.stub().returns(new Promise(resolve => resolve({"data": "some test data"})))
+  };
+  const mockHttpClient = new HttpClient(mockRequest, "dummyPublicKey", "dummyPrivateKey");
+
+  const atlasSearch = new AtlasSearch(mockHttpClient, "dummyBaseUrl", "dummyProjectId");
+
+  describe("When getAllAnalyzers method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasSearch.getAllAnalyzers("clusterName", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/analyzers?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When Get method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasSearch.get("clusterName", "indexId", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/indexes/indexId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When upsertAnalyzer method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "PUT",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}};
+      await atlasSearch.upsertAnalyzer("clusterName", {"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/analyzers?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When getAll method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasSearch.getAll("clusterName", "databaseName", "collectionName", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/indexes/databaseName/collectionName?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When delete method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "DELETE"
+      };
+      await atlasSearch.delete("clusterName", "indexId", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/indexes/indexId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When update method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "PATCH",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}
+      };
+      await atlasSearch.update("clusterName", "indexId", {"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/indexes/indexId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When create method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "POST",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}
+      };
+      await atlasSearch.create("clusterName", {"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/clusters/clusterName/fts/indexes?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+});

package/test/atlasUser.test.js

@@ -2,6 +2,9 @@ const {describe, it} = exports.lab = require("@hapi/lab").script();
 const {expect} = require("@hapi/code");
 const nock = require("nock");
 const getClient = require("../src");
+const AtlasUser = require("../src/atlasUser");
+const HttpClient = require("../src/httpClient");
+const sinon = require("sinon");
 
 const baseUrl = "http://dummyBaseUrl";
 const projectId = "dummyProjectId";
@@ -80,3 +83,66 @@ describe("Mongo Atlas Api Client - Atlas User", () => {
     });
   });
 });
+
+describe("AtlasUser Class", () => {
+
+  const mockRequest = {
+    "request": sinon.stub().returns(new Promise(resolve => resolve({"data": "some test data"})))
+  };
+  const mockHttpClient = new HttpClient(mockRequest, "dummyPublicKey", "dummyPrivateKey");
+
+  const atlasUser = new AtlasUser(mockHttpClient, "dummyBaseUrl", "dummyProjectId");
+
+  describe("When getByName method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasUser.getByName("username", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/users/byName/username?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When getById method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasUser.getById("userId", {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/users/userId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When getAll method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {"digestAuth": "dummyPublicKey:dummyPrivateKey", "dataType": "json"};
+      await atlasUser.getAll({"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/groups/dummyProjectId/users?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When update method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "PATCH",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}
+      };
+      await atlasUser.update("userId", {"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/users/userId?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+  describe("When create method is called with querystring parameters and httpOptions", () => {
+    it("Should send appropriate parameters to underlying request", async () => {
+      const requestParams = {
+        "digestAuth": "dummyPublicKey:dummyPrivateKey",
+        "dataType": "json",
+        "method": "POST",
+        "data": {"body": "text"},
+        "headers": {"Content-Type": "application/json"}
+      };
+      await atlasUser.create({"body": "text"}, {"queryStringParam1": "value1", "httpOptions": {"options1": "value1"}});
+      expect(mockRequest.request.calledWith("dummyBaseUrl/users?queryStringParam1=value1", {...requestParams, "options1": "value1"})).to.be.true();
+    });
+  });
+
+});

package/test/dataLake.test.js

@@ -2,7 +2,6 @@ const {describe, it} = exports.lab = require("@hapi/lab").script();
 const {expect} = require("@hapi/code");
 const nock = require("nock");
 const getClient = require("../src");
-
 const baseUrl = "http://dummyBaseUrl";
 const projectId = "dummyProjectId";
 
@@ -43,7 +42,7 @@ describe("Mongo Atlas Api Client - dataLake", () => {
         .get(`/groups/${projectId}/dataLakes/mydataLakename/queryLogs.gz?key1=value1&key2=value2`)
         .reply(200, Buffer.from("Some test string", "utf8"), {"headers": {"accept": "application/gzip"}});
       const result = await client.dataLake.getLogsStream("mydataLakename", {"key1": "value1", "key2": "value2"});
-      expect(result).to.be.object();
+      expect(result.pipe).to.exist();
       expect(expectedRequest.isDone()).to.be.true();
     });
   });

package/test/helper.test.js

@@ -0,0 +1,38 @@
+const {describe, it} = exports.lab = require("@hapi/lab").script();
+const {expect} = require("@hapi/code");
+const {getQueryStringFromOptions} = require("../src/helper");
+
+describe("Helper Methods", () => {
+
+  describe("When getQueryStringFromOptions is called with emmpty object", () => {
+
+    it("should return empty string", async () => {
+      const result = getQueryStringFromOptions({});
+      expect(result).to.equal("");
+    });
+  });
+
+  describe("When getQueryStringFromOptions is called without httpOptions but other properties", () => {
+
+    it("should return other properties as string", async () => {
+      const result = getQueryStringFromOptions({"a": 1, "b": 23, "httpOptions": {"key": "value"}});
+      expect(result).to.equal("a=1&b=23");
+    });
+  });
+
+  describe("When getQueryStringFromOptions is called with only httpOptions", () => {
+
+    it("should return empty string", async () => {
+      const result = getQueryStringFromOptions({"httpOptions": {"key": "value"}});
+      expect(result).to.equal("");
+    });
+  });
+
+  describe("When getQueryStringFromOptions is called without any parameters", () => {
+
+    it("should return empty string", async () => {
+      const result = getQueryStringFromOptions();
+      expect(result).to.equal("");
+    });
+  });
+});

package/.travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - "10"
-  - "12"
-  - "14"
-script: "npm run travis"