ENH: refs #953. added group.list.users and tests.

Author: Michael Grauer

modules/api/controllers/components/ApiComponent.php

@@ -2959,7 +2959,7 @@ function groupAddUser($args)
     }
 
   /**
-   * Remove a user to a group, returns 'success' => 'true' on success, requires
+   * Remove a user from a group, returns 'success' => 'true' on success, requires
    * admin privileges on the community associated with the group.
    * @param group_id the group to remove the user from
    * @param user_id the user to remove from the group
@@ -3044,4 +3044,44 @@ function groupRemove($args)
     return array('success' => 'true');
     }
 
+  /**
+   * list the users for a group, requires admin privileges on the group
+   * @param group_id id of group
+   * @return array users => a list of user ids mapped to user emails
+   */
+  function groupListUsers($args)
+    {
+    $this->_validateParams($args, array('group_id'));
+
+    $userDao = $this->_getUser($args);
+    if(!$userDao)
+      {
+      throw new Exception('You must be logged in to list users in a group', MIDAS_INVALID_POLICY);
+      }
+
+    $groupId = $args['group_id'];
+    $groupModel = MidasLoader::loadModel('Group');
+    $group = $groupModel->load($groupId);
+    if($group == false)
+      {
+      throw new Exception('This group does not exist', MIDAS_INVALID_PARAMETER);
+      }
+
+    $communityModel = MidasLoader::loadModel('Community');
+    if(!$communityModel->policyCheck($group->getCommunity(), $userDao, MIDAS_POLICY_ADMIN))
+      {
+      throw new Zend_Exception("Community Admin permissions required.", MIDAS_INVALID_POLICY);
+      }
+
+    $users = $group->getUsers();
+    $userIdsToEmail = array();
+    foreach($users as $user)
+      {
+      $userIdsToEmail[$user->getUserId()] = $user->getEmail();
+      }
+    return array('users' => $userIdsToEmail);
+    }
+
+
+
   } // end class

modules/api/tests/controllers/ApiCallGroupMethodsTest.php

@@ -165,4 +165,92 @@ public function testGroupAddRemove()
     $addedGroup = $groupModel->load($addedGroupId);
     $this->assertFalse($addedGroup, "group should have been removed but remains");
     }
+
+  /** Test adding and removing a group */
+  public function testGroupListUsers()
+    {
+    $validCommunityId = 2001;
+    $invalidCommunityId = -10;
+    $commAdminGroupId = 3003;
+    $invalidGroupId = -10;
+
+    $communityModel = MidasLoader::loadModel('Community');
+    $comm2001 = $communityModel->load('2001');
+    $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);
+
+    // group list users
+
+    $groupListMethod = "midas.group.list.users";
+    $requiredParams = array(
+      array('name' => 'group_id', 'valid' => $commAdminGroupId, 'invalid' => $invalidGroupId));
+
+    $this->exerciseInvalidCases($groupListMethod, $commAdmin, $invalidUsers, $requiredParams);
+
+    $this->resetAll();
+    $this->params['token'] = $this->_loginAsUser($commAdmin);
+    $this->params['method'] = $groupListMethod;
+    $this->params['group_id'] = $commAdminGroupId;
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+
+    $users = $resp->data->users;
+    $users = (array)$users;
+    $this->assertEquals(1, sizeof($users), 'users should only have one entry');
+    foreach($users as $id => $email)
+      {
+      $this->assertEquals($id, $commAdminId, 'users should have commAdminId as an entry');
+      }
+
+    // add some users, test again
+
+    $groupModel = MidasLoader::loadModel('Group');
+    $commAdminGroup = $groupModel->load($commAdminGroupId);
+    $groupModel->addUser($commAdminGroup, $commMember);
+    $groupModel->addUser($commAdminGroup, $commModerator);
+
+    $this->resetAll();
+    $this->params['token'] = $this->_loginAsUser($commAdmin);
+    $this->params['method'] = $groupListMethod;
+    $this->params['group_id'] = $commAdminGroupId;
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+    $users = $resp->data->users;
+    $users = (array)$users;
+    $this->assertEquals(3, sizeof($users), 'users should have 3 entries');
+    $members = array($commAdminId, $commMemberId, $commModeratorId);
+    foreach($users as $id => $email)
+      {
+      $this->assertTrue(in_array($id, $members), 'users should have '.$id.' as an entry');
+      }
+
+    // remove some users, test again
+    $groupModel->removeUser($commAdminGroup, $commMember);
+    $groupModel->removeUser($commAdminGroup, $commModerator);
+
+    $this->resetAll();
+    $this->params['token'] = $this->_loginAsUser($commAdmin);
+    $this->params['method'] = $groupListMethod;
+    $this->params['group_id'] = $commAdminGroupId;
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+
+    $users = $resp->data->users;
+    $users = (array)$users;
+    $this->assertEquals(1, sizeof($users), 'users should only have one entry');
+    foreach($users as $id => $email)
+      {
+      $this->assertEquals($id, $commAdminId, 'users should have commAdminId as an entry');
+      }
+
+    }
+
   }