Backend:

   Update docstrings for API views

1 files changed, 68 insertions, 34 deletions

diff --git a/backend/views.py b/backend/views.py
index edd0a2a..8e6cd5b 100644
--- a/backend/views.py
+++ b/backend/views.py
@@ -21,7 +21,8 @@ API_HEADER = '#@scanjam 0.3b\n'
 #
 
 def set_cors_headers(response):
-    """ Setup additional headers for response """
+    """ Setup additional headers for response
+    """
     response['Access-Control-Allow-Origin'] = '*'
     response['Access-Control-Allow-Methods'] = 'POST, GET, OPTIONS'
     response['Access-Control-Allow-Headers'] = 'x-requested-with'
@@ -29,7 +30,8 @@ def set_cors_headers(response):
     response['Content-type'] = 'text/plain; charset=UTF-8'
 
 def api_error(error, response=None):
-    """ Add API error name to response """
+    """ Add API error name to response
+    """
     if not response:
         response = HttpResponse()
     response.write(API_HEADER)
@@ -37,14 +39,16 @@ def api_error(error, response=None):
     return response
 
 def api_error_headers(error, response=None):
-    """ Add API error name with setup headers to response """
+    """ Add API error name with setup headers to response
+    """
     if not response:
         response = HttpResponse()
     set_cors_headers(response)
     return api_error(error, response)
 
 def api_ok_headers(response=None):
-    """ Add API OK with setup headers to response """
+    """ Add API OK with setup headers to response
+    """
     if not response:
         response = HttpResponse()
     set_cors_headers(response)
@@ -53,7 +57,8 @@ def api_ok_headers(response=None):
     return response
 
 def check_form_fields(request, form_fields):
-    """ Check form fields presence """
+    """ Check form fields presence
+    """
     for field, value in request.POST.iteritems():
         print field, '= "%s"' % value
     for field in form_fields:
@@ -63,7 +68,8 @@ def check_form_fields(request, form_fields):
             return api_error_headers('no %s' % field)
 
 def user_response_str(request, user=None):
-    """ Return API response string for user """
+    """ Return API response string for user
+    """
     if not user:
         user = request.user
     if user.is_authenticated():
@@ -83,7 +89,8 @@ def user_response_str(request, user=None):
 
 @require_POST
 def api_auth_login(request):
-    """ Log in user """
+    """ Log in user. Public API
+    """
     form_fields = ['username', 'password']
     response = check_form_fields(request, form_fields)
     if response:
@@ -106,13 +113,15 @@ def api_auth_login(request):
 
 @require_POST
 def api_auth_logout(request):
-    """ Log out user """
+    """ Log out user. Public API
+    """
     auth.logout(request)
     return api_ok_headers()
 
 @require_POST
 def api_auth_sneakin(request):
-    """ Sneak in user """
+    """ Sneak in user. Public API
+    """
     form_fields = ['userid', 'username']
     response = check_form_fields(request, form_fields)
     if response:
@@ -134,7 +143,8 @@ def api_auth_sneakin(request):
 
 @require_POST
 def api_auth_register(request):
-    """ Register new user """
+    """ Register new user. Public API
+    """
     form_fields = ['username', 'password']
     response = check_form_fields(request, form_fields)
     if response:
@@ -164,7 +174,8 @@ def api_auth_register(request):
 
 @require_POST
 def api_auth_available(request):
-    """ Check if user exists"""
+    """ Check if user exists. Public API
+    """
     form_fields = ['username']
     response = check_form_fields(request, form_fields)
     if response:
@@ -175,7 +186,8 @@ def api_auth_available(request):
 
 @require_POST
 def api_auth_checkin(request):
-    """ Check in user """
+    """ Check in user. Private API
+    """
     if request.user.is_authenticated():
         response = api_ok_headers()
         response.write(user_response_str(request))
@@ -184,7 +196,8 @@ def api_auth_checkin(request):
 
 @require_POST
 def api_auth_password(request):
-    """ Change user password """
+    """ Change user password. Private API
+    """
     form_fields = ['username', 'password']
     response = check_form_fields(request, form_fields)
     if response:
@@ -210,7 +223,8 @@ def api_auth_password(request):
 
 @require_POST
 def api_user_videos(request):
-    """"""
+    """ Public API
+    """
     form_fields = ['user', 'start']
     response = check_form_fields(request, form_fields)
     if response:
