Merge lp:~leonardr/launchpad/add-mutators into lp:launchpad/db-devel

[Leonard Richardson]

By reading https://bugs.edge.launchpad.net/lazr.restful/+bug/336866/comments/46, I got the idea that two named operations of IBug should be made into mutators. I decided to do this quickly so as to avoid possible complications when we have multiple active versions of the web service.

However, it turns out those two named operations are already mutators, and are no longer listed on, eg., https://staging.launchpad.net/+apidoc/devel.html. But, I did discover that IBranch.setPrivate should be the mutator for IBranch.private, but isn't. This branch makes it a mutator and adds a test to show that the behavior of the named operation (present as a named operation in beta, not present in devel) is correct.

(This test is kind of stupid and I don't intend to do it every time I make an existing named operator a mutator, since the general behavior is well tested, but I figured it was good for the first time.)

[Brad Crittenden (bac)]

review: Approve (code)

=== modified file 'lib/lp/code/interfaces/branch.py'
--- lib/lp/code/interfaces/branch.py	2010-03-18 06:03:11 +0000
+++ lib/lp/code/interfaces/branch.py	2010-03-23 18:36:40 +0000
@@ -47,11 +47,11 @@
 
 from lazr.restful.fields import CollectionField, Reference, ReferenceChoice
 from lazr.restful.declarations import (
-    call_with, collection_default_content, export_as_webservice_collection,
-    export_as_webservice_entry, export_factory_operation,
+    REQUEST_USER, call_with, collection_default_content,
+    export_as_webservice_collection, export_as_webservice_entry,
+    export_destructor_operation, export_factory_operation,
     export_operation_as, export_read_operation, export_write_operation,
-    export_destructor_operation, exported, operation_parameters,
-    operation_returns_entry, REQUEST_USER)
+    exported, mutator_for, operation_parameters, operation_returns_entry)
 
 from canonical.config import config
 
@@ -406,6 +406,7 @@
             description=_(
                 "Make this branch visible only to its subscribers.")))
 
+    @mutator_for(private)
     @call_with(user=REQUEST_USER)
     @operation_parameters(
         private=Bool(title=_("Keep branch confidential")))

=== modified file 'lib/lp/code/stories/webservice/xx-branch.txt'
--- lib/lp/code/stories/webservice/xx-branch.txt	2010-03-17 01:18:32 +0000
+++ lib/lp/code/stories/webservice/xx-branch.txt	2010-03-23 18:36:40 +0000
@@ -244,6 +244,31 @@
     >>> print_branches(webservice, '/widgets', ('Experimental'))
     ~eric/fooix/feature-branch - Experimental
 
+Differences between versions
+============================
+
+In version 'beta', a branch can be made private or public by invoking
+the named operation 'setPrivate'.
+
+    >>> branch = webservice.get(branch_url).jsonBody()
+    >>> print branch['private']
+    False
+
+    >>> response = webservice.named_post(
+    ...     branch_url, 'setPrivate', api_version='beta', private=True)
+    >>> branch = webservice.get(branch_url).jsonBody()
+    >>> print branch['private']
+    True
+
+In subsequent versions, 'setPrivate' is gone; you have to set the
+'private' field directly.
+
+    >>> print webservice.named_post(
+    ...     branch_url, 'setPrivate', api_version='devel', private=True)
+    HTTP/1.1 400 Bad Request
+    ...
+    No such operation: setPrivate
+
 Removing branches
 =================