Merge lp:~scott-armitage/pyng/uri-pattern into lp:pyng

[Scott Armitage]

Added URI handling and basic exception definitions.

[Scott Armitage (scott-armitage)]

review: Approve

=== modified file 'PyngPyng/__init__.py' (properties changed: +x to -x)
--- PyngPyng/__init__.py	2009-05-24 23:57:05 +0000
+++ PyngPyng/__init__.py	2009-05-26 02:25:17 +0000
@@ -16,6 +16,7 @@
 
 # Extension modules -----------------------------------------------------------
 from PyngPyng.pages import Page, ErrorPage
+from PyngPyng import exceptions as exc
 from PyngPyng import version
 
 # Module function -------------------------------------------------------------
@@ -53,9 +54,9 @@
     # Run the requested page
     try:
         page = Page(environ)
-        page.parse_request()
-        page.execute()
-        page.composite()
+        page.do_it()
+        if not page.content:
+            raise exc.NoContentException('Expected page content to be generated. Perhaps the page compositor has not been implemented?')
         start_response(page.status,page.headers)
         return page.content
     except:

=== modified file 'PyngPyng/exceptions.py'
--- PyngPyng/exceptions.py	2009-05-25 03:11:31 +0000
+++ PyngPyng/exceptions.py	2009-05-26 02:09:15 +0000
@@ -14,6 +14,12 @@
 # Exception class -------------------------------------------------------------
 class Pyngception(Exception):
     """An internal PyngPyng exception occured."""
+    http_code = '500 Internal Server Error'
+
+
+# Exception class -------------------------------------------------------------
+class NoContentException(Pyngception):
+    """The page content is empty or None."""
     pass
 
 

=== modified file 'PyngPyng/pages.py'
--- PyngPyng/pages.py	2009-05-25 03:11:31 +0000
+++ PyngPyng/pages.py	2009-05-26 02:25:17 +0000
@@ -12,22 +12,58 @@
 
 # Extension modules -----------------------------------------------------------
 from PyngPyng import version
+from PyngPyng import exceptions as exc
+
+# Class factory ---------------------------------------------------------------
+def Page(environ):
+    """
+    Create a Page object (of appropriate subclass) based on the request URI.
+    
+    Parameters
+    ----------
+    environ : dict
+        The WSGI environment variable is a dictionary object containing CGI-
+        style environment variables. See PEP333 for specification. It also
+        contains the pre-parsed URI and ARGS parameters.
+    
+    Returns
+    -------
+    page : PageBase
+        The PageBase (or PageBase-subclass) object associated with the request.
+    
+    """
+    pagename = environ['URI'][0]
+    if pagename == '':   # we are at the application root
+        return RootPage(environ)
+    elif pagename == 'rules':    # we are at the rules static-ish page
+        return RulesPage(environ)
+    elif pagename == 'retired':  # we are looking at retired players
+        return RetiredPage(environ)
+    elif pagename == '+game':    # we are adding a game
+        return GameAction(environ)
+    elif pagename == '+user':    # we are adding a user
+        return UserAction(environ)
+    elif pagename == '+retire':  # we are retiring a user
+        return RetireAction(environ)
+    else:   # we expect uri[0] to be a {username}
+        return FilterPage(environ)
 
 
 # Module class ----------------------------------------------------------------
-class Page(object):
+class PageBase(object):
     
     """
-    A Page object is resonsible for processing content, applying themes, and
-    returning the XHTML to the user via HTTP.
+    A PageBase object is resonsible for processing content, applying themes,
+    and returning the XHTML to the user via HTTP. This is a base class that
+    should be subclassed for specific functionality.
     
     """
     
     # Class initializer -------------------------------------------------------
     def __init__(self,environ):
         """
-        Initialize the Page instance. This is a lean operation in that the page
-        content is not generated until required.
+        Initialize the PageBase instance. This is a lean operation in that the
+        page content is not generated until required.
         
         Parameters
         ----------
@@ -44,13 +80,17 @@
         # Set status and headers (assume OK; if not, these will get changed)
         self.status = '200 OK'
         self.headers = [('Content-Type','text/html')]
-        self.template = 'PyngPyng/templates/pyng.page'
+        self.template = 'PyngPyng/templates/pyng.tpl'
         # Copy environment parameters
         self.script_name = environ.get('SCRIPT_NAME','')
         self.request_method = environ.get('REQUEST_METHOD',None)
-        self.args = environ.get('ARGS',None)
-        self.uri = environ.get('URI',None)
+        self.args = environ['ARGS'] # If args or uri are not set, something is messed up
+        self.uri = environ['URI']
         # Set initial page attributes
+        self.template_parameters = {
+            'uri'   :   self.uri
+        }
+        self.is_action = False
         self.is_composited = False
         self.content = None
         self.page = None
@@ -70,8 +110,11 @@
         None
         
         """
