1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
.. _simple_ajax:
Example Application: Simple AJAX
================================
This guide will walk you through building a simple Pecan web application that uses AJAX to fetch JSON data from a server.
Project Setup
-------------
First, you'll need to install Pecan:
::
$ pip install pecan
Use Pecan's basic template support to start a new project:
::
$ pecan create myajax
$ cd myajax
Install the new project in development mode:
::
$ python setup.py develop
Adding JavaScript AJAX Support
------------------------------
For this project we will need to add `jQuery <http://jquery.com/>`_ support. To add jQuery go into the ``templates`` folder and edit the ``layout.html`` file.
Adding jQuery support is easy, we actually only need one line of code:
.. code-block:: html
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
The JavaScript to make the AJAX call is a little more in depth but shouldn't be unfamiliar if you've ever worked with jQuery before.
The ``layout.html`` file will look like this:
.. code-block:: html
<html>
<head>
<title>${self.title()}</title>
${self.style()}
${self.javascript()}
</head>
<body>
${self.body()}
</body>
</html>
<%def name="title()">
Default Title
</%def>
<%def name="style()">
<link rel="stylesheet" type="text/css" media="screen" href="/css/style.css" />
</%def>
<%def name="javascript()">
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
<script language="text/javascript" src="/javascript/shared.js"></script>
<script>
function onSuccess(data, status, jqXHR) {
// Use a template or something here instead
// Just for demo purposes
$("#result").html("<div>" +
"<p></p><strong>Project Name: " + data.name + "</strong></p>" +
"<p>Project License: " + data.licensing + "</p>" +
"<p><a href='" + data.repository + "'>Project Repository: " + data.repository + "</a></p>" +
"<p><a href='" + data.documentation + "'>Project Documentation: " + data.documentation + "</a></p>" +
"</div>");
}
function onError(jqXHR, textStatus, errorThrown) {
alert('HTTP Status Code: ' + jqXHR.status + ', ' + errorThrown);
}
$(document).ready(function () {
$("#submit").click(function () {
$.ajax({
url: "/projects/",
data: "id=" + $("#projects").val(),
contentType: 'application/json',
dataType: 'json',
success: onSuccess,
error: onError
});
return false;
});
});
</script>
</%def>
**What did we just do?**
#. In the ``head`` section we added jQuery support via the `Google CDN <https://developers.google.com/speed/libraries/devguide>`_
#. Added JavaScript to make an AJAX call to the server via an HTTP ``GET`` passing in the ``id`` of the project to fetch more information on
#. Once the ``onSuccess`` event is triggered by the returning data we take that and display it on the web page below the controls
Adding Additional HTML
----------------------
Let's edit the ``index.html`` file next. We will add HTML to support the AJAX interaction between the web page and Pecan. Modify ``index.html`` to look like this:
.. code-block:: html
<%inherit file="layout.html" />
<%def name="title()">
Welcome to Pecan!
</%def>
<header>
<h1><img src="/images/logo.png"/></h1>
</header>
<div id="content">
<p>Select a project to get details:</p>
<select id="projects">
<option value="0">OpenStack</option>
<option value="1">Pecan</option>
<option value="2">Stevedore</option>
</select>
<button id="submit" type="submit">Submit</button>
<div id="result"></div>
</div>
**What did we just do?**
#. Added a dropdown control and submit button for the user to interact with. Users can pick an open source project and get more details on it
Building the Model with JSON Support
------------------------------------
The HTML and JavaScript work is now taken care of. At this point we can add a model to our project inside of the ``model`` folder. Create a file in there called ``projects.py`` and add the following to it:
.. code-block:: python
class Project(object):
def __init__(self, name, licensing, repository, documentation):
self.name = name
self.licensing = licensing
self.repository = repository
self.documentation = documentation
def __json__(self):
return dict(
name=self.name,
licensing=self.licensing,
repository=self.repository,
documentation=self.documentation
)
**What did we just do?**
#. Created a model called ``Project`` that can hold project specific data
#. Added a ``__json__`` method so an instance of the ``Project class`` can be easily represented as JSON. The controller we will soon build will make use of that JSON capability
.. note::
There are other ways to return JSON with Pecan, check out :ref:`jsonify` for more information.
Working with the Controllers
----------------------------
We don't need to do anything major to the ``root.py`` file in the ``controllers`` folder except to add support for a new controller we will call ``ProjectsController``. Modify the ``root.py`` like this:
.. code-block:: python
from pecan import expose
from myajax.controllers.projects import ProjectsController
class RootController(object):
projects = ProjectsController()
@expose(generic=True, template='index.html')
def index(self):
return dict()
**What did we just do?**
#. Removed some of the initial boilerplate code since we won't be using it
#. Add support for the upcoming ``ProjectsController``
The final piece is to add a file called ``projects.py`` to the ``controllers`` folder. This new file will host the ``ProjectsController`` which will listen for incoming AJAX ``GET`` calls (in our case) and return the appropriate JSON response.
Add the following code to the ``projects.py`` file:
.. code-block:: python
from pecan import expose, response
from pecan.rest import RestController
from myajax.model.projects import Project
class ProjectsController(RestController):
# Note: You would probably store this information in a database
# This is just for simplicity and demonstration purposes
def __init__(self):
self.projects = [
Project(name='OpenStack',
licensing='Apache 2',
repository='http://github.com/openstack',
documentation='http://docs.openstack.org'),
Project(name='Pecan',
licensing='BSD',
repository='http://github.com/stackforge/pecan',
documentation='http://pecan.readthedocs.org'),
Project(name='stevedore',
licensing='Apache 2',
repository='http://github.com/dreamhost/pecan',
documentation='http://stevedore.readthedocs.org')
]
@expose('json', content_type='application/json')
def get(self, id):
response.status = 200
return self.projects[int(id)]
**What did we just do?**
#. Created a local class variable called ``projects`` that holds three open source projects and their details. Typically this kind of information would probably reside in a database
#. Added code for the new controller that will listen on the ``projects`` endpoint and serve back JSON based on the ``id`` passed in from the web page
Run the application:
::
$ pecan serve config.py
Open a web browser: `http://127.0.0.1:8080/ <http://127.0.0.1:8080/>`_
There is something else we could add. What if an ``id`` is passed that is not found? A proper ``HTTP 404`` should be sent back. For this we will modify the ``ProjectsController``.
Change the ``get`` function to look like this:
.. code-block:: python
@expose('json', content_type='application/json')
def get(self, id):
try:
response.status = 200
return self.projects[int(id)]
except (IndexError, ValueError) as ex:
abort(404)
To test this out we need to pass an invalid ``id`` to the ``ProjectsController``. This can be done by going into the ``index.html`` and adding an additional ``option`` tag with an ``id`` value that is outside of 0-2.
.. code-block:: html
<p>Select a project to get details:</p>
<select id="projects">
<option value="0">OpenStack</option>
<option value="1">Pecan</option>
<option value="2">Stevedore</option>
<option value="3">WSME</option>
</select>
You can see that we added ``WSME`` to the list and the value is 3.
Run the application:
::
$ pecan serve config.py
Open a web browser: `http://127.0.0.1:8080/ <http://127.0.0.1:8080/>`_
Select ``WSME`` from the list. You should see the error dialog box triggered.
|
