Merge lp:~bac/launchpad/bug-514447-anon-api into lp:launchpad

[Brad Crittenden]

Add security adapter so that distro.series can be seen via anonymous API access.

[Brad Crittenden (bac)]

= Summary =

When anonymous API access was enabled the series data for distributions was returning
an empty list. The problem was reported as bug 514447 and was discovered to be the
same root cause as bug 515761.

== Proposed fix ==

Even though the distribution interface IDistributionPublic has no access restrictions
in the registry configure.zcml the series data was not authorized for launchpad.View.
 Creating a security adapter for IDistroSeries was required.

== Pre-implementation notes ==

Talks on IRC with Leonard and Jamal, who was fixing bug 515761.

== Implementation details ==

Create the new security adapter and test.

Also you'll see some drive-by cleanups including some annoying trailing whitespace
deletions (thanks emacs!).

Also you'll note an XXX comment in the code that I'll remove before landing. Jamal
created a new security adapter for anonymous access that I wanted to take advantage
of. Unfortunately his branch was delayed in landing (I am running it through ec2 at
the moment). When his branch lands I'll merge it in and delete the
'AnonymousAuthorization' class I've temporarily included in this branch.

== Tests ==

bin/test -vvm lp.registry -t xx-distroseries.txt

== Demo and Q/A ==

Use launchpadlib to do:

> ubuntu = lp.distributions['ubuntu']
> list(ubuntu.series)

If you run against edge you'll see all of the usual suspects. If you run against
launchpad.dev you'll see the four in the test data. You should definitely not get an
empty list.

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/canonical/launchpad/security.py
  lib/lp/registry/configure.zcml
  lib/lp/registry/interfaces/sourcepackage.py
  lib/lp/registry/interfaces/distribution.py
  lib/lp/registry/stories/webservice/xx-distroseries.txt

== Pylint notices ==

lib/lp/registry/interfaces/sourcepackage.py
    21: [F0401] Unable to import 'lazr.enum' (No module named enum)
    27: [F0401] Unable to import 'lazr.restful.fields' (No module named restful)
    28: [F0401] Unable to import 'lazr.restful.declarations' (No module named restful)
    187: [C0322, ISourcePackage.getBranch] Operator not preceded by a space
    vocabulary=DBEnumeratedType))
    ^

    @operation_returns_entry(Interface)
    @export_read_operation()
    def getBranch(pocket):
    205: [C0322, ISourcePackage.setBranch] Operator not preceded by a space
    vocabulary=DBEnumeratedType),
    ^
    branch=Reference(Interface, title=_("Branch"), required=False))
    @call_with(registrant=REQUEST_USER)
    @export_write_operation()
    def setBranch(pocket, branch, registrant):

lib/lp/registry/interfaces/distribution.py
    224: [C0301] Line too long (79/78)
    26: [F0401] Unable to import 'lazr.restful.fields' (No module named restful)
    27: [F0401] Unable to import 'lazr.restful.interface' (No module named restful)
    28: [F0401] Unable to import 'lazr.restful.declarations' (No module named restful)

[Aaron Bentley (abentley)]

review: Approve

=== modified file 'lib/canonical/launchpad/security.py'
--- lib/canonical/launchpad/security.py	2010-02-04 23:18:16 +0000
+++ lib/canonical/launchpad/security.py	2010-02-08 20:33:22 +0000
@@ -813,6 +813,11 @@
                 user.in_admin)
 
 
