Merge lp:~leonardr/lazr.restful/move-example into lp:lazr.restful

[Leonard Richardson]

[Leonard Richardson (leonardr)]

In the beginning there was one lazr.restful example web service, and it lived in lazr.restful.example. Then I created the WSGI example web service, in lazr.restful.example.wsgi. The problem with this packaging arrangement is it makes the WSGI web service look like part of the basic example service. Actually, they're two completely different services.

I was planning to fix this eventually, and now I have to fix it, because I'm trying to introduce grok into the mix. When you grok a package, it recursively groks all sub-packages. That means that the WSGI service's configuration is interfering with the basic service's configuration. The solution is to move the basic service into lazr.restful.example.base, making it totally separate from lazr.restful.example.wsgi.

All I've done in this branch is move the files and change the external references.

[Graham Binns (gmb)]

review: Approve

=== modified file 'src/lazr/restful/README.txt'
--- src/lazr/restful/README.txt	2009-08-04 14:17:40 +0000
+++ src/lazr/restful/README.txt	2009-09-01 12:24:18 +0000
@@ -35,11 +35,11 @@
 ============================
 
 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.
+defined in src/lazr/restful/example/base/. 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
@@ -48,7 +48,7 @@
 you do have to know a fair amount about Zope).
 
 You can test the example web service by running `bin/test`. The
-doctests in src/lazr/restful/example/tests use a fake httplib2
+doctests in src/lazr/restful/example/base/tests use a fake httplib2
 connection to simulate HTTP requests to the web service. You can watch
 the tests make GET, PUT, POST, PATCH, and DELETE requests to the web
 service. Start with root.txt.

=== modified file 'src/lazr/restful/docs/webservice-marshallers.txt'
--- src/lazr/restful/docs/webservice-marshallers.txt	2009-08-11 18:36:20 +0000
+++ src/lazr/restful/docs/webservice-marshallers.txt	2009-09-01 12:07:59 +0000
@@ -10,7 +10,7 @@
 
     >>> from lazr.restful.testing.webservice import WebServiceTestPublication
     >>> from lazr.restful.simple import Request
-    >>> from lazr.restful.example.root import (
+    >>> from lazr.restful.example.base.root import (
     ...     CookbookServiceRootResource)
     >>> request = Request("", {'HTTP_HOST': 'cookbooks.dev'})
     >>> application = CookbookServiceRootResource()
@@ -469,7 +469,7 @@
 And the unmarshall() method returns a link that will serve the file.
 
     >>> from lazr.restful import EntryResource
-    >>> from lazr.restful.example.interfaces import ICookbookSet
+    >>> from lazr.restful.example.base.interfaces import ICookbookSet
     >>> from zope.component import getUtility
     >>> entry_resource = EntryResource(
     ...     getUtility(ICookbookSet).get('Everyday Greens'), request)
@@ -604,7 +604,7 @@
 value. A string that doesn't correspond to any enumerated value results
 in a helpful ValueError.
 
-    >>> from lazr.restful.example.interfaces import Cuisine
+    >>> from lazr.restful.example.base.interfaces import Cuisine
     >>> field = Choice(vocabulary=Cuisine)
     >>> marshaller = getMultiAdapter((field, request), IFieldMarshaller)
     >>> verifyObject(IFieldMarshaller, marshaller)
@@ -648,14 +648,14 @@
 An object is marshalled to its URL.
 
     >>> from lazr.restful.fields import Reference
-    >>> from lazr.restful.example.interfaces import ICookbook
+    >>> from lazr.restful.example.base.interfaces import ICookbook
     >>> reference_field = Reference(schema=ICookbook)
     >>> reference_marshaller = getMultiAdapter(
     ...     (reference_field, request), IFieldMarshaller)
     >>> verifyObject(IFieldMarshaller, reference_marshaller)
     True
 
-    >>> from lazr.restful.example.root import COOKBOOKS
+    >>> from lazr.restful.example.base.root import COOKBOOKS
     >>> cookbook = COOKBOOKS[0]
     >>> cookbook_url = reference_marshaller.unmarshall(None, cookbook)
     >>> print cookbook_url
@@ -679,7 +679,7 @@
 
     >>> from zope.schema import List, Tuple, Set
     >>> list_of_strings_field = List(value_type=Text())
-    >>> from lazr.restful.example.interfaces import Cuisine
+    >>> from lazr.restful.example.base.interfaces import Cuisine
     >>> tuple_of_ints_field = Tuple(value_type=Int())
     >>> list_of_choices_field = List(
     ...     value_type=Choice(vocabulary=Cuisine))
@@ -799,7 +799,7 @@
 something like that.)
 
     >>> from lazr.restful.fields import CollectionField
