Summary

Add an API resource for hosting services.

Review Request #5882 — Created May 26, 2014 and submitted May 27, 2014, 5:50 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

master

Bugs

Depends On

~~5883~~

Commit

b163f12...

Reviewers

Groups

reviewboard

People

Description

This introduces /api/hosting-services/, which provides basic information
on the hosting services supported by Review Board.

The resource does not expose all the information on a HostingService.
Right now, I'm keeping to the basic information, such as the name and
capabilities, until I determine what we're going to want to use for the
new repository configuration UI. This UI may impact how HostingService
itself structures data down the road, so it's not worth baking anything
related to that into the API yet.

This work is loosely based on Olessia's UCOSP work, though many
changes were made to better fit in with other resources, to take
advantage of what WebAPIResource provides, and to make use of the new
LocalDataQuerySet (which greatly reduces the amount of code).

Testing Done

Fetched the list resource and compared the output to the values from
the HostingServices.

Followed links to the item resources. Saw those being fetched as well,
with the correct data.

Tested that things like pagination worked (had to limit the number of
results for this).

Unit tests passed.

Issues

Description	From	Last Updated
'webapi_response_errors' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'webapi_request_fields' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'webapi_login_required' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'PERMISSION_DENIED' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'DOES_NOT_EXIST' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'NOT_LOGGED_IN' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'get_hosting_service' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'webapi_check_login_required' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
'webapi_check_local_site' imported but unused	reviewbot	May 27, 2014, 12:03 a.m.
Hmm. Can we clarify this somehow? "Whether creating review requests for committed changes is supported through the web UI?"	david	May 27, 2014, 2:33 p.m.

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

This is a review from Review Bot.
  Tool: Pyflakes
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'webapi_response_errors' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'webapi_request_fields' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'webapi_login_required' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'PERMISSION_DENIED' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'DOES_NOT_EXIST' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'NOT_LOGGED_IN' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'get_hosting_service' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'webapi_check_login_required' imported but unused
```
reviewboard/webapi/resources/hosting_service.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'webapi_check_local_site' imported but unused
```

Change Summary:

Fixed unused imports.

Commit:

0d057a82da3cc3fb49ee44c9e4c6394792711553

697885011801d31399e2cc17c62febfff473aa36

Diff:

Revision 2 (+220)

Show changes

	docs/manual/webapi/2.0/resources/hosting-service.rst
	docs/manual/webapi/2.0/resources/hosting-service-list.rst
	docs/manual/webapi/2.0/resources/index.rst
	reviewboard/webapi/resources/hosting_service.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_hosting_service.py
	reviewboard/webapi/tests/urls.py

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

This is a review from Review Bot.
  Tool: Pyflakes
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

reviewboard/webapi/resources/hosting_service.py (Diff revision 2)

The issue has been resolved. Show all issues

Hmm. Can we clarify this somehow? "Whether creating review requests for committed changes is supported through the web UI?"

Change Summary:

Improved the wording of the supports_post_commit capability.

Commit:

697885011801d31399e2cc17c62febfff473aa36

d5418bf814fcdc156e6aad2d63286ef9adb8c34a

Diff:

Revision 3 (+221)

Show changes

	docs/manual/webapi/2.0/resources/hosting-service.rst
	docs/manual/webapi/2.0/resources/hosting-service-list.rst
	docs/manual/webapi/2.0/resources/index.rst
	reviewboard/webapi/resources/hosting_service.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_hosting_service.py
	reviewboard/webapi/tests/urls.py

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

This is a review from Review Bot.
  Tool: Pyflakes
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

Ship it!

reviewboard/webapi/resources/hosting_service.py (Diff revisions 2 - 3)

This is still not great, since rbtools can "post an existing commit through the API". That said, I'm struggling to come up with anything better, and I doubt anyone will actually use this anyway.

chipx86 May 27, 2014, 5:06 p.m.

True. Maybe it's worth nuking that capability and add some more fine-grained ones for things like commit lookup, branch lookup, etc. That could be more useful and descriptive.

I can remove it from the API for now.

Change Summary:

Removed the supports_post_commit capability in the API until we know what we want to do here.

Commit:

d5418bf814fcdc156e6aad2d63286ef9adb8c34a

b163f12f7d65bdb237ba77aa439ab16553694ca4

Diff:

Revision 4 (+214)

Show changes

	docs/manual/webapi/2.0/resources/hosting-service.rst
	docs/manual/webapi/2.0/resources/hosting-service-list.rst
	docs/manual/webapi/2.0/resources/index.rst
	reviewboard/webapi/resources/hosting_service.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_hosting_service.py
	reviewboard/webapi/tests/urls.py

This is a review from Review Bot.
  Tool: PEP8 Style Checker
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

This is a review from Review Bot.
  Tool: Pyflakes
  Processed Files:
    reviewboard/webapi/tests/test_hosting_service.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/resources/hosting_service.py
    reviewboard/webapi/tests/mimetypes.py
  Ignored Files:
    docs/manual/webapi/2.0/resources/hosting-service-list.rst
    docs/manual/webapi/2.0/resources/hosting-service.rst
    docs/manual/webapi/2.0/resources/index.rst

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (e84c2aa)