Merge lp:~thumper/launchpad/get-branch-by-date into lp:launchpad

[Tim Penhey]

Allow the getBranches API method to specify modified_since to limit the returned branches.

[Tim Penhey (thumper)]

Adds another option to the getBranches method of the IHasBranches interface.

This allows the user to specify the modified_since option to limit the branches returned to those whose date_last_modified is after the specified datetime.

[Michael Hudson-Doyle (mwhudson)]

Looks good to me.

review: Approve

=== modified file 'lib/lp/code/interfaces/hasbranches.py'
--- lib/lp/code/interfaces/hasbranches.py	2009-06-30 16:56:07 +0000
+++ lib/lp/code/interfaces/hasbranches.py	2010-02-08 01:44:13 +0000
@@ -11,7 +11,7 @@
 
 
 from zope.interface import Interface
-from zope.schema import Choice, List
+from zope.schema import Choice, Datetime, List
 
 from canonical.launchpad import _
 from lp.code.enums import BranchLifecycleStatus, BranchMergeProposalStatus
@@ -34,15 +34,21 @@
     @operation_parameters(
         status=List(
             title=_("A list of branch lifecycle statuses to filter by."),
-            value_type=Choice(vocabulary=BranchLifecycleStatus)))
+            value_type=Choice(vocabulary=BranchLifecycleStatus)),
+        modified_since=Datetime(
+            title=_('Limit the branches to those modified since this date.'),
+            required=False))
     @call_with(visible_by_user=REQUEST_USER)
     @operation_returns_collection_of(Interface) # Really IBranch.
     @export_read_operation()
-    def getBranches(status=None, visible_by_user=None):
+    def getBranches(status=None, visible_by_user=None,
+                    modified_since=None):
         """Returns all branches with the given lifecycle status.
 
         :param status: A list of statuses to filter with.
         :param visible_by_user: Normally the user who is asking.
+        :param modified_since: If set, filters the branches being returned
+            to those that have been modified since the specified date/time.
         :returns: A list of `IBranch`.
         """
 

=== modified file 'lib/lp/code/model/hasbranches.py'
--- lib/lp/code/model/hasbranches.py	2009-06-30 16:56:07 +0000
+++ lib/lp/code/model/hasbranches.py	2010-02-08 01:44:13 +0000
@@ -18,13 +18,16 @@
 class HasBranchesMixin:
     """A mixin implementation for `IHasBranches`."""
 
-    def getBranches(self, status=None, visible_by_user=None):
+    def getBranches(self, status=None, visible_by_user=None,
+                    modified_since=None):
         """See `IHasBranches`."""
         if status is None:
             status = DEFAULT_BRANCH_STATUS_IN_LISTING
 
         collection = IBranchCollection(self).visibleByUser(visible_by_user)
         collection = collection.withLifecycleStatus(*status)
+        if modified_since is not None:
+            collection = collection.modifiedSince(modified_since)
         return collection.getBranches()
 
 

=== modified file 'lib/lp/code/stories/webservice/xx-branch.txt'
--- lib/lp/code/stories/webservice/xx-branch.txt	2010-01-14 01:28:55 +0000
+++ lib/lp/code/stories/webservice/xx-branch.txt	2010-02-08 01:44:13 +0000
@@ -79,7 +79,8 @@
     >>> fooix = factory.makeProduct(name='fooix')
     >>> branch = factory.makeProductBranch(
     ...     branch_type=BranchType.HOSTED, owner=eric, product=fooix,
-    ...     name='trunk', title='The Fooix Trunk')
+    ...     name='trunk', title='The Fooix Trunk',
+    ...     date_created=datetime(2009, 1, 1, tzinfo=pytz.UTC))
     >>> feature_branch = factory.makeAnyBranch(
     ...     owner=eric, product=fooix, name='feature-branch',
     ...     lifecycle_status=BranchLifecycleStatus.EXPERIMENTAL)
@@ -108,8 +109,8 @@
     branch_type: u'Hosted'
     bzr_identity: u'lp://dev/~eric/fooix/trunk'
     control_format: None
-    date_created: ...
-    date_last_modified: ...
+    date_created: u'2009-01-01T00:00:00+00:00'
+    date_last_modified: u'2009-01-01T00:00:00+00:00'
     dependent_branches_collection_link: u'.../~eric/fooix/trunk/dependent_branches'
     description: None
     display_name: u'lp://dev/~eric/fooix/trunk'
@@ -181,10 +182,10 @@
 
     >>> def print_branch(branch):
     ...     print branch['unique_name'] + ' - ' + branch['lifecycle_status']
-    >>> def print_branches(webservice, url, status=None):
+    >>> def print_branches(webservice, url, status=None, modified_since=None):
     ...     branches = webservice.named_get(
     ...         url, 'getBranches',
-    ...         status=status).jsonBody()
+    ...         status=status, modified_since=modified_since).jsonBody()
     ...     for branch in branches['entries']:
     ...         print_branch(branch)
 
@@ -192,6 +193,13 @@
     ~eric/fooix/trunk - Development
     ~eric/fooix/feature-branch - Experimental
 
+The branches can be limited to those that have been modified since a specified
+time.
+
+    >>> print_branches(webservice, '/fooix',
+    ...                modified_since=u'2010-01-01T00:00:00+00:00')
+    ~eric/fooix/feature-branch - Experimental
+
 A list of lifecycle statuses can be provided for filtering.
 
     >>> print_branches(webservice, '/fooix', ('Experimental'))