Add error argument to createStubRequest

Author: dpikt

docs.md

@@ -350,6 +350,8 @@ A function that creates action creators for making stubbed API requests.
 Unlike [createRequest][21], these action creators do not make real API calls but rather
 resolve immediately with the provided data.
 
+If an `error` key is provided in the stub data object, the "request" will reject with the value of that key instead of resolving.
+
 ### Parameters
 
 -   `type` **[String][33]** A unique key that will be used to identify the request internally in redux
@@ -358,6 +360,8 @@ resolve immediately with the provided data.
 ### Examples
 
 ```javascript
+// ** Stubbing a successful request: **
+
 export const fetchUser = createStubRequest('FETCH_USER', (id) => ({ id }))
 
 fetchUsers(5)
@@ -369,6 +373,13 @@ handleActions({
    [apiActions.fetchUser]: (state, action) => ...
 })
 
+// ** Stubbing a failed request: **
+
+export const fetchUser = createStubRequest('FETCH_USER', (id) => ({ error: new Error('My mock error.') }))
+
+fetchUsers(5)
+// -> won't make any api request, but will reject with the given error.
+
 *
 ```
 

src/create-stub-request.js

@@ -7,14 +7,17 @@ import { isObject, isFunction, identity } from 'lodash'
  * 
  * Unlike {@link createRequest}, these action creators do not make real API calls but rather
  * resolve immediately with the provided data.
+ * 
+ * If an `error` key is provided in the stub data object, the "request" will reject with the value of that key instead of resolving.
  *
  * @name createStubRequest
  * @param {String} type - A unique key that will be used to identify the request internally in redux
  * @param {Object|Function} dataDefinition - Data that the request will resolve with, or a function that returns data to resolve with.
  * @returns {Function} An action creator that passes its arguments to `dataDefinition` and makes the resulting stubbed API request.
  * @example
  *
- *
+ * // ** Stubbing a successful request: **
+ * 
  * export const fetchUser = createStubRequest('FETCH_USER', (id) => ({ id }))
  *
  * fetchUsers(5)
@@ -25,6 +28,13 @@ import { isObject, isFunction, identity } from 'lodash'
  * handleActions({
  *    [apiActions.fetchUser]: (state, action) => ...
  * })
+ * 
+ * // ** Stubbing a failed request: **
+ * 
+ * export const fetchUser = createStubRequest('FETCH_USER', (id) => ({ error: new Error('My mock error.') }))
+ *
+ * fetchUsers(5)
+ * // -> won't make any api request, but will reject with the given error.
  *
 **/
 

src/middleware/middleware.js

@@ -32,10 +32,12 @@ import { isFunction } from 'lodash'
  * @type Function
  */
 
-// custom HTTP method for stub requests- makes no call, but resolves with provided data.
+// custom HTTP method for stub requests- makes no call, but resolves/rejects with provided data
 function createStubRequest (data) {
   return function request () {
-    return Promise.resolve(data)
+    return new Promise((resolve, reject) => {
+      return data.error ? reject(data.error) : resolve(data)
+    })
   }
 }
 

test/middleware.test.js

@@ -149,6 +149,21 @@ test('middleware resolves stubbed requests with provided data', () => {
   })
 })
 
+test('middleware rejects stubbed requests with error key', () => {
+  expect.assertions(1)
+  const ERROR = new Error('mock error')
+  const store = mockStore({})
+  const stubAction = {
+    [LP_API]: {
+      isStub: true,
+      stubData: { error: ERROR }
+    }
+  }
+  return store.dispatch(stubAction).catch((res) => {
+    expect(res).toEqual(ERROR)
+  })
+})
+
 test('middleware dispatches default success action with correct data argument', () => {
   const store = mockStore({})
   return store.dispatch(actionWithURL(successUrl)).then(() => {