Merge lp:~leonardr/lazr.restful/tag-web-service-request into lp:lazr.restful

[Leonard Richardson]

[Leonard Richardson (leonardr)]

I was having problems that stemmed from the fact that browser_request_to_web_service_request() (in publisher.py) was incorrectly tagging new web service requests with version information. I refactored the tagging code from WebServiceRequestTraversal.traverse() into a utility function and used it in both places. (I could have made it a private helper function in publisher.py, but 1) I like being able to test it on its own in a unit test, and 2) I believe it will be useful again in the future.)

I propose releasing this branch as lazr.restful 0.9.22, but it is not based on the current lazr.restful trunk. The current trunk has code to do with mutator named operations which I don't want to integrate into Launchpad right now.

[Leonard Richardson (leonardr)]

Here's the diff: http://pastebin.ubuntu.com/387038/

[Brad Crittenden (bac)]

review: Approve (code)

=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2010-02-23 19:07:23 +0000
+++ src/lazr/restful/NEWS.txt	2010-03-02 15:20:33 +0000
@@ -2,6 +2,7 @@
 NEWS for lazr.restful
 =====================
 
+<<<<<<< TREE
 Development
 ===========
 
@@ -15,6 +16,14 @@
 your web service in the "last_version_with_named_mutator_operations"
 field of your IWebServiceConfiguration implementation.
 
+=======
+0.9.22 (2010-03-02)
+===================
+
+Refactored the code that tags request objects with version
+information, so that tagging would happen consistently.
+
+>>>>>>> MERGE-SOURCE
 0.9.21 (2010-02-23)
 ===================
 

=== modified file 'src/lazr/restful/docs/webservice-request.txt'
--- src/lazr/restful/docs/webservice-request.txt	2009-11-12 19:08:10 +0000
+++ src/lazr/restful/docs/webservice-request.txt	2010-03-02 15:20:33 +0000
@@ -29,8 +29,13 @@
     ...         request.setPublication(WebServiceTestPublication(None))
     ...         return request
 
+    >>> from lazr.restful.interfaces import IWebServiceVersion
+    >>> class IBetaVersion(IWebServiceVersion):
+    ...     """Marker interface for web service version."""
+
     >>> sm = getSiteManager()
     >>> sm.registerUtility(SimpleWebServiceConfiguration())
+    >>> sm.registerUtility(IBetaVersion, IWebServiceVersion, name="beta")
     >>> sm.registerAdapter(browser_request_to_web_service_request)
 
     >>> website_request = TestRequest(SERVER_URL="http://cookbooks.dev/")

=== modified file 'src/lazr/restful/publisher.py'
--- src/lazr/restful/publisher.py	2010-02-11 17:57:16 +0000
+++ src/lazr/restful/publisher.py	2010-03-02 15:20:33 +0000
@@ -36,6 +36,7 @@
     IByteStorage, ICollection, ICollectionField, IEntry, IEntryField,
     IHTTPResource, IServiceRootResource, IWebBrowserInitiatedRequest,
     IWebServiceClientRequest, IWebServiceConfiguration, IWebServiceVersion)
+from lazr.restful.utils import tag_request_with_version_name
 
 
 class WebServicePublicationMixin:
@@ -253,13 +254,7 @@
                     break
         if version is None:
             raise NotFound(self, '', self)
-        self.annotations[self.VERSION_ANNOTATION] = version
-
-        # Find the version-specific interface this request should
-        # provide, and provide it.
-        to_provide = getUtility(IWebServiceVersion, name=version)
-        alsoProvides(self, to_provide)
-        self.version = version
+        tag_request_with_version_name(self, version)
 
         # Find the appropriate service root for this version and set
         # the publication's application appropriately.
@@ -309,7 +304,6 @@
     web_service_request = config.createRequest(body, environ)
     web_service_request.setVirtualHostRoot(
         names=[config.path_override, web_service_version])
-    web_service_request.annotations[web_service_request.VERSION_ANNOTATION] = (
-        web_service_request)
+    tag_request_with_version_name(web_service_request, web_service_version)
     web_service_request._vh_root = website_request.getVirtualHostRoot()
     return web_service_request

