Merge lp:~julian-edwards/launchpad/api-commercial-ppas-bug-597211 into lp:launchpad/db-devel

[Julian Edwards]

= Summary =
Add IDistribution.getCommercialPPAs() and export it on the webservice

== Implementation details ==
Trivial change!

== Tests ==
bin/test -cvvt archive-commercial.txt -t xx-archive-commercial.txt

== Demo and Q/A ==
Will set up a commercial PPA on staging and query it with the webservice.

= Launchpad lint =

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

Linting changed files:
  lib/lp/soyuz/interfaces/archive.py
  lib/lp/soyuz/doc/archive-commercial.txt
  lib/lp/registry/interfaces/distribution.py
  lib/lp/soyuz/model/archive.py
  lib/lp/soyuz/stories/webservice/xx-archive-commercial.txt
  lib/canonical/launchpad/interfaces/_schema_circular_imports.py
  lib/lp/registry/model/distribution.py

== Pylint notices ==

<deletetia> - madness ensues with lint checking on interfaces with exports

[Jeroen T. Vermeulen (jtv)]

Nice branch. Just a few remarks as per IRC:

 * "Lets" in the doctest is a typo for "Let's."

 * Starting doctest paragraphs with "Let's" usually indicates you're passing off setup as documentation. You can just say "we have a" or "foo is a."

 * Use IStore instead of IStoreSelector... it saves typing.

That's it. Approving.

review: Approve

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-06-21 19:29:34 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-06-30 13:55:45 +0000
@@ -301,6 +301,8 @@
     IDistribution, 'getSourcePackage', IDistributionSourcePackage)
 patch_collection_return_type(
     IDistribution, 'searchSourcePackages', IDistributionSourcePackage)
+patch_collection_return_type(
+    IDistribution, 'getCommercialPPAs', IArchive)
 patch_reference_property(
     IDistribution, 'main_archive', IArchive)
 IDistribution['all_distro_archives'].value_type.schema = IArchive

=== modified file 'lib/lp/registry/interfaces/distribution.py'
--- lib/lp/registry/interfaces/distribution.py	2010-06-11 10:11:28 +0000
+++ lib/lp/registry/interfaces/distribution.py	2010-06-30 13:55:45 +0000
@@ -516,6 +516,18 @@
     def getAllPPAs():
         """Return all PPAs for this distribution."""
 
+    # Really returns IArchive, see
+    # _schema_circular_imports.py.
+    @operation_returns_collection_of(Interface)
+    @export_read_operation()
+    def getCommercialPPAs():
+        """Return all commercial PPAs.
+
+        Commercial PPAs are private, but explicitly flagged up as commercial
+        so that they are discoverable by people who wish to buy items
+        from them.
+        """
+
     def searchPPAs(text=None, show_inactive=False):
         """Return all PPAs matching the given text in this distribution.
 

=== modified file 'lib/lp/registry/model/distribution.py'
--- lib/lp/registry/model/distribution.py	2010-06-21 21:33:53 +0000
+++ lib/lp/registry/model/distribution.py	2010-06-30 13:55:45 +0000
@@ -1259,6 +1259,12 @@
             distribution=self,
             purpose=ArchivePurpose.PPA).order_by('id')
 
+    def getCommercialPPAs(self):
+        """See `IDistribution`."""
+        # If we ever see non-Ubuntu PPAs, this will return more than
+        # just the PPAs for the Ubuntu context.
+        return getUtility(IArchiveSet).getCommercialPPAs()
+
     def searchPPAs(self, text=None, show_inactive=False, user=None):
         """See `IDistribution`."""
         clauses = ["""

