Fix: sending JSON or multipart requests #995
Open
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
Sending url-encoded params, json or multipart requests with Guzzle is easy, because shortcuts are implemented within [`GuzzleHttp\Client::applyOptions()`](https://github.com/guzzle/guzzle/blob/7.5.0/src/Client.php#L340). Currently, those shortcuts are unreachable through the League OAuth2 Client, and thus all its providers. This fix relies on `AbstractProvider::getResponse()`, and does not affect `AbstractProvider::getAuthenticatedRequest()`. `GuzzleHttp\ClientInterface::send()` method supports a second optional `$options` parameter [since v6.0](guzzle/guzzle@1a9ad6b?diff=split#diff-7fe9d7bab1528c58fb39365621c6f02430dd01828c26fe8b00f0408de72c71b8). Upgrading `AbstractProvider::getResponse()` to support this second optional parameter allows the developper to use a `"form_params"`, `"json"` or `"multipart"` option key : ```php $options = ['multipart' => $multipart]; $request = $oauth2client->getAuthenticatedRequest($method, $url, $token); $response = $oauth2client->getResponse($request, $options); ```
This was referenced Mar 25, 2023
|
@fverry, thank you for submitting this PR. Please take a look at the failing tests and fix those. Then, we'll accept this. |
|
I'd note that this is an issue for @fverry I'm wondering why you chose this as the fix though. Would it not be better to fix RequestFactory::getRequestWithOptions to use GuzzleHttp\Client::applyOptions() instead of cherry-picking only |
|
Wow thank god I found this thread because I was having a hell of a time getting POST requests to work. |
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.
Sending url-encoded params, json or multipart requests with Guzzle is easy, because shortcuts are implemented within
GuzzleHttp\Client::applyOptions().Currently, those shortcuts are unreachable through the League OAuth2 Client, and thus all its providers.
This fix relies on
AbstractProvider::getResponse(), and does not affectAbstractProvider::getAuthenticatedRequest().GuzzleHttp\ClientInterface::send()method supports a second optional$optionsparameter since v6.0.Upgrading
AbstractProvider::getResponse()to support this second optional parameter allows the developper to use a"form_params","json"or"multipart"option key :See also
Fixes: #935 #985
Duplicates: #967
For immediate use
Run the following on composer CLI:
composer config repositories.oauth2-client vcs https://github.com/fverry/oauth2-client composer require "league/oauth2-client:dev-httpclientinterface-send-options as 2.x-dev"Workaround
Use:
Instead of: