feat: adding support for cookie auth (#817)

* feat: adding support for cookie auth * test: adding tests for cookie auth security handling * docs: adding node-simple to the auth-types example def * chore(deps): upgrading @readme/oas-tooling to 3.5.0
readmeio · Jul 1, 2020 · 5a2ef14 · 5a2ef14
1 parent a40b605
commit 5a2ef14
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 9 deletions.
diff --git a/example/swagger-files/auth-types.json b/example/swagger-files/auth-types.json
@@ -69,6 +69,21 @@
           }
         ]
       }
+    },
+    "/anything/apiKey-cookie": {
+      "post": {
+        "summary": "ApiKey security type via cookie",
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "apiKeyCookie": []
+          }
+        ]
+      }
     }
   },
   "components": {
@@ -89,10 +104,15 @@
         "type": "apiKey",
         "in": "query",
         "name": "apiKey"
+      },
+      "apiKeyCookie": {
+        "type": "apiKey",
+        "in": "cookie",
+        "name": "apiKey"
       }
     }
   },
   "x-explorer-enabled": true,
   "x-samples-enabled": true,
-  "x-samples-languages": ["curl", "node", "ruby", "javascript", "python"]
+  "x-samples-languages": ["curl", "node", "node-simple", "ruby", "javascript", "python"]
 }
diff --git a/packages/api-explorer/package-lock.json b/packages/api-explorer/package-lock.json
diff --git a/packages/api-explorer/package.json b/packages/api-explorer/package.json
@@ -9,7 +9,7 @@
     "@readme/markdown-magic": "^6.12.0",
     "@readme/oas-extensions": "^6.10.2",
     "@readme/oas-to-har": "^6.12.1",
-    "@readme/oas-tooling": "^3.4.7",
+    "@readme/oas-tooling": "^3.5.0",
     "@readme/react-jsonschema-form": "^1.1.5",
     "@readme/syntax-highlighter": "^6.10.2",
     "@readme/variable": "^6.10.2",

diff --git a/packages/oas-to-har/__tests__/index.test.js b/packages/oas-to-har/__tests__/index.test.js
@@ -1171,6 +1171,38 @@ describe('auth', () => {
     ]);
   });
 
+  it('should work for cookie', () => {
+    expect(
+      oasToHar(
+        new Oas({
+          components: {
+            securitySchemes: {
+              'auth-cookie': {
+                type: 'apiKey',
+                name: 'authCookie',
+                in: 'cookie',
+              },
+            },
+          },
+        }),
+        {
+          path: '/security',
+          method: 'get',
+          security: [{ 'auth-cookie': [] }],
+        },
+        {},
+        {
+          'auth-cookie': 'value',
+        }
+      ).log.entries[0].request.cookies
+    ).toStrictEqual([
+      {
+        name: 'authCookie',
+        value: 'value',
+      },
+    ]);
+  });
+
   it('should work for multiple (||)', () => {
     expect(
       oasToHar(

diff --git a/packages/oas-to-har/package-lock.json b/packages/oas-to-har/package-lock.json
diff --git a/packages/oas-to-har/package.json b/packages/oas-to-har/package.json
@@ -5,7 +5,7 @@
   "main": "src/index.js",
   "dependencies": {
     "@readme/oas-extensions": "^6.10.2",
-    "@readme/oas-tooling": "^3.4.7"
+    "@readme/oas-tooling": "^3.5.0"
   },
   "scripts": {
     "inspect": "jsinspect",

diff --git a/packages/oas-to-har/src/lib/configure-security.js b/packages/oas-to-har/src/lib/configure-security.js
@@ -50,6 +50,11 @@ module.exports = function configureSecurity(oas, values, scheme) {
       }
 
       return harValue('headers', header);
+    } else if (security.in === 'cookie') {
+      return harValue('cookies', {
+        name: security.name,
+        value: values[scheme],
+      });
     }
   }