Changes between Version 18 and Version 19 of BluePrintRESTImplementation

Timestamp:

01/02/09 02:03:22 (16 years ago)

Author:

Fran Boon

Comment:

New Implementation with shn_rest_controller() broken out :)

BluePrintRESTImplementation

@@ -2 +2 @@
 
 == Model ==
-Simplified:
-{{{
-db.define_table('cr_shelter',
-                SQLField('modified_on','datetime',default=now),
-                SQLField('uuid',length=64,default=uuid.uuid4()),
-                SQLField('name'))
-db.cr_shelter.represent=lambda table:shn_list_item(table,resource='shelter',action='display')
-}}}
-
-== Controller ==
-{{{
-# RESTful controller function
-# Anonymous users can Read
-# Authentication required for Create/Update/Delete
-def shelter():
-    resource='shelter'
+{{{
+def shn_crud_strings_lookup(resource):
+    "Look up CRUD strings for a given resource."
+    if resource=='shelter':
+        return Storage(title_create=T('Add Shelter'),
+            title_display=T('Organisation Details'),
+            title_list=T('List Shelters'),
+            title_update=T('Edit Shelter'),
+            subtitle_list=T('Shelters'),
+            subtitle_create=T('Add New Shelter'),
+            label_list_button=T('List Shelters'),
+            label_create_button=T('Add Shelter'),
+            msg_record_created=T('Shelter added'),
+            msg_record_modified=T('Shelter updated'),
+            msg_record_deleted=T('Shelter deleted'),
+            msg_list_empty=T('No Shelters currently registered'))
+    else:
+        # Undefined Resource!
+        return
+
+def shn_rest_controller(module,resource):
+    """
+    RESTful controller function.
+    
+    Anonymous users can Read.
+    Authentication required for Create/Update/Delete.
+    
+    ToDo:
+        Alternate Representations
+        Search method
+        Customisable Security Policy
+    """
+    
     table=db['%s_%s' % (module,resource)]
-    if request.args:
+    
+    crud_strings=shn_crud_strings_lookup(resource)
+
+    if len(request.args)==0:
+        # No arguments => default to list (or list_create if logged_in)
+        list=t2.itemize(table)
+        if list=="No data":
+            list=crud_strings.msg_list_empty
+        title=crud_strings.title_list
+        subtitle=crud_strings.subtitle_list
+        if t2.logged_in:
+            form=t2.create(table)
+            response.view='list_create.html'
+            addtitle=crud_strings.subtitle_create
+            return dict(module_name=module_name,modules=modules,options=options,list=list,form=form,title=title,subtitle=subtitle,addtitle=addtitle)
+        else:
+            add_btn=A(crud_strings.label_create_button,_href=t2.action(resource,'create'))
+            response.view='list.html'
+            return dict(module_name=module_name,modules=modules,options=options,list=list,title=title,subtitle=subtitle,add_btn=add_btn)
+            
+    else:
         method=request.args[0]
-        try:
-            # 1st argument is ID not method => display
-            id = int(method)
+        if request.args[0].isdigit():
+            # 1st argument is ID not method => display.
+            # Default format (representation) is full HTML page
             item=t2.display(table)
             response.view='display.html'
-            title=T('Shelter Details')
+            title=crud_strings.title_display
             edit=A(T("Edit"),_href=t2.action(resource,['update',t2.id]))
-            list_btn=A(T("List Shelters"),_href=t2.action(resource))
+            list_btn=A(crud_strings.label_list_button,_href=t2.action(resource))
             return dict(module_name=module_name,modules=modules,options=options,item=item,title=title,edit=edit,list_btn=list_btn)
-        except:
+        else:
             if method=="create":
                 if t2.logged_in:
-                    t2.messages.record_created=T("Shelter added")
+                    t2.messages.record_created=crud_strings.msg_record_created
                     form=t2.create(table)
                     response.view='create.html'
-                    title=T('Add Shelter')
-                    list_btn=A(T("List Shelters"),_href=t2.action(resource))
+                    title=crud_strings.title_create
+                    list_btn=A(crud_strings.label_list_button,_href=t2.action(resource))
                     return dict(module_name=module_name,modules=modules,options=options,form=form,title=title,list_btn=list_btn)
                 else:
@@ -45 +82 @@
             elif method=="update":
                 if t2.logged_in:
-                    t2.messages.record_modified=T("Shelter updated")
+                    t2.messages.record_modified=crud_strings.msg_record_modified
                     form=t2.update(table)
                     response.view='update.html'
-                    title=T('Edit Shelter')
-                    list_btn=A(T("List Shelters"),_href=t2.action(resource))
+                    title=crud_strings.title_update
+                    list_btn=A(crud_strings.label_list_button,_href=t2.action(resource))
                     return dict(module_name=module_name,modules=modules,options=options,form=form,title=title,list_btn=list_btn)
                 else:
@@ -55 +92 @@
             elif method=="delete":
                 if t2.logged_in:
-                    t2.messages.record_deleted=T("Shelter deleted")
+                    t2.messages.record_deleted=crud_strings.msg_record_deleted
                     t2.delete(table,next=resource)
                     return
@@ -61 +98 @@
                     t2.redirect('login',vars={'_destination':'%s/delete/%i' % (resource,t2.id)})
             else:
-                # Invalid!
-                return
-    else:
-        # No arguments => default to list
-        list=t2.itemize(table)
-        if list=="No data":
-            list="No Shelters currently registered."
-        title=T('List Shelters')
-        subtitle=T('Shelters')
-        if t2.logged_in:
-            form=t2.create(table)
-            response.view='list_create.html'
-            addtitle=T('Add New Shelter')
-            return dict(module_name=module_name,modules=modules,options=options,list=list,form=form,title=title,subtitle=subtitle,addtitle=addtitle)
-        else:
-            add_btn=A(T("Add Shelter"),_href=t2.action(resource,'create'))
-            response.view='list.html'
-            return dict(module_name=module_name,modules=modules,options=options,list=list,title=title,subtitle=subtitle,add_btn=add_btn)
+                # Unsupported method!
+                t2.redirect(resource)
+}}}
+
+Simplified module table:
+{{{
+db.define_table('cr_shelter',
+                SQLField('modified_on','datetime',default=now),
+                SQLField('uuid',length=64,default=uuid.uuid4()),
+                SQLField('name'))
+db.cr_shelter.represent=lambda table:shn_list_item(table,resource='shelter',action='display')
+}}}
+
+== Controller ==
+{{{
+def shelter():
+    "RESTful CRUD controller"
+    return shn_rest_controller(module,'shelter')
 }}}