Commits

Lynn Rees committed 4bc24b1

[svn]

Comments (0)

Files changed (4)

trunk/ez_setup.py

 This file can also be run as a script to install or upgrade setuptools.
 """
 import sys
-DEFAULT_VERSION = "0.6a9"
+DEFAULT_VERSION = "0.6c3"
 DEFAULT_URL     = "http://cheeseshop.python.org/packages/%s/s/setuptools/" % sys.version[:3]
 
 md5_data = {
-    'setuptools-0.5a13-py2.3.egg': '85edcf0ef39bab66e130d3f38f578c86',
-    'setuptools-0.5a13-py2.4.egg': 'ede4be600e3890e06d4ee5e0148e092a',
-    'setuptools-0.6a1-py2.3.egg': 'ee819a13b924d9696b0d6ca6d1c5833d',
-    'setuptools-0.6a1-py2.4.egg': '8256b5f1cd9e348ea6877b5ddd56257d',
-    'setuptools-0.6a2-py2.3.egg': 'b98da449da411267c37a738f0ab625ba',
-    'setuptools-0.6a2-py2.4.egg': 'be5b88bc30aed63fdefd2683be135c3b',
-    'setuptools-0.6a3-py2.3.egg': 'ee0e325de78f23aab79d33106dc2a8c8',
-    'setuptools-0.6a3-py2.4.egg': 'd95453d525a456d6c23e7a5eea89a063',
-    'setuptools-0.6a4-py2.3.egg': 'e958cbed4623bbf47dd1f268b99d7784',
-    'setuptools-0.6a4-py2.4.egg': '7f33c3ac2ef1296f0ab4fac1de4767d8',
-    'setuptools-0.6a5-py2.3.egg': '748408389c49bcd2d84f6ae0b01695b1',
-    'setuptools-0.6a5-py2.4.egg': '999bacde623f4284bfb3ea77941d2627',
-    'setuptools-0.6a6-py2.3.egg': '7858139f06ed0600b0d9383f36aca24c',
-    'setuptools-0.6a6-py2.4.egg': 'c10d20d29acebce0dc76219dc578d058',
-    'setuptools-0.6a7-py2.3.egg': 'cfc4125ddb95c07f9500adc5d6abef6f',
-    'setuptools-0.6a7-py2.4.egg': 'c6d62dab4461f71aed943caea89e6f20',
-    'setuptools-0.6a8-py2.3.egg': '2f18eaaa3f544f5543ead4a68f3b2e1a',
-    'setuptools-0.6a8-py2.4.egg': '799018f2894f14c9f8bcb2b34e69b391',
-    'setuptools-0.6a9-py2.3.egg': '8e438ad70438b07b0d8f82cae42b278f',
-    'setuptools-0.6a9-py2.4.egg': '8f6e01fc12fb1cd006dc0d6c04327ec1',
+    'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
+    'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
+    'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
+    'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
+    'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
+    'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
+    'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
+    'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
+    'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
+    'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
+    'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
+    'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
+    'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
+    'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
+    'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
 }
 
 import sys, os
                 % egg_name
             )
             sys.exit(2)
-    return data    
+    return data
 
 
 def use_setuptools(
     be the number of seconds that will be paused before initiating a download,
     should one be required.  If an older version of setuptools is installed,
     this routine will print a message to ``sys.stderr`` and raise SystemExit in
-    an attempt to abort the calling script.  
+    an attempt to abort the calling script.
     """
     try:
         import setuptools
     try:
         pkg_resources.require("setuptools>="+version)
 
-    except pkg_resources.VersionConflict:
+    except pkg_resources.VersionConflict, e:
         # XXX could we install in a subprocess here?
         print >>sys.stderr, (
             "The required version of setuptools (>=%s) is not available, and\n"
             "can't be installed while this script is running. Please install\n"
-            " a more recent version first."
-        ) % version
+            " a more recent version first.\n\n(Currently using %r)"
+        ) % (version, e.args[0])
         sys.exit(2)
 
 def download_setuptools(
 %s), but
 you may need to enable firewall access for this script first.
 I will start the download in %d seconds.
