Adds API Key authentification method (#118)

* Adds API Key authentification method * Makes header name configurable
MobilityData · Jul 12, 2023 · 29efce7 · 29efce7
1 parent 83a22f5
commit 29efce7
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 0 deletions.
diff --git a/gbfs-validator/__test__/__snapshots__/gbfs.test.js.snap b/gbfs-validator/__test__/__snapshots__/gbfs.test.js.snap
@@ -72,3 +72,26 @@ GBFS {
   "url": "http://localhost:8888/gbfs.json",
 }
 `;
+
+exports[`initialization with auth should correctly initialize with \`api_key\` 1`] = `
+GBFS {
+  "auth": Object {
+    "apiKey": Object {
+      "key": "mykey",
+      "value": "myvalue",
+    },
+    "type": "api_key",
+  },
+  "gotOptions": Object {
+    "headers": Object {
+      "mykey": "myvalue",
+    },
+  },
+  "options": Object {
+    "docked": false,
+    "freefloating": false,
+    "version": null,
+  },
+  "url": "http://localhost:8888/gbfs.json",
+}
+`;
diff --git a/gbfs-validator/__test__/gbfs.test.js b/gbfs-validator/__test__/gbfs.test.js
@@ -51,6 +51,20 @@ describe('initialization', () => {
         })
       ).toMatchSnapshot()
     })
+
+    test('should correctly initialize with `api_key`', () => {
+      expect(
+        new GBFS('http://localhost:8888/gbfs.json', {
+          auth: {
+            type: 'api_key',
+            apiKey: {
+              key: 'mykey',
+              value: 'myvalue'
+            }
+          }
+        })
+      ).toMatchSnapshot()
+    })
   })
 })
 

diff --git a/gbfs-validator/gbfs.js b/gbfs-validator/gbfs.js
@@ -186,6 +186,12 @@ class GBFS {
           Authorization: `Bearer ${this.auth.bearerToken.token}`
         }
       }
+
+      if (this.auth.type === 'api_key' && this.auth.apiKey) {
+        this.gotOptions.headers = {
+          [this.auth.apiKey.key]: `${this.auth.apiKey.value}`
+        }
+      }
     }
   }
 

diff --git a/website/src/pages/Validator.vue b/website/src/pages/Validator.vue
@@ -15,6 +15,7 @@ const state = reactive({
       type: null,
       basicAuth: { user: null, password: null },
       bearerToken: { token: null },
+      apiKey: { key: null },
       oauthClientCredentialsGrant: {
         user: null,
         password: null,
@@ -45,6 +46,10 @@ const state = reactive({
       value: 'bearer_token',
       text: 'Bearer Token'
     },
+    {
+      value: 'api_key',
+      text: 'API Key'
+    },
     {
       value: 'oauth_client_credentials_grant',
       text: 'Oauth Client Credentials Grant'
@@ -196,6 +201,30 @@ function updateURL() {
             ></b-form-input>
           </b-form-group>
 
+           <b-form-group
+            id="input-group-api_key"
+            label="Authentification"
+            label-for="input-api_key"
+            v-if="state.options.auth.type === 'api_key'"
+          >
+            <b-row>
+              <b-col>
+                <b-form-input
+                  id="input-api_key-key"
+                  placeholder="key"
+                  v-model="state.options.auth.apiKey.key"
+                ></b-form-input>
+              </b-col>
+              <b-col>
+                <b-form-input
+                  id="input-api_key-value"
+                  placeholder="value"
+                  v-model="state.options.auth.apiKey.value"
+                ></b-form-input>
+              </b-col>
+            </b-row>
+          </b-form-group>
+
           <b-form-group
             id="input-group-oauth_client_credentials_grant"
             label="Authentification"