1
=== modified file 'src/lazr/restful/NEWS.txt'
2
--- src/lazr/restful/NEWS.txt	2010-01-12 17:41:25 +0000
3
+++ src/lazr/restful/NEWS.txt	2010-02-11 15:31:14 +0000
4
@@ -2,19 +2,20 @@
5
2
NEWS for lazr.restful
2
NEWS for lazr.restful
6
3
=====================
3
=====================
7
4
4
10
5
Development
5
0.9.18 (2010-02-11)
11
6
===========
6
===================
12
7
7
13
8
Special note: this version contains backwards-incompatible
8
Special note: this version contains backwards-incompatible
14
9
changes. You *must* change your configuration object to get your code
9
changes. You *must* change your configuration object to get your code
16
10
to work in this version! See "active_versions" below.
10
to work in this version! See "active_versions" and
17
11
"latest_version_uri_prefix" below.
18
11
12
19
12
Added a versioning system for web services. Clients can now request
13
Added a versioning system for web services. Clients can now request
25
13
the "trunk" of a web service as well as one published version. Apart
14
any number of distinct versions as well as a floating "trunk" which is
26
14
from the URIs served, the two web services are exactly the same. There
15
always the most recent version. By using version-aware annotations,
27
15
is no way to serve two different versions of a web service without
16
developers can publish the same data model differently over time. See
28
16
defining both versions from scratch. (There will eventually be
17
the example web service in example/multiversion/ to see how the
29
17
annotations to make this easy.)
18
annotations work.
30
18
19
31
19
This release introduces a new field to IWebServiceConfiguration:
20
This release introduces a new field to IWebServiceConfiguration:
32
20
latest_version_uri_prefix. If you are rolling your own
21
latest_version_uri_prefix. If you are rolling your own
33
21
22
34
=== modified file 'src/lazr/restful/_resource.py'
35
--- src/lazr/restful/_resource.py	2010-02-03 21:22:19 +0000
36
+++ src/lazr/restful/_resource.py	2010-02-11 15:31:14 +0000
37
@@ -1598,6 +1598,14 @@
38
1598
        collection_classes = []
1598
        collection_classes = []
39
1599
        singular_names = {}
1599
        singular_names = {}
40
1600
        plural_names = {}
1600
        plural_names = {}
41
1601
42
1602
        # Determine the name of the earliest version. We'll be using this later.
43
1603
        config = getUtility(IWebServiceConfiguration)
44
1604
        if len(config.active_versions) > 0:
45
1605
            earliest_version = config.active_versions[0]
46
1606
        else:
47
1607
            earliest_version = config.latest_version_uri_prefix
48
1608
49
1601
        for registration in sorted(site_manager.registeredAdapters()):
1609
        for registration in sorted(site_manager.registeredAdapters()):
50
1602
            provided = registration.provided
1610
            provided = registration.provided
51
1603
            if IInterface.providedBy(provided):
1611
            if IInterface.providedBy(provided):
52
@@ -1610,10 +1618,26 @@
53
1610
                    # of the classes with schemas, which we do describe.
1618
                    # of the classes with schemas, which we do describe.
54
1611
1619
55
1612
                    # Make sure we have a registration relevant to
1620
                    # Make sure we have a registration relevant to
57
1613
                    # this version. A given entry may be have one
1621
                    # this version. A given entry may have one
58
1614
                    # registration for every web service version.
1622
                    # registration for every web service version.
61
1615
                    schema, version = registration.required
1623
                    schema, version_marker = registration.required
62
1616
                    if not version.providedBy(self.request):
1624
63
1625
                    if (version_marker is IWebServiceClientRequest
64
1626
                        and self.request.version != earliest_version):
65
1627
                        # We are generating WADL for some version
66
1628
                        # other than the earliest version, and this is
67
1629
                        # a registration for the earliest version. We
68
1630
                        # can ignore it.
69
1631
                        #
