Summary

Create new web api for Checklist templates

Review Request #6106 — Created July 15, 2014 and discarded Dec. 10, 2014, 4:54 p.m.

Information

Owner

salam0smy

Repository

rb-extension-pack

Branch

Bugs

Depends On

Reviewers

Groups

students

People

Description

Declerations, and override access methods.

Added create method to post a new template list. It attaches the user to the new template list.

Added update method that :
- creates a new items when id is not present
- updates items when id, and description is present
- delete item when only id is present

Testing Done

Issues

Description	From	Last Updated
Col: 46 E127 continuation line over-indented for visual indent	reviewbot	July 17, 2014, 11:41 a.m.
Col: 80 E501 line too long (80 > 79 characters)	reviewbot	July 17, 2014, 11:41 a.m.
Col: 54 W292 no newline at end of file	reviewbot	July 17, 2014, 11:41 a.m.
Col: 46 E127 continuation line over-indented for visual indent	reviewbot	July 17, 2014, 11:41 a.m.
Col: 17 E127 continuation line over-indented for visual indent	reviewbot	July 17, 2014, 11:41 a.m.
undefined name 'ObjectDoesNotExist'	reviewbot	July 17, 2014, 11:41 a.m.
undefined name 'DOES_NOT_EXIST'	reviewbot	July 17, 2014, 11:41 a.m.
'PERMISSION_DENIED' imported but unused	reviewbot	July 23, 2014, 12:31 p.m.
'NOT_LOGGED_IN' imported but unused	reviewbot	July 23, 2014, 12:31 p.m.
You only really need braces around the from _ import _ if it spans multiple lines.	MA matthewcmaclean	July 28, 2014, 3:59 p.m.
Reviewboard uses trailing commas on lists and dictionaries.	MA matthewcmaclean	July 28, 2014, 3:59 p.m.
Reviewboard uses trailing commas on lists and dictionaries. You should add them to all your other dictionaries as well.	MA matthewcmaclean	July 28, 2014, 3:59 p.m.
This shouldn't be necessary. You can add a request argument (immediately after self), and then use request.user to find the …	david	July 28, 2014, 4 p.m.
PUT is used to update an object. I don't think you should support adding or deletion in update. In the …	MA matthewcmaclean	July 25, 2014, 8:27 p.m.
'User' imported but unused	reviewbot	Aug. 10, 2014, 6:29 p.m.
Can you change this to name = 'checklist_template'?	anselina	Aug. 10, 2014, 6:27 p.m.
Very minor nitpick - there is no need for extra newlines before elif/else clauses (at least that's how it's done …	VO volodymyr	Aug. 10, 2014, 6:28 p.m.
Add one more blank line before this. (There should be two blank lines between top-level blocks.)	anselina	Aug. 10, 2014, 6:28 p.m.

Tool: PEP8 Style Checker
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py



Tool: Pyflakes
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py

checklist/checklist/ChecklistTemplateResource.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 46
 E127 continuation line over-indented for visual indent
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (80 > 79 characters)
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 54
 W292 no newline at end of file
```

Change Summary:

Added update method

Description:

		Declerations, and override access methods.



		Added create method to post a new template list. It attaches the user to the new template list.
	+
	+	Added update method that :
	+	- creates a new items when id is not present
	+	- updates items when id, and description is present
	+	- delete item when only id is present

Commit:

34a6bd7af5f8e8b38e5393c889b8e9a96bc116c1

0ab373fbd5f8b27a1caa75f817487164193a8bc4

Diff:

Revision 2 (+90)

Show changes

checklist/checklist/ChecklistTemplateResource.py

Tool: PEP8 Style Checker
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py



Tool: Pyflakes
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py

checklist/checklist/ChecklistTemplateResource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Col: 46
 E127 continuation line over-indented for visual indent
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Col: 17
 E127 continuation line over-indented for visual indent
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'ObjectDoesNotExist'
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
 undefined name 'DOES_NOT_EXIST'
```

Change Summary:

Imported errors and exception objects

Commit:

0ab373fbd5f8b27a1caa75f817487164193a8bc4

bf801a5af61aed33eda9a0ee7c1ff58e2b831099

Diff:

Revision 3 (+93)

Show changes

checklist/checklist/ChecklistTemplateResource.py

Tool: PEP8 Style Checker
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py



Tool: Pyflakes
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py

checklist/checklist/ChecklistTemplateResource.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 'PERMISSION_DENIED' imported but unused
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 3)
The issue has been resolved. Show all issues
```
 'NOT_LOGGED_IN' imported but unused
```

