- Download Diff

Summary:

Add `api` command and options like `--get`, `--post`, `--put`, `--delete`, `--data=key1=value1` and `--header=headercontent`

Review Request #11479 — Created Feb. 21, 2021 and updated Feb. 21, 2021, 3:12 p.m.

Information
Owner:	qianxi
Repository:	RBTools
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	rbtools
People:

Description

The reason why we need api command instead of api-get is simple: We need to do HTTP GET, POST, PUT, DELETE requests.
I created api command, with new options --get, --post, --put, --delete, --data=key1=value1, --header=headercontent , original --pretty option and server options still work.
I'll add support for file data POST and PUT later.
Please omit "Merge XDG project changes in local branch into local master" commit, I believe the commit content should be the same as https://reviews.reviewboard.org/r/11423/.

Testing Done

For api --get, --post, --put, --delete options, I did some basic testings using command line tools. They all work for non-existed urls and --get works for existing api resources. We can use --data=key1=value1 to add post data and use --header=headercontent to add customized headers. And --pretty option still works. I will do further testing later.

Commits

Summary
Merge XDG project changes in local branch into local master
[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
[WIP]Add api.py file, forget to stage this file in the last commit.
[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
Refactor methods in api class. Now support use --header option to add customized header in a request.
[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
Remove redundant print statements from api-get.py
Fix coding style problems.
Fix more coding style problems.
Add a newline character.

Screenshots

Issues

Description	From	Last Updated
E225 missing whitespace around operator	reviewbot	Feb. 21, 2021, 2:49 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:49 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:50 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:51 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:51 p.m.
F401 'rbtools.commands.OptionGroup' imported but unused	reviewbot	Feb. 21, 2021, 2:52 p.m.
E302 expected 2 blank lines, found 1	reviewbot	Feb. 21, 2021, 2:52 p.m.
E128 continuation line under-indented for visual indent	reviewbot	Feb. 21, 2021, 2:54 p.m.
W503 line break before binary operator	reviewbot	Feb. 21, 2021, 2:56 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:57 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:57 p.m.
E128 continuation line under-indented for visual indent	reviewbot	Feb. 21, 2021, 2:57 p.m.
W503 line break before binary operator	reviewbot	Feb. 21, 2021, 2:58 p.m.
E303 too many blank lines (2)	reviewbot	Feb. 21, 2021, 2:58 p.m.
E231 missing whitespace after ':'	reviewbot	Feb. 21, 2021, 2:59 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 2:59 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 2:59 p.m.
W391 blank line at end of file	reviewbot	Feb. 21, 2021, 3 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 3:08 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 3:08 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 3:07 p.m.
W291 trailing whitespace	reviewbot	Feb. 21, 2021, 3:07 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 3:07 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 3:07 p.m.
W391 blank line at end of file	reviewbot	Feb. 21, 2021, 3:06 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 21, 2021, 3:06 p.m.
W292 no newline at end of file	reviewbot	Feb. 21, 2021, 3:11 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
E225 missing whitespace around operator
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/__init__.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```

rbtools/commands/api.py (Diff revision 1)

Show all issues

F401 'rbtools.commands.OptionGroup' imported but unused

rbtools/commands/api.py (Diff revision 1)
Show all issues
```
E302 expected 2 blank lines, found 1
```

rbtools/commands/api.py (Diff revision 1)

Show all issues

E128 continuation line under-indented for visual indent

rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W503 line break before binary operator
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```

rbtools/commands/api.py (Diff revision 1)

Show all issues

E128 continuation line under-indented for visual indent

rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W503 line break before binary operator
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
E303 too many blank lines (2)
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
E231 missing whitespace after ':'
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W291 trailing whitespace
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/api.py (Diff revision 1)
Show all issues
```
W391 blank line at end of file
```

Change Summary:

Fix coding style problems

Commits:

	Summary
-	Merge XDG project changes in local branch into local master
-	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
-	[WIP]Add api.py file, forget to stage this file in the last commit.
-	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
-	Refactor methods in api class. Now support use --header option to add customized header in a request.
-	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
-	Remove redundant print statements from api-get.py
+	Merge XDG project changes in local branch into local master
+	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
+	[WIP]Add api.py file, forget to stage this file in the last commit.
+	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
+	Refactor methods in api class. Now support use --header option to add customized header in a request.
+	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
+	Remove redundant print statements from api-get.py
+	Fix coding style problems.

Diff:

Revision 2 (+1120 -218)

Show changes

	.DS_Store
	setup.py
	contrib/tools/git-hook-check-approval
	rbtools/.DS_Store
	rbtools/api/client.py
	rbtools/api/request.py
	rbtools/api/tests/test_http_request.py
	rbtools/api/transport/sync.py
	9 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbtools/api/transport/sync.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/api/transport/sync.py (Diff revision 2)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 2)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 2)
Show all issues
```
W291 trailing whitespace
```
rbtools/api/transport/sync.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/__init__.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```
rbtools/commands/api.py (Diff revision 2)
Show all issues
```
W391 blank line at end of file
```
rbtools/commands/api.py (Diff revision 2)
Show all issues
```
W293 blank line contains whitespace
```

Change Summary:

Fix more coding style problems.

Commits:

	Summary
-	Merge XDG project changes in local branch into local master
-	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
-	[WIP]Add api.py file, forget to stage this file in the last commit.
-	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
-	Refactor methods in api class. Now support use --header option to add customized header in a request.
-	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
-	Remove redundant print statements from api-get.py
-	Fix coding style problems.
+	Merge XDG project changes in local branch into local master
+	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
+	[WIP]Add api.py file, forget to stage this file in the last commit.
+	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
+	Refactor methods in api class. Now support use --header option to add customized header in a request.
+	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
+	Remove redundant print statements from api-get.py
+	Fix coding style problems.
+	Fix more coding style problems.

Diff:

Revision 3 (+1124 -226)

Show changes

	.DS_Store
	setup.py
	contrib/tools/git-hook-check-approval
	rbtools/.DS_Store
	rbtools/api/client.py
	rbtools/api/request.py
	rbtools/api/tests/test_http_request.py
	rbtools/api/transport/sync.py
	9 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbtools/commands/api.py (Diff revision 3)
Show all issues
```
W292 no newline at end of file
```

Change Summary:

Add a newline character

Commits:

	Summary
-	Merge XDG project changes in local branch into local master
-	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
-	[WIP]Add api.py file, forget to stage this file in the last commit.
-	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
-	Refactor methods in api class. Now support use --header option to add customized header in a request.
-	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
-	Remove redundant print statements from api-get.py
-	Fix coding style problems.
-	Fix more coding style problems.
+	Merge XDG project changes in local branch into local master
+	[WIP]Add a new command called "api". Add option commands called "--get", "--post", "--delete". "api --get" option can substitute original "api-get" option now.
+	[WIP]Add api.py file, forget to stage this file in the last commit.
+	[WIP]Add "--put" option but still need to find out how to send post/put data. Add "--header" option, still need to find a way to combine our customized header with original data.
+	Refactor methods in api class. Now support use --header option to add customized header in a request.
+	[WIP]Allow basic HTTP GET, DELETE. Allow POST and PUT key value pairs. Still need further testings
+	Remove redundant print statements from api-get.py
+	Fix coding style problems.
+	Fix more coding style problems.
+	Add a newline character.

Diff:

Revision 4 (+1125 -227)

Show changes

	.DS_Store
	setup.py
	contrib/tools/git-hook-check-approval
	rbtools/.DS_Store
	rbtools/api/client.py
	rbtools/api/request.py
	rbtools/api/tests/test_http_request.py
	rbtools/api/transport/sync.py
	9 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

You have a pending review.

Review Board 4.0 RC1 (dev)

Add `api` command and options like `--get`, `--post`, `--put`, `--delete`, `--data=key1=value1` and `--header=headercontent`

flake8

Change Summary:

Commits:

Diff:

Checks run (1 failed, 1 succeeded)

flake8

Change Summary:

Commits:

Diff:

Checks run (1 failed, 1 succeeded)

flake8

Change Summary:

Commits:

Diff:

Checks run (2 succeeded)