mongodb-atlas-api-client 3.0.0 → 3.1.0

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '39 7 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-atlas-api-client",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A mongodb atlas api client for nodejs.",
   "main": "src/index.js",
   "scripts": {

package/src/atlasUser.js

@@ -35,7 +35,6 @@ class AtlasUser {
     return response;
   }
 
-
   async update(userId, body, options = {}) {
     const queryString = getQueryStringFromOptions(options);
     const httpOptions = options.httpOptions;

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();
+    });
+  });
+
+});