@@ -219,7 +233,8 @@ def api_user_videos(request):
 
 @require_POST
 def api_user_likes(request):
-    """"""
+    """ Public API
+    """
     form_fields = ['user', 'start']
     response = check_form_fields(request, form_fields)
     if response:
@@ -228,7 +243,8 @@ def api_user_likes(request):
 
 @require_POST
 def api_user_top(request):
-    """"""
+    """ Public API
+    """
     form_fields = ['user']
     response = check_form_fields(request, form_fields)
     if response:
@@ -237,7 +253,8 @@ def api_user_top(request):
 
 @require_POST
 def api_user_settings(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['user', 'bio', 'settings']
     response = check_form_fields(request, form_fields)
     if response:
@@ -250,7 +267,8 @@ def api_user_settings(request):
 
 @require_POST
 def api_room_watch(request):
-    """"""
+    """ Public API
+    """
     form_fields = ['room', 'last']
     response = check_form_fields(request, form_fields)
     if response:
@@ -259,12 +277,14 @@ def api_room_watch(request):
 
 @require_POST
 def api_room_list(request):
-    """"""
+    """ Public API
+    """
     return HttpResponse('Not implemented yet!\n')
 
 @require_POST
 def api_room_view(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'last']
     response = check_form_fields(request, form_fields)
     if response:
@@ -273,7 +293,8 @@ def api_room_view(request):
 
 @require_POST
 def api_room_join(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'enqueue']
     response = check_form_fields(request, form_fields)
     if response:
@@ -282,7 +303,8 @@ def api_room_join(request):
 
 @require_POST
 def api_room_read(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'enqueue']
     response = check_form_fields(request, form_fields)
     if response:
@@ -291,7 +313,8 @@ def api_room_read(request):
 
 @require_POST
 def api_room_poll(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'last', 'cam']
     response = check_form_fields(request, form_fields)
     if response:
@@ -300,7 +323,8 @@ def api_room_poll(request):
 
 @require_POST
 def api_room_settings(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'settings']
     response = check_form_fields(request, form_fields)
     if response:
@@ -309,7 +333,8 @@ def api_room_settings(request):
 
 @require_POST
 def api_room_say(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'msg']
     response = check_form_fields(request, form_fields)
     if response:
@@ -318,7 +343,8 @@ def api_room_say(request):
 
 @require_POST
 def api_room_video(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['room', 'msg']
     response = check_form_fields(request, form_fields)
     if response:
@@ -331,7 +357,8 @@ def api_room_video(request):
 
 @require_POST
 def api_video_date(request):
-    """"""
+    """ Public API
+    """
     form_fields = ['day', 'month', 'year']
     response = check_form_fields(request, form_fields)
     if response:
@@ -340,7 +367,8 @@ def api_video_date(request):
 
 @require_POST
 def api_video_view(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['video']
     response = check_form_fields(request, form_fields)
     if response:
@@ -349,7 +377,8 @@ def api_video_view(request):
 
 @require_POST
 def api_video_like(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['video']
     response = check_form_fields(request, form_fields)
     if response:
@@ -358,7 +387,8 @@ def api_video_like(request):
 
 @require_POST
 def api_video_unlike(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['video']
     response = check_form_fields(request, form_fields)
     if response:
@@ -367,7 +397,8 @@ def api_video_unlike(request):
 
 @require_POST
 def api_video_remove(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['video', 'room']
     response = check_form_fields(request, form_fields)
     if response:
@@ -376,7 +407,8 @@ def api_video_remove(request):
 
 @require_POST
 def api_video_search(request):
-    """"""
+    """ Private API
+    """
     form_fields = ['q', 'start', 'limit']
     response = check_form_fields(request, form_fields)
     if response:
@@ -388,7 +420,8 @@ def api_video_search(request):
 #
 
 def stats(request):
-    """ View statistics """
+    """ View statistics
+    """
     uptime = str(datetime.now() - settings.START_TIME)
     videos_today = None
     videos_total = None
@@ -412,7 +445,8 @@ def stats(request):
                                              'uptime': uptime})
 
 def redirect(request):
-    """ Permanent redirect """
+    """ Permanent redirect
+    """
     response = HttpResponsePermanentRedirect(redirect_to='http://scannerjammer.com')
     template = loader.get_template('redirect.html')
     response.write(template.render(Context()))