ENH: refs #953. added community.list.groups and tests.

Author: Michael Grauer

modules/api/controllers/components/ApiComponent.php

@@ -3045,7 +3045,8 @@ function groupRemove($args)
     }
 
   /**
-   * list the users for a group, requires admin privileges on the group
+   * list the users for a group, requires admin privileges on the community
+   * assiated with the group
    * @param group_id id of group
    * @return array users => a list of user ids mapped to user emails
    */
@@ -3082,6 +3083,41 @@ function groupListUsers($args)
     return array('users' => $userIdsToEmail);
     }
 
+  /**
+   * list the groups for a community, requires admin privileges on the community
+   * @param community_id id of community
+   * @return array groups => a list of group ids mapped to group names
+   */
+  function communityListGroups($args)
+    {
+    $this->_validateParams($args, array('community_id'));
+
+    $userDao = $this->_getUser($args);
+    if(!$userDao)
+      {
+      throw new Exception('You must be logged in to list groups in a community', MIDAS_INVALID_POLICY);
+      }
+
+    $communityId = $args['community_id'];
+    $communityModel = MidasLoader::loadModel('Community');
+    $community = $communityModel->load($communityId);
+    if(!$community)
+      {
+      throw new Exception('Invalid community_id', MIDAS_INVALID_PARAMETER);
+      }
+    if(!$communityModel->policyCheck($community, $userDao, MIDAS_POLICY_ADMIN))
+      {
+      throw new Zend_Exception("Community Admin permissions required.", MIDAS_INVALID_POLICY);
+      }
+
+    $groups = $community->getGroups();
+    $groupIdsToName = array();
+    foreach($groups as $group)
+      {
+      $groupIdsToName[$group->getGroupId()] = $group->getName();
+      }
+    return array('groups' => $groupIdsToName);
+    }
 
 
   } // end class

modules/api/tests/controllers/ApiCallCommunityMethodsTest.php

@@ -275,4 +275,48 @@ public function testCommunityGet()
     $this->assertEquals($resp->data->community_id, '2000');
     }
 
+  /** Test listing the groups in a community */
+  public function testCommunityListGroups()
+    {
+    $validCommunityId = 2001;
+    $invalidCommunityId = -10;
+
+    $communityModel = MidasLoader::loadModel('Community');
+    $comm2001 = $communityModel->load($validCommunityId);
+    $userModel = MidasLoader::loadModel('User');
+    $commMemberId = '4';
+    $commModeratorId = '5';
+    $commAdminId = '6';
+    $commMember = $userModel->load($commMemberId);
+    $commModerator = $userModel->load($commModeratorId);
+    $commAdmin = $userModel->load($commAdminId);
+
+    // add in an anonymous user to non admins
+    $invalidUsers = array($commMember, $commModerator, false);
+
+    // community list groups
+
+    $communityListMethod = "midas.community.list.groups";
+    $requiredParams = array(
+      array('name' => 'community_id', 'valid' => $validCommunityId, 'invalid' => $invalidCommunityId));
+
+    $this->exerciseInvalidCases($communityListMethod, $commAdmin, $invalidUsers, $requiredParams);
+
+    $this->resetAll();
+    $this->params['token'] = $this->_loginAsUser($commAdmin);
+    $this->params['method'] = $communityListMethod;
+    $this->params['community_id'] = $validCommunityId;
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+    $groups = (array)$resp->data->groups;
+    $this->assertEquals(3, sizeof($groups), 'groups should have 3 entries');
+
+    $expectedGroups = array('3003', '3004', '3005');
+    foreach($groups as $id => $name)
+      {
+      $this->assertTrue(in_array($id, $expectedGroups), 'id should have been in expectedGroups');
+      }
+    }
+
+
   }

modules/api/tests/controllers/ApiCallGroupMethodsTest.php

@@ -166,7 +166,7 @@ public function testGroupAddRemove()
     $this->assertFalse($addedGroup, "group should have been removed but remains");
     }
 
-  /** Test adding and removing a group */
+  /** Test listing the users in a group */
   public function testGroupListUsers()
     {
     $validCommunityId = 2001;