+
+(Note: if this machine does not have network access, please obtain the file
+
+   %s
+
+and place it in this directory before rerunning this script.)
 ---------------------------------------------------------------------------""",
-                    version, download_base, delay
+                    version, download_base, delay, url
                 ); from time import sleep; sleep(delay)
             log.warn("Downloading %s", url)
             src = urllib2.urlopen(url)
     try:
         import setuptools
     except ImportError:
-        import tempfile, shutil
-        tmpdir = tempfile.mkdtemp(prefix="easy_install-")
+        egg = None
         try:
-            egg = download_setuptools(version, to_dir=tmpdir, delay=0)
+            egg = download_setuptools(version, delay=0)
             sys.path.insert(0,egg)
             from setuptools.command.easy_install import main
-            main(list(argv)+[egg])
+            return main(list(argv)+[egg])   # we're done here
         finally:
-            shutil.rmtree(tmpdir)
+            if egg and os.path.exists(egg):
+                os.unlink(egg)
     else:
         if setuptools.__version__ == '0.0.1':
             # tell the user to uninstall obsolete version
             print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
 
 
-            
+
 def update_md5(filenames):
     """Update our built-in md5 registry"""
 
 
     for name in filenames:
         base = os.path.basename(name)
-        f = open(name,'rb')       
+        f = open(name,'rb')
         md5_data[base] = md5(f.read()).hexdigest()
         f.close()
 
     else:
         main(sys.argv[1:])
 
+
+
+
+
-# Copyright (c) 2006 L. C. Rees.  All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# 1.  Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-# 2.  Redistributions in binary form must reproduce the above copyright
-# notice, this list of conditions and the following disclaimer in the
-# documentation and/or other materials provided with the distribution.
-# 3.  Neither the name of the Portable Site Information Project nor the names
-# of its contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# Copyright (c) 2006 L. C. Rees
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#    1. Redistributions of source code must retain the above copyright notice, 
+#       this list of conditions and the following disclaimer.
+#    
+#    2. Redistributions in binary form must reproduce the above copyright 
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#
+#    3. Neither the name of Django nor the names of its contributors may be used
+#       to endorse or promote products derived from this software without
+#       specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 '''setup - setuptools based setup for urlrelay.'''
 
     from distutils.core import setup
 
 setup(name='urlrelay',
-      version='0.1',
-      description='''Passes HTTP content to a WSGI callable based on a URL and HTTP method.''',
-      long_description='''Simple relay for passing HTTP content to a WSGI callable based on URL
-        pattern and HTTP request method.''',
+      version='0.6',
+      description='''RESTful WSGI URL dispatcher.''',
+      long_description='''Simple URL dispatcher that passes HTTP
+requests to a WSGI application based on a matching URL path regex
+pattern and an optional HTTP request method.
+
+Usage example:
+
+#!/bin/env python
+
+import urlrelay
+
+# Simple URL to application mapping
+urlrelay.url('^/$')
+def index(environ, start_response):
+    start_response('200 OK', [('Content-type', 'text/plain')])
+    return ['Home Page']
+    
+# "RESTful" URL to application mapping
+urlrelay.url('^/hello_world$', 'GET')
+def hello_world(environ, start_response):
+    start_response('200 OK', [('Content-type', 'text/plain')])
+    return ['Hello World']
+    
+# URL to on-disk application mapping
+# urlrelay.register('^/ondisk$', 'module.on_disk')    
+
+if __name__ == '__main__':
+    from wsgiref.simple_server import make_server
+    http = make_server('', 8080, urlrelay.URLRelay())
+    http.serve_forever()''',
       author='L. C. Rees',
       author_email='lcrees@gmail.com',
       license='BSD',
-      py_modules=['urlrelay', 'ez_setup', 'setup'],
-      packages = [],
+      py_modules=['urlrelay'],
+      packages = ['tests'],
+      test_suite='tests.test_urlrelay',
       zip_safe = True,
-      keywords='wsgi URL relay route dispatch middleware web HTTP',
-      classifiers=['Development Status :: 3 - Alpha',
-                    'Environment :: Web Environment',
-                    'License :: OSI Approved :: BSD License',
-                    'Natural Language :: English',
-                    'Operating System :: OS Independent',
-                    'Programming Language :: Python',
-                    'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
-                    'Topic :: Internet :: WWW/HTTP :: Site Management',
-                    'Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware'])
-
+      keywords='WSGI URL dispatch relay route middleware web HTTP',
+      classifiers=['Development Status :: 4 - Beta',
+          'Environment :: Web Environment',
+          'License :: OSI Approved :: BSD License',
+          'Natural Language :: English',
+          'Operating System :: OS Independent',
+          'Programming Language :: Python',
+          'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+          'Topic :: Internet :: WWW/HTTP :: Site Management',
+          'Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware'])

trunk/tests/test_urlrelay.py

+# Copyright (c) 2006 L. C. Rees
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#    1. Redistributions of source code must retain the above copyright notice, 
+#       this list of conditions and the following disclaimer.
+#    
+#    2. Redistributions in binary form must reproduce the above copyright 
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#
+#    3. Neither the name of Django nor the names of its contributors may be used
+#       to endorse or promote products derived from this software without
+#       specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+'''Unit tests for urlrelay.'''
+
+import re
+import urlrelay
+import unittest
+
+def dummy_sr(status, headers, exc_info=None):
+    pass
+
+@urlrelay.url(r'^/$')
+def index(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    return ['index']
+
+@urlrelay.url(r'^/handle$', 'GET')
+def get_handle(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    return ['GET']
+
+@urlrelay.url(r'^/handle$', 'POST')
+def post_handle(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    return ['POST']
+
+@urlrelay.url(r'^/handle$', 'PUT')
+def put_handle(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    return ['PUT']    
+
+@urlrelay.url(r'^/argtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$')
+def args(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    args, kwargs = environ['wsgiorg.routing_args']
+    return [' '.join([args[0], args[1], kwargs['kwarg1'], kwargs['kwarg2']])]
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'GET')
+def meth_get(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    args, kwargs = environ['wsgiorg.routing_args']
+    return [' '.join(['GET', args[0], args[1], kwargs['kwarg1'], kwargs['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'POST')
+def meth_get(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    args, kwargs = environ['wsgiorg.routing_args']
+    return [' '.join(['POST', args[0], args[1], kwargs['kwarg1'], kwargs['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'PUT')
+def meth_get(environ, start_response):
+    start_response('200 Ok', [('Content-Type', 'text/plain')])
+    args, kwargs = environ['wsgiorg.routing_args']
+    return [' '.join(['PUT', args[0], args[1], kwargs['kwarg1'], kwargs['kwarg2']])]
+
+urlrelay.register('^/notfound$', 'urlrelay._handler')
+urlrelay.register('^/notfound2$', 'urlrelay._handler', 'GET')
+urlrelay.register('^/notfound2$', 'urlrelay._handler', 'PUT')
+urlrelay.register('^/notfound2$', 'urlrelay._handler', 'POST')
+urlrelay.register('^/notfound4$', '_handler')
+urlrelay.register('^/notfound3$', '_handler', 'GET')
+urlrelay.register('^/notfound3$', '_handler', 'PUT')
+urlrelay.register('^/notfound3$', '_handler', 'POST')
+
+class UrlRelayTest(unittest.TestCase):      
+
+    def test_inmem_root(self):
+        '''Checks simple url.'''
+        environ = {'PATH_INFO':'/', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'index')
+
+    def test_inmem_method_get(self):
+        '''Checks url + get method.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'GET')
+
+    def test_inmem_method_post(self):
+        '''Checks url + post method.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'POST'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'POST')        
+
+    def test_inmem_method_put(self):
+        '''Checks url + put method.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'PUT'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'PUT')
+
+    def test_inmem_argextract(self):
+        '''Checks arg/kwarg extraction from URL.'''
+        environ = {'PATH_INFO':'/argtest/kwarg1/kwarg2/arg1/arg2',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'arg1 arg2 kwarg1 kwarg2')
+
+    def test_inmem_method_extract_get(self):
+        '''Checks arg/kwarg extraction from URL + get method.'''
+        environ = {'PATH_INFO':'/methtest/kwarg1/kwarg2/arg1/arg2',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'GET arg1 arg2 kwarg1 kwarg2')
+
+    def test_inmem_method_extract_post(self):
+        '''Checks arg/kwarg extraction from URL + post method.'''
+        environ = {'PATH_INFO':'/methtest/kwarg1/kwarg2/arg1/arg2',
+            'REQUEST_METHOD':'POST'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'POST arg1 arg2 kwarg1 kwarg2')
+
+    def test_inmem_method_extract_put(self):
+        '''Checks arg/kwarg extraction from URL + put method.'''
+        environ = {'PATH_INFO':'/methtest/kwarg1/kwarg2/arg1/arg2',
+            'REQUEST_METHOD':'PUT'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'PUT arg1 arg2 kwarg1 kwarg2')
+
+    def test_offdisk_method(self):
+        '''Checks loading handler off of a disk.'''
+        environ = {'PATH_INFO':'/notfound',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound was not found on this server.')
+
+    def test_offdisk_method_get(self):
+        '''Checks loading handler off of a disk + get method.'''
+        environ = {'PATH_INFO':'/notfound2',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound2 was not found on this server.')
+
+    def test_offdisk_method_put(self):
+        '''Checks loading handler off of a disk + put method.'''
+        environ = {'PATH_INFO':'/notfound2',
+            'REQUEST_METHOD':'PUT'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound2 was not found on this server.')
+
+    def test_offdisk_method_post(self):
+        '''Checks loading handler off of a disk + post method.'''
+        environ = {'PATH_INFO':'/notfound2',
+            'REQUEST_METHOD':'POST'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound2 was not found on this server.')         
+
+    def test_offdisk_method_modpath(self):
+        '''Checks loading handler off of a disk.'''
+        environ = {'PATH_INFO':'/notfound4',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(modpath='urlrelay')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound4 was not found on this server.')
+
+    def test_offdisk_method_get_modpath(self):
+        '''Checks loading handler off of a disk + get method.'''
+        environ = {'PATH_INFO':'/notfound3',
+            'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(modpath='urlrelay')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound3 was not found on this server.')
+
+    def test_offdisk_method_put_modpath(self):
+        '''Checks loading handler off of a disk + put method.'''
+        environ = {'PATH_INFO':'/notfound3',
+            'REQUEST_METHOD':'PUT'}
+        result = urlrelay.URLRelay(modpath='urlrelay')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound3 was not found on this server.')
+
+    def test_offdisk_method_post_modpath(self):
+        '''Checks loading handler off of a disk + post method.'''
+        environ = {'PATH_INFO':'/notfound3',
+            'REQUEST_METHOD':'POST'}
+        result = urlrelay.URLRelay(modpath='urlrelay')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /notfound3 was not found on this server.')
+
+    def test_inmem_defaultapp(self):
+        '''Checks using default app url.'''
+        environ = {'PATH_INFO':'/plt', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(default=index)(environ, dummy_sr)
+        self.assertEqual(result[0], 'index')        
+
+    def test_inmem_defaultapp_args(self):
+        '''Checks arg/kwarg extraction from URL + put method.'''
+        environ = {'PATH_INFO':'/methkwarg1', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(default=args, kwargs={'kwarg1':'kwarg1',
+            'kwarg2':'kwarg2'}, args=('arg1','arg2'))(environ, dummy_sr)
+        self.assertEqual(result[0], 'arg1 arg2 kwarg1 kwarg2')
+
+    def test_inmem_defaultapp(self):
+        '''Checks using default app url.'''
+        environ = {'PATH_INFO':'/plt', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(default=index)(environ, dummy_sr)
+        self.assertEqual(result[0], 'index')        
+
+    def test_ondisk_defaultapp(self):
+        '''Checks arg/kwarg extraction from URL + put method.'''
+        environ = {'PATH_INFO':'/methkwarg1', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(default='urlrelay._handler')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /methkwarg1 was not found on this server.')
+
+    def test_ondisk_defaultapp_modpath(self):
+        '''Checks arg/kwarg extraction from URL + put method.'''
+        environ = {'PATH_INFO':'/methkwarg1', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(default='_handler', modpath='urlrelay')(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /methkwarg1 was not found on this server.')
+
+    def test_handler_override(self):
+        '''Checks overriding the default 404 handler.'''
+        def handle(environ, start_response):                
+            start_response('404 Not Found', [('content-type', 'text/plain')])
+            return ['404']
+        environ = {'PATH_INFO':'/methkwarg1', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay(handler=handle)(environ, dummy_sr)
+        self.assertEqual(result[0], '404')
+
+    def test_notfound(self):
+        '''Checks that default 404 handler responds.'''
+        environ = {'PATH_INFO':'/methkwarg1', 'REQUEST_METHOD':'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEqual(result[0], 'Requested URL /methkwarg1 was not found on this server.')
+
+    def test_nonregistry_paths_index(self):
+        '''Checks use of non-global path registry.'''
+        environ = {'PATH_INFO':'/', 'REQUEST_METHOD':'GET'}        
+        tpaths = ((r'^/$', index), (r'^/handle$', {'GET':get_handle,'POST':post_handle,
+            'PUT':put_handle}))
+        result = urlrelay.URLRelay(paths=tpaths)(environ, dummy_sr)
+        self.assertEqual(result[0], 'index')
+
+    def test_nonregistry_paths_get(self):
+        '''Checks use of non-global path registry.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'GET'}        
+        tpaths = ((r'^/$', index), (r'^/handle$', {'GET':get_handle,'POST':post_handle,
+            'PUT':put_handle}))
+        result = urlrelay.URLRelay(paths=tpaths)(environ, dummy_sr)
+        self.assertEqual(result[0], 'GET')
+
+    def test_nonregistry_paths_post(self):
+        '''Checks use of non-global path registry.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'POST'}        
+        tpaths = ((r'^/$', index), (r'^/handle$', {'GET':get_handle,'POST':post_handle,
+            'PUT':put_handle}))
+        result = urlrelay.URLRelay(paths=tpaths)(environ, dummy_sr)
+        self.assertEqual(result[0], 'POST')
+
+    def test_nonregistry_paths_put(self):
+        '''Checks use of non-global path registry.'''
+        environ = {'PATH_INFO':'/handle', 'REQUEST_METHOD':'PUT'}        
+        tpaths = ((r'^/$', index), (r'^/handle$', {'GET':get_handle,'POST':post_handle,
+            'PUT':put_handle}))
+        result = urlrelay.URLRelay(paths=tpaths)(environ, dummy_sr)
+        self.assertEqual(result[0], 'PUT')
+
+    def test_noncallable_in_registry(self):
+        '''Checks that non callables or module strings are not allowed in
+        non-global path registry.'''
+        environ = {'PATH_INFO':'/', 'REQUEST_METHOD':'PUT'}
+        def tempfunc(): 
+            test = urlrelay.URLRelay(paths=((r'^/$', []),))
+            test(environ, dummy_sr)
+        self.assertRaises(AssertionError, tempfunc)           
+        
+
+if __name__ == '__main__': unittest.main()
+

trunk/urlrelay.py

-# Copyright (c) 2005, the Lawrence Journal-World
 # Copyright (c) 2006 L. C. Rees
 # All rights reserved.
 #
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
 #    1. Redistributions of source code must retain the above copyright notice, 
 #       this list of conditions and the following disclaimer.
 #       to endorse or promote products derived from this software without
 #       specific prior written permission.
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-'''Simple relay for passing HTTP content to a WSGI callable based on URL
-pattern and HTTP request method.'''
+'''RESTful WSGI URL dispatcher.'''
 
-__author__ = 'L.C. Rees (lcreesl@gmail.com)'
-__revision__ = '0.1'
+__author__ = 'L.C. Rees (lcrees@gmail.com)'
+__revision__ = '0.6'
 
-import re, sys
+import re
 
+__all__ = ['URLRelay', 'url', 'register']
 
-def addsyspath(path):
-    '''Adds a filesystem path to the PYTHONPATH.
 
-    @param path A filesystem path.'''
-    sys.path.append(path)
+class _Registry(object):
+
+    '''Maintains order of URL preference while updating the central URL path
+    registry.'''
+
+    _register = list()
+
+    def __iter__(self):
+        '''Iterator for registry.'''
+        return iter(self._register)
+
+    def add(self, pattern, mapping):
+        '''Add tuple to registry.
+
+        @param pattern URL pattern
+        @param mapping WSGI application mapping
+        '''
+        self._register.append((pattern, mapping))
+
+    def get(self):
+        '''Returns current registry.'''
+        return tuple(self._register)
+
+
+# URL registry and cache
+_reg, _cache = _Registry(), dict()
+
+def _handler(environ, start_response):
+    '''Default HTTP 404 handler.'''
+    path = environ['PATH_INFO']
+    start_response('404 Not Found', [('content-type', 'text/plain')])
+    return ['Requested URL %s was not found on this server.' % path]
+
+def register(pattern, application, method=None):
+    '''Registers a pattern, application, and optional HTTP method.
+
+    @param pattern URL pattern
+    @param application WSGI application
+    @param method HTTP method (default: None)
+    '''
+    if method is None:
+        _reg.add(pattern, application)
+    # Handle URL/method combinations
+    else:
+        # Update any existing registry entry
+        for entry in _reg:
+            if entry[0] == pattern:
+                entry[1][method] = application
+                return
+        # Add new registry entry
+        _reg.add(pattern, {method:application})
+
+def url(pattern, method=None):
+    '''Decorator for registering a path pattern /application pair.
+
+    @param pattern Regex pattern for path
+    @param method HTTP method (default: None)
+    '''
+    def decorator(application):
+        register(pattern, application, method)
+        return application
+    return decorator
 
 
 class URLRelay(object):
 
-    '''Passes HTTP content to a WSGI callable based on a URL and HTTP method.'''
+    '''Passes HTTP requests to a WSGI callable based on URL path component and
+    HTTP request method.
+    '''
 
-    def __init__(self, urls, modpath='', syspaths=None):
-        '''Init
+    def __init__(self, **k):
+        # Add any iterable of pairs consisting of a path pattern and either a
+        # callback name or a dictionary of HTTP method/callback names
+        self.paths = tuple((re.compile(u), v) for u, v in k.get('paths', _reg.get()))
+        # Shortcut for full module search path
+        self.modpath = k.get('modpath', '')
+        # 404 handler
+        self.handler = k.get('handler', _handler)
+        # Default function
+        self.default = k.get('default')
+        # Default positional and keyword arguments
+        self.args, self.kwargs = k.get('args', ()), k.get('kwargs', {})
+        # routing_args environ keyword
+        self.key = k.get('key', 'wsgiorg.routing_args')
+        # Key for passing kwargs individually
+        self.kkey = k.get('kkey', 'wsgize.kwargs')
+        # Key for passing args individually
+        self.akey = k.get('akey', 'wsgize.args')
+        # URL <-> callable mapping Cache 
+        self.cache = k.get('cache', _cache)
 
-        @param urls Iterable of pairs consisting of a URL pattern and either a
-            callback name or a dictionary of HTTP method/callback names
-        @param modpath Shortcut for modules in the same package (default: '')
-        '''
-        self.urls = tuple((re.compile(url[0]), url[1]) for url in urls)        
-        self.modpath = modpath
-        for path in syspaths: addsyspath(path)
+    def __call__(self, env, start_response):
+        try:
+            # Fetch app and any positional or keyword arguments in path
+            app, arg, kw = self.resolve(env['PATH_INFO'], env['REQUEST_METHOD'])
+            # Place args in environ dictionary
+            env[self.key], env[self.akey], env[self.kkey] = (arg, kw), arg, kw
+            return app(env, start_response)
+        except (ImportError, AttributeError):
+            # Return 404 handler for any exceptions
+            return self.handler(env, start_response)    
 
+    def getapp(self, app):
+        '''Loads a callable based on its name
 
-    def get_mod_func(self, callback):
-        '''Breaks a callable name out from a module name.
-
-        @param callback Name of a callback        
-        '''
+        @param app An WSGI application's name'''
         # Add shortcut to module if present
-        if self.modpath != '': callback = '.'.join([self.modpath, callback])
-        dot = callback.rindex('.')
-        return callback[:dot], callback[dot+1:]        
+        if self.modpath != '': app = '.'.join([self.modpath, app])
+        dot = app.rindex('.')
+        # Import module
+        return getattr(__import__(app[:dot], '', '', ['']), app[dot+1:])        
 
     def relay(self, environ, start_response):
-        '''Passes WSGI params to a callable based on URL path and method.
-        
-        environ Dictionary of WSGI environment variables
-        start_response Stores headers untill any HTTP content is returned'''
-        callback = self.resolve(environ['PATH_INFO'], environ['REQUEST_METHOD'])
-        return callback(environ, start_response)
+        '''Legacy method.'''
+        return self.__call__(environ, start_response)
 
-    def resolve(self, url, method):
-        '''Fetches a callable based on a URL and method.
+    def resolve(self, path, method):
+        '''Fetches a WSGI app based on URL path component and method.
 
-        url URL path component
-        method HTTP method (default: '')
+        @param path URL path component
+        @param method HTTP method
         '''
-        for pattern, callbacks in self.urls:
-            if pattern.search(url):
-                # Get callable based on URL alone
-                if isinstance(callbacks, basestring):
-                    callback = self.get_callback(callbacks)
-                # Get callable based on URL and method
-                elif isinstance(callbacks, dict):
-                    callback = self.get_callback(callbacks.get(method))
-                return callback
-        raise ImportError()
-
-    def get_callback(self, callback):
-        '''Loads a callable based on its name
-
-        callback A callback's name'''        
-        mod_name, func_name = self.get_mod_func(callback)
+        key = ':'.join([path, method])
+        # Try fetching app and positional and keyword args from cache
         try:
-            return getattr(__import__(mod_name, '', '', ['']), func_name)
-        except ImportError, error:
-            raise ImportError(
-                'Could not import %s. Error was: %s' % (mod_name, str(error)))
-        except AttributeError, error:
-            raise AttributeError(
-                'Tried %s in module %s. Error was: %s' % (func_name,
-                 mod_name, str(error)))
-
-
-__all__ = ['URLRelay']
+            return self.cache[key]
+        except KeyError:
+            # Loop through path patterns <-> app mappings
+            for pattern, app in self.paths:
+                # Test path for match
+                search = pattern.search(path)
+                # Continue with next iteration if not a match
+                if not search: continue                
+                # Load app from storage if module name string
+                if isinstance(app, basestring):
+                    app = self.getapp(app)
+                # Get app linked to HTTP method
+                elif isinstance(app, dict):
+                    app = app.get(method)
+                    # Load app from storage if module name string
+                    if isinstance(app, basestring): app = self.getapp(app)
+                # Ensure we have a callable object
+                assert hasattr(app, '__call__')
+                # Extract any positional or keywords arguments in the path
+                args, kwargs = search.groups(), search.groupdict()
+                # Eliminate keyword values in args
+                args = tuple(i for i in args if i not in kwargs.itervalues())
+                # Cache callable, positional and keyword arguments
+                self.cache[key] = (app, args, kwargs)                
+                return app, args, kwargs
+            # Return defaults if no matching path and default app is set
+            if self.default is not None:
+                default = self.default
+                # Load default app from storage if module name string
+                if isinstance(default, basestring):
+                    default = self.getapp(default)
+                return default, self.args, self.kwargs
+            else:
+                raise ImportError()