-    >>> from lazr.restful.example.interfaces import IRecipe
+    >>> from lazr.restful.example.base.interfaces import IRecipe
     >>> field = CollectionField(
     ...     __name__='recipes', value_type=Reference(schema=IRecipe))
     >>> marshaller = getMultiAdapter((field, request), IFieldMarshaller)

=== modified file 'src/lazr/restful/docs/webservice.txt'
--- src/lazr/restful/docs/webservice.txt	2009-08-27 15:50:55 +0000
+++ src/lazr/restful/docs/webservice.txt	2009-09-01 12:07:59 +0000
@@ -503,7 +503,7 @@
     ... <configure xmlns="http://namespaces.zope.org/zope">
     ...   <include package="lazr.restful" file="basic-site.zcml"/>
     ...   <utility
-    ...       factory="lazr.restful.example.filemanager.FileManager" />
+    ...       factory="lazr.restful.example.base.filemanager.FileManager" />
     ... </configure>
     ... """)
 
@@ -1701,9 +1701,9 @@
 implementation that serves all files from the /files path.
 
     >>> from lazr.restful.interfaces import IByteStorage
-    >>> from lazr.restful.example.interfaces import (
+    >>> from lazr.restful.example.base.interfaces import (
     ...     IFileManagerBackedByteStorage)
-    >>> from lazr.restful.example.root import SimpleByteStorage
+    >>> from lazr.restful.example.base.root import SimpleByteStorage
     >>> protect_schema(SimpleByteStorage, IFileManagerBackedByteStorage)
     >>> sm.registerAdapter(SimpleByteStorage, provided=IByteStorage)
 

=== added directory 'src/lazr/restful/example/base'
=== added file 'src/lazr/restful/example/base/__init__.py'
=== renamed file 'src/lazr/restful/example/configure.zcml' => 'src/lazr/restful/example/base/configure.zcml'
--- src/lazr/restful/example/configure.zcml	2009-08-27 15:50:55 +0000
+++ src/lazr/restful/example/base/configure.zcml	2009-09-01 12:07:59 +0000
@@ -2,17 +2,17 @@
     xmlns="http://namespaces.zope.org/zope"
     xmlns:webservice="http://namespaces.canonical.com/webservice">
 
-  <webservice:register module="lazr.restful.example.interfaces" />
+  <webservice:register module="lazr.restful.example.base.interfaces" />
 
-  <class class="lazr.restful.example.root.CookbookSet">
-      <allow interface='lazr.restful.example.interfaces.ICookbookSet' />
+  <class class="lazr.restful.example.base.root.CookbookSet">
+      <allow interface='lazr.restful.example.base.interfaces.ICookbookSet' />
   </class>
 
-  <permission id="lazr.restful.example.View" title="Viewing something" />
-  <permission id="lazr.restful.example.ViewPrivate"
+  <permission id="lazr.restful.example.base.View" title="Viewing something" />
+  <permission id="lazr.restful.example.base.ViewPrivate"
    title="Viewing private information" />
 
-  <class class="lazr.restful.example.root.Cookbook">
+  <class class="lazr.restful.example.base.root.Cookbook">
     <require attributes="name copyright_date cover cuisine description
                          recipes find_recipe_for find_recipes last_printing
                          make_more_interesting price replace_cover
@@ -22,77 +22,77 @@
              permission="zope.Public" />
     <require attributes="confirmed"
              set_attributes="confirmed"
-             permission="lazr.restful.example.ViewPrivate" />
+             permission="lazr.restful.example.base.ViewPrivate" />
   </class>
 
-  <class class="lazr.restful.example.root.Dish">
-      <require interface='lazr.restful.example.interfaces.IDish'
-       set_schema='lazr.restful.example.interfaces.IDish'
+  <class class="lazr.restful.example.base.root.Dish">
+      <require interface='lazr.restful.example.base.interfaces.IDish'
+       set_schema='lazr.restful.example.base.interfaces.IDish'
        permission = "zope.Public" />
   </class>
 
-  <class class="lazr.restful.example.root.DishSet">
-      <allow interface='lazr.restful.example.interfaces.IDishSet' />
-  </class>
-
-  <class class="lazr.restful.example.root.Recipe">
-      <require interface='lazr.restful.example.interfaces.IRecipe'
-       set_schema='lazr.restful.example.interfaces.IRecipe'
-       permission="lazr.restful.example.ViewPrivate" />
-  </class>
-
-  <class class="lazr.restful.example.root.RecipeSet">
-      <allow interface='lazr.restful.example.interfaces.IRecipeSet' />
+  <class class="lazr.restful.example.base.root.DishSet">
+      <allow interface='lazr.restful.example.base.interfaces.IDishSet' />
+  </class>
+
+  <class class="lazr.restful.example.base.root.Recipe">
+      <require interface='lazr.restful.example.base.interfaces.IRecipe'
+       set_schema='lazr.restful.example.base.interfaces.IRecipe'
+       permission="lazr.restful.example.base.ViewPrivate" />
+  </class>
+
+  <class class="lazr.restful.example.base.root.RecipeSet">
+      <allow interface='lazr.restful.example.base.interfaces.IRecipeSet' />
   </class>
 
   <utility
-      factory="lazr.restful.example.root.WebServiceConfiguration" />
-
-  <utility factory="lazr.restful.example.filemanager.FileManager" />
-
-  <class class="lazr.restful.example.filemanager.FileManager">
-      <allow interface='lazr.restful.example.interfaces.IFileManager' />
+      factory="lazr.restful.example.base.root.WebServiceConfiguration" />
+
+  <utility factory="lazr.restful.example.base.filemanager.FileManager" />
+
+  <class class="lazr.restful.example.base.filemanager.FileManager">
+      <allow interface='lazr.restful.example.base.interfaces.IFileManager' />
   </class>
 
-  <class class="lazr.restful.example.filemanager.ManagedFileResource">
+  <class class="lazr.restful.example.base.filemanager.ManagedFileResource">
       <allow interface='lazr.restful.interfaces.IHTTPResource' />
   </class>
 
-  <utility factory="lazr.restful.example.root.CookbookSet"
-           provides="lazr.restful.example.interfaces.ICookbookSet"/>
-  <utility factory="lazr.restful.example.root.DishSet"
-           provides="lazr.restful.example.interfaces.IDishSet"/>
-  <utility factory="lazr.restful.example.root.RecipeSet"
-           provides="lazr.restful.example.interfaces.IRecipeSet"/>
+  <utility factory="lazr.restful.example.base.root.CookbookSet"
+           provides="lazr.restful.example.base.interfaces.ICookbookSet"/>
+  <utility factory="lazr.restful.example.base.root.DishSet"
+           provides="lazr.restful.example.base.interfaces.IDishSet"/>
+  <utility factory="lazr.restful.example.base.root.RecipeSet"
+           provides="lazr.restful.example.base.interfaces.IRecipeSet"/>
 
   <utility
-    factory="lazr.restful.example.root.FeaturedCookbookLink"
-    provides="lazr.restful.example.interfaces.IFeaturedCookbookLink" />
+    factory="lazr.restful.example.base.root.FeaturedCookbookLink"
+    provides="lazr.restful.example.base.interfaces.IFeaturedCookbookLink" />
 
   <utility
     provides="lazr.restful.interfaces.IServiceRootResource"
-    factory="lazr.restful.example.root.CookbookServiceRootResource" />
+    factory="lazr.restful.example.base.root.CookbookServiceRootResource" />
 
-  <adapter factory="lazr.restful.example.root.SimpleByteStorage"
+  <adapter factory="lazr.restful.example.base.root.SimpleByteStorage"
            provides="lazr.restful.interfaces.IByteStorage"/>
-  <class class="lazr.restful.example.root.SimpleByteStorage">
-      <allow interface='lazr.restful.example.interfaces.IFileManagerBackedByteStorage' />
+  <class class="lazr.restful.example.base.root.SimpleByteStorage">
+      <allow interface='lazr.restful.example.base.interfaces.IFileManagerBackedByteStorage' />
   </class>
 
 
-  <adapter factory="lazr.restful.example.traversal.TraverseWithGet" />
+  <adapter factory="lazr.restful.example.base.traversal.TraverseWithGet" />
   <adapter
-    factory="lazr.restful.example.traversal.CookbookSetTraverse" />
+    factory="lazr.restful.example.base.traversal.CookbookSetTraverse" />
 
   <adapter
-      for="lazr.restful.example.root.CookbookWebServiceObject
+      for="lazr.restful.example.base.root.CookbookWebServiceObject
       lazr.restful.interfaces.IWebServiceLayer"
       provides="zope.traversing.browser.interfaces.IAbsoluteURL"
       factory="zope.traversing.browser.absoluteurl.AbsoluteURL"
       />
 
   <adapter
-      for="lazr.restful.example.root.CookbookWebServiceObject
+      for="lazr.restful.example.base.root.CookbookWebServiceObject
       lazr.restful.interfaces.IWebServiceLayer"
       provides="zope.traversing.browser.interfaces.IAbsoluteURL"
       factory="zope.traversing.browser.absoluteurl.AbsoluteURL"
@@ -102,9 +102,9 @@
   <adapter factory="lazr.restful.simple.RootResourceAbsoluteURL" />
 
   <subscriber
-   for="lazr.restful.example.interfaces.ICookbook
+   for="lazr.restful.example.base.interfaces.ICookbook
         lazr.lifecycle.interfaces.IObjectModifiedEvent"
-   handler="lazr.restful.example.subscribers.update_cookbook_revision_number" />
+   handler="lazr.restful.example.base.subscribers.update_cookbook_revision_number" />
 
 
 </configure>

=== renamed file 'src/lazr/restful/example/filemanager.py' => 'src/lazr/restful/example/base/filemanager.py'
--- src/lazr/restful/example/filemanager.py	2009-04-17 14:40:17 +0000
+++ src/lazr/restful/example/base/filemanager.py	2009-09-01 12:07:59 +0000
@@ -12,7 +12,7 @@
 from zope.interface import implements
 
 from lazr.restful import ReadOnlyResource
-from lazr.restful.example.interfaces import IFileManager
+from lazr.restful.example.base.interfaces import IFileManager
 from lazr.restful.utils import get_current_browser_request
 
 

=== renamed file 'src/lazr/restful/example/interfaces.py' => 'src/lazr/restful/example/base/interfaces.py'
=== renamed file 'src/lazr/restful/example/root.py' => 'src/lazr/restful/example/base/root.py'
--- src/lazr/restful/example/root.py	2009-08-27 15:50:55 +0000
+++ src/lazr/restful/example/base/root.py	2009-09-01 12:07:59 +0000
@@ -22,7 +22,7 @@
 from lazr.restful.interfaces import (
     IByteStorage, IEntry, IServiceRootResource, ITopLevelEntryLink,
     IWebServiceConfiguration)
-from lazr.restful.example.interfaces import (
+from lazr.restful.example.base.interfaces import (
     AlreadyNew, Cuisine, ICookbook, ICookbookSet, IDish, IDishSet,
     IFileManager, IRecipe, IRecipeSet, IHasGet, NameAlreadyTaken)
 from lazr.restful.simple import make_simple_configuration
@@ -369,7 +369,7 @@
     match_batch_size=50,
     service_version_uri_prefix='1.0',
     use_https=False,
-    view_permission='lazr.restful.example.View',
+    view_permission='lazr.restful.example.base.View',
     )
 
 WebServiceConfiguration = make_simple_configuration(

=== renamed file 'src/lazr/restful/example/security.py' => 'src/lazr/restful/example/base/security.py'
--- src/lazr/restful/example/security.py	2009-03-26 17:25:22 +0000
+++ src/lazr/restful/example/base/security.py	2009-09-01 12:07:59 +0000
@@ -9,7 +9,7 @@
 
 from zope.security.simplepolicies import PermissiveSecurityPolicy
 from zope.security.proxy import removeSecurityProxy
-from lazr.restful.example.interfaces import ICookbook, IRecipe
+from lazr.restful.example.base.interfaces import ICookbook, IRecipe
 
 
 class CookbookWebServiceSecurityPolicy(PermissiveSecurityPolicy):
@@ -19,12 +19,12 @@
         """Check against a simple policy.
 
         * Private recipes are always hidden.
