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

[Leonard Richardson]

[Leonard Richardson (leonardr)]

This branch adds the framework necessary for converting a web service request into a website request. I don't want to land it until I know this is what I need for Launchpad.

[Gavin Panella (allenap)]

Leonard, is this proposal still active? The branch looks to not have been touched since 3rd June.

review: Needs Information

Unmerged revisions

49. By Leonard Richardson on 2009-06-03

Merge from trunk.

48. By Leonard Richardson on 2009-06-01

Removed adapter registration for function that's no longer an adapter.

47. By Leonard Richardson on 2009-06-01

Cleanup and removed the registration for web_service_request_to_browser_request, which will never be used because it goes from the specific to the general.

46. By Leonard Richardson on 2009-06-01

Added createWebsiteRequest to IWebServiceConfiguration.

45. By Leonard Richardson on 2009-06-01

Okay, it appears to work, at any rate.

44. By Leonard Richardson on 2009-06-01

First stab at implementation.

=== modified file 'src/lazr/restful/docs/webservice-request.txt'
--- src/lazr/restful/docs/webservice-request.txt	2009-03-28 14:35:27 +0000
+++ src/lazr/restful/docs/webservice-request.txt	2009-06-01 18:45:20 +0000
@@ -6,15 +6,15 @@
 website neeeds to be treated as a web service request. It's easy to
 adapt an IBrowserRequest into an IIWebServiceClientRequest request.
 
-This adapters uses the request factory from the IWebServiceConfiguration
-utility.
+This adapter uses a factory for web service requests defined in
+IWebServiceConfiguration.createRequest.
 
     >>> from lazr.restful.interfaces import (
     ...     IWebServiceConfiguration, IWebServiceClientRequest)
     >>> from lazr.restful.publisher import (
     ...     browser_request_to_web_service_request)
     >>> from lazr.restful.testing.webservice import (
-    ...     WebServiceTestPublication, WebServiceTestRequest)
+    ...     TestPublication, WebServiceTestPublication, WebServiceTestRequest)
     >>> from zope.interface import implements
     >>> from zope.component import getSiteManager
     >>> from zope.publisher.browser import TestRequest
@@ -28,6 +28,12 @@
     ...         request = WebServiceTestRequest(body_stream, environ)
     ...         request.setPublication(WebServiceTestPublication(None))
     ...         return request
+    ...
+    ...     def createWebsiteRequest(self, body_stream, environ):
+    ...         request = TestRequest(body_stream, environ)
+    ...         request.setPublication(TestPublication(None))
+    ...         return request
+
 
     >>> sm = getSiteManager()
     >>> sm.registerUtility(SimpleWebServiceConfiguration())
@@ -40,6 +46,29 @@
     >>> request.getApplicationURL()
     'http://cookbooks.dev/api/beta'
 
+Adapting a web service request into a browser request
+*****************************************************
+
+Sometimes it goes the other way: a web service request needs to be
+treated as a browser request. The reverse transformation is also easy.
+
+This adapter uses a factory for website requests defined in
+IWebServiceConfiguration.createWebsiteRequest.
+
+    >>> from lazr.restful.publisher import (
+    ...     web_service_request_to_browser_request)
+    >>> from cStringIO import StringIO
+
+    >>> service_request = WebServiceTestRequest(
+    ...     StringIO(""), {'SERVER_URL': "http://cookbooks.dev/"})
+
+    >>> website_request = web_service_request_to_browser_request(
+    ...     service_request)
+    >>> website_request
+    <zope.publisher.browser.TestRequest...>
+    >>> website_request.getApplicationURL()
+    'http://cookbooks.dev'
+
 ==============
 The JSON Cache
 ==============

=== modified file 'src/lazr/restful/interfaces/_rest.py'
--- src/lazr/restful/interfaces/_rest.py	2009-04-15 19:05:23 +0000
+++ src/lazr/restful/interfaces/_rest.py	2009-06-01 18:07:47 +0000
@@ -435,6 +435,19 @@
         :param environ: A dict containing the request environment.
         """
 
+    def createWebsiteRequest(body_instream, environ):
+        """A factory method that creates a request for the website.
+
+        This is necessary when converting web service requests into
+        website requests.
+
+        It should have the correct publication set for the application.
+
+        :param body_instream: A file-like object containing the request
+            input stream.
+        :param environ: A dict containing the request environment.
+        """
+
     def get_request_user():
         """The user who made the current web service request.
 

=== modified file 'src/lazr/restful/publisher.py'
--- src/lazr/restful/publisher.py	2009-03-27 04:25:34 +0000
+++ src/lazr/restful/publisher.py	2009-06-01 18:43:23 +0000
@@ -11,6 +11,7 @@
     'browser_request_to_web_service_request',
     'WebServicePublicationMixin',
     'WebServiceRequestTraversal',
+    'web_service_request_to_browser_request',
     ]
 
 import urllib
@@ -250,3 +251,19 @@
         names=[config.path_override, config.service_version_uri_prefix])
     web_service_request._vh_root = website_request.getVirtualHostRoot()
     return web_service_request
+
+
+def web_service_request_to_browser_request(web_service_request):
+    """An adapter from a web service request to a browser request.
+
+    Used when generating XHTML representations (and, in the future,
+    the web_link for JSON representations).
+    """
+    config = getUtility(IWebServiceConfiguration)
+    body = web_service_request.bodyStream.getCacheStream().read()
+    environ = dict(web_service_request.environment)
+    # Zope picks up on SERVER_URL when setting the _app_server attribute
+    # of the new request.
+    environ['SERVER_URL'] = web_service_request.getApplicationURL()
+    website_request = config.createWebsiteRequest(body, environ)
+    return website_request