feat: add get method to credentials

Author: bitkidd

adonis-typings/index.ts

@@ -1,5 +1,6 @@
 declare module '@ioc:Adonis/Addons/Credentials' {
   export interface CredentialsContract {
+    get(key?: string): string | Record<string, string>
     initialize(): void
   }
 

src/Credentials/index.ts

@@ -16,12 +16,13 @@ import { CredentialsContract } from '@ioc:Adonis/Addons/Credentials'
 import { Vault } from '../Vault'
 
 export class Credentials implements CredentialsContract {
+  private initialized = false
   private env = 'development'
   private key: string | null = null
   private keyParam = 'APP_CREDENTIALS_KEY'
   private credentialsPath = join('resources', 'credentials')
   private content: string = ''
-  private credentials: Object = {}
+  private credentials: Record<string, string> = {}
 
   constructor(args?: {
     env?: string
@@ -94,11 +95,25 @@ export class Credentials implements CredentialsContract {
     }
   }
 
+  public get(key?: string): string | Record<string, string> {
+    if (!this.initialized) {
+      this.initialize()
+    }
+
+    if (key) {
+      return this.credentials[key]
+    } else {
+      return this.credentials
+    }
+  }
+
   public initialize(): void {
     this.check()
     this.read()
     this.validate()
     this.parse()
     this.populate()
+
+    this.initialized = true
   }
 }

test/credentials.spec.ts

@@ -83,6 +83,24 @@ test.group('Credentials', (group) => {
     assert.equal(process.env.HELLO, 'world')
   })
 
+  test('should pick up key from credentials and return in', async (assert) => {
+    const credentials = new Credentials({
+      env: 'test',
+      credentialsPath: app.resourcesPath('/credentials'),
+    })
+
+    assert.equal(credentials.get('HELLO'), 'world')
+  })
+
+  test('should pick up all keys from credentials and return them', async (assert) => {
+    const credentials = new Credentials({
+      env: 'test',
+      credentialsPath: app.resourcesPath('/credentials'),
+    })
+
+    assert.deepStrictEqual(credentials.get(), { HELLO: 'world' })
+  })
+
   test('should throw an error when no credentials key', async (assert) => {
     await fs.remove('resources/credentials/test.key')