Merge lp:~leonardr/lazr.restful/wsgi.improvements.1 into lp:lazr.restful

[Leonard Richardson]

[Leonard Richardson (leonardr)]

This branch does some minor cleanup of lazr.restful to reduce the amount of code in the example web services.

1. I changed some README files to point to the lazr.restful.example.wsgi README, which is the best place to get started learning about lazr.restful. (This was something gary requested while reviewing an earlier branch, that I didn't carry out.)

2. I removed example/wsgi/initialize.py, which wasn't used anywhere.

3. I changed SimplePublication into a mixin, and created a new SimplePublication that included it along with the WebServicePublicationMixin. This removed the need to create new publication classes that included both SimplePublication and WebServicePublicationMixin. I got rid of now-redundant publication classes in lazr.restful.example.wsgi, and slightly simplified the publication class in lazr.restful.testing.webservice.

(Why make SimplePublication a mixin? Why not just make it mix in WebServicePublicationMixin? Because SP.traverseName() expects to be the super() of WSPM. If SP mixes in WSPM, WSPM.traverseName() will be the super() of SP.traverseName(), and the code won't work.)

[lp:~leonardr/lazr.restful/wsgi.improvements.1]

47. By Leonard Richardson on 2009-08-04

Removed unneeded code from test_integration.py.

[Deryck Hodge (deryck)]

Hi, Leonard.

This is a nice looking clean up branch. Cheers,

deryck

review: Approve

[Leonard Richardson (leonardr)]

Here's the incremental diff for a follow-up that creates a SimpleRequest to match SimplePublication, and uses it to replace WSGIExampleWebServiceRequest and WebServiceTestRequest.

https://pastebin.canonical.com/20760/

[Deryck Hodge (deryck)]

> Here's the incremental diff for a follow-up that creates a SimpleRequest to
> match SimplePublication, and uses it to replace WSGIExampleWebServiceRequest
> and WebServiceTestRequest.
>
> https://pastebin.canonical.com/20760/

This incremental diff looks fine, too.

Cheers,
deryck

review: Approve

[lp:~leonardr/lazr.restful/wsgi.improvements.1]

48. By Leonard Richardson on 2009-08-04

Replaced miscellaneous request classes with SimpleRequest.

[Leonard Richardson (leonardr)]

And here's the incremental diff for a change that refactors a lot of the basic runtime ZCML into basic-site.zcml, used by numerous tests and examples:

https://pastebin.canonical.com/20767/

=== modified file 'README.txt'
--- README.txt	2009-04-29 15:34:56 +0000
+++ README.txt	2009-08-04 14:46:24 +0000
@@ -15,4 +15,5 @@
     You should have received a copy of the GNU Lesser General Public License
     along with lazr.restful.  If not, see <http://www.gnu.org/licenses/>.
 
-Please see the package README for an introduction.
+Please see the package README for an introduction. For a quick start,
+look at example/wsgi/README.txt within the package.

=== modified file 'src/lazr/restful/README.txt'
--- src/lazr/restful/README.txt	2009-04-29 15:34:56 +0000
+++ src/lazr/restful/README.txt	2009-08-04 14:17:40 +0000
@@ -21,16 +21,25 @@
 RESTful web service. To tell lazr.restful which objects you want
 exposed and how, you annotate your existing Zope interfaces.
 
-The example web service
-=======================
-
-The example web service is the best place to start understanding
-lazr.restful. The web service is in src/lazr/restful/example. It
-defines a simple application serving information about cookbooks and
-recipes. The interfaces (interfaces.py) are annotated with
-lazr.restful decorators that say which fields and methods to publish
-from IRecipe, ICookbook, and so on. The implementations of those
-interfaces are in root.py.
+
+The WSGI example web service
+============================
+
+The example web service in src/lazr/restful/example/wsgi/ is the best
+place to start understanding lazr.restful. It's a very simple web
+service that uses a subset of lazr.restful's features and can be run
+as a standalone WSGI application. An explanation of the code can be
+found in src/lazr/restful/example/wsgi/README.txt
+
+The full example web service
+============================
+
+To understand all of lazr.restful, you should look at the web service
+defined in src/lazr/restful/example/. It defines a simple application
+serving information about cookbooks and recipes. The interfaces
+(interfaces.py) are annotated with lazr.restful decorators that say
+which fields and methods to publish from IRecipe, ICookbook, and so
+on. The implementations of those interfaces are in root.py.
 
 The machinery of lazr.restful takes the decorators in interfaces.py,
 and generates an interface that maps incoming HTTP requests to

=== removed file 'src/lazr/restful/example/wsgi/initialize.py'
--- src/lazr/restful/example/wsgi/initialize.py	2009-07-07 14:58:36 +0000
+++ src/lazr/restful/example/wsgi/initialize.py	1970-01-01 00:00:00 +0000
@@ -1,15 +0,0 @@
-"""Web service initialization."""
-
-__metaclass__ = type
-__all__ = [
-    'initialize',
-    ]
-
-
-from zope.configuration import xmlconfig
-
-
-def initialize():
-    """Initialize the admin web service and the Zope Component Architecture."""
-    import lazr.restful.example.wsgi
-    xmlconfig.file('configure.zcml', lazr.restful.example.wsgi)

=== removed file 'src/lazr/restful/example/wsgi/publication.py'
--- src/lazr/restful/example/wsgi/publication.py	2009-07-07 18:56:50 +0000
+++ src/lazr/restful/example/wsgi/publication.py	1970-01-01 00:00:00 +0000
@@ -1,13 +0,0 @@
-"""Module stuff."""
-
-__metaclass__ = type
-__all__ = [
-    'WSGIExampleWebServicePublication',
-    ]
-
-from lazr.restful.publisher import (
-    SimplePublication, WebServicePublicationMixin)
-
-class WSGIExampleWebServicePublication(
-    WebServicePublicationMixin, SimplePublication):
-    """A publication that mixes in the necessary web service stuff."""

=== modified file 'src/lazr/restful/example/wsgi/tests/test_integration.py'
--- src/lazr/restful/example/wsgi/tests/test_integration.py	2009-07-07 18:56:50 +0000
+++ src/lazr/restful/example/wsgi/tests/test_integration.py	2009-08-04 14:46:24 +0000
@@ -16,18 +16,10 @@
 
 from lazr.restful.example.wsgi.root import WSGIExampleWebServiceRootResource
 from lazr.restful.interfaces import IWebServiceConfiguration
-from lazr.restful.publisher import (
-    WebServicePublicationMixin, SimplePublication)
+from lazr.restful.publisher import SimplePublication
 from lazr.restful.testing.webservice import WebServiceApplication
 
 
-class WSGIExampleWebServiceTestPublication(
-    WebServicePublicationMixin, SimplePublication):
-
-    def getApplication(self, request):
-        return WSGIExampleWebServiceRootResource()
-
-
 DOCTEST_FLAGS = (
     doctest.ELLIPSIS |
     doctest.NORMALIZE_WHITESPACE |
@@ -39,6 +31,12 @@
 zcml_layer(FunctionalLayer)
 
 
+class WSGIExampleWebServiceTestPublication(SimplePublication):
+
+    def getApplication(self, request):
+        return WSGIExampleWebServiceRootResource()
+
+
 class WSGILayer(FunctionalLayer):
     @classmethod
     def make_application(self):

=== modified file 'src/lazr/restful/example/wsgi/webservice.py'
--- src/lazr/restful/example/wsgi/webservice.py	2009-07-07 19:23:03 +0000
+++ src/lazr/restful/example/wsgi/webservice.py	2009-08-04 14:46:24 +0000
@@ -20,7 +20,7 @@
 from lazr.restful.publisher import WebServiceRequestTraversal
 
 
-from lazr.restful.example.wsgi.publication import WSGIExampleWebServicePublication
+from lazr.restful.publisher import SimplePublication
 from lazr.restful.example.wsgi.root import WSGIExampleWebServiceRootResource
 
 
@@ -41,7 +41,7 @@
         method = environ.get('REQUEST_METHOD', 'GET').upper()
         service_root = WSGIExampleWebServiceRootResource()
         request = WSGIExampleWebServiceRequest(environ['wsgi.input'], environ)
-        request.setPublication(WSGIExampleWebServicePublication(service_root))
+        request.setPublication(SimplePublication(service_root))
         # Support post-mortem debugging.
         handle_errors = environ.get('wsgi.handleErrors', True)
         # The request returned by the publisher may in fact be different than

=== modified file 'src/lazr/restful/publisher.py'
--- src/lazr/restful/publisher.py	2009-07-08 14:09:00 +0000
+++ src/lazr/restful/publisher.py	2009-08-04 14:46:24 +0000
@@ -181,7 +181,7 @@
         return value
 
 
-class SimplePublication(object):
+class SimplePublicationMixin(object):
     """A very simple implementation of `IPublication`.
 
     The object passed to the constructor is returned by getApplication().
@@ -268,6 +268,10 @@
         endInteraction()
 
 
+class SimplePublication(WebServicePublicationMixin, SimplePublicationMixin):
+    pass
+
+
 class TraverseWithGet(object):
     """An implementation of `IPublishTraverse` that uses the get() method.
 

=== modified file 'src/lazr/restful/testing/webservice.py'
--- src/lazr/restful/testing/webservice.py	2009-07-07 18:30:11 +0000
+++ src/lazr/restful/testing/webservice.py	2009-08-04 14:46:24 +0000
@@ -124,7 +124,7 @@
     implements(IWebServiceLayer)
 
 
-class WebServiceTestPublication(WebServicePublicationMixin, SimplePublication):
+class WebServiceTestPublication(SimplePublication):
     """Test publication that mixes in the necessary web service stuff."""
 
     def wrapTraversedObject(self, ob):