Merge pull request #1821 from davebx/toolshed_decouple_api

Cherry-picked changes from pull request #1392.

Author: martenson

lib/galaxy/web/form_builder.py

@@ -288,8 +288,9 @@ class SelectField(BaseField):
     <div><input type="checkbox" name="bar" value="3" id="bar|3"><label class="inline" for="bar|3">automatic</label></div>
     <div><input type="checkbox" name="bar" value="4" id="bar|4" checked='checked'><label class="inline" for="bar|4">bazooty</label></div>
     """
-    def __init__( self, name, multiple=None, display=None, refresh_on_change=False, refresh_on_change_values=None, size=None ):
+    def __init__( self, name, multiple=None, display=None, refresh_on_change=False, refresh_on_change_values=None, size=None, field_id=None ):
         self.name = name
+        self.field_id = field_id
         self.multiple = multiple or False
         self.size = size
         self.options = list()
@@ -312,7 +313,11 @@ def __init__( self, name, multiple=None, display=None, refresh_on_change=False,
     def add_option( self, text, value, selected=False ):
         self.options.append( ( text, value, selected ) )
 
-    def get_html( self, prefix="", disabled=False ):
+    def get_html( self, prefix="", disabled=False, extra_attr=None ):
+        if extra_attr is not None:
+            self.extra_attributes = ' %s' % ' '.join( [ '%s="%s"' % ( k, escape( v ) ) for k, v in extra_attr.items() ] )
+        else:
+            self.extra_attributes = ''
         if self.display == "checkboxes":
             return self.get_html_checkboxes( prefix, disabled )
         elif self.display == "radio":
@@ -335,8 +340,8 @@ def get_html_checkboxes( self, prefix="", disabled=False ):
             selected_text = ""
             if selected:
                 selected_text = " checked='checked'"
-            rval.append( '<div%s><input type="checkbox" name="%s%s" value="%s" id="%s"%s%s><label class="inline" for="%s">%s</label></div>'
-                         % ( style, prefix, self.name, escaped_value, uniq_id, selected_text, self.get_disabled_str( disabled ), uniq_id, escape( text, quote=True ) ) )
+            rval.append( '<div%s><input type="checkbox" name="%s%s" value="%s" id="%s"%s%s%s><label class="inline" for="%s">%s</label></div>'
+                         % ( style, prefix, self.name, escaped_value, uniq_id, selected_text, self.get_disabled_str( disabled ), self.extra_attributes, uniq_id, escape( text, quote=True ) ) )
             ctr += 1
         return unicodify( "\n".join( rval ) )
 
@@ -352,7 +357,7 @@ def get_html_radio( self, prefix="", disabled=False ):
             selected_text = ""
             if selected:
                 selected_text = " checked='checked'"
-            rval.append( '<div%s><input type="radio" name="%s%s"%s value="%s" id="%s"%s%s><label class="inline" for="%s">%s</label></div>'
+            rval.append( '<div%s><input type="radio" name="%s%s"%s value="%s" id="%s"%s%s%s><label class="inline" for="%s">%s</label></div>'
                          % ( style,
                              prefix,
                              self.name,
@@ -361,6 +366,7 @@ def get_html_radio( self, prefix="", disabled=False ):
                              uniq_id,
                              selected_text,
                              self.get_disabled_str( disabled ),
+                             self.extra_attributes,
                              uniq_id,
                              text ) )
             ctr += 1
@@ -388,8 +394,12 @@ def get_html_default( self, prefix="", disabled=False ):
             rval.append( '<option value="%s"%s>%s</option>' % ( escape( unicodify( value ), quote=True ), selected_text, escape( unicodify( text ), quote=True ) ) )
         if last_selected_value:
             last_selected_value = ' last_selected_value="%s"' % escape( unicodify( last_selected_value ), quote=True )
-        rval.insert( 0, '<select name="%s%s"%s%s%s%s%s>'
-                     % ( prefix, self.name, multiple, size, self.refresh_on_change_text, last_selected_value, self.get_disabled_str( disabled ) ) )
+        if self.field_id is not None:
+            id_string = ' id="%s"' % self.field_id
+        else:
+            id_string = ''
+        rval.insert( 0, '<select name="%s%s"%s%s%s%s%s%s%s>'
+                     % ( prefix, self.name, multiple, size, self.refresh_on_change_text, last_selected_value, self.get_disabled_str( disabled ), id_string, self.extra_attributes ) )
         rval.append( '</select>' )
         return unicodify( "\n".join( rval ) )
 

lib/galaxy/webapps/tool_shed/api/categories.py

@@ -15,8 +15,11 @@
 class CategoriesController( BaseAPIController ):
     """RESTful controller for interactions with categories in the Tool Shed."""
 
+    def __get_repository_count( self, trans, category_name ):
+        return self.app.repository_registry.viewable_repositories_and_suites_by_category.get( category_name, 0 )
+
     def __get_value_mapper( self, trans ):
-        value_mapper = { 'id' : trans.security.encode_id }
+        value_mapper = { 'id': trans.security.encode_id }
         return value_mapper
 
     @expose_api
@@ -41,11 +44,11 @@ def create( self, trans, payload, **kwd ):
             if not description:
                 # Default the description to the name.
                 description = name
-            if suc.get_category_by_name( trans.app, name ):
+            if suc.get_category_by_name( self.app, name ):
                 raise exceptions.Conflict( 'A category with that name already exists.' )
             else:
                 # Create the category
-                category = trans.app.model.Category( name=name, description=description )
+                category = self.app.model.Category( name=name, description=description )
                 trans.sa_session.add( category )
                 trans.sa_session.flush()
                 category_dict = category.to_dict( view='element',
@@ -58,6 +61,30 @@ def create( self, trans, payload, **kwd ):
             raise exceptions.RequestParameterMissingException( 'Missing required parameter "name".' )
         return category_dict
 
+    @expose_api_anonymous_and_sessionless
+    def get_repositories( self, trans, category_id, **kwd ):
+        """
+        GET /api/categories/{encoded_category_id}/repositories
+        Return information about the provided category and the repositories in that category.
+
+        :param id: the encoded id of the Category object
+
+        Example: GET localhost:9009/api/categories/f9cad7b01a472135/repositories
+        """
+        category = suc.get_category( self.app, category_id )
+        if category is None:
+            category_dict = dict( message='Unable to locate category record for id %s.' % ( str( id ) ),
+                                  status='error' )
+            return category_dict
+        category_dict = category.to_dict( view='element',
+                                          value_mapper=self.__get_value_mapper( trans ) )
+        category_dict[ 'url' ] = web.url_for( controller='categories',
+                                              action='show',
+                                              id=trans.security.encode_id( category.id ) )
+        repositories = suc.get_repositories_by_category( self.app, category.id )
+        category_dict[ 'repositories' ] = repositories
+        return category_dict
+
     @expose_api_anonymous_and_sessionless
     def index( self, trans, deleted=False, **kwd ):
         """
