feat!: add support for pat token to authenticate (#154)

Author: samjohnsonamp

README.md

@@ -33,11 +33,12 @@ var dc = require('dc-management-sdk-js');
 
 ### Authentication
 
-The content management API uses OAuth 2 to authenticate requests.
-When creating an API client you can provide your API key and secret
+The content management API uses either OAuth2 or Person Access Tokens (PAT) to authenticate requests.
+
+When using OAuth 2 to create an API client you can provide your API key and secret
 and the client will handle creating authentication tokens.
 
-For assistance creating API credentials and configuring permissions please contact [Amplience Support](https://support.amplience.com/).
+For assistance creating API credentials, PAT's and configuring permissions please contact [Amplience Support](https://support.amplience.com/).
 
 ```typescript
 const client = new DynamicContent({
@@ -55,6 +56,22 @@ var client = new dc.DynamicContent({
 });
 ```
 
+Create a client using a PAT
+
+```typescript
+const client = new DynamicContent({
+  patToken: process.env.PAT
+});
+```
+
+OR
+
+```javascript
+var client = new dc.DynamicContent({
+  patToken: process.env.PAT
+});
+```
+
 ### Making requests
 
 The most common top level resources (such as Hub and ContentItem) can be requested directly by calling the appropriate method on the client instance. This will return a native promise that will yield the resource or an error (e.g. if you do not have permission to access the resource).

src/index.ts

@@ -1,8 +1,8 @@
 export { DynamicContent } from './lib/DynamicContent';
-export { OAuth2Client } from './lib/oauth2/services/OAuth2Client';
-export { OAuth2ClientCredentials } from './lib/oauth2/models/OAuth2ClientCredentials';
+export { Oauth2AuthHeaderProvider } from './lib/oauth2/services/Oauth2AuthHeaderProvider';
+export { PatTokenAuthHeaderProvider } from './lib/auth/PatTokenAuthHeaderProvider';
+export { Oauth2AuthHeaderProviderCredentials } from './lib/oauth2/models/Oauth2AuthHeaderProviderCredentials';
 export { AccessToken } from './lib/oauth2/models/AccessToken';
-export { AccessTokenProvider } from './lib/oauth2/models/AccessTokenProvider';
 export { HalClient, DefaultHalClient } from './lib/hal/services/HalClient';
 export {
   HalResource,

src/lib/DynamicContent.mocks.ts

@@ -4,8 +4,7 @@ import { HalClient } from './hal/services/HalClient';
 import { HalLiteral, HalMocks } from './hal/utils/HalMock';
 import { AxiosHttpClient } from './http/AxiosHttpClient';
 import { HttpClient } from './http/HttpClient';
-import { AccessTokenProvider } from './oauth2/models/AccessTokenProvider';
-import { OAuth2ClientCredentials } from './oauth2/models/OAuth2ClientCredentials';
+import { Oauth2AuthHeaderProviderCredentials } from './oauth2/models/Oauth2AuthHeaderProviderCredentials';
 
 /* tslint:disable:object-literal-sort-keys */
 
@@ -2993,6 +2992,8 @@ export class DynamicContentFixtures {
  */
 import MockAdapter from 'axios-mock-adapter';
 import { Status } from './model/Status';
+import { AuthorizationConfig } from './auth/AuthorizationConfig';
+import { AuthHeaderProvider } from './auth/AuthHeaderProvider';
 
 /**
  * @hidden
@@ -3001,12 +3002,12 @@ export class MockDynamicContent extends DynamicContent {
   public mock: MockAdapter;
 
   constructor(
-    clientCredentials?: OAuth2ClientCredentials,
+    authCredentials?: AuthorizationConfig,
     dcConfig?: DynamicContentConfig,
     httpClient?: AxiosRequestConfig
   ) {
     super(
-      clientCredentials || {
+      authCredentials || {
         client_id: 'client_id',
         client_secret: 'client_secret',
       },
@@ -3018,23 +3019,18 @@ export class MockDynamicContent extends DynamicContent {
   protected createTokenClient(
     /* eslint-disable unused-imports/no-unused-vars-ts */
     dcConfig: DynamicContentConfig,
-    clientCredentials: OAuth2ClientCredentials,
+    clientCredentials: Oauth2AuthHeaderProviderCredentials,
     httpClient: HttpClient
-  ): AccessTokenProvider {
+  ): AuthHeaderProvider {
     /* eslint-enable */
     return {
-      getToken: () =>
-        Promise.resolve({
-          access_token: 'token',
-          expires_in: 60,
-          refresh_token: 'refresh',
-        }),
+      getAuthHeader: () => Promise.resolve('bearer token'),
     };
   }
 
   protected createResourceClient(
     dcConfig: DynamicContentConfig,
-    tokenProvider: AccessTokenProvider,
+    tokenProvider: AuthHeaderProvider,
     httpClient: HttpClient
   ): HalClient {
     const client = super.createResourceClient(

src/lib/DynamicContent.ts

@@ -13,13 +13,15 @@ import { Hub, HubsPage } from './model/Hub';
 import { Page } from './model/Page';
 import { Pageable } from './model/Pageable';
 import { Snapshot } from './model/Snapshot';
-import { AccessTokenProvider } from './oauth2/models/AccessTokenProvider';
-import { OAuth2ClientCredentials } from './oauth2/models/OAuth2ClientCredentials';
-import { OAuth2Client } from './oauth2/services/OAuth2Client';
+import { Oauth2AuthHeaderProviderCredentials } from './oauth2/models/Oauth2AuthHeaderProviderCredentials';
+import { Oauth2AuthHeaderProvider } from './oauth2/services/Oauth2AuthHeaderProvider';
 import { HierarchyParents } from './model/HierarchyParents';
 import { HierarchyChildren } from './model/HierarchyChildren';
 import { WorkflowState } from './model/WorkflowState';
 import { Extension } from './model/Extension';
+import { AuthorizationConfig } from './auth/AuthorizationConfig';
+import { PatTokenAuthHeaderProvider } from './auth/PatTokenAuthHeaderProvider';
+import { AuthHeaderProvider } from './auth/AuthHeaderProvider';
 
 /**
  * Configuration settings for Dynamic Content API client. You can optionally
@@ -270,7 +272,7 @@ export class DynamicContent {
    * @param httpClient Optional request settings, can be used to provide proxy settings, add interceptors etc
    */
   constructor(
-    clientCredentials: Partial<OAuth2ClientCredentials>,
+    authCredentials: Partial<AuthorizationConfig>,
     dcConfig?: DynamicContentConfig,
     httpClient?: AxiosRequestConfig | HttpClient
   ) {
@@ -289,7 +291,7 @@ export class DynamicContent {
 
     const tokenClient = this.createTokenClient(
       dcConfig,
-      clientCredentials as OAuth2ClientCredentials,
+      authCredentials as AuthorizationConfig,
       httpClientInstance
     );
 
@@ -302,11 +304,15 @@ export class DynamicContent {
 
   protected createTokenClient(
     dcConfig: DynamicContentConfig,
-    clientCredentials: OAuth2ClientCredentials,
+    authCredentials: AuthorizationConfig,
     httpClient: HttpClient
-  ): AccessTokenProvider {
-    return new OAuth2Client(
-      clientCredentials,
+  ): AuthHeaderProvider {
+    if (authCredentials.patToken) {
+      return new PatTokenAuthHeaderProvider(authCredentials.patToken);
+    }
+
+    return new Oauth2AuthHeaderProvider(
+      authCredentials as Oauth2AuthHeaderProviderCredentials,
       {
         authUrl: dcConfig.authUrl,
       },
@@ -316,7 +322,7 @@ export class DynamicContent {
 
   protected createResourceClient(
     dcConfig: DynamicContentConfig,
-    tokenProvider: AccessTokenProvider,
+    tokenProvider: AuthHeaderProvider,
     httpClient: HttpClient
   ): HalClient {
     return new DefaultHalClient(dcConfig.apiUrl, httpClient, tokenProvider);

src/lib/auth/AuthHeaderProvider.ts

@@ -0,0 +1,8 @@
+/**
+ * AuthHeaderProvider is used to provide a getAuthHeader method to provide and authorization header
+ * Oauth2AuthHeaderProvider and PatTokenAuthHeaderProvider are two options for providing an AuthHeaderProvider
+ */
+
+export interface AuthHeaderProvider {
+  getAuthHeader(): Promise<string>;
+}

src/lib/auth/AuthorizationConfig.ts

@@ -0,0 +1,10 @@
+/**
+ * AuthorizationConfig
+ * @description Either Oauth2AuthHeaderProviderCredentials or a Personal Access Token
+ */
+
+export interface AuthorizationConfig {
+  patToken?: string;
+  client_id?: string;
+  client_secret?: string;
+}

src/lib/auth/PatTokenAuthHeaderProvider.spec.ts

@@ -0,0 +1,8 @@
+import test from 'ava';
+import { PatTokenAuthHeaderProvider } from './PatTokenAuthHeaderProvider';
+
+test('It should return an auth header for a Pat token', async (t) => {
+  const client = new PatTokenAuthHeaderProvider('amp-pat-token');
+  const header = await client.getAuthHeader();
+  t.is(header, 'bearer amp-pat-token');
+});

src/lib/auth/PatTokenAuthHeaderProvider.ts

@@ -0,0 +1,8 @@
+import { AuthHeaderProvider } from './AuthHeaderProvider';
+export class PatTokenAuthHeaderProvider implements AuthHeaderProvider {
+  constructor(private readonly patToken: string) {}
+
+  public async getAuthHeader(): Promise<string> {
+    return `bearer ${this.patToken}`;
+  }
+}

src/lib/hal/models/HalResource.spec.ts

@@ -14,12 +14,7 @@ import MockAdapter from 'axios-mock-adapter';
  * @hidden
  */
 const tokenProvider = {
-  getToken: () =>
-    Promise.resolve({
-      access_token: 'token',
-      expires_in: 500,
-      refresh_token: 'refresh',
-    }),
+  getAuthHeader: () => Promise.resolve('bearer token'),
 };
 
 /**

src/lib/hal/services/HalClient.spec.ts

@@ -26,12 +26,7 @@ function createMockClient(): [HalClient, any] {
  * @hidden
  */
 const tokenProvider = {
-  getToken: () =>
-    Promise.resolve({
-      access_token: 'token',
-      expires_in: 500,
-      refresh_token: 'refresh',
-    }),
+  getAuthHeader: () => Promise.resolve('bearer token'),
 };
 
 test('fetchResource should load and parse resource', async (t) => {
@@ -137,21 +132,15 @@ test('requests should include auth token', async (t) => {
 test('should ask for token from provider every request', async (t) => {
   const httpClient = new AxiosHttpClient({});
 
-  let tokenCount = 0;
   const client = new DefaultHalClient('', httpClient, {
-    getToken: () =>
-      Promise.resolve({
-        access_token: 'token' + tokenCount++,
-        expires_in: 500,
-        refresh_token: 'refresh',
-      }),
+    getAuthHeader: () => Promise.resolve('bearer token'),
   });
 
   const mock = new MockAdapter(httpClient.client);
   mock
     .onGet('/hubs/1', undefined, {
       Accept: 'application/json, text/plain, */*',
-      Authorization: 'bearer token0',
+      Authorization: 'bearer token',
     })
     .reply(200, {
       name: 'hub 1',