Merge lp:~adiroiban/launchpad/bug-527728 into lp:launchpad

[Adi Roiban]

Export latest_published_component_name in the ISourcePackage API.

[Adi Roiban (adiroiban)]

= Bug 527728 =

It looks like the source_package is already exported in API (https://api.launchpad.net/+apidoc/#source_package).

To help with translation reporting tasks (https://dev.launchpad.net/Translations/Specs/ReportingAPI) it would be nice to also have the component name for a source package.

== Proposed fix ==
Add compoment_name in the list of exported attributes for ISourcePackage

== Pre-implementation notes ==
Sinzui suggest exporting the compoment_name as latest_published_component_name, since this is the flattening export for latest_published_component

== Implementation details ==

I don't know how to get rid of those lazr.restful lint warning.
Any suggestion is much appreciated.

== Tests ==
lp-test -t source-package.txt

== Demo and Q/A ==
The Ubuntu Hoary source package is exported via API at:
https://launchpad.dev/api/beta/ubuntu/hoary/+source/evolution

The list of attributes should include the „component_name” and it should match the component name displayed at https://launchpad.dev/ubuntu/lucid/+source/evolution

= 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/registry/interfaces/sourcepackage.py
  lib/lp/registry/model/sourcepackage.py
  lib/lp/registry/stories/webservice/xx-source-package.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)
    188: [C0322, ISourcePackage.getBranch] Operator not preceded by a space
    vocabulary=DBEnumeratedType))
    ^

    @operation_returns_entry(Interface)
    @export_read_operation()
    def getBranch(pocket):
    206: [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):

[Brad Crittenden (bac)]

Hi Adi,

Thanks for this work. Once the newest version was pushed up everything worked fine.

As I mentioned on IRC it's always a good idea to exercise API changes via launchpadlib. Here's how I verified your new property:

1: lp = launchpad
2: u = lp.distributions['ubuntu']
3: hoary = u.getSeries(name_or_version='hoary')
4: ev = hoary.getSourcePackage(name='evolution')
5: dir(ev)
6: ev.latest_published_component_name

review: Approve (code)

[Brad Crittenden (bac)]

Adi I will be glad to land your branch when PQM re-opens after the roll out. Please remind me if I forget.

=== modified file 'lib/lp/registry/interfaces/sourcepackage.py'
--- lib/lp/registry/interfaces/sourcepackage.py	2010-02-10 07:36:25 +0000
+++ lib/lp/registry/interfaces/sourcepackage.py	2010-03-02 18:29:15 +0000
@@ -225,6 +225,11 @@
         title=u'The component in which the package was last published.',
         schema=IComponent, readonly=True, required=False)
 
+    latest_published_component_name = exported(TextLine(
+        title=u'The name of the component in which the package'
+               ' was last published.',
+        readonly=True, required=False))
+
     def get_default_archive(component=None):
         """Get the default archive of this package.
 

=== modified file 'lib/lp/registry/model/sourcepackage.py'
--- lib/lp/registry/model/sourcepackage.py	2010-02-24 13:49:17 +0000
+++ lib/lp/registry/model/sourcepackage.py	2010-03-02 18:29:15 +0000
@@ -12,10 +12,10 @@
     ]
 
 from operator import attrgetter
-from sqlobject.sqlbuilder import SQLConstant
 from zope.interface import classProvides, implements
 from zope.component import getUtility
 
+from sqlobject.sqlbuilder import SQLConstant
 from storm.locals import And, Desc, In, Select, SQL, Store
 
 from canonical.database.constants import UTC_NOW
@@ -566,6 +566,14 @@
         else:
             return None
 
+    @property
+    def latest_published_component_name(self):
+        """See `ISourcePackage`."""
+        if self.latest_published_component is not None:
+            return self.latest_published_component.name
+        else:
+            return None
+
     def get_default_archive(self, component=None):
         """See `ISourcePackage`."""
         if component is None:

=== modified file 'lib/lp/registry/stories/webservice/xx-source-package.txt'
--- lib/lp/registry/stories/webservice/xx-source-package.txt	2009-12-24 01:41:54 +0000
+++ lib/lp/registry/stories/webservice/xx-source-package.txt	2010-03-02 18:29:15 +0000
@@ -1,4 +1,9 @@
-= Prelude =
+Source Package API
+==================
+
+
+Prelude
+-------
 
     >>> from zope.component import getUtility
     >>> from lp.registry.interfaces.distribution import (
@@ -11,7 +16,9 @@
     >>> from canonical.launchpad.webapp.interfaces import OAuthPermission
     >>> from lazr.restful.testing.webservice import pprint_entry
 
-= Source Packages =
+
+Getting source packages
+-----------------------
 
 We can get source packages that are bound to a distribution series from the
 distribution series.
@@ -26,6 +33,7 @@
     displayname: u'evolution in Ubuntu Hoary'
     distribution_link: u'http://.../ubuntu'
     distroseries_link: u'http://.../ubuntu/hoary'
+    latest_published_component_name: u'main'
     name: u'evolution'
     official_bug_tags: []
     productseries_link: u'http://.../evolution/trunk'
@@ -33,7 +41,8 @@
     self_link: u'http://.../ubuntu/hoary/+source/evolution'
 
 
-== Getting official branches ==
+Getting official branches
+-------------------------
 
 Then we can get the branches that are bound to various pockets of this
 distribution series. By default, there are none bound to evolution.
@@ -44,7 +53,8 @@
     None
 
 
-== Setting official branches ==
+Setting official branches
+-------------------------
 
 We can even set a branch for the series. First we need to *make* a branch
 though.