Merge pull request #269 from icedream/pr/job-token

feat: Implement jobToken property to allow authentication via CI job token
jdalrymple · Feb 22, 2019 · 8f551f1 · 8f551f1
2 parents a52c03d + cb0826b
commit 8f551f1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -159,6 +159,13 @@ const api = new Gitlab({
   oauthToken: 'abcdefghij123456'
 })
 
+// You can also use a CI job token:
+
+const api = new Gitlab({
+  url:   'http://example.com', // Defaults to https://gitlab.com
+  jobToken: process.env.CI_JOB_TOKEN
+})
+
 ```
 
 #### Specific Imports

diff --git a/src/infrastructure/BaseService.ts b/src/infrastructure/BaseService.ts
@@ -5,6 +5,7 @@ import XMLHttpRequester, { XhrStaticPromisified } from './XMLHttpRequester';
 interface BaseModelOptions {
   url?: string;
   token?: string;
+  jobToken?: string;
   oauthToken?: string;
   useXMLHttpRequest?: boolean;
   version?: string;
@@ -14,6 +15,7 @@ interface BaseModelOptions {
 
 export type BaseModelContructorOptions =
   | BaseModelOptions & Required<Pick<BaseModelOptions, 'token'>>
+  | BaseModelOptions & Required<Pick<BaseModelOptions, 'jobToken'>>
   | BaseModelOptions & Required<Pick<BaseModelOptions, 'oauthToken'>>;
 class BaseModel {
   public url: string;
@@ -24,6 +26,7 @@ class BaseModel {
 
   constructor({
     token,
+    jobToken,
     oauthToken,
     sudo,
     url = 'https://gitlab.com',
@@ -40,6 +43,7 @@ class BaseModel {
 
     // Handle auth tokens
     if (oauthToken) this.headers.authorization = `Bearer ${oauthToken}`;
+    else if (jobToken) this.headers['job-token'] = jobToken;
     else if (token) this.headers['private-token'] = token;
 
     // Set sudo