Merge pull request #9 from thexdev/feature

feat(api): add delete order command

Author: thexdev

src/commands/delete-order.ts

@@ -0,0 +1,11 @@
+import Command from './command';
+
+export class DeleteOrder extends Command {
+  execute(): Promise<Response> {
+    return this.http
+      .setBody({
+        cancellation_reason: this.extra.cancellation_reason,
+      })
+      .delete(`v1/orders/${this.extra.id}`);
+  }
+}

src/http.ts

@@ -55,4 +55,9 @@ export class Http {
     const response = await this.setUrl(url).setMethod('POST').run();
     return await response.json();
   }
+
+  async delete(url: string) {
+    const response = await this.setUrl(url).setMethod('DELETE').run();
+    return await response.json();
+  }
 }

src/index.ts

@@ -1,5 +1,6 @@
 import { Biteship } from './biteship';
 import { CreateOrder } from './commands/create-order';
+import { DeleteOrder } from './commands/delete-order';
 import { RetrieveArea } from './commands/retrieve-area';
 import { RetrieveCourierRates } from './commands/retrieve-courier-rates';
 import { RetrieveOrder } from './commands/retrieve-order';
@@ -8,6 +9,7 @@ import { SearchRates } from './commands/search-rates';
 export {
   Biteship,
   CreateOrder,
+  DeleteOrder,
   RetrieveArea,
   RetrieveOrder,
   RetrieveCourierRates,

src/types.ts

@@ -1,2 +1,2 @@
 export type ApiKey = string;
-export type HTTPMethod = 'GET' | 'POST';
+export type HTTPMethod = 'GET' | 'POST' | 'DELETE';

tests/commands/delete-order.test.ts

@@ -0,0 +1,90 @@
+import Command from '../../src/commands/command';
+import { DeleteOrder } from '../../src';
+import { rest } from 'msw';
+import { baseUrl } from '../fixtures/base-url';
+import {
+  invokerWithApiKey,
+  invokerWithInvalidApiKey,
+  invokerWithMissingApiKey,
+} from '../fixtures/invoker';
+import { server } from '../fixtures/server';
+
+describe('create-order.ts', () => {
+  it('should be able to instantiated', async () => {
+    const command = new DeleteOrder();
+    expect(command).toBeInstanceOf(Command);
+  });
+
+  describe('when API_KEY is not provided', () => {
+    it('should returns authorization failure', async () => {
+      const payload = {
+        success: true,
+        error: 'Authorization failed',
+        code: 40101001,
+      };
+
+      server.use(
+        rest.delete(baseUrl('orders/1'), (_, res, ctx) => {
+          return res(ctx.status(401), ctx.json(payload));
+        }),
+      );
+
+      const command = new DeleteOrder({ id: 1 });
+
+      const response = await invokerWithMissingApiKey.send(command);
+
+      expect(response).toEqual(payload);
+    });
+  });
+
+  describe('when API_KEY is invalid', () => {
+    it('should return invalid api key warnings', async () => {
+      const payload = {
+        success: false,
+        error:
+          'Authentication for your key is failed. Please make sure input the right key or contact info@biteship.com for more information.',
+        code: 40000001,
+      };
+
+      server.use(
+        rest.delete(baseUrl('orders/1'), (_, res, ctx) => {
+          return res(ctx.status(400), ctx.json(payload));
+        }),
+      );
+
+      const command = new DeleteOrder({ id: 1 });
+
+      const response = await invokerWithInvalidApiKey.send(command);
+
+      expect(response).toEqual(payload);
+    });
+  });
+
+  describe('when order successfully deleted', () => {
+    it('should returns 200 OK', async () => {
+      const payload = {
+        success: true,
+        message: 'Order successfully deleted',
+        object: 'order',
+        id: '5dd5a396248481164a225af4',
+        status: 'cancelled',
+        cancellation_reason: 'Ingin mengganti kurir',
+      };
+
+      server.use(
+        rest.delete(baseUrl('orders/1'), (_, res, ctx) => {
+          return res(ctx.status(200), ctx.json(payload));
+        }),
+      );
+
+      const command = new DeleteOrder({
+        id: 1,
+        cancelllation_reason: 'Ingin mengganti kurir',
+      });
+
+      const response = await invokerWithApiKey.send(command);
+
+      expect(response).toEqual(payload);
+    });
+  });
+});

tests/commands/retrieve-order.test.ts

@@ -51,7 +51,7 @@ describe('retrieve-order.ts', () => {
         }),
       );
 
-      const command = new RetrieveOrder({id: 123});
+      const command = new RetrieveOrder({ id: 123 });
 
       const response = await invokerWithInvalidApiKey.send(command);