feat(api): add another way of customizing otp query

This option allows setting the custom builder function in the config
when creating the reducer’s initial state.  When using all of the
reducers together they make calls to the planTrip action, but there
wasn’t really a way to pass in a custom function that way.  For now it
seems like the only way to do this could be to set something in the
config of the state.

This PR includes the work done in #12.

Author: evansiroky

__tests__/actions/__snapshots__/api.js.snap

@@ -1,8 +1,48 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`actions > api should make a query to OTP 1`] = `"/api/plan?arriveBy=false&fromPlace=12%2C34&showIntermediateStops=true&toPlace=34%2C12"`;
+exports[`actions > api > planTrip should make a query to OTP with customOtpQueryBuilder in state config 1`] = `"/api/plan?from=here&to=there"`;
 
-exports[`actions > api should make a query to OTP 2`] = `
+exports[`actions > api > planTrip should make a query to OTP with customOtpQueryBuilder in state config 2`] = `
+Array [
+  Array [
+    Object {
+      "type": "PLAN_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "fake": "response",
+      },
+      "type": "PLAN_RESPONSE",
+    },
+  ],
+]
+`;
+
+exports[`actions > api > planTrip should make a query to OTP with customOtpQueryBuilder sent to action 1`] = `"/api/plan?from=here&to=there"`;
+
+exports[`actions > api > planTrip should make a query to OTP with customOtpQueryBuilder sent to action 2`] = `
+Array [
+  Array [
+    Object {
+      "type": "PLAN_REQUEST",
+    },
+  ],
+  Array [
+    Object {
+      "payload": Object {
+        "fake": "response",
+      },
+      "type": "PLAN_RESPONSE",
+    },
+  ],
+]
+`;
+
+exports[`actions > api > planTrip should make a query to OTP with default settings 1`] = `"/api/plan?arriveBy=false&fromPlace=12%2C34&showIntermediateStops=true&toPlace=34%2C12"`;
+
+exports[`actions > api > planTrip should make a query to OTP with default settings 2`] = `
 Array [
   Array [
     Object {

__tests__/actions/api.js

@@ -10,48 +10,82 @@ function timeoutPromise (ms) {
   })
 }
 
-const planTripAction = planTrip()
-
 describe('actions > api', () => {
-  it('should make a query to OTP', async () => {
-    nock('http://mock-host.com')
-      .get(/api\/plan/)
-      .reply(200, {
-        fake: 'response'
-      })
-      .on('request', (req, interceptor) => {
-        expect(req.path).toMatchSnapshot()
-      })
+  describe('> planTrip', () => {
+    const defaultState = {
+      otp: {
+        config: {
+          api: {
+            host: 'http://mock-host.com',
+            path: '/api',
+            port: 80
+          }
+        },
+        currentQuery: {
+          from: { lat: 12, lon: 34 },
+          to: { lat: 34, lon: 12 }
+        },
+        searches: []
+      }
+    }
 
-    const mockDispatch = jest.fn()
-    planTripAction(mockDispatch, () => {
-      return {
-        otp: {
-          config: {
-            api: {
-              host: 'http://mock-host.com',
-              path: '/api',
-              port: 80
-            }
-          },
-          currentQuery: {
-            from: {
-              lat: 12,
-              lon: 34
-            },
-            to: {
-              lat: 34,
-              lon: 12
-            }
+    const customOtpQueryBuilder = () => {
+      return `http://mock-host.com/api/plan?from=here&to=there`
+    }
+
+    const stateWithCustomBuilderFunction = {
+      otp: {
+        config: {
+          api: {
+            host: 'http://mock-host.com',
+            path: '/api',
+            port: 80
           },
-          searches: []
-        }
+          customOtpQueryBuilder
+        },
+        currentQuery: {
+          from: { lat: 12, lon: 34 },
+          to: { lat: 34, lon: 12 }
+        },
+        searches: []
       }
-    })
+    }
 
-    // wait for request to complete
-    await timeoutPromise(100)
+    const testCases = [{
+      state: defaultState,
+      title: 'default settings'
+    }, {
+      customOtpQueryBuilder,
+      state: defaultState,
+      title: 'customOtpQueryBuilder sent to action'
+    }, {
+      state: stateWithCustomBuilderFunction,
+      title: 'customOtpQueryBuilder in state config'
+    }]
 
-    expect(mockDispatch.mock.calls).toMatchSnapshot()
+    testCases.forEach((testCase) => {
+      it(`should make a query to OTP with ${testCase.title}`, async () => {
+        const planTripAction = planTrip(testCase.customOtpQueryBuilder)
+
+        nock('http://mock-host.com')
+          .get(/api\/plan/)
+          .reply(200, {
+            fake: 'response'
+          })
+          .on('request', (req, interceptor) => {
+            expect(req.path).toMatchSnapshot()
+          })
+
+        const mockDispatch = jest.fn()
+        planTripAction(mockDispatch, () => {
+          return testCase.state
+        })
+
+        // wait for request to complete
+        await timeoutPromise(100)
+
+        expect(mockDispatch.mock.calls).toMatchSnapshot()
+      })
+    })
   })
 })

lib/actions/api.js

@@ -8,7 +8,7 @@ if (typeof (fetch) === 'undefined') {
   require('isomorphic-fetch')
 }
 
-import { hasValidLocation } from '../util/state'
+import { queryIsValid } from '../util/state'
 
 export const receivedPlanResponse = createAction('PLAN_RESPONSE')
 export const requestPlanResponse = createAction('PLAN_REQUEST')
@@ -22,9 +22,9 @@ export function planTrip (customOtpQueryBuilder) {
       console.log('query hasn\'t changed')
       return
     }
-    if (!hasValidLocation(otpState, 'from') || !hasValidLocation(otpState, 'to')) return // TODO: replace with isQueryValid?
+    if (!queryIsValid(otpState)) return
     dispatch(requestPlanResponse())
-    const queryBuilderFn = customOtpQueryBuilder || constructPlanQuery
+    const queryBuilderFn = customOtpQueryBuilder || otpState.config.customOtpQueryBuilder || constructPlanQuery
     const url = queryBuilderFn(otpState.config.api, otpState.currentQuery)
     // setURLSearch(url)
     fetch(url)