Added the activeOnly flag to the GetProjectUser and added the Disable…

…UsersInProject command.
gooddata · Aug 11, 2011 · d5fb04c · d5fb04c
1 parent b1fa9e0
commit d5fb04c
Show file tree

Hide file tree

Showing 20 changed files with 146 additions and 39 deletions.
diff --git a/backend/pom.xml b/backend/pom.xml
@@ -28,7 +28,7 @@
     <parent>
         <groupId>com.gooddata.cl</groupId>
         <artifactId>gooddata-cl</artifactId>
-        <version>1.2.38-BETA</version>
+        <version>1.2.39-BETA</version>
     </parent>
 
     <artifactId>gooddata-cl-backend</artifactId>

diff --git a/backend/src/main/java/com/gooddata/integration/rest/GdcRESTApiWrapper.java b/backend/src/main/java/com/gooddata/integration/rest/GdcRESTApiWrapper.java
@@ -1485,19 +1485,19 @@ public GdcUser(JSONObject user) {
             }
             this.setLogin(v);
             v = c.getString("firstname");
-            if(v != null && v.trim().length()<=0) {
+            if(v != null && v.trim().length()>0) {
                 this.setFirstName(v);
             }
             v = c.getString("lastname");
-            if(v != null && v.trim().length()<=0) {
+            if(v != null && v.trim().length()>0) {
                 this.setLastName(v);
             }
             v = c.getString("phonenumber");
-            if(v != null && v.trim().length()<=0) {
+            if(v != null && v.trim().length()>0) {
                 this.setPhoneNumber(v);
             }
             v = c.getString("status");
-            if(v != null && v.trim().length()<=0) {
+            if(v != null && v.trim().length()>0) {
                 this.setStatus(v);
             }
             JSONObject l = u.getJSONObject("links");
@@ -1781,12 +1781,73 @@ private JSONObject getAddUsersToProjectStructure(List<String> uris, String roleU
         return param;
     }
 
+    /**
+     * Disables a user in project
+     *
+     * @param projectId project ID
+     * @param uris user URIs
+     * @throws GdcRestApiException
+     */
+    public void disableUsersInProject(String projectId, List<String> uris)
+            throws GdcRestApiException {
+
+            l.debug("Disabling users "+uris+" in project "+projectId);
+            String projectsUrl = getProjectUrl(projectId);
+
+            PostMethod req = createPostMethod(projectsUrl+PROJECT_USERS_SUFFIX);
+            JSONObject param = getDisableUsersInProjectStructure(uris);
+            InputStreamRequestEntity request = new InputStreamRequestEntity(new ByteArrayInputStream(
+                    param.toString().getBytes()));
+            req.setRequestEntity(request);
+            String result = null;
+            try {
+                String response = executeMethodOk(req);
+                JSONObject responseObject = JSONObject.fromObject(response);
+                JSONObject projectUsersUpdateResult = responseObject.getJSONObject("projectUsersUpdateResult");
+                JSONArray failed = projectUsersUpdateResult.getJSONArray("failed");
+                if(!failed.isEmpty()) {
+                    String errMsg = "Following users can't be disabled in the project:";
+                    for(Object uri : failed.toArray()) {
+                        errMsg += " "+uris.toString();
+                    }
+                    l.debug(errMsg);
+                    throw new GdcRestApiException(errMsg);
+                }
+                //JSONArray successful = projectUsersUpdateResult.getJSONArray("successful");
+            } catch (HttpMethodException ex) {
+                l.debug("Error disabling users "+uris+" in project",ex);
+                throw new GdcRestApiException("Error disabling users "+uris+" in project ",ex);
+            } finally {
+                req.releaseConnection();
+            }
+    }
+
+    private JSONObject getDisableUsersInProjectStructure(List<String> uris) {
+        JSONObject param = new JSONObject();
+        JSONArray users = new JSONArray();
+        for(String uri : uris) {
+            JSONObject user = new JSONObject();
+            JSONObject content = new JSONObject();
+            content.put("status","DISABLED");
+            user.put("content", content);
+            JSONObject links = new JSONObject();
+            links.put("self", uri);
+            user.put("links", links);
+            JSONObject item = new JSONObject();
+            item.put("user",user);
+            users.add(item);
+        }
+        param.put("users", users);
+        return param;
+    }
+
     /**
      * Returns the selected project's users
      * @param pid  project ID
+     * @param activeUsersOnly lists only active users
      * @return array of the project's users
      */
-    public ArrayList<GdcUser> getProjectUsers(String pid) {
+    public ArrayList<GdcUser> getProjectUsers(String pid, boolean activeUsersOnly) {
         ArrayList<GdcUser> ret = new ArrayList<GdcUser>();
         l.debug("Executing getProjectUsers for project id="+pid);
         HttpMethod req = createGetMethod(getProjectUrl(pid) + PROJECT_USERS_SUFFIX);
@@ -1804,7 +1865,10 @@ public ArrayList<GdcUser> getProjectUsers(String pid) {
             }
             for(Object o : users) {
                 JSONObject user = (JSONObject)o;
-                ret.add(new GdcUser(user));
+                GdcUser g = new GdcUser(user);
+                if((activeUsersOnly && "ENABLED".equalsIgnoreCase(g.getStatus())) || (!activeUsersOnly)) {
+                    ret.add(g);
+                }
             }
             return ret;
         }
@@ -3269,7 +3333,7 @@ private static <T extends HttpMethod> T configureHttpMethod(T request) {
         request.setRequestHeader("Content-Type", "application/json; charset=utf-8");
         request.setRequestHeader("Accept", "application/json");
         request.setRequestHeader("Accept-Charset", "utf-u");
-        request.setRequestHeader("User-Agent", "GoodData CL/1.2.38-BETA");
+        request.setRequestHeader("User-Agent", "GoodData CL/1.2.39-BETA");
         return request;
     }
 

diff --git a/cli-distro/doc/CLI.md b/cli-distro/doc/CLI.md
@@ -87,14 +87,18 @@ Project Management Commands:
 - usersFile - (optional) writes the user's URI to the specified file
 - append - (optional) should the users file be appended (default is false)
 
-`GetProjectUsers(usersFile="...", field = "...");` - get list of users from the current project
+`GetProjectUsers(usersFile="...", field = "...", activeOnly=<true|false>);` - get list of users from the current project
 - usersFile - writes the user's URI to the specified file
 - field - uri | email - writes either user uri or e-mail to the usersFile
+- activeOnly - (optional) lists only active users (not disabled) the false is default
 
 `AddUsersToProject(usersFile="...", role="...")` - adds users in the usersFile to the open project in a specific role
-- usersFile - (optional) writes the user's URI to the specified file
+- usersFile - the list of user URIs in a file
 - role  - (optional) initial user's role: admin|editor|dashboard only
 
+`DisableUsersInProject(usersFile="...")` - disables users in the usersFile in the open project
+- usersFile - the list of user URIs in a file
+
 `ExportProject(tokenFile="...", exportUsers="...", exportData="...", authorizedUsers="...");` - exports an existing project to temporary storage and returns the import token
 - tokenFile - a file where the import token will be stored
 - exportUsers - export existing project users `true` | `false`

diff --git a/cli-distro/examples/create_user/cmd.txt b/cli-distro/examples/create_user/cmd.txt
@@ -9,4 +9,8 @@ CreateUser(domain="GoodData", username="jane.doe.3@gooddata.com", password="secr
 
 CreateProject(name="Users Test");
 
-AddUsersToProject(usersFile="examples/create_user/users.txt", role="DASHBOARD ONLY");
+AddUsersToProject(usersFile="examples/create_user/users.txt", role="DASHBOARD ONLY");
+GetProjectUsers(usersFile="examples/create_user/users.1.txt", field = "email", activeOnly="false");
+DisableUsersInProject(usersFile="examples/create_user/users.txt");
+GetProjectUsers(usersFile="examples/create_user/users.2.txt", field = "email", activeOnly="false");
+GetProjectUsers(usersFile="examples/create_user/users.3.txt", field = "email", activeOnly="true");
diff --git a/cli-distro/pom.xml b/cli-distro/pom.xml
@@ -29,7 +29,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-cli</artifactId>

diff --git a/cli/pom.xml b/cli/pom.xml
@@ -27,7 +27,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-cl-cli</artifactId>

diff --git a/cli/src/main/java/com/gooddata/processor/GdcDI.java b/cli/src/main/java/com/gooddata/processor/GdcDI.java
@@ -329,7 +329,7 @@ protected CliParams parse(CommandLine ln, Properties defaults) throws InvalidArg
 
         if(cp.containsKey(CLI_PARAM_VERSION[0])) {
 
-            l.info("GoodData CL version 1.2.38-BETA" +
+            l.info("GoodData CL version 1.2.39-BETA" +
                     ((BUILD_NUMBER.length()>0) ? ", build "+BUILD_NUMBER : "."));
             System.exit(0);
 
@@ -578,6 +578,9 @@ else if(c.match("CreateUser")) {
             else if(c.match("AddUsersToProject")) {
                 addUsersToProject(c, cli, ctx);
             }
+            else if(c.match("DisableUsersInProject")) {
+                disableUsersInProject(c, cli, ctx);
+            }
             else if(c.match("GetProjectUsers")) {
                 getProjectUsers(c, cli, ctx);
             }
@@ -777,6 +780,31 @@ private void addUsersToProject(Command c, CliParams p, ProcessingContext ctx) th
         l.info("Users "+uris+"' successfully added to project "+pid);
     }
 
+
+    /**
+     * Adds a new user to project
+     * @param c command
+     * @param p cli parameters
+     * @param ctx current context
+     * @throws IOException IO issues
+     */
+    private void disableUsersInProject(Command c, CliParams p, ProcessingContext ctx) throws IOException {
+        l.info("Disabling users in project.");
+
+        String pid = ctx.getProjectIdMandatory();
+        String usersFile = c.getParamMandatory("usersFile");
+        List<String> uris = new ArrayList<String>();
+        BufferedReader r = FileUtil.createBufferedUtf8Reader(usersFile);
+        String uri = r.readLine();
+        while (uri != null && uri.trim().length()>0) {
+            uris.add(uri.trim());
+            uri = r.readLine();
+        }
+        ctx.getRestApi(p).disableUsersInProject(pid, uris);
+        l.info("Users "+uris+"' successfully disabled in project "+pid);
+    }
+
+
     /**
      * Adds a new user to project
      * @param c command
@@ -786,11 +814,14 @@ private void addUsersToProject(Command c, CliParams p, ProcessingContext ctx) th
      */
     private void getProjectUsers(Command c, CliParams p, ProcessingContext ctx) throws IOException {
         String pid = ctx.getProjectIdMandatory();
-        l.info("Getting users from project"+pid);
+        l.info("Getting users from project "+pid);
         String usersFile = c.getParamMandatory("usersFile");
         String field = c.getParamMandatory("field");
+        String activeOnlys = c.getParam("activeOnly");
+        final boolean activeOnly = (activeOnlys != null && "true".equalsIgnoreCase(activeOnlys));
+
         if("email".equalsIgnoreCase(field) || "uri".equalsIgnoreCase(field)) {
-            List<GdcRESTApiWrapper.GdcUser> users = ctx.getRestApi(p).getProjectUsers(pid);
+            List<GdcRESTApiWrapper.GdcUser> users = ctx.getRestApi(p).getProjectUsers(pid,activeOnly);
             for(GdcRESTApiWrapper.GdcUser user : users) {
                 if("email".equalsIgnoreCase(field)) {
                     FileUtil.writeStringToFile(user.getLogin()+"\n", usersFile, true);

diff --git a/cli/src/main/resources/com/gooddata/processor/COMMANDS.txt b/cli/src/main/resources/com/gooddata/processor/COMMANDS.txt
@@ -40,14 +40,18 @@ CreateUser(domain="...", username="...", password="...", firstName="...", lastNa
 - usersFile - (optional) writes the user's URI to the specified file
 - append - (optional) should the users file be appended (default is false)
 
-GetProjectUsers(usersFile="...", field = "..."); - get list of users from the current project
+GetProjectUsers(usersFile="...", field = "...", activeOnly=<true|false>); - get list of users from the current project
 - usersFile - writes the user's URI to the specified file
 - field - uri | email - writes either user uri or e-mail to the usersFile
+- activeOnly - (optional) lists only active users (not disabled) the false is default
 
 AddUsersToProject(usersFile="...", role="...") - adds users in the usersFile to the open project in a specific role
-- usersFile - (optional) writes the user's URI to the specified file
+- usersFile - the list of user URIs in a file
 - role  - (optional) initial user's role: admin|editor|dashboard only
 
+DisableUsersInProject(usersFile="...") - disables users in the usersFile in the open project
+- usersFile - the list of user URIs in a file
+
 ExportProject(tokenFile="...", exportUsers="...", exportData="...", authorizedUsers="..."); - exports an existing project to temporary storage and returns the import token
 - tokenFile - a file where the import token will be stored
 - exportUsers - export existing project users true | false

diff --git a/common/pom.xml b/common/pom.xml
@@ -28,7 +28,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-cl-common</artifactId>

diff --git a/connector/pom.xml b/connector/pom.xml
@@ -27,7 +27,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-cl-connector</artifactId>

diff --git a/connector/src/main/java/com/gooddata/chargify/ChargifyWrapper.java b/connector/src/main/java/com/gooddata/chargify/ChargifyWrapper.java
@@ -244,7 +244,7 @@ private static DeleteMethod createDeleteMethod(String path) {
     private static <T extends HttpMethod> T configureHttpMethod(T request) {
         request.setRequestHeader("Content-Type", "text/xml");
         request.setRequestHeader("Accept", "text/xml");
-        request.setRequestHeader("User-Agent", "GoodData CL/1.2.38-BETA");
+        request.setRequestHeader("User-Agent", "GoodData CL/1.2.39-BETA");
         return request;
     }
 

diff --git a/gooddata-snaplogic/pom.xml b/gooddata-snaplogic/pom.xml
@@ -29,7 +29,7 @@
     <parent>
         <groupId>com.gooddata.cl</groupId>
         <artifactId>gooddata-cl</artifactId>
-        <version>1.2.38-BETA</version>
+        <version>1.2.39-BETA</version>
     </parent>
 
     <artifactId>gooddata-cl-snaplogic</artifactId>

diff --git a/notification-distro/pom.xml b/notification-distro/pom.xml
@@ -29,7 +29,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-alert</artifactId>

diff --git a/notification/pom.xml b/notification/pom.xml
@@ -29,7 +29,7 @@
 	<parent>
 		<groupId>com.gooddata.cl</groupId>
 		<artifactId>gooddata-cl</artifactId>
-		<version>1.2.38-BETA</version>
+		<version>1.2.39-BETA</version>
 	</parent>
 
 	<artifactId>gooddata-notification</artifactId>

diff --git a/notification/src/main/java/com/gooddata/processor/GdcNotification.java b/notification/src/main/java/com/gooddata/processor/GdcNotification.java
@@ -386,7 +386,7 @@ else if (defaults.getProperty(name) != null) {
         }
 
         if(cp.containsKey(CLI_PARAM_VERSION[0])) {
-            l.info("GoodData Notification Tool version 1.2.38-BETA" +
+            l.info("GoodData Notification Tool version 1.2.39-BETA" +
                     ((BUILD_NUMBER.length()>0) ? ", build "+BUILD_NUMBER : "."));
             System.exit(0);