-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add put functionality to Oauth2 Client #30
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally the
put
method wouldn't have a different signature than the other method sigs. In order to support sending non-json payloads (which I assume you intend to do viakwargs['data']
?), we have some options to consider:put
using standard signature (i.e.put(self, request_path, json, **kwargs)
and your integration may be able to just passNone
as second arg? The client would still be json-inclined, but support this as a workaround for sending non-json payloadsjson
as a required second arg inpatch
andpost
, obligating integrations to pass it inkwargs
. This would be a breaking change.Thoughts, @charmingduchess ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinkin something similar, but it's also not completely clear to me what the scope / purpose of this class is. It's named like a generic oauth2 client, but it seems to have some platform api specific implementation details / functionality.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah naming things is hard. We would have called it PlatformApiClient, but we also use it for interacting with Sierra, which makes similar auth and payload choices. The uniting theme (and only real convenience provided by use of this client) is it does the oauth2 auth for you - hence the name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense - I'm aligned with keeping the method signatures the same and maybe we can revisit changing the standard signature later on?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea I was going to say the same thing. I think the signatures should match. Maybe for a major release we can reconsider the favoring of json. But for now let's keep the signatures the same.