-        * Any fields protected by lazr.restful.example.ViewPrivate are
+        * Any fields protected by lazr.restful.example.base.ViewPrivate are
           hidden.
         """
         if IRecipe.providedBy(object):
             return not removeSecurityProxy(object).private
-        elif permission == "lazr.restful.example.ViewPrivate":
+        elif permission == "lazr.restful.example.base.ViewPrivate":
             return False
         else:
             return True

=== renamed file 'src/lazr/restful/example/subscribers.py' => 'src/lazr/restful/example/base/subscribers.py'
--- src/lazr/restful/example/subscribers.py	2009-04-24 15:14:07 +0000
+++ src/lazr/restful/example/base/subscribers.py	2009-09-01 12:07:59 +0000
@@ -5,7 +5,7 @@
 __metaclass__ = type
 __all__ = ['update_cookbook_revision_number']
 
-from lazr.restful.example.interfaces import ICookbook
+from lazr.restful.example.base.interfaces import ICookbook
 
 def update_cookbook_revision_number(object, event):
     """Increment ICookbook.revision_number."""

=== renamed directory 'src/lazr/restful/example/tests' => 'src/lazr/restful/example/base/tests'
=== renamed file 'src/lazr/restful/example/traversal.py' => 'src/lazr/restful/example/base/traversal.py'
--- src/lazr/restful/example/traversal.py	2009-03-27 04:25:34 +0000
+++ src/lazr/restful/example/base/traversal.py	2009-09-01 12:07:59 +0000
@@ -14,7 +14,7 @@
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
 from zope.traversing.browser import absoluteURL
 
-from lazr.restful.example.interfaces import ICookbookSet, IHasGet
+from lazr.restful.example.base.interfaces import ICookbookSet, IHasGet
 from lazr.restful import RedirectResource
 
 

=== modified file 'src/lazr/restful/ftesting.zcml'
--- src/lazr/restful/ftesting.zcml	2009-08-04 19:27:13 +0000
+++ src/lazr/restful/ftesting.zcml	2009-09-01 12:07:59 +0000
@@ -4,9 +4,9 @@
     i18n_domain="lazr">
 
     <include package="lazr.restful" file="basic-site.zcml"/>
-    <include package="lazr.restful.example" file="configure.zcml" />
+    <include package="lazr.restful.example.base" file="configure.zcml" />
     <securityPolicy
-     component="lazr.restful.example.security.CookbookWebServiceSecurityPolicy"
+     component="lazr.restful.example.base.security.CookbookWebServiceSecurityPolicy"
      />
 
 </configure>