Change Summary:

deleted unused imports.

Commit:

bf801a5af61aed33eda9a0ee7c1ff58e2b831099

e113f67958e85ad7595867a4e5738c86c403c653

Diff:

Revision 4 (+92)

Show changes

checklist/checklist/ChecklistTemplateResource.py

Summary:: [WIP] Create new web api for Checklist templates
Create new web api for Checklist templates

Tool: PEP8 Style Checker
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py



Tool: Pyflakes
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py

Fix it!

checklist/checklist/ChecklistTemplateResource.py (Diff revision 4)
The issue has been resolved. Show all issues
```
You only really need braces around the from _ import _ if it spans multiple lines.
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 4)
The issue has been resolved. Show all issues
```
Reviewboard uses trailing commas on lists and dictionaries.
```

checklist/checklist/ChecklistTemplateResource.py (Diff revision 4)

The issue has been resolved. Show all issues

Reviewboard uses trailing commas on lists and dictionaries. You should add them to all your other dictionaries as well.

checklist/checklist/ChecklistTemplateResource.py (Diff revision 4)

An issue was opened. Show all issues

PUT is used to update an object. I don't think you should support adding or deletion in update. In the situation that the object is invalid if it has no description so it should be deleted, you might want to make the field required instead of optional.

salam0smy July 28, 2014, 3:59 p.m.

Here the update is used to manipulate the object's properties including a list. Adding or deleting from the list is still considered an update because the parent object exists, and its properies has changed. DELETE is used to delete the whole object including the list.

checklist/checklist/ChecklistTemplateResource.py (Diff revision 4)

The issue has been resolved. Show all issues

This shouldn't be necessary. You can add a request argument (immediately after self), and then use request.user to find the authenticated user.

That also prevents people from impersonating others when creating checklist templates.

Change Summary:

Fixed format, added a flag for deleting items.

Commit:

e113f67958e85ad7595867a4e5738c86c403c653

b7f57c5f1a48c9ab6243f6329b63a499eab9a545

Diff:

Revision 5 (+88)

Show changes

checklist/checklist/ChecklistTemplateResource.py

Tool: PEP8 Style Checker
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py



Tool: Pyflakes
Processed Files:
    checklist/checklist/ChecklistTemplateResource.py

checklist/checklist/ChecklistTemplateResource.py (Diff revision 5)
The issue has been resolved. Show all issues
```
 'User' imported but unused
```

checklist/checklist/ChecklistTemplateResource.py (Diff revision 5)

The issue has been resolved. Show all issues

Very minor nitpick - there is no need for extra newlines before elif/else clauses (at least that's how it's done in 99% of the codebase).

checklist/checklist/ChecklistTemplateResource.py (Diff revision 5)
The issue has been resolved. Show all issues
```
Can you change this to name = 'checklist_template'?
```
checklist/checklist/ChecklistTemplateResource.py (Diff revision 5)
The issue has been resolved. Show all issues
```
Add one more blank line before this. (There should be two blank lines between top-level blocks.)
```

Change Summary:

Changed api name to include underscore instead of camel case style. Fixed a bug where I wasn't initlizing the right resource for the api.

Commit:

b7f57c5f1a48c9ab6243f6329b63a499eab9a545

6f966a5d6194f17cb7e6a39ace78f356b0f9c244

Diff:

Revision 6 (+7 -34)

Show changes

	checklist/checklist/ChecklistTemplateResource.py
	checklist/checklist/extension.py
	checklist/checklist/urls.py
	checklist/checklist/views.py

Status:: Discarded