annotate wsgraph/web.py @ 10:81d68388ec97

some nonsense about how this model is full of holes and how it should be better
author Jeff Hammel <jhammel@mozilla.com>
date Mon, 10 Dec 2012 17:14:49 -0800
parents 9016b126aa87
children 421d5119e324
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 #!/usr/bin/env python
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 web handler for WSGraph
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5 """
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7 import json
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 from webob import Request, Response, exc
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
10 # rank constants
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
11 GRAPH = 0
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
12 NODE = 1
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
13 EDGE = 2
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
14
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
15 # XXX stubbing hacks
7
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
16 class JSONformatter(object):
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
17 def __init__(self, sort_keys=True):
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
18 self.sort_keys = sort_keys
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
19
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
20 def format(self, _object):
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
21 return json.dumps(graph.node(node), sort_keys=self.sort_keys)
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
22
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
23 def node(self, node, graph, request):
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
24 return Response(body=self.format(graph.node(node)))
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
25
6
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
26 def JSONFormatter(node, graph, request):
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
27 return json.dumps(graph.node(node), sort_keys=True)
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
28 def JSONGraphFormatter(graph, request):
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
29 return json.dumps({'nodes': graph.nodes(),
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
30 'edges': graph.edges()},
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
31 sort_keys=True)
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
32
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
33 class Dispatcher(object):
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
34
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
35 def __init__(self, graph,
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
36 graph_formatters=None,
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
37 node_formatters=None,
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
38 edge_formatters=None,
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
39 require_auth=False):
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
40 self.graph = graph
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
41 self.require_auth = require_auth
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
42
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
43 # use JSON formatter by default
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
44 if graph_formatters is None:
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
45 graph_formatters = {None: JSONGraphFormatter}
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
46 if node_formatters is None:
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
47 node_formatters = {None: JSONFormatter}
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
48 if edge_formatters is None:
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
49 edge_formatters = {None: JSONFormatter}
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
50
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
51 self.formatters = {GRAPH: graph_formatters,
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
52 NODE: node_formatters,
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
53 EDGE: edge_formatters}
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
54 for key, value in formatters.items():
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
55 # ensure default formatter
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
56 assert None in value
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
57
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
58 self.methods = dict([(i, getattr(self, i))
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
59 for i in dir(self)
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
60 if i.isupper()])
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
61
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
62 def __call__(self, environ, start_response):
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
63 request = Request(environ)
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
64 method = self.methods.get(request.method)
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
65 if method is None:
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
66 return exc.HTTPMethodNotAllowed()(environ, start_response)
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
67 response = method(request)
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
68 return response(environ, start_response)
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
69
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
70 @staticmethod
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
71 def path_segments(path):
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
72 """split a path into segments"""
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
73 segments = path.strip('/').split('/')
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
74 if segments == ['']:
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
75 segments = []
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
76 return segments
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
77
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
78 # HTTP methods
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
79
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
80 def GET(self, request):
2
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
81 """
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
82 respond to a GET request
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
83
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
84 Formatters are keyed off of
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
85
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
86 formatters = {0: {
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
87 }
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
88
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
89 A graph formatter takes the following arguments:
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
90
6
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
91 def sample_graph_formatter(graph, request):
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
92
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
93 A node formatter takes the following arguments:
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
94
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
95 def sample_node_formatter(node, graph, request):
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
96
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
97 An edge formatter takes the following arguments:
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
98
259210f2e029 more formatter stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
99 def sample_edge_formatter(edge, graph, request):
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
100
2
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
101 API:
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
102
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
103 ?format=<format>
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
104
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
105 """
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
106
7
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
107 # get resource requestor
5
9d5a8c90c482 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
108 segments = self.path_segments(request.path_info)
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
109 if len(segments) not in (0,1,2):
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
110 return exc.HTTPNotFound()
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
111
7
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
112
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
113 # is resource in the graph? [TODO]
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
114
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
115 # formatter
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
116 formatter = self.formatters[len(segments)]
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
117 return Response(content_type='text/plain',
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
118 body="WSGraph")
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
119
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
120 def POST(self, request):
2
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
121 """
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
122 respond to a POST request
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
123
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
124 API:
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
125
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
126 ?update :
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
127 """
7a3b21cafc00 start to sketch out REST API
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
128
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
129 return exc.HTTPSeeOther(location='/') # TODO: /path/to/self
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
130
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
131 def HEAD(self, request):
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
132 """respond to a HEAD request"""
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
133 raise NotImplementedError
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
134
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
135 def OPTIONS(self, request):
4
c7170cab1184 more RESTful stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
136 return Response() # TODO: Allow=', '.join(self.methods); Content-Length=0
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
137
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
138 if __name__ == '__main__':
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
139
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
140 ### example web server
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
141
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
142 # imports
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
143 from wsgiref import simple_server
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
144 from model import MemoryCache
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
145 from optparse import OptionParser
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
146
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
147 # parse command line options
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
148 parser = OptionParser()
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
149 parser.add_option('-p', '--port', type='int', default=8080,
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
150 help="port to serve on")
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
151 options, args = parser.parse_args()
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
152
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
153 # example model
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
154 graph = MemoryCache()
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
155
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
156 # WSGI app
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
157 app = Dispatcher(graph=graph)
3
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
158 server = simple_server.make_server(host='0.0.0.0', port=options.port, app=app)
42f484880808 wire this up
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
159 print 'http://localhost:%s/' % options.port
0
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
160 server.serve_forever()
cfcfa093e4b4 initial commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
161