+class ViewDistroSeries(AnonymousAuthorization):
+    """Anyone can view a DistroSeries."""
+    usedfor = IDistroSeries
+
+
 class SeriesDrivers(AuthorizationBase):
     """Drivers can approve or decline features and target bugs.
 

=== modified file 'lib/lp/registry/configure.zcml'
--- lib/lp/registry/configure.zcml	2010-01-27 19:06:49 +0000
+++ lib/lp/registry/configure.zcml	2010-02-08 20:33:22 +0000
@@ -1375,7 +1375,13 @@
             interface="lp.registry.interfaces.distribution.IDistributionDriverRestricted"/>
         <require
             permission="launchpad.Edit"
-            set_attributes="displayname title summary description                                                                                         translation_focus translationgroup translationpermission                                                                                         driver members owner security_contact mirror_admin                                                                                         homepage_content icon logo mugshot enable_bug_expiration                                                                                         bug_reporting_guidelines official_blueprints                                                                                         official_malone official_rosetta official_answers                                                                                         official_bug_tags"/>
+            set_attributes="displayname title summary description
+            		    translation_focus translationgroup translationpermission
+                            driver members owner security_contact mirror_admin
+                            homepage_content icon logo mugshot enable_bug_expiration
+                            bug_reporting_guidelines official_blueprints
+                            official_malone official_rosetta official_answers
+                            official_bug_tags"/>
         <require
             permission="launchpad.TranslationsAdmin"
             set_attributes="language_pack_admin"/>
@@ -1701,7 +1707,7 @@
     </securedutility>
 
     <!-- StructuralSubscription -->
-    
+
     <class
         class="lp.registry.model.structuralsubscription.StructuralSubscription">
         <allow

=== modified file 'lib/lp/registry/interfaces/distribution.py'
--- lib/lp/registry/interfaces/distribution.py	2010-02-01 19:48:57 +0000
+++ lib/lp/registry/interfaces/distribution.py	2010-02-08 20:33:22 +0000
@@ -166,8 +166,7 @@
             description=_("The distro's owner."), required=True))
     date_created = exported(
         Datetime(title=_('Date created'),
-                 description=_("The date this distribution was registered.")),
-        exported_as='date_created')
+                 description=_("The date this distribution was registered.")))
     driver = exported(
         PublicPersonChoice(
             title=_("Driver"),
@@ -210,9 +209,8 @@
     series = exported(
         CollectionField(
             title=_("DistroSeries inside this Distribution"),
-            # Really IDistroSeries, see below.
-            value_type=Reference(schema=Interface)),
-        exported_as="series")
+            # Really IDistroSeries, see _schema_circular_imports.py.
+            value_type=Reference(schema=Interface)))
     architectures = List(
         title=_("DistroArchSeries inside this Distribution"))
     bugCounter = Attribute("The distro bug counter")
@@ -223,7 +221,7 @@
     # properties
     currentseries = exported(
         Reference(
-            Interface, # Really IDistroSeries, see below
+            Interface, # Really IDistroSeries, see _schema_circular_imports.py.
             title=_("Current series"),
             description=_(
                 "The current development series of this distribution. "
@@ -253,14 +251,15 @@
     main_archive = exported(
         Reference(
             title=_('Distribution Main Archive.'), readonly=True,
-            schema=Interface)) # Really IArchive, circular import fix below.
+            # Really IArchive, see _schema_circular_imports.py.
+            schema=Interface))
 
     all_distro_archives = exported(
         CollectionField(
             title=_("A sequence of the distribution's non-PPA Archives."),
             readonly=True, required=False,
             value_type=Reference(schema=Interface)),
-                # Really Iarchive, circular import fix below.
+                # Really IArchive, see _schema_circular_imports.py.
         exported_as='archives')
 
     all_distro_archive_ids = Attribute(
@@ -291,7 +290,7 @@
     def __iter__():
         """Iterate over the series for this distribution."""
 
-    # Really IDistroSeries, see below
+    # Really IDistroSeries, see _schema_circular_imports.py.
     @operation_returns_collection_of(Interface)
     @export_operation_as(name="getDevelopmentSeries")
     @export_read_operation()
@@ -300,7 +299,8 @@
 
     @operation_parameters(
         name_or_version=TextLine(title=_("Name or version"), required=True))
-    @operation_returns_entry(Interface) # Really IDistroSeries, see below
+    # Really IDistroSeries, see _schema_circular_imports.py.
+    @operation_returns_entry(Interface)
     @export_read_operation()
     def getSeries(name_or_version):
         """Return the series with the name or version given.
@@ -330,7 +330,8 @@
 
     @operation_parameters(
         name=TextLine(title=_("Package name"), required=True))
-    # Really returns IDistributionSourcePackage, see below.
+    # Really returns IDistributionSourcePackage, see
+    # _schema_circular_imports.py.
     @operation_returns_entry(Interface)
     @export_read_operation()
     def getSourcePackage(name):
@@ -402,12 +403,13 @@
     @operation_parameters(
         text=TextLine(title=_("Source package name substring match"),
                       required=True))
-    # Really returns IDistributionSourcePackage, see below.
+    # Really returns IDistributionSourcePackage, see
+    # _schema_circular_imports.py.
     @operation_returns_collection_of(Interface)
     @export_read_operation()
     def searchSourcePackages(text):
         """Search for source packages that correspond to the given text.
- 
+
         This method just decorates the result of searchSourcePackageCaches()
         to return DistributionSourcePackages.
         """
@@ -597,7 +599,3 @@
         Exception.__init__(
             self, "Partner archive for distro '%s' not found"
             % (distribution.name,))
-
-
-# Monkey patching to fix circular imports done in
-# _schema_circular_imports.py

=== modified file 'lib/lp/registry/interfaces/sourcepackage.py'
--- lib/lp/registry/interfaces/sourcepackage.py	2009-11-24 23:12:23 +0000
+++ lib/lp/registry/interfaces/sourcepackage.py	2010-02-08 20:33:22 +0000
@@ -94,7 +94,7 @@
             vocabulary="ProductSeries",
             schema=Interface,
             description=_(
-                "The registered project series that this source package. "
+                "The registered project series that this source package "
                 "is based on. This series may be the same as the one that "
                 "earlier versions of this source packages were based on.")))
 

=== modified file 'lib/lp/registry/stories/webservice/xx-distroseries.txt'
--- lib/lp/registry/stories/webservice/xx-distroseries.txt	2009-09-09 13:19:41 +0000
+++ lib/lp/registry/stories/webservice/xx-distroseries.txt	2010-02-08 20:33:22 +0000
@@ -18,6 +18,17 @@
     http://.../ubuntu/hoary
     http://.../ubuntu/warty
 
+The series are available to the anonymous API user too:
+
+    >>> all_series = anon_webservice.get(
+    ...     ubuntu['series_collection_link']).jsonBody()
+    >>> for entry in all_series['entries']:
+    ...     print entry['self_link']
+    http://.../ubuntu/breezy-autotest
+    http://.../ubuntu/grumpy
+    http://.../ubuntu/hoary
+    http://.../ubuntu/warty
+
 Via the current series:
 
     >>> current_series = webservice.get(
@@ -84,4 +95,3 @@
     ...
     Location: http://.../ubuntu/+milestone/alpha1
     ...
-