-        pass
-        
+        if self.request_method == 'POST' and not self.is_action:
+            raise exc.HTTPMethodNotAllowedError('POST methods are only allowed for ''action'' resources, indicated by a ''+''.')
+        elif self.request_method != 'GET':
+            raise exc.HTTPMethodNotAllowedError('Only GET and POST methods are allowed at this time; POST methods are only allowed on ''action'' resources, indicated by a ''+''.')
+    
     # Class function ----------------------------------------------------------
     def execute(self):
         """
@@ -106,23 +149,66 @@
         None
         
         """
-        self.page = '\n'.join([
-            'Hello, world!',
-            'How are you today?',
-            'I am fine, thank you!'
-        ])
-        template_parameters = {
-            'title' :   'PyngPyng games ladder',
-            'page'  :   self.page,
-            'uri'   :   self.uri
-        }
+        pass
+    
+    # Class function ----------------------------------------------------------
+    def do_it(self):
+        self.parse_request()
+        self.execute()
+        self.composite()
+
+
+# Module class ----------------------------------------------------------------
+class ActionBase(PageBase):
+    def __init__(self,environ):
+        PageBase.__init__(self,environ)
+        self.is_action = self.request_method == 'POST'
+
+
+# Module class ----------------------------------------------------------------
+class RootPage(PageBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class RulesPage(PageBase):
+    def composite(self):
+        self.template_parameters['title'] = 'PyngPyng games ladder'
+        with open('PyngPyng/templates/rules.page','r') as rules:
+            self.page = rules.read()
         with open(self.template,'r') as template:
-            self.content = template.read() % template_parameters
+            self.template_parameters['page'] = self.page
+            self.content = template.read() % self.template_parameters
             self.is_composited = True
 
 
 # Module class ----------------------------------------------------------------
-class ErrorPage(Page):
+class RetiredPage(PageBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class GameAction(ActionBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class UserAction(ActionBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class RetireAction(ActionBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class FilterPage(PageBase):
+    pass
+
+
+# Module class ----------------------------------------------------------------
+class ErrorPage(PageBase):
     
     """
     An ErrorPage object is responsible for reporting application errors to the
@@ -133,14 +219,26 @@
     # Class function ----------------------------------------------------------
     def __init__(self,environ,exc_info):
         """
-        Initialize the ErrorPage instance.
+        Initialize the ErrorPage instance. This is generates the output
+        immediately.
+        
+        Parameters
+        ----------
+        environ : dict
+            The WSGI environment variable is a dictionary object containing CGI-
+            style environment variables. See PEP333 for specification. It also
+            contains the pre-parsed URI and ARGS parameters.
+        
+        Returns
+        -------
+        None
         
         """
         import traceback
-        Page.__init__(self,environ)
+        PageBase.__init__(self,environ)
         # Copy exception information
         self.etype, self.evalue, self.etrace = exc_info
-        self.template = 'PyngPyng/templates/error.page'
+        self.template = 'PyngPyng/templates/error.tpl'
         # Set default error status and headers (can be changed later to
         #  customize for particular error conditions)
         try:

=== removed file 'PyngPyng/templates/error.page'
--- PyngPyng/templates/error.page	2009-05-24 19:57:14 +0000
+++ PyngPyng/templates/error.page	1970-01-01 00:00:00 +0000
@@ -1,34 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head profile="http://gmpg.org/xfn/11">
-	<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
-	<meta name="robots" content="none" />
-	<title>%(title)s</title>
-	<style type="text/css">
-	    body { font-family:Verdana; font-size:10pt; }
-	    h1 { font-weight:normal; font-size:18pt; color:red; }
-	    h2 { font-weight:normal; font-style:italic; font-size:14pt; color:maroon; }
-	    div#trace { background-color:#FFFFCC; margin-top:-0.75em; }
-	    div#version { color:gray; }
-	</style>
-</head>
-
-<body>
-    <h1>Server Error at '%(request_uri)s' in %(app_name)s.</h1>
-    <hr width="100%%" size=1 color="silver" />
-    <h2>%(exc_type)s &raquo; %(exc_details)s</h2>
-    
-	<b>Description:</b>&nbsp;%(exc_description)s<br/><br/>
-	<b>Exception Details:</b>&nbsp;%(exc_type)s: %(exc_details)s<br/><br/>
-	
-	<b>Stack Trace:</b>
-	<div id="trace">
-        <code><pre>%(exc_trace)s</code></pre>
-    </div>
-	<hr width="100%%" size=1 color="silver" />
-	<div id="version">
-    	<b>Version Information:</b>&nbsp;%(version)s
-    </div>
-</body>
-</html>

=== added file 'PyngPyng/templates/error.tpl'
--- PyngPyng/templates/error.tpl	1970-01-01 00:00:00 +0000
+++ PyngPyng/templates/error.tpl	2009-05-25 18:49:00 +0000
@@ -0,0 +1,34 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head profile="http://gmpg.org/xfn/11">
+	<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
+	<meta name="robots" content="none" />
+	<title>%(title)s</title>
+	<style type="text/css">
+	    body { font-family:Verdana; font-size:10pt; }
+	    h1 { font-weight:normal; font-size:18pt; color:red; }
+	    h2 { font-weight:normal; font-style:italic; font-size:14pt; color:maroon; }
+	    div#trace { background-color:#FFFFCC; margin-top:-0.75em; }
+	    div#version { color:gray; }
+	</style>
+</head>
+
+<body>
+    <h1>Server Error at '%(request_uri)s' in %(app_name)s.</h1>
+    <hr width="100%%" size=1 color="silver" />
+    <h2>%(exc_type)s &raquo; %(exc_details)s</h2>
+    
+	<b>Description:</b>&nbsp;%(exc_description)s<br/><br/>
+	<b>Exception Details:</b>&nbsp;%(exc_type)s: %(exc_details)s<br/><br/>
+	
+	<b>Stack Trace:</b>
+	<div id="trace">
+        <code><pre>%(exc_trace)s</code></pre>
+    </div>
+	<hr width="100%%" size=1 color="silver" />
+	<div id="version">
+    	<b>Version Information:</b>&nbsp;%(version)s
+    </div>
+</body>
+</html>

=== removed file 'PyngPyng/templates/pyng.page'
--- PyngPyng/templates/pyng.page	2009-05-25 03:11:31 +0000
+++ PyngPyng/templates/pyng.page	1970-01-01 00:00:00 +0000
@@ -1,24 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head profile="http://gmpg.org/xfn/11">
-	<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
-	<meta name="distribution" content="global" />
-	<meta name="robots" content="index,follow" />
-	<meta name="language" content="en, sv" />
-	<title>%(title)s</title>
-	<!--<link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="http://localhost:8080/static/default.css" />-->
-</head>
-
-<body>
-    <div id="header">
-        %(uri)s
-    </div>
-    <div id="page">
-        %(page)s
-    </div>
-    <div id="footer">
-        <div id="xhtml">Valid <a href="http://validator.w3.org/check/referer">XHTML</a> and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></div>
-    </div>
-</body>
-</html>

=== added file 'PyngPyng/templates/pyng.tpl'
--- PyngPyng/templates/pyng.tpl	1970-01-01 00:00:00 +0000
+++ PyngPyng/templates/pyng.tpl	2009-05-25 18:49:00 +0000
@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head profile="http://gmpg.org/xfn/11">
+	<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
+	<meta name="distribution" content="global" />
+	<meta name="robots" content="index,follow" />
+	<meta name="language" content="en, sv" />
+	<title>%(title)s</title>
+	<!--<link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="http://localhost:8080/static/default.css" />-->
+</head>
+
+<body>
+    <div id="header">
+        %(uri)s
+    </div>
+    <div id="page">
+        %(page)s
+    </div>
+    <div id="footer">
+        <div id="xhtml">Valid <a href="http://validator.w3.org/check/referer">XHTML</a> and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></div>
+    </div>
+</body>
+</html>

=== added file 'PyngPyng/templates/rules.page'
--- PyngPyng/templates/rules.page	1970-01-01 00:00:00 +0000
+++ PyngPyng/templates/rules.page	2009-05-25 18:49:00 +0000
@@ -0,0 +1,13 @@
+<ol id="rules">
+	<li>All matches are to be best of three games.</li>
+	<li>All games are to be played to 21 points.</li>
+	<li>A game weighting is to be decided on before the game. It must be an integer from 1 to 10 (inclusive).</li>
+	<li>The higher the weight of the game the more points the winners can win (and the losers can lose).</li>
+	<li>If no game weight is chosen, the default game weight is 4.</li>
+	<li>Both singles and doubles games count towards the SFL Ping Pong ladder.</li>
+	<li>We salute those SFL Ping Pongers that have come before us.</li>
+	<li>By default assume that Grant is cheating and take appropriate action.</li>
+	<li>Let Mark win sometimes, his score is pathetic.</li>
+	<li>Honour Chris for creating this magical software.</li>
+	<li>If Guy is going to smash, for safety's sake get as close to the table as possible, because the ball is not going anywhere near it.</li>
+</ol>

=== modified file 'PyngPyng/version.py' (properties changed: -x to +x)
--- PyngPyng/version.py	2009-05-24 23:57:05 +0000
+++ PyngPyng/version.py	2009-05-25 12:12:54 +0000
@@ -10,7 +10,7 @@
 # Version information ---------------------------------------------------------
 project = 'PyngPyng'
 release = '0'
-revision = 'lp:pyng (trunk)'
+revision = 'lp:~scott-armitage/pyng/uri-pattern'
 agent = ' '.join((project,release,revision))
 
 # Script body -----------------------------------------------------------------