feat($post-request): add support for mocking post requests

added the method along with all implementation inside react-mock class, it is probably better to put
logic in a separate file for ease of scalabilty

Author: Marcellin Nshimiyimana

src/react-mock/index.ts

@@ -63,6 +63,28 @@ export default class ServerClass {
     })
     // END save handler to our pretender map
   }
+
+  mockPost(
+    endPoint: string,
+    handler: (
+      req: Object,
+      generator: IDataGenerator
+    ) => ResponseData | Promise<ResponseData>,
+    ...rest: Array<any>
+  ): void {
+    // START save handler to our pretender map
+    let dataGenerator = this.dataGenerator
+    this.routeMapList.push(function routeMap(this: Pretender) {
+      this.post(
+        endPoint,
+        (req: Object) => {
+          return handler(req, dataGenerator)
+        },
+        ...rest
+      )
+    })
+    // END save handler to our pretender map
+  }
 }
 
 export const Faker = faker

test/acceptance/mock-delete.test.ts

@@ -0,0 +1,80 @@
+// import ServerClass, { Server, Faker, uid } from 'react-mock'
+import axios from 'axios'
+import ServerClass, {
+  Server,
+  Faker,
+  uid,
+  IDataGenerator
+} from '../../src/react-mock'
+
+describe('Get Request', () => {
+  afterEach(() => {
+    return Server.off()
+  })
+
+  const apiRoute = '/api/v1/guides'
+
+  const schema = {
+    description: () => Faker.lorem.sentence(),
+    createdAt: () => Faker.date.past(),
+    favoredCount: () => Faker.random.number(),
+    isPublic: () => Faker.random.boolean(),
+    author: {
+      id: uid.next(),
+      name: Faker.name.findName(),
+      picture: Faker.internet.avatar()
+    }
+  }
+
+  it('mocks get request with array response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is an array of 10 objects in it
+          return expect(data.length).toEqual(5)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+
+  it('mocks get request with map response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema, true)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is a map of 10 objects where key is the id of each object
+          let firstKey = Object.keys(data)[0]
+          let firstObject = data[firstKey]
+          return expect(firstObject.id).toEqual(firstKey)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+})

test/acceptance/mock-patch.test.ts

@@ -0,0 +1,80 @@
+// import ServerClass, { Server, Faker, uid } from 'react-mock'
+import axios from 'axios'
+import ServerClass, {
+  Server,
+  Faker,
+  uid,
+  IDataGenerator
+} from '../../src/react-mock'
+
+describe('Get Request', () => {
+  afterEach(() => {
+    return Server.off()
+  })
+
+  const apiRoute = '/api/v1/guides'
+
+  const schema = {
+    description: () => Faker.lorem.sentence(),
+    createdAt: () => Faker.date.past(),
+    favoredCount: () => Faker.random.number(),
+    isPublic: () => Faker.random.boolean(),
+    author: {
+      id: uid.next(),
+      name: Faker.name.findName(),
+      picture: Faker.internet.avatar()
+    }
+  }
+
+  it('mocks get request with array response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is an array of 10 objects in it
+          return expect(data.length).toEqual(5)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+
+  it('mocks get request with map response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema, true)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is a map of 10 objects where key is the id of each object
+          let firstKey = Object.keys(data)[0]
+          let firstObject = data[firstKey]
+          return expect(firstObject.id).toEqual(firstKey)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+})

test/acceptance/mock-post.test.ts

@@ -0,0 +1,54 @@
+// import ServerClass, { Server, Faker, uid } from 'react-mock'
+import axios from 'axios'
+import ServerClass, {
+  Server,
+  Faker,
+  uid,
+  IDataGenerator
+} from '../../src/react-mock'
+
+describe('Get Request', () => {
+  afterEach(() => {
+    return Server.off()
+  })
+
+  const apiRoute = '/api/v1/guides'
+
+  const schema = {
+    description: Faker.lorem.sentence(),
+    createdAt: Faker.date.past(),
+    favoredCount: Faker.random.number(),
+    isPublic: Faker.random.boolean(),
+    author: {
+      id: uid.next(),
+      name: Faker.name.findName(),
+      picture: Faker.internet.avatar()
+    }
+  }
+
+  const id = uid.next()
+  it('mocks post request with an object response that has id', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guide = { ...schema, id }
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guide)
+      ]
+    }
+
+    Server.mockPost(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.post('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is an object that has an id value in it
+          return expect(data.id).toEqual(id)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+})

test/acceptance/mock-put.test.ts

@@ -0,0 +1,80 @@
+// import ServerClass, { Server, Faker, uid } from 'react-mock'
+import axios from 'axios'
+import ServerClass, {
+  Server,
+  Faker,
+  uid,
+  IDataGenerator
+} from '../../src/react-mock'
+
+describe('Get Request', () => {
+  afterEach(() => {
+    return Server.off()
+  })
+
+  const apiRoute = '/api/v1/guides'
+
+  const schema = {
+    description: () => Faker.lorem.sentence(),
+    createdAt: () => Faker.date.past(),
+    favoredCount: () => Faker.random.number(),
+    isPublic: () => Faker.random.boolean(),
+    author: {
+      id: uid.next(),
+      name: Faker.name.findName(),
+      picture: Faker.internet.avatar()
+    }
+  }
+
+  it('mocks get request with array response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is an array of 10 objects in it
+          return expect(data.length).toEqual(5)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+
+  it('mocks get request with map response', () => {
+    const requestHandler = (request, generator): [number, any, string] => {
+      const guides = generator.next(5, schema, true)
+      return [
+        200,
+        { 'Content-Type': 'application/json' },
+        JSON.stringify(guides)
+      ]
+    }
+
+    Server.mockGet(apiRoute, requestHandler, 1000)
+
+    return Server.on()
+      .then(() => {
+        return axios.get('/api/v1/guides').then(({ data }) => {
+          // console.log('[axios] /api/v1/guides', data)
+          // we assert that data is a map of 10 objects where key is the id of each object
+          let firstKey = Object.keys(data)[0]
+          let firstObject = data[firstKey]
+          return expect(firstObject.id).toEqual(firstKey)
+        })
+      })
+      .then(() => {
+        return Server.off()
+      })
+  })
+})