Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add flag to allow UrlEncodedContent to use UriPath escaping #1100

Merged
merged 7 commits into from Oct 13, 2020
Merged

feat: add flag to allow UrlEncodedContent to use UriPath escaping #1100

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e61cccf
Add the possibility to use UriPath encoding for the URL content inste…
guillaumeblaquiere Aug 28, 2020
6b50a04
Use boolean primitive type.
guillaumeblaquiere Aug 29, 2020
681381d
Fix documentation issues
guillaumeblaquiere Oct 12, 2020
a8d4e87
Fix documentation typos
guillaumeblaquiere Oct 12, 2020
b528d57
fix: documentation typos.
guillaumeblaquiere Oct 12, 2020
84c482f
Merge remote-tracking branch 'origin/1098/uripathencoding' into 1098/…
guillaumeblaquiere Oct 12, 2020
92ac9ab
chore: fix lint
chingor13 Oct 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 9 additions & 4 deletions google-http-client/src/main/java/com/google/api/client/http/UrlEncodedContent.java
View file
Open in desktop
Expand Up @@ -53,25 +53,30 @@ public class UrlEncodedContent extends AbstractHttpContent {
/** Use URI Path encoder flag. False by default (use legacy and deprecated escapeUri) */
private boolean uriPathEncodingFlag;

/** @param data key name/value data */
/**
* Initialize the UrlEncodedContent with the legacy and deprecated escapeUri encoder
* @param data key name/value data
* */
public UrlEncodedContent(Object data) {
super(UrlEncodedParser.MEDIA_TYPE);
setData(data);
this.uriPathEncodingFlag = false;
}

/**
* Initialize the UrlEncodedContent with our without the legacy and deprecated escapeUri encoder
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

our --> or?

* @param data key name/value data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the key is a name and a value? That's surprising.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy paste of the legacy comment (see line 56 of the file.) I kept the legacy signature and behavior, and I added mine with additional parameter. This one is unchanged (and I guess its description also!)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if you want me to improve both or if keeping the existing description is ok.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I look at this the weirder it is. Why is this an object instead of a Map?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree; it's strange and I don't know why to use an Object instead of a Map! However to ensure the compatibility with other app that depends on this library, I kept the existing signature.

* @param useUriPathEncoding Escapes the string value so it can be safely included in URI path segments. For details on
* * escaping URIs, see <a href="http://tools.ietf.org/html/rfc3986#section-2.4">RFC 3986 - section
* * 2.4</a>
* @param useUriPathEncoding Escapes the string value so it can be safely included in URI path segments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Escapes --> escapes

* For details on escaping URIs, see <a href="http://tools.ietf.org/html/rfc3986#section-2.4">RFC 3986 -
* section 2.4</a>
*/
public UrlEncodedContent(Object data, Boolean useUriPathEncoding) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boolean --> boolean
per Effective Java

super(UrlEncodedParser.MEDIA_TYPE);
setData(data);
this.uriPathEncodingFlag = useUriPathEncoding;
}

@Override
public void writeTo(OutputStream out) throws IOException {
Writer writer = new BufferedWriter(new OutputStreamWriter(out, getCharset()));
boolean first = true;
Expand Down