Changeset 201 for trunk/examples

Timestamp:

09/06/08 10:47:31 (18 months ago)

Author:

cmlenz

Message:

Divan: Add some very basic tests for the OpenID support.

Location:

trunk/examples/divan/divan

Files:

• comments.py (modified) (4 diffs)
• tests/__init__.py (modified) (1 diff)
• tests/comments.py (added)

trunk/examples/divan/divan/comments.py

@@ -98 +98 @@
             'Host': get_hostname(comment.openid_server)
         })
-        result = parse_kv_encoding(body.strip())
+        result = decode_kvform(body.strip())
         if result['is_valid'] == 'true':
             log.info('OpenID authentication for %r validated by %r',
@@ -201 +201 @@
 
 def get_hostname(url):
+    """Extract the host name from the given URL, which does not include the
+    port for HTTP and HTTPS URLs using the respective default port.
+    
+    >>> get_hostname('http://me.yahoo.com/')
+    'me.yahoo.com'
+    >>> get_hostname('http://me.yahoo.com:80/')
+    'me.yahoo.com'
+    >>> get_hostname('https://me.yahoo.com:443/')
+    'me.yahoo.com'
+    
+    :param url: the URL from which to extract the host name
+    :return: the extracted host name
+    """
     scheme, netloc, path, query, fragment = list(urlsplit(url))
     if ':' in netloc:
         hostname, port = netloc.split(':')
-        if port == '80' and scheme == 'https':
+        if port == '80' and scheme == 'http':
             port = None
         elif port == '443' and scheme == 'https':
@@ -213 +226 @@
 
 def normalize_openid(url):
+    """Normalize the given OpenID URL.
+    
+    >>> normalize_openid('me.yahoo.com')
+    'http://me.yahoo.com/'
+    >>> normalize_openid('https://me.yahoo.com')
+    'https://me.yahoo.com/'
+    >>> normalize_openid('https://me.yahoo.com/joe')
+    'https://me.yahoo.com/joe'
+    
+    :param url: the URL to normalize
+    :return: the normalized URL
+    """
     if '://' not in url:
         url = 'http://%s' % url
@@ -221 +246 @@
 
 
-def parse_kv_encoding(string):
-    lines = string.splitlines()
+def decode_kvform(string):
+    """Parse a key-value form encoded string as defined in the OpenID
+    specification, and return a dictionary mapping values to keys.
+    
+    >>> encoded = 'ns:http://specs.openid.net/auth/2.0\\nis_valid:true'
+    >>> parsed = decode_kvform(encoded)
+    >>> parsed['ns']
+    u'http://specs.openid.net/auth/2.0'
+    >>> parsed['is_valid']
+    u'true'
+    
+    :param string: the key-value form encoded string
+    :return: dictionary mapping values to keys
+    """
+    if not isinstance(string, unicode):
+        string = string.decode('utf-8')
+    string = string.strip()
     retval = {}
-    for line in lines:
+    for line in string.split('\n'):
         key, value = line.split(':', 1)
-        retval[key] = value
+        retval[key.strip()] = value.strip()
     return retval
 

trunk/examples/divan/divan/tests/__init__.py

@@ -4 +4 @@
 
 def suite():
-    from divan.tests import model, publish
+    from divan.tests import comments, model, publish
 
     suite = unittest.TestSuite()
+    suite.addTest(comments.suite())
     suite.addTest(model.suite())
     suite.addTest(publish.suite())