Add a package listing API to cipd.

appengine/chrome_infra_packages/cipd/api.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Cloud Endpoints API for Package Repository service."""
 
 import functools
 
 import endpoints
 
@@ skipping 202 matching lines @@
   status = messages.EnumField(Status, 1, required=True)
   error_message = messages.StringField(2, required=False)
 
   # For SUCCESS, information about the package.
   package = messages.MessageField(Package, 3, required=False)
 
 
 ################################################################################
 
 
+class ListPackagesResponse(messages.Message):
+  """Results of listPackage call."""
+
+  status = messages.EnumField(Status, 1, required=True)
+  error_message = messages.StringField(2, required=False)
+
+  # For SUCCESS, names of the packages.
+  packages = messages.StringField(3, repeated=True)
+
+
+################################################################################
+
+
 class RegisterPackageResponse(messages.Message):
   """Results of registerPackage call."""
   status = messages.EnumField(Status, 1, required=True)
   error_message = messages.StringField(2, required=False)
 
   # For REGISTERED or ALREADY_REGISTERED, information about the package.
   package = messages.MessageField(Package, 3, required=False)
 
 
 ################################################################################
@@ skipping 297 matching lines @@
 
     caller = auth.get_current_identity()
     if not acl.can_register_package(package_name, caller):
       raise auth.AuthorizationError()
 
     pkg, registered = self.service.register_package(package_name, caller)
     return RegisterPackageResponse(
         status=Status.REGISTERED if registered else Status.ALREADY_REGISTERED,
         package=package_to_proto(pkg))
 
+  # REVIEW: Should I be reusing the /package path with an additional prefix

[Vadim Sh., 2015/06/19 21:12:03]

I think packages is ok. Consider also "GET /package/search?prefix=...". It will
be similar to existing "/instance/search?tag=..." call then. The idea here is
that we retrieve "search results" object, not a package. Thus "package/search"
noun, not "package".

But it doesn't really matter :)

[estaab, 2015/06/20 02:25:25]

Done.

+  # parameter? I haven't done much RESTful API work before.
+  @endpoints_method(
+      endpoints.ResourceContainer(
+          message_types.VoidMessage,
+          prefix=messages.StringField(1, required=False)),
+      ListPackagesResponse,
+      http_method='GET',
+      path='packages',
+      name='listPackages')
+  def list_packages(self, request):
+    """Returns information about a package."""
+    prefix = request.prefix or ''
+
+    pkgs = self.service.list_packages(prefix)
+    caller = auth.get_current_identity()
+    visible_pkgs = [p for p in pkgs if acl.can_fetch_package(p, caller)]
+
+    return ListPackagesResponse(packages=visible_pkgs)
+
 
   ### PackageInstance methods.
 
 
   @endpoints_method(
       endpoints.ResourceContainer(
           message_types.VoidMessage,
           package_name=messages.StringField(1, required=True),
           instance_id=messages.StringField(2, required=True)),
       FetchInstanceResponse,
@@ skipping 336 matching lines @@
       return FetchClientBinaryResponse(
         status=Status.NOT_EXTRACTED_YET,
         instance=instance_to_proto(instance))
 
     return FetchClientBinaryResponse(
         instance=instance_to_proto(instance),
         client_binary=FetchClientBinaryResponse.ClientBinary(
             sha1=client_info.sha1,
             size=client_info.size,
             fetch_url=client_info.fetch_url))