Summary

FileProvider resource web API for providers

Review Request #7124 — Created March 26, 2015 and updated May 20, 2015, 6:16 p.m.

Information

Owner

VTL-Developer

Repository

Review Board

Branch

master

Bugs

Depends On

6948, 6806

Blocks

7140

Commit

f853527...

Reviewers

Groups

reviewboard, students

People

Description

Any instance of ReviewBoard may support the FileProvider framework. If they do, they may support different sets of file providers and each one may be implemented differently. By having an API for GET requests, it can lists all of the supported file providers for users and implementations to know what file providers are supported, and information associated with them. GET requests for to learn about individual file providers can also be made with api/file-providers/<name>/

Testing Done

Test cases for the GET api calls (via reviewboard/webapi/tests/test_file_provider.py), and manual testing with GET requests

Issues

Description	From	Last Updated
'webapi_response_errors' imported but unused	reviewbot	March 26, 2015, 2:35 p.m.
This can be one line. Same below.	chipx86	April 2, 2015, 8:49 a.m.
No parens here.	chipx86	April 2, 2015, 8:50 a.m.
Or here.	chipx86	April 2, 2015, 8:49 a.m.
Where is this being caught? Also, can we raise FileProvider.DoesNotExist? the ObjectDoesNotExist exception could apply to any model.	brennie	April 15, 2015, 2:48 p.m.
This can be a single line.	brennie	April 16, 2015, 12:24 p.m.
No blank line here.	brennie	April 16, 2015, 12:24 p.m.
"file-providers/"	brennie	April 16, 2015, 12:24 p.m.
Test docstrings should not end in a period.	brennie	April 16, 2015, 12:24 p.m.
Should be in the imperative mood ("Return")	david	May 20, 2015, 6:16 p.m.
Should be in the imperative mood ("Return")	david	May 20, 2015, 6:16 p.m.

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/tests/test_file_provider.py
    reviewboard/fileproviders/fileprovider.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/tests/test_file_provider.py
    reviewboard/fileproviders/fileprovider.py

reviewboard/webapi/resources/file_provider.py (Diff revision 1)
Show all issues
```
 'webapi_response_errors' imported but unused
```

Change Summary:

Added get_links for FileProviderAccountResource for items to point to the correct url for their file provider item

Commit:

-	9985b6cc4f52a15d0a24c07bf1a287b44723d77e
+	645246c9df72f2c2653120f40c65dffbc35120f4

Diff:

Revision 2 (+233)

Show changes

	reviewboard/fileproviders/fileprovider.py
	reviewboard/webapi/resources/file_provider.py
	reviewboard/webapi/resources/file_provider_account.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_file_provider.py
	reviewboard/webapi/tests/urls.py

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py



Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py

Summary:

-	[WIP] FileProvider resource web API for providers
+	FileProvider resource web API for providers

Depends On:

+	6948 - FileProvider WebApi interaction with file provider account

reviewboard/webapi/resources/file_provider.py (Diff revision 2)
Show all issues
```
This can be one line.
Same below.
```
reviewboard/webapi/tests/test_file_provider.py (Diff revision 2)
Show all issues
```
No parens here.
```
reviewboard/webapi/tests/test_file_provider.py (Diff revision 2)
Show all issues
```
Or here.
```

Change Summary:

Fixed styling issues brought up by reviews.
Updated the return to remove path_sep in the payload, as that is no longer supported. Adjusted test cases accordingly as well.

Description:

~		Any instance of ReviewBoard may support the FileProvider framework, and if they do, they may support different sets of file providers and each one may be implemented differently. By having an API that lists all of the supported file providers, users and implemenntations would know what file providers are supported, and information associated with them.
	~	Any instance of ReviewBoard may support the FileProvider framework. If they do, they may support different sets of file providers and each one may be implemented differently. By having an API that lists all of the supported file providers, users and implementations would know what file providers are supported, and information associated with them.

Commit:

-	645246c9df72f2c2653120f40c65dffbc35120f4
+	f3d36dce2452d0e14c687f85ebcf5f5de42fab03

Diff:

Revision 3 (+225)

Show changes

	reviewboard/fileproviders/fileprovider.py
	reviewboard/webapi/resources/file_provider.py
	reviewboard/webapi/resources/file_provider_account.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_file_provider.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py

Description:

~		Any instance of ReviewBoard may support the FileProvider framework. If they do, they may support different sets of file providers and each one may be implemented differently. By having an API that lists all of the supported file providers, users and implementations would know what file providers are supported, and information associated with them.
	~	Any instance of ReviewBoard may support the FileProvider framework. If they do, they may support different sets of file providers and each one may be implemented differently. By having an API for GET requests, it can lists all of the supported file providers for users and implementations to know what file providers are supported, and information associated with them. GET requests for to learn about individual file providers can also be made with `api/file-providers/<name>/`

Fix it!

reviewboard/webapi/resources/file_provider.py (Diff revision 3)

Show all issues

Where is this being caught?

Also, can we raise FileProvider.DoesNotExist? the ObjectDoesNotExist exception could apply to any model.

VTL-Developer April 16, 2015, 12:27 p.m.

This would be handled the parent class WebAPIResource in djblets (djblets/djblets/webapi/resources.py). The documentation in get_queryset for WebAPIResource specifies to throw that particular ObjectDoesNotExist if the requested object is not found. The parent class would handle the rest. Drop issue?

brennie April 16, 2015, 1:26 p.m.

It should still raise a FileProvider.DoesNotExist error instead.

reviewboard/webapi/resources/file_provider.py (Diff revision 3)
Show all issues
```
This can be a single line.
```
reviewboard/webapi/tests/test_file_provider.py (Diff revision 3)
Show all issues
```
No blank line here.
```
reviewboard/webapi/tests/test_file_provider.py (Diff revision 3)
Show all issues
```
"file-providers/"
```
reviewboard/webapi/tests/test_file_provider.py (Diff revision 3)
Show all issues
```
Test docstrings should not end in a period.
```

Change Summary:

Fixed documentation issues, and styling for code.

Commit:

-	f3d36dce2452d0e14c687f85ebcf5f5de42fab03
+	f853527b2cd68bd7877b699be65f5814e3ab3369

Diff:

Revision 4 (+222)

Show changes

	reviewboard/fileproviders/fileprovider.py
	reviewboard/webapi/resources/file_provider.py
	reviewboard/webapi/resources/file_provider_account.py
	reviewboard/webapi/resources/root.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_file_provider.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/file_provider.py
    reviewboard/webapi/resources/root.py
    reviewboard/fileproviders/fileprovider.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/file_provider_account.py
    reviewboard/webapi/tests/test_file_provider.py

Ship it! Fix it!

reviewboard/webapi/resources/file_provider.py (Diff revision 4)
Show all issues
```
Should be in the imperative mood ("Return")
```
reviewboard/webapi/resources/file_provider.py (Diff revision 4)
Show all issues
```
Should be in the imperative mood ("Return")
```