Commits

Lynn Rees  committed c9dfabd

- update

  • Participants
  • Parent commits 05edb09
  • Branches urlrelay

Comments (0)

Files changed (9)

File __init__.py

Empty file added.
+# 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.'''
+
+import ez_setup
+ez_setup.use_setuptools()
+
+try:
+    from setuptools import setup
+except:
+    from distutils.core import setup
+
+setup(name='urlrelay',
+      version='0.7.1',
+      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'],
+      packages=['tests'],
+      test_suite='tests.test_urlrelay',
+      zip_safe = True,
+      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'])

File 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 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 argtests(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join([args[0], args[1], kw['kwarg1'], kw['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, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['GET', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'POST')
+def meth_post2(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['POST', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'PUT')
+def meth_put(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['PUT', args[0], args[1], kw['kwarg1'], kw['kwarg2']])]
+
+@urlrelay.url(r'/spectest/', 'POST')
+def meth_post(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    return ['Empty post']
+
+@urlrelay.url(r'/spectest/(.*)', 'GET')
+def meth_get2(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['GET', args[0]])]
+
+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 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 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 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 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 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 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 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 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_defaultapp2(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 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 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 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)
+        
+    def test_call_more_specific(self):
+        '''Checks calling a more-specific URL than one that has a method
+        associated with it.'''
+        environ = {'PATH_INFO': '/spectest/foo', 'REQUEST_METHOD': 'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEquals('GET foo', result[0])        
+    
+if __name__ == '__main__': unittest.main()

File 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 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 argtests(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join([args[0], args[1], kw['kwarg1'], kw['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, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['GET', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'POST')
+def meth_post2(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['POST', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
+
+@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'PUT')
+def meth_put(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['PUT', args[0], args[1], kw['kwarg1'], kw['kwarg2']])]
+
+@urlrelay.url(r'/spectest/', 'POST')
+def meth_post(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    return ['Empty post']
+
+@urlrelay.url(r'/spectest/(.*)', 'GET')
+def meth_get2(environ, start_response):
+    start_response('200 OK', [('Content-Type', 'text/plain')])
+    args, kw = environ['wsgiorg.routing_args']
+    return [' '.join(['GET', args[0]])]
+
+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 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 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 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 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 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 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 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 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_defaultapp2(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 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 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 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)
+        
+    def test_call_more_specific(self):
+        '''Checks calling a more-specific URL than one that has a method
+        associated with it.'''
+        environ = {'PATH_INFO': '/spectest/foo', 'REQUEST_METHOD': 'GET'}
+        result = urlrelay.URLRelay()(environ, dummy_sr)
+        self.assertEquals('GET foo', result[0])        
+    
+if __name__ == '__main__': unittest.main()
+# Copyright (c) 2006-2008 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.
+
+'''RESTful WSGI URL dispatcher.'''
+
+import re
+import time
+import copy
+import random
+import threading
+from fnmatch import translate
+
+__author__ = 'L.C. Rees (lcrees@gmail.com)'
+__revision__ = '0.7'
+__all__ = ['URLRelay', 'url', 'register']
+
+
+def synchronized(func):
+    '''
+    Decorator to lock and unlock a method (Phillip J. Eby).
+
+    @param func Method to decorate
+    '''
+    def wrapper(self, *__args, **__kw):
+        self._lock.acquire()
+        try:
+            return func(self, *__args, **__kw)
+        finally:
+            self._lock.release()
+    wrapper.__name__ = func.__name__
+    wrapper.__dict__ = func.__dict__
+    wrapper.__doc__ = func.__doc__
+    return wrapper
+
+
+def _handler(environ, start_response):
+    start_response('404 Not Found', [('content-type', 'text/plain')])
+    return ['Requested URL was not found on this server.']
+
+
+def pattern_compile(pattern, pattern_type):
+    '''Compile pattern.'''
+    # Convert glob expression to regex
+    if pattern_type == 'glob':
+        pattern = translate(pattern)
+    return re.compile(pattern)
+
+
+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
+_reg = _Registry()
+
+
+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 None
+        # 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 lazy(object):
+
+    '''Lazily assign attributes on an instance upon first use.'''
+
+    def __init__(self, method):
+        self.method = method
+        self.name = method.__name__
+
+    def __get__(self, instance, cls):
+        if instance is None:
+            return self
+        value = self.method(instance)
+        setattr(instance, self.name, value)
+        return value
+
+
+class MemoryCache(object):
+
+    '''Base Cache class.'''
+
+    def __init__(self, **kw):
+        # Set timeout
+        timeout = kw.get('timeout', 300)
+        try:
+            timeout = int(timeout)
+        except (ValueError, TypeError):
+            timeout = 300
+        self.timeout = timeout
+        # Get random seed
+        random.seed()
+        self._cache = dict()
+        # Set max entries
+        max_entries = kw.get('max_entries', 300)
+        try:
+            self._max_entries = int(max_entries)
+        except (ValueError, TypeError):
+            self._max_entries = 300
+        # Set maximum number of items to cull if over max
+        self._maxcull = kw.get('maxcull', 10)
+        self._lock = threading.Condition()
+
+    def __getitem__(self, key):
+        '''Fetch a given key from the cache.'''
+        return self.get(key)
+
+    def __setitem__(self, key, value):
+        '''Set a value in the cache. '''
+        self.set(key, value)
+
+    def __delitem__(self, key):
+        '''Delete a key from the cache.'''
+        self.delete(key)
+
+    def __contains__(self, key):
+        '''Tell if a given key is in the cache.'''
+        return self.get(key) is not None
+
+    def get(self, key, default=None):
+        '''
+        Fetch a given key from the cache.  If the key does not exist, return
+        default, which itself defaults to None.
+
+        @param key Keyword of item in cache.
+        @param default Default value (default: None)
+        '''
+        values = self._cache.get(key)
+        if values is None:
+            value = default
+        elif values[0] < time.time():
+            self.delete(key)
+            value = default
+        else:
+            value = values[1]
+        return copy.deepcopy(value)
+
+    def set(self, key, value):
+        '''
+        Set a value in the cache.
+
+        @param key Keyword of item in cache.
+        @param value Value to be inserted in cache.
+        '''
+        # Cull timed out values if over max # of entries
+        if len(self._cache) >= self._max_entries:
+            self._cull()
+        # Set value and timeout in cache
+        self._cache[key] = (time.time() + self.timeout, value)
+
+    def delete(self, key):
+        '''
+        Delete a key from the cache, failing silently.
+
+        @param key Keyword of item in cache.
+        '''
+        try:
+            del self._cache[key]
+        except KeyError:
+            pass
+
+    def keys(self):
+        '''Returns a list of keys in the cache.'''
+        return self._cache.keys()
+
+    def _cull(self):
+        '''Remove items in cache to make room.'''
+        num, maxcull = 0, self._maxcull
+        # Cull number of items allowed (set by self._maxcull)
+        for key in self.keys():
+            # Remove only maximum # of items allowed by maxcull
+            if num <= maxcull:
+                # Remove items if expired
+                if self.get(key) is None:
+                    num += 1
+            else:
+                break
+        # Remove any additional items up to max # of items allowed by maxcull
+        while len(self.keys()) >= self._max_entries and num <= maxcull:
+            # Cull remainder of allowed quota at random
+            self.delete(random.choice(self.keys()))
+            num += 1
+
+
+class URLRelay(object):
+
+    '''
+    Passes HTTP requests to a WSGI callable based on URL path component and
+    HTTP request method.
+    '''
+
+    def __init__(self, **kw):
+        # Values can be 'regex' or 'glob'
+        pattern_type = kw.get('pattern_type', 'regex')
+        # 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(
+            (pattern_compile(u, pattern_type), v)
+            for u, v in kw.get('paths', _reg.get())
+        )
+        # Shortcut for full module search path
+        self._modpath = kw.get('modpath', '')
+        # 404 handler
+        self._response = kw.get('handler', _handler)
+        # Default function
+        self._default = kw.get('default')
+        # Set maximum number of items to cull from cache if over max
+        self._maxcull = kw.get('maxcull', 10)
+        # Set cache max entries
+        self._max_entries = kw.get('max_entries', 300)
+        # Set cache time out
+        self._timeout = kw.get('timeout', 300)
+
+    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['wsgiorg.routing_args'] = (arg, kw)
+        except (ImportError, AttributeError):
+            # Return 404 handler for any exceptions
+            return self._response(env, start_response)
+        return app(env, start_response)
+
+    @lazy
+    def _cache(self):
+        '''URL <-> callable mapping Cache.'''
+        return MemoryCache(
+            timeout=self._timeout,
+            maxcull=self._maxcull,
+            max_entries=self._max_entries,
+        )
+
+    def _getapp(self, app):
+        '''
+        Loads a callable based on its name
+
+        @param app An WSGI application
+        '''
+        if isinstance(app, basestring):
+            try:
+                # Add shortcut to module if present
+                dot = app.rindex('.')
+                # Import module
+                return getattr(
+                    __import__(app[:dot], '', '', ['']), app[dot + 1:]
+                )
+            # If nothing but module name, import the module
+            except ValueError:
+                return __import__(app, '', '', [''])
+        return app
+
+    def _loadapp(self, app):
+        '''
+        Loads an application based on its name.
+
+        @param app Web application name
+        '''
+        # Add module shortcut to module string
+        if self._modpath != '' and isinstance(app, basestring):
+            app = '.'.join([self._modpath, app])
+        newapp = self._getapp(app)
+        return newapp
+
+    def resolve(self, path, method):
+        '''
+        Fetches a WSGI app based on URL path component and method.
+
+        @param path URL path component
+        @param method HTTP method
+        '''
+        key = ':'.join([path, method])
+        # Try fetching app from cache
+        app = self._cache.get(key)
+        if app is not None:
+            return app
+        # Loop through path patterns -> applications
+        for pattern, app in self._paths:
+            # Test path for match
+            search = pattern.search(path)
+            # Continue with next iteration if no match
+            if not search:
+                continue
+            # Get any app specifically linked to an HTTP method
+            if isinstance(app, dict):
+                app = app.get(method)
+                if app is None:
+                    continue
+            app = self._loadapp(app)
+            # Ensure we have a callable
+            assert hasattr(app, '__call__')
+            # Extract any keyword arguments in the path
+            kw = search.groupdict()
+            # Extract any positional arguments
+            args = tuple(i for i in search.groups() if i not in kw)
+            # Cache app, positional and keyword arguments
+            self._cache[key] = (app, args, kw)
+            return app, args, kw
+        # Return default app if no matching path and default app is set
+        if self._default is not None:
+            default = self._loadapp(self._default)
+            return default, (), {}
+        raise ImportError()

File urlrelay/ez_setup.py

-#!python
-"""Bootstrap setuptools installation
-
-If you want to use setuptools in your package's setup.py, just include this
-file in the same directory with it, and add this to the top of your setup.py::
-
-    from ez_setup import use_setuptools
-    use_setuptools()
-
-If you want to require a specific version of setuptools, set a download
-mirror, or use an alternate download directory, you can do so by supplying
-the appropriate options to ``use_setuptools()``.
-
-This file can also be run as a script to install or upgrade setuptools.
-"""
-import sys
-DEFAULT_VERSION = "0.6c9"
-DEFAULT_URL     = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3]
-
-md5_data = {
-    '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',
-    'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
-    'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
-    'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
-    'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
-    'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
-    'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
-    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
-    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
-    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
-    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
-    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
-    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
-    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
-    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
-    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
-    'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03',
-    'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a',
-    'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6',
-    'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a',
-}
-
-import sys, os
-try: from hashlib import md5
-except ImportError: from md5 import md5
-
-def _validate_md5(egg_name, data):
-    if egg_name in md5_data:
-        digest = md5(data).hexdigest()
-        if digest != md5_data[egg_name]:
-            print >>sys.stderr, (
-                "md5 validation of %s failed!  (Possible download problem?)"
-                % egg_name
-            )
-            sys.exit(2)
-    return data
-
-def use_setuptools(
-    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
-    download_delay=15
-):
-    """Automatically find/download setuptools and make it available on sys.path
-
-    `version` should be a valid setuptools version number that is available
-    as an egg for download under the `download_base` URL (which should end with
-    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
-    it is not already available.  If `download_delay` is specified, it should
-    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.
-    """
-    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
-    def do_download():
-        egg = download_setuptools(version, download_base, to_dir, download_delay)
-        sys.path.insert(0, egg)
-        import setuptools; setuptools.bootstrap_install_from = egg
-    try:
-        import pkg_resources
-    except ImportError:
-        return do_download()       
-    try:
-        pkg_resources.require("setuptools>="+version); return
-    except pkg_resources.VersionConflict, e:
-        if was_imported:
-            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, using 'easy_install -U setuptools'."
-            "\n\n(Currently using %r)"
-            ) % (version, e.args[0])
-            sys.exit(2)
-        else:
-            del pkg_resources, sys.modules['pkg_resources']    # reload ok
-            return do_download()
-    except pkg_resources.DistributionNotFound:
-        return do_download()
-
-def download_setuptools(
-    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
-    delay = 15
-):
-    """Download setuptools from a specified location and return its filename
-
-    `version` should be a valid setuptools version number that is available
-    as an egg for download under the `download_base` URL (which should end
-    with a '/'). `to_dir` is the directory where the egg will be downloaded.
-    `delay` is the number of seconds to pause before an actual download attempt.
-    """
-    import urllib2, shutil
-    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
-    url = download_base + egg_name
-    saveto = os.path.join(to_dir, egg_name)
-    src = dst = None
-    if not os.path.exists(saveto):  # Avoid repeated downloads
-        try:
-            from distutils import log
-            if delay:
-                log.warn("""
----------------------------------------------------------------------------
-This script requires setuptools version %s to run (even to display
-help).  I will attempt to download it for you (from
-%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, url
-                ); from time import sleep; sleep(delay)
-            log.warn("Downloading %s", url)
-            src = urllib2.urlopen(url)
-            # Read/write all in one block, so we don't create a corrupt file
-            # if the download is interrupted.
-            data = _validate_md5(egg_name, src.read())
-            dst = open(saveto,"wb"); dst.write(data)
-        finally:
-            if src: src.close()
-            if dst: dst.close()
-    return os.path.realpath(saveto)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-def main(argv, version=DEFAULT_VERSION):
-    """Install or upgrade setuptools and EasyInstall"""
-    try:
-        import setuptools
-    except ImportError:
-        egg = None
-        try:
-            egg = download_setuptools(version, delay=0)
-            sys.path.insert(0,egg)
-            from setuptools.command.easy_install import main
-            return main(list(argv)+[egg])   # we're done here
-        finally:
-            if egg and os.path.exists(egg):
-                os.unlink(egg)
-    else:
-        if setuptools.__version__ == '0.0.1':
-            print >>sys.stderr, (
-            "You have an obsolete version of setuptools installed.  Please\n"
-            "remove it from your system entirely before rerunning this script."
-            )
-            sys.exit(2)
-
-    req = "setuptools>="+version
-    import pkg_resources
-    try:
-        pkg_resources.require(req)
-    except pkg_resources.VersionConflict:
-        try:
-            from setuptools.command.easy_install import main
-        except ImportError:
-            from easy_install import main
-        main(list(argv)+[download_setuptools(delay=0)])
-        sys.exit(0) # try to force an exit
-    else:
-        if argv:
-            from setuptools.command.easy_install import main
-            main(argv)
-        else:
-            print "Setuptools version",version,"or greater has been installed."
-            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
-
-def update_md5(filenames):
-    """Update our built-in md5 registry"""
-
-    import re
-
-    for name in filenames:
-        base = os.path.basename(name)
-        f = open(name,'rb')
-        md5_data[base] = md5(f.read()).hexdigest()
-        f.close()
-
-    data = ["    %r: %r,\n" % it for it in md5_data.items()]
-    data.sort()
-    repl = "".join(data)
-
-    import inspect
-    srcfile = inspect.getsourcefile(sys.modules[__name__])
-    f = open(srcfile, 'rb'); src = f.read(); f.close()
-
-    match = re.search("\nmd5_data = {\n([^}]+)}", src)
-    if not match:
-        print >>sys.stderr, "Internal error!"
-        sys.exit(2)
-
-    src = src[:match.start(1)] + repl + src[match.end(1):]
-    f = open(srcfile,'w')
-    f.write(src)
-    f.close()
-
-
-if __name__=='__main__':
-    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
-        update_md5(sys.argv[2:])
-    else:
-        main(sys.argv[1:])
-
-
-
-
-
-

File urlrelay/setup.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.
-
-'''setup - setuptools based setup for urlrelay.'''
-
-import ez_setup
-ez_setup.use_setuptools()
-
-try:
-    from setuptools import setup
-except:
-    from distutils.core import setup
-
-setup(name='urlrelay',
-      version='0.7.1',
-      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'],
-      packages=['tests'],
-      test_suite='tests.test_urlrelay',
-      zip_safe = True,
-      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'])

File urlrelay/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 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 argtests(environ, start_response):
-    start_response('200 OK', [('Content-Type', 'text/plain')])
-    args, kw = environ['wsgiorg.routing_args']
-    return [' '.join([args[0], args[1], kw['kwarg1'], kw['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, kw = environ['wsgiorg.routing_args']
-    return [' '.join(['GET', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
-
-@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'POST')
-def meth_post2(environ, start_response):
-    start_response('200 OK', [('Content-Type', 'text/plain')])
-    args, kw = environ['wsgiorg.routing_args']
-    return [' '.join(['POST', args[0], args[1], kw['kwarg1'], kw['kwarg2']])] 
-
-@urlrelay.url(r'^/methtest/(?P<kwarg1>\w+)/(?P<kwarg2>\w+)/(\w+)/(\w+)$', 'PUT')
-def meth_put(environ, start_response):
-    start_response('200 OK', [('Content-Type', 'text/plain')])
-    args, kw = environ['wsgiorg.routing_args']
-    return [' '.join(['PUT', args[0], args[1], kw['kwarg1'], kw['kwarg2']])]
-
-@urlrelay.url(r'/spectest/', 'POST')
-def meth_post(environ, start_response):
-    start_response('200 OK', [('Content-Type', 'text/plain')])
-    return ['Empty post']
-
-@urlrelay.url(r'/spectest/(.*)', 'GET')
-def meth_get2(environ, start_response):
-    start_response('200 OK', [('Content-Type', 'text/plain')])
-    args, kw = environ['wsgiorg.routing_args']
-    return [' '.join(['GET', args[0]])]
-
-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 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 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 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 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 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 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 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 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_defaultapp2(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 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 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 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)
-        
-    def test_call_more_specific(self):
-        '''Checks calling a more-specific URL than one that has a method
-        associated with it.'''
-        environ = {'PATH_INFO': '/spectest/foo', 'REQUEST_METHOD': 'GET'}
-        result = urlrelay.URLRelay()(environ, dummy_sr)
-        self.assertEquals('GET foo', result[0])        
-    
-if __name__ == '__main__': unittest.main()

File urlrelay/urlrelay.py

-# Copyright (c) 2006-2008 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.
-
-'''RESTful WSGI URL dispatcher.'''
-
-import re
-import time
-import copy
-import random
-import threading
-from fnmatch import translate
-
-__author__ = 'L.C. Rees (lcrees@gmail.com)'
-__revision__ = '0.7'
-__all__ = ['URLRelay', 'url', 'register']
-
-def synchronized(func):
-    '''Decorator to lock and unlock a method (Phillip J. Eby).
-
-    @param func Method to decorate
-    '''
-    def wrapper(self, *__args, **__kw):
-        self._lock.acquire()
-        try:
-            return func(self, *__args, **__kw)
-        finally:
-            self._lock.release()
-    wrapper.__name__ = func.__name__
-    wrapper.__dict__ = func.__dict__
-    wrapper.__doc__ = func.__doc__
-    return wrapper
-
-def _handler(environ, start_response):
-    start_response('404 Not Found', [('content-type', 'text/plain')])
-    return ['Requested URL was not found on this server.']
-
-def pattern_compile(pattern, pattern_type):
-    '''Compile pattern.'''
-    # Convert glob expression to regex
-    if pattern_type == 'glob': pattern = translate(pattern)
-    return re.compile(pattern)
-
-
-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
-_reg = _Registry()
-
-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 None
-        # 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 lazy(object):
-
-    '''Lazily assign attributes on an instance upon first use.'''
-
-    def __init__(self, method):
-        self.method = method
-        self.name = method.__name__
-
-    def __get__(self, instance, cls):
-        if instance is None: return self
-        value = self.method(instance)
-        setattr(instance, self.name, value)
-        return value
-
-
-class MemoryCache(object):
-
-    '''Base Cache class.'''    
-    
-    def __init__(self, **kw):
-        # Set timeout
-        timeout = kw.get('timeout', 300)
-        try:
-            timeout = int(timeout)
-        except (ValueError, TypeError):
-            timeout = 300
-        self.timeout = timeout
-        # Get random seed
-        random.seed()
-        self._cache = dict()
-        # Set max entries
-        max_entries = kw.get('max_entries', 300)
-        try:
-            self._max_entries = int(max_entries)
-        except (ValueError, TypeError):
-            self._max_entries = 300
-        # Set maximum number of items to cull if over max
-        self._maxcull = kw.get('maxcull', 10)
-        self._lock = threading.Condition()
-
-    def __getitem__(self, key):
-        '''Fetch a given key from the cache.'''
-        return self.get(key)
-
-    def __setitem__(self, key, value):
-        '''Set a value in the cache. '''
-        self.set(key, value)
-
-    def __delitem__(self, key):
-        '''Delete a key from the cache.'''
-        self.delete(key) 
-
-    def __contains__(self, key):
-        '''Tell if a given key is in the cache.'''
-        return self.get(key) is not None   
-
-    def get(self, key, default=None):
-        '''Fetch a given key from the cache.  If the key does not exist, return
-        default, which itself defaults to None.
-
-        @param key Keyword of item in cache.
-        @param default Default value (default: None)
-        '''
-        values = self._cache.get(key)
-        if values is None: 
-            value = default
-        elif values[0] < time.time():
-            self.delete(key)
-            value = default
-        else:
-            value = values[1]
-        return copy.deepcopy(value)
-
-    def set(self, key, value):
-        '''Set a value in the cache.
-
-        @param key Keyword of item in cache.
-        @param value Value to be inserted in cache.
-        '''
-        # Cull timed out values if over max # of entries
-        if len(self._cache) >= self._max_entries: self._cull()
-        # Set value and timeout in cache
-        self._cache[key] = (time.time() + self.timeout, value)
-
-    def delete(self, key):
-        '''Delete a key from the cache, failing silently.
-
-        @param key Keyword of item in cache.
-        '''