Merge lp:~sinzui/launchpad/api-bug-tracker-0 into lp:launchpad

[Curtis Hovey]

This is my branch to export bugtrackerset over the api.

    lp:~sinzui/launchpad/api-bug-tracker-0
    Diff size: 129
    Launchpad bug: https://bugs.launchpad.net/bugs/id
    Test command: ./bin/test -vv \
        -t webservice/xx-bug-tracker
    Pre-implementation: Edwin
    Target release: 10.03

Export bugtrackerset over the api
---------------------------------

Export the bugtrackerset of the api so that ensureBugTracker() can be
used in API operations. We want a formoverlay to register an new bugtracker
when user discovers that the bug tracker he wants to set to the project is
not registered.

Rules
-----

    * Export IBugTrackerSet and ensureBugTracker

QA
--

    * Verify that you can get the IBugTrackerSet via anonymous api
    * Verify that you can use ensureBugTracker() to register a tracker
      logged in.

Lint
----

Linting changed files:
  lib/canonical/launchpad/security.py
  lib/lp/bugs/interfaces/bugtracker.py
  lib/lp/bugs/stories/webservice/xx-bug-tracker.txt

Test
----

    * lib/lp/bugs/stories/webservice/xx-bug-tracker.txt
      * Added tests to verify that IBugTrakerSet is exported for anonymous
        Use. Added a test to verify that ensureBugTracker can create a
        new bugtracker.

Implementation
--------------

    * lib/canonical/launchpad/security.py
      * Added a security checker for IBugTracker to ensure anonymous users
        can see them.
    * lib/lp/bugs/interfaces/bugtracker.py
      * Exported IbugTrackerSet with search and ensureBugTracker methods.

[Edwin Grubbs (edwin-grubbs)]

Hi Curtis,

This branch looks good. Just one comment below.

merge-conditional

-Edwin

>=== added file 'lib/lp/bugs/stories/webservice/xx-bug-tracker.txt'
>--- lib/lp/bugs/stories/webservice/xx-bug-tracker.txt>*1970-01-01 00:00:00 +0000
>+++ lib/lp/bugs/stories/webservice/xx-bug-tracker.txt>*2010-03-10 16:34:01 +0000
>@@ -0,0 +1,62 @@
>+Bug tracker
>+===========
>+
>+The bug tracker set is exported as a collection at /bugs/bugtrackers that
>+any user can access.
>+
>+ >>> from lazr.restful.testing.webservice import (
>+ ... pprint_collection, pprint_entry)
>+
>+ >>> bug_tracker_collection = anon_webservice.get(
>+ ... '/bugs/bugtrackers').jsonBody()
>+ >>> pprint_collection(bug_tracker_collection)
>+ next_collection_link:
>+ u'http://api.launchpad.dev/beta/bugs/bugtrackers?ws.start=5&ws.size=5'

Normally, "api.launchpad.dev/beta" is replaced with "..." so that the test doesn't break when the default version changes.
Please replace all the other instances also.

review: Approve (code)

=== modified file 'lib/canonical/launchpad/security.py'
--- lib/canonical/launchpad/security.py	2010-03-10 00:46:20 +0000
+++ lib/canonical/launchpad/security.py	2010-03-10 19:03:28 +0000
@@ -1297,6 +1297,11 @@
              user.inTeam(translation_group.owner)))
 
 
+class ViewBugTracker(AnonymousAuthorization):
+    """Anyone can view a bug tracker."""
+    usedfor = IBugTracker
+
+
 class EditBugTracker(AuthorizationBase):
     permission = 'launchpad.Edit'
     usedfor = IBugTracker

=== modified file 'lib/lp/bugs/interfaces/bugtracker.py'
--- lib/lp/bugs/interfaces/bugtracker.py	2009-12-25 16:36:53 +0000
+++ lib/lp/bugs/interfaces/bugtracker.py	2010-03-10 19:03:28 +0000
@@ -32,7 +32,10 @@
 
 from lazr.lifecycle.snapshot import doNotSnapshot
 from lazr.restful.declarations import (
-    export_as_webservice_entry, exported)
+    call_with, collection_default_content, export_as_webservice_collection,
+    export_as_webservice_entry, export_factory_operation,
+    export_read_operation, exported, operation_parameters,
+    operation_returns_entry, rename_parameters_as, REQUEST_USER)
 from lazr.restful.fields import CollectionField, Reference
 
 
@@ -325,6 +328,7 @@
     Each BugTracker is a distinct instance of a bug tracking tool. For
     example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.
     """
+    export_as_webservice_collection(IBugTracker)
 
     title = Attribute('Title')
 
@@ -336,6 +340,10 @@
         If no tracker with the given id exists, return default.
         """
 