=== modified file 'src/lazr/restful/testing/webservice.py'
--- src/lazr/restful/testing/webservice.py	2010-02-11 17:57:16 +0000
+++ src/lazr/restful/testing/webservice.py	2010-03-02 15:20:33 +0000
@@ -118,6 +118,7 @@
         self.query_string_params = {}
         self.method = 'GET'
 
+
     def getTraversalStack(self):
         """See `IPublicationRequest`.
 

=== modified file 'src/lazr/restful/tests/test_utils.py'
--- src/lazr/restful/tests/test_utils.py	2010-02-18 15:23:59 +0000
+++ src/lazr/restful/tests/test_utils.py	2010-03-02 15:20:33 +0000
@@ -29,4 +29,5 @@
         endInteraction()
 
     # For the sake of convenience, test_get_current_web_service_request()
-    # is tested in test_webservice.py.
+    # and tag_request_with_version_name() are tested in test_webservice.py.
+

=== modified file 'src/lazr/restful/tests/test_webservice.py'
--- src/lazr/restful/tests/test_webservice.py	2010-02-25 17:07:16 +0000
+++ src/lazr/restful/tests/test_webservice.py	2010-03-02 15:20:33 +0000
@@ -36,7 +36,8 @@
     create_web_service_request, WebServiceTestPublication)
 from lazr.restful.testing.tales import test_tales
 from lazr.restful.utils import (
-    get_current_browser_request, get_current_web_service_request)
+    get_current_browser_request, get_current_web_service_request,
+    tag_request_with_version_name)
 
 
 def get_resource_factory(model_interface, resource_interface):
@@ -459,8 +460,18 @@
         webservice_request = get_current_web_service_request()
         self.assertEquals("2.0", webservice_request.version)
         marker_20 = getUtility(IWebServiceVersion, "2.0")
-        marker_20.providedBy(webservice_request)
-
+        self.assertTrue(marker_20.providedBy(webservice_request))
+
+        # We can use tag_request_with_version_name to change the
+        # version of a request object.
+        tag_request_with_version_name(webservice_request, '1.0')
+        self.assertEquals("1.0", webservice_request.version)
+        marker_10 = getUtility(IWebServiceVersion, "1.0")
+        self.assertTrue(marker_10.providedBy(webservice_request))
+
+        tag_request_with_version_name(webservice_request, '2.0')
+        self.assertEquals("2.0", webservice_request.version)
+        self.assertTrue(marker_20.providedBy(webservice_request))
 
 def additional_tests():
     return unittest.TestLoader().loadTestsFromName(__name__)

=== modified file 'src/lazr/restful/utils.py'
--- src/lazr/restful/utils.py	2010-02-18 15:02:10 +0000
+++ src/lazr/restful/utils.py	2010-03-02 15:20:33 +0000
@@ -13,6 +13,7 @@
     'safe_hasattr',
     'smartquote',
     'simple_popen2',
+    'tag_request_with_version_name',
     'VersionedDict',
     ]
 
@@ -25,10 +26,12 @@
 
 from simplejson import encoder
 
+from zope.component import getUtility
 from zope.schema import getFieldsInOrder
-from zope.interface import classImplements
+from zope.interface import alsoProvides, classImplements
 
-from lazr.restful.interfaces import IWebServiceClientRequest
+from lazr.restful.interfaces import (
+    IWebServiceClientRequest, IWebServiceVersion)
 
 
 missing = object()
@@ -236,6 +239,17 @@
         return None
     return IWebServiceClientRequest(request)
 
+
+def tag_request_with_version_name(request, version):
+    """Tag a request with a version name and marker interface."""
+    request.annotations[request.VERSION_ANNOTATION] = version
+    # Find the version-specific marker interface this request should
+    # provide, and provide it.
+    to_provide = getUtility(IWebServiceVersion, name=version)
+    alsoProvides(request, to_provide)
+    request.version = version
+
+
 def simple_popen2(command, input, env=None, in_bufsize=1024, out_bufsize=128):
     """Run a command, give it input on its standard input, and capture its
     standard output.

=== modified file 'src/lazr/restful/version.txt'
--- src/lazr/restful/version.txt	2010-02-23 13:26:11 +0000
+++ src/lazr/restful/version.txt	2010-03-02 15:20:33 +0000
@@ -1,1 +1,1 @@
-0.9.21
+0.9.22