set userinfo using Mojo::URL in Mojo::UserAgent Basic auth example #1407
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
|
@mojolicious/core Calling for a vote |
|
I don't know that I agree with removing the first style, I could see adding the other style too. Might also want to show url escaped example |
|
I considered that but it seems too busy for what is a tiny segment of an already pretty full synopsis. I think it's best to only show the best way that covers all situations. |
kraih
requested changes
Sep 16, 2019
lib/Mojo/UserAgent.pm
Outdated
| @@ -385,7 +385,9 @@ Mojo::UserAgent - Non-blocking I/O HTTP and WebSocket user agent | |||
| my $tx = $ua->put('[::1]:3000' => {'Content-Type' => 'text/plain'} => 'Hi!'); | |||
|
|
|||
| # Quick JSON API request with Basic authentication | |||
| my $value = $ua->get('https://sri:t3st@example.com/test.json')->result->json; | |||
| use Mojo::URL; | |||
There was a problem hiding this comment.
I don't like that this example contains a use line. That doesn't feel right for a synopsis.
There was a problem hiding this comment.
Would you prefer it just be omitted? (The example for the prepare event does this already)
There was a problem hiding this comment.
Removed the use line
Grinnz
force-pushed
the
useragent_basic_example
branch
from
f0d4043
to
77bbd09
Compare
|
Restarting the vote @mojolicious/core |
kraih
approved these changes
Sep 17, 2019
jberger
approved these changes
Sep 17, 2019
jhthorsen
approved these changes
Sep 17, 2019
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.
Summary
Basic auth commonly uses username and password values from external sources, so they should be set using the Mojo::URL userinfo method rather than directly in the URL where they need to be escaped.
Motivation
More correct example for a common use case
References
IRC discussion