Merge lp:~wgrant/launchpad/export-basic-binary-download-stats into lp:launchpad/db-devel

[William Grant]

Allow users to extract basic per-package PPA download counts through the webservice.

This simple branch adds and exports IBinaryPackagePublishingHistory.getDownloadCount(), allowing users to retrieve a simple download total for each package in a PPA. More detailed methods are coming later.

[Paul Hummer (rockstar)]

160 +We can also retrieve the total download count for the binary in this archive.
161 +
162 + >>> webservice.named_get(
163 + ... pubs['entries'][0]['self_link'], 'getDownloadCount').jsonBody()
164 + 0
165 +

I'd feel a bit happier if we also had a case where there was a result to getDownloadCount that resulted in something other than 0. In fact, if it were a either/or, I'd prefer the non-zero test, but since you've already got this one, adding another for non-zero would be preferred.

review: Needs Fixing (code)

[Michael Hudson-Doyle (mwhudson)]

I'll send this to ec2.

review: Approve

=== modified file 'lib/lp/soyuz/doc/archive.txt'
--- lib/lp/soyuz/doc/archive.txt	2010-03-15 23:01:48 +0000
+++ lib/lp/soyuz/doc/archive.txt	2010-03-18 22:52:32 +0000
@@ -2771,3 +2771,47 @@
 
     >>> ppa_with_key.signing_key == cprov.archive.signing_key
     True
+
+
+== Download counts ==
+
+Counts of downloads per binary package release, day and country are kept
+up to date by a log-processing script. Archives have a method to get the
+total number of downloads for a particular binary package release.
+
+    >>> login('[e-mail]')
+    >>> binaries = test_publisher.getPubBinaries(
+    ...     architecturespecific=True)
+    >>> archive = binaries[0].archive
+    >>> binary0, binary1 = (b.binarypackagerelease for b in binaries)
+
+The new packages have no downloads yet.
+
+    >>> print archive.getPackageDownloadTotal(binary0)
+    0
+    >>> print archive.getPackageDownloadTotal(binary1)
+    0
+
+We will fake some package downloads.
+
+    >>> from datetime import date
+    >>> from lp.services.worlddata.interfaces.country import ICountrySet
+    >>> australia = getUtility(ICountrySet)['AU']
+    >>> uk = getUtility(ICountrySet)['GB']
+
+    >>> archive.updatePackageDownloadCount(
+    ...     binary0, date(2010, 2, 21), None, 10)
+    >>> archive.updatePackageDownloadCount(
+    ...     binary0, date(2010, 2, 22), uk, 5)
+    >>> archive.updatePackageDownloadCount(
+    ...     binary0, date(2010, 2, 22), australia, 4)
+
+    >>> archive.updatePackageDownloadCount(
+    ...     binary1, date(2010, 2, 21), australia, 2)
+    >>> archive.updatePackageDownloadCount(
+    ...     binary1, date(2010, 2, 21), uk, 1)
+
+    >>> print archive.getPackageDownloadTotal(binary0)
+    19
+    >>> print archive.getPackageDownloadTotal(binary1)
+    3

=== modified file 'lib/lp/soyuz/doc/publishing.txt'
--- lib/lp/soyuz/doc/publishing.txt	2010-03-15 17:12:18 +0000
+++ lib/lp/soyuz/doc/publishing.txt	2010-03-18 22:52:32 +0000
@@ -949,6 +949,19 @@
     >>> [pub_file.archive_url for pub_file in bpph.files]
     [u'http://ftpmaster.internal/debian/pool/universe/m/mozilla-firefox/mozilla-firefox_0.9_i386.deb']
 
+Binary publishing records also have a download count, which contains
+the number of downloads of this binary package release in this archive.
+
+    >>> print bpph.getDownloadCount()
+    0
+
+    >>> from datetime import date
+    >>> bpph.archive.updatePackageDownloadCount(
+    ...     bpph.binarypackagerelease, date(2010, 2, 21), None, 10)
+
+    >>> print bpph.getDownloadCount()
+    10
+
 
 IPublishingSet
 ==============