+    @operation_parameters(
+        name=TextLine(title=u"The bug tracker name", required=True))
+    @operation_returns_entry(IBugTracker)
+    @export_read_operation()
     def getByName(name, default=None):
         """Get a BugTracker by its name.
 
@@ -352,9 +360,23 @@
     def __iter__():
         """Iterate through BugTrackers."""
 
+    @rename_parameters_as(baseurl='base_url')
+    @operation_parameters(
+        baseurl=TextLine(
+            title=u"The base URL of the bug tracker", required=True))
+    @operation_returns_entry(IBugTracker)
+    @export_read_operation()
     def queryByBaseURL(baseurl):
         """Return one or None BugTracker's by baseurl"""
 
+    @call_with(owner=REQUEST_USER)
+    @rename_parameters_as(
+        baseurl='base_url', bugtrackertype='bug_tracker_type',
+        contactdetails='contat_details')
+    @export_factory_operation(
+        IBugTracker,
+        ['baseurl', 'bugtrackertype', 'title', 'summary',
+         'contactdetails', 'name'])
     def ensureBugTracker(baseurl, owner, bugtrackertype,
         title=None, summary=None, contactdetails=None, name=None):
         """Make sure that there is a bugtracker for the given base url.
@@ -362,6 +384,7 @@
         If not, create one using the given attributes.
         """
 
+    @collection_default_content()
     def search():
         """Search all the IBugTrackers in the system."""
 

=== added file 'lib/lp/bugs/stories/webservice/xx-bug-tracker.txt'
--- lib/lp/bugs/stories/webservice/xx-bug-tracker.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/bugs/stories/webservice/xx-bug-tracker.txt	2010-03-10 19:03:28 +0000
@@ -0,0 +1,77 @@
+Bug tracker
+===========
+
+The bug tracker set is exported as a collection at /bugs/bugtrackers that
+any user can access.
+
+    >>> from lazr.restful.testing.webservice import (
+    ...     pprint_collection, pprint_entry)
+
+    >>> bug_tracker_collection = anon_webservice.get(
+    ...     '/bugs/bugtrackers').jsonBody()
+    >>> pprint_collection(bug_tracker_collection)
+    next_collection_link: u'http://.../bugs/bugtrackers?ws.start=5&ws.size=5'
+    resource_type_link: u'http://.../#bug_trackers'
+    start: 0
+    total_size: 8
+    ---
+    active: True
+    base_url: u'https://bugzilla.mozilla.org/'
+    base_url_aliases: []
+    bug_tracker_type: u'Bugzilla'
+    contact_details: u'Carrier pigeon only'
+    has_lp_plugin: None
+    name: u'mozilla.org'
+    registrant_link: u'http://.../~name12'
+    resource_type_link: u'http://.../#bug_tracker'
+    self_link: u'http://.../bugs/bugtrackers/mozilla.org'
+    summary: u'The Mozilla.org bug tracker is the grand-daddy of ...'
+    title: u'The Mozilla.org Bug Tracker'
+    watches_collection_link: u'http:.../bugs/bugtrackers/mozilla.org/watches'
+    --- ...
+
+A bug tracker can be retrieved using the the bug tracker collection's
+getByName named operation.
+
+    >>> bug_tracker = anon_webservice.named_get(
+    ...     '/bugs/bugtrackers', 'getByName',
+    ...     name='gnome-bugzilla').jsonBody()
+    >>> print bug_tracker['name']
+    gnome-bugzilla
+
+A bug tracker can be retrieved using the the bug tracker collection's
+queryByBaseURL named operation.
+
+    >>> bug_tracker = anon_webservice.named_get(
+    ...     '/bugs/bugtrackers', 'queryByBaseURL',
+    ...     base_url='https://bugzilla.mozilla.org/').jsonBody()
+    >>> print bug_tracker['name']
+    mozilla.org
+
+The bug tracker set provides the ensureBugTracker named operation that a
+logged in user can call to create a bug tracker.
+
+    >>> params = dict(
+    ...     base_url='http://wombat.zz/', bug_tracker_type='Bugzilla',
+    ...     name='wombat', title='Wombat title', summary='Wombat summary',
+    ...     contact_details='[e-mail]')
+    >>> print webservice.named_post(
+    ...     '/bugs/bugtrackers', 'ensureBugTracker', **params)
+    HTTP/1.1 201 Created ...
+    Location: http://.../bugs/bugtrackers/wombat ...
+
+    >>> bug_tracker = webservice.get('/bugs/bugtrackers/wombat').jsonBody()
+    >>> pprint_entry(bug_tracker)
+    active: True
+    base_url: u'http://wombat.zz/'
+    base_url_aliases: []
+    bug_tracker_type: u'Bugzilla'
+    contact_details: None
+    has_lp_plugin: False
+    name: u'wombat'
+    registrant_link: u'http://.../~salgado'
+    resource_type_link: u'http://.../#bug_tracker'
+    self_link: u'http://.../bugs/bugtrackers/wombat'
+    summary: u'Wombat summary'
+    title: u'Wombat title'
+    watches_collection_link: u'http://.../bugs/bugtrackers/wombat/watches'