=== added file 'lib/lp/soyuz/doc/archive-commercial.txt'
--- lib/lp/soyuz/doc/archive-commercial.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/doc/archive-commercial.txt	2010-06-30 13:55:45 +0000
@@ -0,0 +1,56 @@
+===============
+Commercial PPAs
+===============
+
+Commercial PPAs are to all intents and purposes identical to private PPAs.
+They contain a 'commercial' flag which indicates that the PPA is actively
+selling software and should be more discoverable.
+
+We have a private PPA for demonstration purposes:
+
+    >>> ppa = factory.makeArchive(private=True, name="pppa")
+
+
+Discovering Commercial PPAs
+---------------------------
+
+IArchive.getCommercialPPAs() retrieves the subset of all private PPAs that are
+marked for commercial usage.
+
+    >>> from lp.soyuz.interfaces.archive import IArchiveSet
+    >>> archive_set = getUtility(IArchiveSet)
+    >>> for commercial_ppa in archive_set.getCommercialPPAs():
+    ...     print commercial_ppa.name
+
+There are none yet - if we mark "ppa" as commercial it will be
+returned:
+
+    >>> # Setting 'commercial' is restricted to admins but we don't want to
+    >>> # worry about that here. See lib/lp/soyuz/tests/test_archive.py
+    >>> from zope.security.proxy import removeSecurityProxy
+    >>> removeSecurityProxy(ppa).commercial = True
+    >>> for commercial_ppa in archive_set.getCommercialPPAs():
+    ...     print commercial_ppa.name
+    pppa
+
+
+Security
+--------
+
+Anyone is allowed to retrieve the list of commercial PPAs.  Normal security
+restrictions apply to individual PPA access though.
+
+    >>> login(ANONYMOUS)
+    >>> ppas = archive_set.getCommercialPPAs()
+
+'name is a public attribute:
+
+    >>> print ppas[0].name
+    pppa
+
+'description' is not, however.
+
+    >>> ppas[0].description
+    Traceback (most recent call last):
+    ...
+    Unauthorized:...

=== modified file 'lib/lp/soyuz/interfaces/archive.py'
--- lib/lp/soyuz/interfaces/archive.py	2010-06-25 15:03:10 +0000
+++ lib/lp/soyuz/interfaces/archive.py	2010-06-30 13:55:45 +0000
@@ -1557,6 +1557,14 @@
     def getPrivatePPAs():
         """Return a result set containing all private PPAs."""
 
+    def getCommercialPPAs():
+        """Return a result set containing all commercial PPAs.
+
+        Commercial PPAs are private, but explicitly flagged up as commercial
+        so that they are discoverable by people who wish to buy items
+        from them.
+        """
+
     def getPublicationsInArchives(source_package_name, archive_list,
                                   distribution):
         """Return a result set of publishing records for the source package.

=== modified file 'lib/lp/soyuz/model/archive.py'
--- lib/lp/soyuz/model/archive.py	2010-06-29 09:37:26 +0000
+++ lib/lp/soyuz/model/archive.py	2010-06-30 13:55:45 +0000
@@ -95,6 +95,8 @@
 from lp.soyuz.model.binarypackagerelease import BinaryPackageRelease
 from lp.registry.interfaces.sourcepackagename import ISourcePackageNameSet
 from lp.soyuz.scripts.packagecopier import do_copy
+
+from canonical.launchpad.interfaces.lpstorm import IStore
 from canonical.launchpad.webapp.interfaces import (
     IStoreSelector, MAIN_STORE, DEFAULT_FLAVOR)
 from canonical.launchpad.webapp.url import urlappend
@@ -1927,6 +1929,14 @@
             Archive.private == True,
             Archive.purpose == ArchivePurpose.PPA)
 
+    def getCommercialPPAs(self):
+        """See `IArchiveSet`."""
+        store = IStore(Archive)
+        return store.find(
+            Archive,
+            Archive.commercial == True,
+            Archive.purpose == ArchivePurpose.PPA)
+
     def getArchivesForDistribution(self, distribution, name=None,
                                    purposes=None, user=None,
                                    exclude_disabled=True):

=== added file 'lib/lp/soyuz/stories/webservice/xx-archive-commercial.txt'
--- lib/lp/soyuz/stories/webservice/xx-archive-commercial.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/soyuz/stories/webservice/xx-archive-commercial.txt	2010-06-30 13:55:45 +0000
@@ -0,0 +1,28 @@
+=============================================
+Using the webservice with commercial archives
+=============================================
+
+(See also soyuz/stories/webservice/xx-archive.txt and
+soyuz/doc/archive-commercial.txt)
+
+Start by making a commercial PPA that we can fetch via the webservice:
+
+    >>> login("[e-mail]")
+    >>> ppa = factory.makeArchive(private=True, name="cpppa")
+    >>> from zope.security.proxy import removeSecurityProxy
+    >>> removeSecurityProxy(ppa).commercial = True
+    >>> import transaction
+    >>> transaction.commit()
+    >>> logout()
+
+Commercial archives can be found with a custom method 'getCommercialPPAs'
+that lives on the distribution object.
+
+Using webservice directly:
+
+    >>> ubuntu = webservice.get("/ubuntu").jsonBody()
+    >>> cppas = webservice.named_get(
+    ...     ubuntu['self_link'], 'getCommercialPPAs').jsonBody()
+    >>> for entry in cppas['entries']:
+    ...     print entry['name']
+    cpppa