Add API and form adapters #42
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There’s an issue with mocha-webpack where requiring the spec helper in the config file doesn’t make its changes visible to the actual specs. See zinserjan/mocha-webpack#1.
With `formApiAdapter`, you can wrap a redux-api-middleware action creator in such a way that it will work as expected by redux-form. The promise returned by the adapter will: * Resolve with a successful payload * Reject with a failing payload If the failing payload is a 422 error, the rejection contains error information in the format expected by redux-form. The error formatting is Rails-specific for now. It would be possible to pass the error formatter into `formApiAdapter` and rename our current formatter as `railsErrorFormatter` or something like that.
Provide a `callApi` helper that wraps a redux-api-middleware action and augments it as follows: * Call an `onSuccess` callback on a successful call. This allows for follow-up actions to be taken and/or dispatched when the API call succeeds. * Default the request method to `GET`. This can still be overridden. * Add a `Content-Type: ‘application/json’` header to the request. * Convert any keys in the body to snake_case * Convert keys in a success or failure response back to camelCase * Convert `’true’` and `’false’` strings in success payloads to booleans
|
Looks good to me. Hopefully the require thing will be resolved soon. |
# Conflicts: # package.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Forms
With
formApiAdapter, you can wrap a redux-api-middleware actioncreator in such a way that it will work as expected by redux-form. The
promise returned by the adapter will:
If the failing payload is a 422 error, the rejection contains error
information in the format expected by redux-form.
The error formatting is Rails-specific for now. It would be possible
to pass the error formatter into
formApiAdapterand rename ourcurrent formatter as
railsErrorFormatteror something like that.API calls
Provide a
callApihelper that wraps a redux-api-middleware action andaugments it as follows:
onSuccesscallback on a successful call. This allows forfollow-up actions to be taken and/or dispatched when the API call
succeeds.
GET. This can still be overridden.Content-Type: ‘application/json’header to the request.’true’and’false’strings in success payloads to booleansOther
Import specHelper in every spec file (for now).
There’s an issue with mocha-webpack where requiring the spec helper in the config file doesn’t make its changes visible to the actual specs. See zinserjan/mocha-webpack#1.
I forgot to
git pairon this; I paired with @awc737. This PR supercedes the earlier #34 that @julianrogmans worked on because the project code that this was based on changed significantly since he opened that PR.