@@ -72,14 +99,15 @@ def index( self, trans, deleted=False, **kwd ):
         deleted = util.asbool( deleted )
         if deleted and not trans.user_is_admin():
             raise exceptions.AdminRequiredException( 'Only administrators can query deleted categories.' )
-        for category in trans.sa_session.query( trans.app.model.Category ) \
-                                        .filter( trans.app.model.Category.table.c.deleted == deleted ) \
-                                        .order_by( trans.app.model.Category.table.c.name ):
+        for category in trans.sa_session.query( self.app.model.Category ) \
+                                        .filter( self.app.model.Category.table.c.deleted == deleted ) \
+                                        .order_by( self.app.model.Category.table.c.name ):
             category_dict = category.to_dict( view='collection',
                                               value_mapper=self.__get_value_mapper( trans ) )
             category_dict[ 'url' ] = web.url_for( controller='categories',
                                                   action='show',
                                                   id=trans.security.encode_id( category.id ) )
+            category_dict[ 'repositories' ] = self.app.repository_registry.viewable_repositories_and_suites_by_category.get( category.name, 0 )
             category_dicts.append( category_dict )
         return category_dicts
 
@@ -93,7 +121,7 @@ def show( self, trans, id, **kwd ):
 
         Example: GET localhost:9009/api/categories/f9cad7b01a472135
         """
-        category = suc.get_category( trans.app, id )
+        category = suc.get_category( self.app, id )
         if category is None:
             category_dict = dict( message='Unable to locate category record for id %s.' % ( str( id ) ),
                                   status='error' )