implement getByKey

Author: BramKaashoek

src/repositories/abstract.ts

@@ -49,6 +49,14 @@ export default abstract class AbstractRepository {
     return this._storage.get(projectKey, this.getTypeId(), id, params)
   }
 
+  getByKey(
+    projectKey: string,
+    key: string,
+    params: GetParams = {}
+  ): BaseResource | null {
+    return this._storage.getByKey(projectKey, this.getTypeId(), key, params)
+  }
+
   delete(
     projectKey: string,
     id: string,

src/services/abstract.ts

@@ -1,3 +1,4 @@
+import { QueryParams } from './../repositories/abstract'
 import { Update } from '@commercetools/platform-sdk'
 import { ParsedQs } from 'qs'
 import { Request, Response, Router } from 'express'
@@ -21,15 +22,15 @@ export default abstract class AbstractService {
     this.extraRoutes(router)
 
     router.get('/', this.get.bind(this))
+    router.get('/key=:key', this.getWithKey.bind(this)) // same thing goes for the key routes
     router.get('/:id', this.getWithId.bind(this))
-    router.get('/key=:key', this.getWithKey.bind(this))
 
-    router.delete('/:id', this.deletewithId.bind(this))
     router.delete('/key=:key', this.deletewithKey.bind(this))
+    router.delete('/:id', this.deletewithId.bind(this))
 
     router.post('/', this.post.bind(this))
-    router.post('/:id', this.postWithId.bind(this))
     router.post('/key=:key', this.postWithKey.bind(this))
+    router.post('/:id', this.postWithId.bind(this))
 
     parent.use(`/${basePath}`, router)
   }
@@ -47,7 +48,13 @@ export default abstract class AbstractService {
   }
 
   getWithKey(request: Request, response: Response) {
-    return response.status(500).send('Not implemented')
+    const result = this.repository.getByKey(
+      request.params.projectKey,
+      request.params['key'],
+      { expand: this._parseParam(request.query.expand) }
+    )
+    if (!result) return response.status(404).send()
+    return response.status(200).send(result)
   }
 
   deletewithId(request: Request, response: Response) {

src/services/store.test.ts

@@ -0,0 +1,60 @@
+import supertest from 'supertest'
+import { CommercetoolsMock } from '../index'
+
+const ctMock = new CommercetoolsMock()
+
+describe('Store', () => {
+  beforeAll(() => {
+    ctMock.start()
+  })
+
+  afterEach(() => {
+    ctMock.clear()
+  })
+
+  afterAll(() => {
+    ctMock.stop()
+  })
+
+  test('Get store by key', async () => {
+    ctMock.project('dummy').add('store', {
+      id: 'fake-store',
+      version: 1,
+      createdAt: '',
+      lastModifiedAt: '',
+      key: 'STOREKEY',
+      distributionChannels: [],
+    })
+
+    const response = await supertest(ctMock.app).get(
+      `/dummy/stores/key=STOREKEY`
+    )
+
+    expect(response.status).toBe(200)
+    expect(response.body).toEqual({
+      createdAt: '',
+      distributionChannels: [],
+      id: 'fake-store',
+      key: 'STOREKEY',
+      lastModifiedAt: '',
+      version: 1,
+    })
+  })
+
+  test('Get store by 404 when not found by key', async () => {
+    ctMock.project('dummy').add('store', {
+      id: 'fake-store',
+      version: 1,
+      createdAt: '',
+      lastModifiedAt: '',
+      key: 'STOREKEY',
+      distributionChannels: [],
+    })
+
+    const response = await supertest(ctMock.app).get(
+      `/dummy/stores/key=DOESNOTEXIST`
+    )
+
+    expect(response.status).toBe(404)
+  })
+})

src/storage.ts

@@ -61,6 +61,13 @@ export abstract class AbstractStorage {
     params: GetParams
   ): ResourceMap[RepositoryTypes] | null
 
+  abstract getByKey<RepositoryTypes extends keyof ResourceMap>(
+    projectKey: string,
+    typeId: RepositoryTypes,
+    key: string,
+    params: GetParams
+  ): ResourceMap[RepositoryTypes] | null
+
   abstract delete(
     projectKey: string,
     typeId: RepositoryTypes,
@@ -163,6 +170,23 @@ export class InMemoryStorage extends AbstractStorage {
     return null
   }
 
+  getByKey<RepositoryTypes extends keyof ResourceMap>(
+    projectKey: string,
+    typeId: RepositoryTypes,
+    key: string,
+    params: GetParams = {}
+  ): ResourceMap[RepositoryTypes] | null {
+    const store = this.forProjectKey(projectKey)[typeId]
+    if (!store) {
+      throw new Error('No type')
+    }
+
+    const resources: any[] = Array.from(store.values())
+    const resource = resources.find(e => e.key === key)
+    if (params.expand) return this.expand(projectKey, resource, params.expand)
+    return resource
+  }
+
   delete(
     projectKey: string,
     typeId: RepositoryTypes,