Summary

Add support for OAuth2 in the web API

Review Request #9030 — Created June 22, 2017 and submitted July 20, 2017, 1:24 p.m.

Information

Owner

brennie

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Blocks

9072

Commit

537d872...

Reviewers

Groups

djblets

People

Description

Djblets now supports OAuth2 authentication in the Web API. Documentation
has been added, in the form of a guide, showing how to enable OAuth2
token access in applications.

This support is added via the django_oauth_toolkit package, which is a
development dependnecy but not a deployment dependency. The OAuth2
features will simply be non-functional if the dependency is not
installed.

Some minor cleanup has been done in the ResourceAPITokenMixin to
help ensure methods from mixins don't override eachother. Additionally,
The WebAPITestCaseMixin was fixed so that additional arguments can be
passed to the underlying client request.

Based on work by: Minh Le Hoang (https://reviews.reviewboard.org/r/7997/)

Testing Done


Ran unit tests.
Tested this with an upcoming change for adding OAuth2 token access to

  Review Board.
Built the docs and read through them.

Files

Issues

Description	From	Last Updated
You posted the wrong revision range. The latest diff here includes other changes.	david	July 17, 2017, 3:11 p.m.
F841 local variable 'old__setattr__' is assigned to but never used	reviewbot	June 22, 2017, 5:18 p.m.
E501 line too long (85 > 79 characters)	reviewbot	July 7, 2017, 4:07 p.m.
W391 blank line at end of file	reviewbot	June 22, 2017, 5:18 p.m.
E501 line too long (85 > 79 characters)	reviewbot	July 7, 2017, 4:07 p.m.
Is there any reason to not include request in the kwargs in the function?	david	July 7, 2017, 2:58 p.m.
Would be a little bit nicer as: if (valid and self.verify_request(request, r.access_token, r.user)): return r.user else: return None	david	July 7, 2017, 3 p.m.
I'm on the edge of my seat.	david	July 7, 2017, 3 p.m.
When importing just a single item, continuation is ok.	david	July 7, 2017, 4:07 p.m.
E501 line too long (85 > 79 characters)	reviewbot	July 7, 2017, 4:07 p.m.
E303 too many blank lines (3)	reviewbot	July 6, 2017, 3:31 p.m.
F401 'oauth2_provider.models.AccessToken' imported but unused	reviewbot	July 6, 2017, 3:31 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
E703 statement ends with a semicolon	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:05 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:05 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:05 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:05 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:05 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
E703 statement ends with a semicolon	reviewbot	July 7, 2017, 4:07 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:07 p.m.
E703 statement ends with a semicolon	reviewbot	July 7, 2017, 4:06 p.m.
W291 trailing whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
W293 blank line contains whitespace	reviewbot	July 7, 2017, 4:06 p.m.
Isn't this part of another change?	david	July 10, 2017, 5:13 p.m.
F401 'djblets.webapi.errors.PERMISSION_DENIED' imported but unused	reviewbot	July 14, 2017, 6:38 p.m.
F401 'djblets.webapi.errors.OAUTH_EXPIRED_ERROR' imported but unused	reviewbot	July 14, 2017, 6:38 p.m.
F401 'djblets.webapi.errors.NOT_LOGGED_IN' imported but unused	reviewbot	July 17, 2017, 3:21 p.m.
Too many blank lines.	david	July 20, 2017, 1:23 p.m.
E501 line too long (94 > 79 characters)	reviewbot	July 20, 2017, 1:22 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/webapi/oauth2_scopes.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F841 local variable 'old__setattr__' is assigned to but never used
```
djblets/webapi/resources/mixins/oauth2_tokens.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (85 > 79 characters)
```
djblets/webapi/tests/test_oauth2_scopes.py (Diff revision 1)
The issue has been resolved. Show all issues
```
W391 blank line at end of file
```

Change Summary:

flake8 fixups

Diff:

Revision 2 (+1240 -25)

	dev-requirements.txt
	djblets/extensions/manager.py
	djblets/extensions/signals.py
	djblets/webapi/oauth2_scopes.py
	djblets/webapi/auth/backends/base.py
	djblets/webapi/auth/backends/oauth2_tokens.py
	djblets/webapi/resources/mixins/api_tokens.py
	djblets/webapi/resources/mixins/oauth2_tokens.py
	8 more

		Ran unit tests.
		Tested this with an upcoming change for adding OAuth2 token access to Review Board.
	+	Built the docs and read through them.

		Djblets now supports OAuth2 authentication in the Web API. Documentation
		has been added, in the form of a guide, showing how to enable OAuth2
		token access in applications.

		This support is added via the `django_oauth_toolkit` package, which is a
		development dependnecy but not a deployment dependency. The OAuth2
		features will simply be non-functional if the dependency is not
		installed.

		Some minor cleanup has been done in the `ResourceAPITokenMixin` to
		help ensure methods from mixins don't override eachother. Additionally,
		The `WebAPITestCaseMixin` was fixed so that additional arguments can be
		passed to the underlying client request.
	+
	+	Based on work by: Minh Le Hoang (https://reviews.reviewboard.org/r/7997/)

	dev-requirements.txt
	djblets/staticbundles.py
	djblets/extensions/manager.py
	djblets/extensions/signals.py
	djblets/static/djblets/css/config-forms.less
	djblets/static/djblets/js/configForms/collections/listItemsCollection.js
	djblets/static/djblets/js/configForms/models/listItemModel.js
	djblets/static/djblets/js/configForms/models/listItemModel.es6.js
	28 more

Add support for OAuth2 in the web API

Information

Reviewers

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (2 succeeded)

Checks run (1 failed, 1 succeeded)

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (1 failed, 1 succeeded)

flake8

Checks run (2 succeeded)

Checks run (2 succeeded)

Checks run (2 succeeded)

Checks run (2 succeeded)

Checks run (1 failed, 1 succeeded)

flake8

Checks run (2 succeeded)

Checks run (1 failed, 1 succeeded)

flake8

Checks run (2 succeeded)

Checks run (1 failed, 1 succeeded)

flake8