70
1632
                        # We need this special test because the normal
71
1633
                        # test (below) is useless when
72
1634
                        # marker_interface is
73
1635
                        # IWebServiceClientRequest. Since all request
74
1636
                        # objects provide IWebServiceClientRequest
75
1637
                        # directly, it will always show up in
76
1638
                        # providedBy(self.request).
77
1639
                        continue
78
1640
                    if not version_marker in providedBy(self.request):
79
1617
                        continue
1641
                        continue
80
1618
1642
81
1619
                    # Make sure that no other entry class is using this
1643
                    # Make sure that no other entry class is using this
82
1620
1644
83
=== modified file 'src/lazr/restful/example/multiversion/tests/introduction.txt'
84
--- src/lazr/restful/example/multiversion/tests/introduction.txt	2010-02-08 18:59:13 +0000
85
+++ src/lazr/restful/example/multiversion/tests/introduction.txt	2010-02-11 15:31:14 +0000
86
@@ -232,7 +232,8 @@
87
232
If an entry field is not published in a certain version, the
232
If an entry field is not published in a certain version, the
88
233
corresponding field resource does not exist for that version.
233
corresponding field resource does not exist for that version.
89
234
234
91
235
    >>> webservice.get('/pairs/foo/deleted', api_version='beta')
235
    >>> print webservice.get('/pairs/foo/deleted', api_version='beta').body
92
236
    Object: ...
93
236
    Traceback (most recent call last):
237
    Traceback (most recent call last):
94
237
    ...
238
    ...
95
238
    NotFound: ... name: u'deleted'
239
    NotFound: ... name: u'deleted'
96
239
240
97
=== added file 'src/lazr/restful/example/multiversion/tests/wadl.txt'
98
--- src/lazr/restful/example/multiversion/tests/wadl.txt	1970-01-01 00:00:00 +0000
99
+++ src/lazr/restful/example/multiversion/tests/wadl.txt	2010-02-11 15:31:14 +0000
100
@@ -0,0 +1,67 @@
101
1
Multi-version WADL documents
102
2
****************************
103
3
104
4
A given version of the web service generates a WADL document which
105
5
describes that version only. Let's go through the WADL documents for
106
6
the different versions and see how they differ.
107
7
108
8
    >>> from lazr.restful.testing.webservice import WebServiceCaller
109
9
    >>> webservice = WebServiceCaller(domain='multiversion.dev')
110
10
111
11
We'll start with a helper function that retrieves the WADL description
112
12
for a given version of the key-value web service, and decomposes the
113
13
top-level tags in the WADL document into a dictionary for easy access
114
14
later. This works because all versions of the web service publish a
115
15
single top-level collection and a single entry type, so the document's
116
16
top-level structure is always the same.
117
17
118
18
    >>> from lxml import etree
119
19
    >>> from lxml.etree import _Comment
120
20
    >>> def wadl_contents_for_version(version):
121
21
    ...     """Parse the key-value service's WADL into a dictionary."""
122
22
    ...     wadl = webservice.get(
123
23
    ...         '/', media_type='application/vnd.sun.wadl+xml',
124
24
    ...         api_version=version).body
125
25
    ...     tree = etree.fromstring(wadl)
126
26
    ...
127
27
    ...     keys = ("base service_root service_root_json pair_collection "
128
28
    ...             "pair_entry pair_full_json pair_diff_jaon pair_page "
129
29
    ...             "pair_page_json hosted_file hosted_file_representation"
130
30
    ...             ).split()
131
31
    ...
132
32
    ...     tags = [child for child in tree if not isinstance(child, _Comment)]
133
33
    ...     contents = {}
134
34
    ...     for i in range(0, len(keys)):
135
35
    ...         contents[keys[i]] = tags[i]
136
36
    ...     return contents
137
37
138
38
Let's take a look at the differences. in 'beta', the 'by_value' method
139
39
is not present at all.
140
40
141
41
    >>> contents = wadl_contents_for_version('beta')
