feat: QA-15 Added http methods for GET,POST,PUT,DELETE with filter as…

… object or string. Renamed addRestMock to mockREST.

AddRestMock became deprecated.

README.md

@@ -22,7 +22,7 @@ test('can create client', async () => {
     const mocketeer = Mocketeer.setup(page);
 
     // Set up a mock
-    const mock = await mocketeer.addRestMock(
+    const mock = await mocketeer.mockREST(
         {
             method: 'POST',
             path: '/api/user',
@@ -64,7 +64,7 @@ import { Mocketeer } from '@hltech/mocketeer';
     const mocketeer = Mocketeer.setup(page);
 
     // Set up a mock
-    const mock = await mocketeer.addRestMock(
+    const mock = await mocketeer.mockREST(
         {
             method: 'POST',
             path: '/api/user',
@@ -133,7 +133,7 @@ const page = await browser.newPage();
 await mocketeer.activate(page);
 ```
 
-#### .addRestMock(filter: RequestFilter, response: MockedResponse, options?): RestMock
+#### .mockREST(filter: RequestFilter, response: MockedResponse, options?): RestMock
 
 Respond to xhr and fetch requests that match the `filter` with provided `response`.
 Pass query params through `query` argument in `filter` object or simply append text to `url`
@@ -158,7 +158,7 @@ Newly created instance of `RestMock`.
 ###### Example
 
 ```typescript
-mocketeer.addRestMock(
+mocketeer.mockREST(
     {
         method: 'POST',
         url: '/api/clients',
@@ -175,7 +175,7 @@ mocketeer.addRestMock(
 ###### Example with query passed as an argument
 
 ```typescript
-mocketeer.addRestMock(
+mocketeer.mockREST(
     {
         method: 'GET',
         url: '/api/clients',
@@ -196,7 +196,7 @@ mocketeer.addRestMock(
 ###### Example with queryString appended to the url
 
 ```typescript
-mocketeer.addRestMock(
+mocketeer.mockREST(
     {
         method: 'GET',
         url: '/api/clients?city=Bristol&limit=10',
@@ -210,6 +210,98 @@ mocketeer.addRestMock(
 );
 ```
 
+#### .mockGET(filter: RequestMethodFilter | string, response: MockedResponse, options?): RestMock
+
+#### .mockPOST(filter: RequestMethodFilter | string, response: MockedResponse, options?): RestMock
+
+#### .mockPUT(filter: RequestMethodFilter | string, response: MockedResponse, options?): RestMock
+
+#### .mockDELETE(filter: RequestMethodFilter | string, response: MockedResponse, options?): RestMock
+
+Respond to xhr and fetch requests with adequate rest method that match the `filter` with provided `response`.
+Pass `filter` as an object or as an `url` string.
+Pass query params through `query` argument in `filter` object or simply append text to `url`
+
+###### Arguments
+
+-   `filter` _(RequestMethodFilter)_ used to determine if request matches the mock
+    -   `url: string`
+    -   `query(optional): QueryObject` object literal which accepts strings and arrays of strings as values, transformed to queryString
+-   `filter` _(string)_ `url` used to determine if request matches the mock
+-   `response` _(MockedResponse)_ content of mocked response
+    -   `status: number`
+    -   `headers: object`
+    -   `body: any`
+-   `options` _(object)_ optional config object
+    -   `prority` _(number)_ when intercepted request matches multiple mock, mocketeer will use the one with highest priority
+
+###### Returns
+
+Newly created instance of `RestMock`.
+
+###### Example of GET request
+
+```typescript
+mocketeer.mockGET(
+    {
+        url: '/api/clients',
+    },
+    {
+        status: 201,
+        body: {
+            clientId: 12345,
+        },
+    }
+);
+```
+
+###### Example of GET request with query passed as an argument
+
+```typescript
+mocketeer.mockGET(
+    {
+        url: '/api/clients',
+        query: {
+            city: 'Bristol',
+            limit: 10,
+        },
+    },
+    {
+        status: 200,
+        body: {
+            clientId: 12345,
+        },
+    }
+);
+```
+
+###### Example of GET request with queryString appended to the url
+
+```typescript
+mocketeer.mockGET(
+    {
+        url: '/api/clients?city=Bristol&limit=10',
+    },
+    {
+        status: 200,
+        body: {
+            clientId: 12345,
+        },
+    }
+);
+```
+
+###### Example of GET request with filter as a string with query
+
+```typescript
+mocketeer.mockGET('/api/clients?city=Bristol&limit=10', {
+    status: 200,
+    body: {
+        clientId: 12345,
+    },
+});
+```
+
 ---
 
 ### RestMock
@@ -239,7 +331,7 @@ Promise resolved with `MatchedRequest` - object representing request that matche
 ###### Example
 
 ```typescript
-const createClientMock = mocketeer.addRestMock(
+const createClientMock = mocketeer.mockREST(
     {
         method: 'POST',
         url: '/api/clients',

src/mocketeer.ts

@@ -2,7 +2,13 @@ import { parse } from 'url';
 import { Page, Request, ResourceType } from 'puppeteer';
 import dbg from 'debug';
 import { RestMock } from './rest-mock';
-import { MockedResponse, MockOptions, RequestFilter } from './types';
+import {
+    MockedResponse,
+    MockOptions,
+    RequestFilter,
+    RequestMethodFilter,
+    REST_METHOD,
+} from './types';
 import { printRequest, requestToPlainObject } from './utils';
 
 const interceptedTypes: ResourceType[] = ['xhr', 'fetch'];
@@ -41,6 +47,10 @@ export class Mocketeer {
         page.on('request', request => this.onRequest(request));
     }
 
+    /*
+     * Use mockREST instead
+     * @deprecated
+     */
     public addRestMock(
         filter: RequestFilter,
         response: MockedResponse,
@@ -53,6 +63,78 @@ export class Mocketeer {
         return mock;
     }
 
+    public mockREST(
+        filter: RequestFilter,
+        response: MockedResponse,
+        options?: Partial<MockOptions>
+    ): RestMock {
+        const mock = new RestMock(filter, response, {
+            ...options,
+        });
+        this.mocks.push(mock);
+        return mock;
+    }
+
+    public mockGET(
+        filter: RequestMethodFilter | string,
+        response: MockedResponse,
+        options?: Partial<MockOptions>
+    ): RestMock {
+        const filterObject =
+            typeof filter === 'string' ? { url: filter } : filter;
+
+        return this.mockREST(
+            { ...filterObject, method: REST_METHOD.GET },
+            response,
+            options
+        );
+    }
+
+    public mockPOST(
+        filter: RequestMethodFilter | string,
+        response: MockedResponse,
+        options?: Partial<MockOptions>
+    ): RestMock {
+        const filterObject =
+            typeof filter === 'string' ? { url: filter } : filter;
+
+        return this.mockREST(
+            { ...filterObject, method: REST_METHOD.POST },
+            response,
+            options
+        );
+    }
+
+    public mockPUT(
+        filter: RequestMethodFilter | string,
+        response: MockedResponse,
+        options?: Partial<MockOptions>
+    ): RestMock {
+        const filterObject =
+            typeof filter === 'string' ? { url: filter } : filter;
+
+        return this.mockREST(
+            { ...filterObject, method: REST_METHOD.PUT },
+            response,
+            options
+        );
+    }
+
+    public mockDELETE(
+        filter: RequestMethodFilter | string,
+        response: MockedResponse,
+        options?: Partial<MockOptions>
+    ): RestMock {
+        const filterObject =
+            typeof filter === 'string' ? { url: filter } : filter;
+
+        return this.mockREST(
+            { ...filterObject, method: REST_METHOD.DELETE },
+            response,
+            options
+        );
+    }
+
     public removeMock(mock: RestMock): RestMock | void {
         const index = this.mocks.indexOf(mock);
         if (index > -1) {

src/types.ts

@@ -2,12 +2,15 @@ import { ResourceType } from 'puppeteer';
 
 export type QueryObject = Record<string, string | string[]>;
 
-export interface RequestFilter {
-    method: string;
+export interface RequestMethodFilter {
     url: string;
     query?: QueryObject;
 }
 
+export interface RequestFilter extends RequestMethodFilter {
+    method: string;
+}
+
 export interface ParsedFilterRequest {
     method: string;
     hostname: string | undefined;
@@ -44,3 +47,10 @@ export interface IMock {
         origin: string
     ): MockedResponse | null;
 }
+
+export enum REST_METHOD {
+    GET = 'GET',
+    POST = 'POST',
+    PUT = 'PUT',
+    DELETE = 'DELETE',
+}

test/integration/fixture/mock-fixtures.ts

@@ -1,4 +1,15 @@
-import { RequestFilter } from '../../../src/types';
+import { RequestFilter, RequestMethodFilter } from '../../../src/types';
+
+export const requestFoo: RequestMethodFilter = {
+    url: '/foo',
+};
+
+export const requestFooWithQuery: RequestMethodFilter = {
+    url: '/foo',
+    query: {
+        param: 'fooParam',
+    },
+};
 
 export const requestGetFoo: RequestFilter = {
     method: 'GET',
@@ -18,6 +29,16 @@ export const requestPostFoo: RequestFilter = {
     url: '/foo',
 };
 
+export const requestPutFoo: RequestFilter = {
+    method: 'PUT',
+    url: '/foo',
+};
+
+export const requestDeleteFoo: RequestFilter = {
+    method: 'DELETE',
+    url: '/foo',
+};
+
 export const response200Empty = {
     status: 200,
     body: {},