Raise SailThru::UnavailableError when unable to parse API response #55
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
If the client fails to parse the response body, then the API is presumed to be malfunctioning and unavailable. Throw an UnavailableError including the actual response body returned.
Only return an error body when a parsable response is returned from the API, including a valid error code. e.g. { 'error'=> 9 }
Values for 'error' should only ever include valid SailThru error codes returned in a well-formed response body. (http://getstarted.sailthru.com/api/api-response-errors)
mtowers
changed the title
|
@mtowers - Your suggestion is appreciated. We'll review this PR and update you about plans to deal with the issue you raised. Thanks. |
|
@mtowers This change is not backwards compatible. We will consider making this change in a major version upgrade but for now we are going to keep it as is. |
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.
If the client fails to parse the response body, then the API is presumed to be malfunctioning and unavailable. Throw an
UnavailableErrorincluding the actual response body returned.Only return a ruby hash when a parsable response is returned from the API, including a valid error code. e.g.
{ 'error'=> 9 }Values for
errorshould only ever include valid SailThru error codes returned in a well-formed response body.