added testcase for newline in api key #185
Merged
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.
Addition to what is written in #184
The current implementation of the authorization header results in an edge case where, when the resulting header is deemed invalid from the underlying HTTP library (urllib3), a value error is thrown, which is simply printed. This includes the content of the authorization header (the API key).
By simply stripping any leading or trailing white spaces (which include newlines), this should get rid of the error.
I can also not think of any edge cases where stripping the API key might lead to problems, since only whitespace leading or trailing the actual API key will be removed.
One could make the case that the strip is unnecessary for the bearer token, but my argument for keeping it is that it
Last point:
Why did I choose strip instead of strip? If we believe that a user, while pasting the API key, might make the mistake of entering a newline at the end of the API key, he might also paste a newline at the beginning.