=== modified file 'lib/lp/soyuz/interfaces/archive.py'
--- lib/lp/soyuz/interfaces/archive.py	2010-03-18 19:57:23 +0000
+++ lib/lp/soyuz/interfaces/archive.py	2010-03-18 22:52:32 +0000
@@ -662,6 +662,9 @@
         count of the existing one by the given amount.
         """
 
+    def getPackageDownloadTotal(bpr):
+        """Get the total download count for a given package."""
+
 
 class IArchiveView(IHasBuildRecords):
     """Archive interface for operations restricted by view privilege."""

=== modified file 'lib/lp/soyuz/interfaces/publishing.py'
--- lib/lp/soyuz/interfaces/publishing.py	2010-02-11 12:47:50 +0000
+++ lib/lp/soyuz/interfaces/publishing.py	2010-03-18 22:52:32 +0000
@@ -856,6 +856,12 @@
             representing the binaries copied to the destination location.
         """
 
+    @export_read_operation()
+    def getDownloadCount():
+        """Get the download count of this binary package in this archive.
+
+        This is currently only meaningful for PPAs."""
+
 
 class IBinaryPackagePublishingHistory(IBinaryPackagePublishingHistoryPublic,
                                       IPublishingEdit):

=== modified file 'lib/lp/soyuz/model/archive.py'
--- lib/lp/soyuz/model/archive.py	2010-03-17 17:26:10 +0000
+++ lib/lp/soyuz/model/archive.py	2010-03-18 22:52:32 +0000
@@ -15,7 +15,7 @@
 from sqlobject import  (
     BoolCol, ForeignKey, IntCol, StringCol)
 from sqlobject.sqlbuilder import SQLConstant
-from storm.expr import Or, And, Select
+from storm.expr import Or, And, Select, Sum
 from storm.locals import Count, Join
 from storm.store import Store
 from zope.component import getUtility
@@ -1342,6 +1342,16 @@
         else:
             entry.count += count
 
+    def getPackageDownloadTotal(self, bpr):
+        """See `IArchive`."""
+        store = Store.of(self)
+        count = store.find(
+            Sum(BinaryPackageReleaseDownloadCount.count),
+            BinaryPackageReleaseDownloadCount.archive == self,
+            BinaryPackageReleaseDownloadCount.binary_package_release == bpr,
+            ).one()
+        return count or 0
+
     def _setBuildStatuses(self, status):
         """Update the pending Build Jobs' status for this archive."""
 

=== modified file 'lib/lp/soyuz/model/publishing.py'
--- lib/lp/soyuz/model/publishing.py	2010-03-15 10:22:34 +0000
+++ lib/lp/soyuz/model/publishing.py	2010-03-18 22:52:32 +0000
@@ -857,6 +857,10 @@
                                    distroseries.name,
                                    self.distroarchseries.architecturetag)
 
+    def getDownloadCount(self):
+        """See `IBinaryPackagePublishingHistory`."""
+        return self.archive.getPackageDownloadTotal(self.binarypackagerelease)
+
     def buildIndexStanzaFields(self):
         """See `IPublishing`."""
         bpr = self.binarypackagerelease

=== modified file 'lib/lp/soyuz/stories/webservice/xx-binary-package-publishing.txt'
--- lib/lp/soyuz/stories/webservice/xx-binary-package-publishing.txt	2010-02-26 14:53:55 +0000
+++ lib/lp/soyuz/stories/webservice/xx-binary-package-publishing.txt	2010-03-18 22:52:32 +0000
@@ -86,6 +86,24 @@
     self_link: u'http://.../~cprov/+archive/ppa/+binarypub/30'
     status: u'Published'
 
+We can also retrieve the total download count for the binary in this archive.
+
+    >>> webservice.named_get(
+    ...     pubs['entries'][0]['self_link'], 'getDownloadCount').jsonBody()
+    0
+
+    >>> login("[e-mail]")
+    >>> from datetime import date
+    >>> from lp.soyuz.model.publishing import BinaryPackagePublishingHistory
+    >>> bpph = BinaryPackagePublishingHistory.get(30)
+    >>> bpph.archive.updatePackageDownloadCount(
+    ...     bpph.binarypackagerelease, date(2010, 2, 21), None, 10)
+    >>> logout()
+
+    >>> webservice.named_get(
+    ...     pubs['entries'][0]['self_link'], 'getDownloadCount').jsonBody()
+    10
+
 
 Security
 ========
@@ -93,7 +111,6 @@
 Create a private PPA for Celso with some binaries.
 
     >>> login("[e-mail]")
-
     >>> from zope.component import getUtility
     >>> from lp.registry.interfaces.person import IPersonSet
     >>> from lp.registry.interfaces.distribution import IDistributionSet