code-e9077def7678/roundup/web/NOTES.md0000644000000000000000000000420512574247130015373 0ustar 00000000000000 Engineering notes for Roundup components for web. ### Logical structure of web components An attempt to see what components are present in web request processing. +-----------+ | | | Router | └─----------+ (pure logic) ---------------------------------------------- +-----------+ | | | Login | └-----------+ (logic + templates + messages) ---------------------------------------------- +-----------+ ¦ ¦ ¦ User DB ¦ └-----------+ (messages) Every component consists of messages (data), logic (code) and representation (templates). Message definition (data) also takes into account actions that make component work. Templates are mostly needed for human readability. ### Router Roundup URL map check for backward compatibility: [ ] check urlpath values for [ ] example.com [ ] example.com/ [ ] example.com/tracker [ ] example.com/tracker/ [ ] example.com/tracker/item [ ] example.com/tracker?anything [ ] example.com/tracker/?anything [ ] example.com/tracker/item?anything [x] get full list of url handlers (1.5.0, entrypoing: cgi.client.main) [x] /xmlrpc - hardcoded xmlrpc endpoint [x] / - main home page /index /home [x] /_file - static resources /@@file [x] / - dynamic handler based on db [ ] check url handling for db scheme paths [ ] example.com/tracker/class [ ] example.com/tracker/class/ [ ] example.com/tracker/class1 [ ] example.com/tracker/class1/ [ ] check url handling for static files /_file/(.*) StaticFileHandler [x] /_file - 500 TypeError: join() [x] /_file/ - 404 [x] /_file/name - 200 from STATIC_FILES or TEMPLATES /@@file/(.*) StaticFileHandler [x] /@@file - 500 TypeError: join() [x] /@@file/ - 404 [x] /@@file/name - 200 from STATIC_FILES or TEMPLATES code-e9077def7678/roundup/web/__init__.py0000644000000000000000000000000012574247130016257 0ustar 00000000000000code-e9077def7678/roundup/web/router.py0000644000000000000000000000704512574247130016060 0ustar 00000000000000#!/usr/bin/env python # This Router component was written by techtonik@gmail.com and it's been # placed in the Public Domain. Copy and modify to your heart's content. """ The purpose of router is to make Roundup URL scheme configurable and allow extensions add their own handlers and URLs to tracker. """ DEBUG = False import re # --- Example URL mapping class NamedObject(object): """Object that outputs its name when printed""" def __init__(self, name): self.name = name def __repr__(self): return self.name ExampleHandler = NamedObject('ExampleHandler') ExampleFileHandler = NamedObject('ExampleFileHandler') EXAMPLE_URL_MAP = ( 'static/(.*)', ExampleFileHandler, 'index', ExampleHandler ) # --- Helper functions def entry(prompt='> '): """Just get text for interactive mode""" import sys if sys.version_info[0] < 3: return raw_input(prompt) else: return input(prompt) # --- Regexp based router class Router(object): urlmap = [] def __init__(self, urlmap=[]): """ `urlmap` is a list (pattern, handler, pattern, ...) leading slash in pattern is stripped """ self.urlmap = urlmap def get_handler(self, urlpath): """ `urlpath` is a part of url /that/looks?like=this (leading slash is optional, will be stripped anyway) returns tuple (handler, arguments) or (None, ()) """ # strip leading slashes before matching path = urlpath.lstrip('/') for pattern, handler in self.iter_urlmap(): pattern = pattern.lstrip('/') if DEBUG: print('router: matching %s' % pattern) match = re.match(pattern, path) if match: return handler, match.groups() return (None, ()) def iter_urlmap(self): """ iterate over self.urlmap returning (pattern, handler) pairs """ for i in range(0, len(self.urlmap), 2): yield self.urlmap[i], self.urlmap[i+1] def interactive(self): print('enter url to test, [l] to list rules, empty line exits') url = entry('url: ') while url != '': if url == 'l': for i in range(0, len(self.urlmap), 2): pattern, handler = self.urlmap[i], self.urlmap[i+1] print(self.urlmap[i:i+2]) print('matched ' + str(self.get_handler(url))) url = entry('url: ') # [ ] len(urlmap) should be even to avoid errors # (find a way to explain this to users) if __name__ == '__main__': import sys if '-i' in sys.argv: router = Router(EXAMPLE_URL_MAP) router.interactive() sys.exit() import unittest class test_Router(unittest.TestCase): def test_example_routes(self): router = Router(EXAMPLE_URL_MAP) self.assertEqual(router.get_handler(''), (None, ())) handler, params = router.get_handler('/index') self.assertEqual(handler, ExampleHandler) self.assertEqual(params, tuple()) def test_route_param(self): def echo_handler(args): return args router = Router(('/files/(.*)', echo_handler)) self.assertEqual(router.get_handler(''), (None, ())) self.assertEqual(router.get_handler('/files'), (None, ())) handler, params = router.get_handler('/files/filename') self.assertEqual(handler, echo_handler) self.assertEqual(params, ('filename',)) unittest.main()