142
42
    >>> print contents['base'].attrib['base']
143
43
    http://multiversion.dev/beta/
144
44
145
45
    >>> pair_collection = contents['pair_collection']
146
46
    >>> sorted([method.attrib['id'] for method in pair_collection])
147
47
    ['key_value_pairs-get']
148
48
149
49
In '2.0', the by_value method is called 'byValue'.
150
50
151
51
    >>> contents = wadl_contents_for_version('2.0')
152
52
    >>> print contents['base'].attrib['base']
153
53
    http://multiversion.dev/2.0/
154
54
155
55
    >>> pair_collection = contents['pair_collection']
156
56
    >>> sorted([method.attrib['id'] for method in pair_collection])
157
57
    ['key_value_pairs-byValue', 'key_value_pairs-get']
158
58
159
59
In '3.0', the method changes its name to 'byValue'.
160
60
161
61
    >>> contents = wadl_contents_for_version('3.0')
162
62
    >>> print contents['base'].attrib['base']
163
63
    http://multiversion.dev/3.0/
164
64
165
65
    >>> pair_collection = contents['pair_collection']
166
66
    >>> sorted([method.attrib['id'] for method in pair_collection])
167
67
    ['key_value_pairs-by_value', 'key_value_pairs-get']
168
0
68
169
=== modified file 'src/lazr/restful/tales.py'
170
--- src/lazr/restful/tales.py	2010-01-11 18:27:43 +0000
171
+++ src/lazr/restful/tales.py	2010-02-11 15:31:14 +0000
172
@@ -291,7 +291,13 @@
173
291
        for interface in (IResourceGETOperation, IResourcePOSTOperation):
291
        for interface in (IResourceGETOperation, IResourcePOSTOperation):
174
292
            operations.extend(getGlobalSiteManager().adapters.lookupAll(
292
            operations.extend(getGlobalSiteManager().adapters.lookupAll(
175
293
                    (model_class, request_interface), interface))
293
                    (model_class, request_interface), interface))
177
294
        return [{'name' : name, 'op' : op} for name, op in operations]
294
178
295
        # An operation that was present in an earlier version but was
179
296
        # removed in the current version will show up in this list as
180
297
        # an stub function that returns None. Since we don't want that
181
298
        # operation to show up in this version, we'll filter it out.
182
299
        return [{'name' : name, 'op' : op} for name, op in operations
183
300
                if IResourceOperation.implementedBy(op)]
184
295
301
185
296
302
186
297
class WadlEntryInterfaceAdapterAPI(WadlResourceAdapterAPI):
303
class WadlEntryInterfaceAdapterAPI(WadlResourceAdapterAPI):
187
298
304
188
=== modified file 'src/lazr/restful/version.txt'
189
--- src/lazr/restful/version.txt	2009-11-10 14:30:52 +0000
190
+++ src/lazr/restful/version.txt	2010-02-11 15:31:14 +0000
191
@@ -1,1 +1,1 @@
193
1
0.9.17
1
0.9.18
Status:	Merged
Merged at revision:	not available
Proposed branch:	lp:~leonardr/lazr.restful/bump-version
Merge into:	lp:lazr.restful
Diff against target:	193 lines (+113/-14) 6 files modified src/lazr/restful/NEWS.txt (+9/-8) src/lazr/restful/_resource.py (+27/-3) src/lazr/restful/example/multiversion/tests/introduction.txt (+2/-1) src/lazr/restful/example/multiversion/tests/wadl.txt (+67/-0) src/lazr/restful/tales.py (+7/-1) src/lazr/restful/version.txt (+1/-1)
To merge this branch:	bzr merge lp:~leonardr/lazr.restful/bump-version
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Michael Nelson (community)	code	2010-02-11	Approve on 2010-02-11
Review via email: mp+19107@code.launchpad.net