Added common code in AppAutomate and Automate in BrowserStackClient

Author: raghuhit

src/main/java/com/browserstack/appautomate/AppAutomate.java

@@ -1,42 +1,13 @@
 package com.browserstack.appautomate;
 
 import java.io.FileNotFoundException;
-import java.util.List;
-import com.browserstack.automate.Automate.BuildStatus;
 import com.browserstack.automate.exception.AppAutomateException;
-import com.browserstack.automate.exception.BuildNotFound;
 import com.browserstack.automate.exception.InvalidFileExtensionException;
-import com.browserstack.automate.exception.SessionNotFound;
-import com.browserstack.automate.model.Build;
-import com.browserstack.automate.model.Session;
+import com.browserstack.automate.model.AppUploadResponse;
 
 public interface AppAutomate {
 
-  public Session getSession(String sessionId) throws SessionNotFound, AppAutomateException;
-
-  public String uploadApp(String filePath)
+  public AppUploadResponse uploadApp(String filePath)
       throws AppAutomateException, FileNotFoundException, InvalidFileExtensionException;
-  
-  List<Build> getBuilds(BuildStatus status, int limit) throws AppAutomateException;
-
-  List<Build> getBuilds(int limit) throws AppAutomateException;
-
-  List<Build> getBuilds(BuildStatus status) throws AppAutomateException;
-
-  List<Build> getBuilds() throws AppAutomateException;
-
-  Build getBuild(String buildId) throws BuildNotFound, AppAutomateException;
-
-  boolean deleteBuild(String buildId) throws AppAutomateException;
-
-  List<Session> getSessions(String buildId, BuildStatus status,
-                            int limit) throws BuildNotFound, AppAutomateException;
-
-  List<Session> getSessions(String buildId) throws BuildNotFound, AppAutomateException;
-
-  List<Session> getSessions(String buildId, int limit) throws BuildNotFound, AppAutomateException;
-
-  List<Session> getSessions(String buildId, BuildStatus status) throws BuildNotFound, AppAutomateException;
-
 
 }

src/main/java/com/browserstack/appautomate/AppAutomateClient.java

@@ -2,8 +2,6 @@
 
 import java.io.File;
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import com.browserstack.automate.Automate.BuildStatus;
 import com.browserstack.automate.exception.AppAutomateException;
@@ -12,15 +10,10 @@
 import com.browserstack.automate.exception.SessionNotFound;
 import com.browserstack.automate.model.AppUploadResponse;
 import com.browserstack.automate.model.Build;
-import com.browserstack.automate.model.BuildNode;
 import com.browserstack.automate.model.Session;
-import com.browserstack.automate.model.SessionNode;
 import com.browserstack.client.BrowserStackClient;
-import com.browserstack.client.BrowserStackRequest;
 import com.browserstack.client.exception.BrowserStackException;
-import com.browserstack.client.exception.BrowserStackObjectNotFound;
-import com.browserstack.client.util.Constants;
-import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.browserstack.client.util.Tools;
 import com.google.api.client.http.FileContent;
 import com.google.api.client.http.HttpHeaders;
 import com.google.api.client.http.HttpMediaType;
@@ -34,24 +27,32 @@ public AppAutomateClient(String username, String accessKey) {
     super(BASE_URL, username, accessKey);
   }
 
+  /**
+   * Gets the session associated with the specified identifier.
+   *
+   * @param sessionId ID that uniquely identifies a session.
+   * @return {@link Session} objects containing test session information.
+   * @throws SessionNotFound
+   * @throws AppAutomateException
+   */
   public Session getSession(String sessionId) throws SessionNotFound, AppAutomateException {
     try {
-      SessionNode sessionNode = newRequest(Method.GET, "/sessions/{sessionId}.json")
-          .routeParam("sessionId", sessionId).asObject(SessionNode.class);
-
-      if (sessionNode.getSession() == null) {
-        throw new SessionNotFound("Session not found: " + sessionId);
-      }
-
-      return sessionNode.getSession().setClient(this);
-    } catch (BrowserStackObjectNotFound e) {
-      throw new SessionNotFound("Session not found: " + sessionId);
+      return super.getSession(sessionId);
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
   }
 
-  public String uploadApp(String filePath)
+  /**
+   * Gets the filePath of app to be uploaded.
+   *
+   * @param filePath absolute path of app to be uploaded.
+   * @return AppUploadResponse object containing app upload response details.
+   * @throws AppAutomateException
+   * @throws FileNotFoundException
+   * @throws InvalidFileExtensionException
+   */
+  public AppUploadResponse uploadApp(String filePath)
       throws AppAutomateException, FileNotFoundException, InvalidFileExtensionException {
     try {
       File file = new File(filePath);
@@ -77,13 +78,13 @@ public String uploadApp(String filePath)
       AppUploadResponse appUploadResponse =
           newRequest(Method.POST, "/upload").body(content).asObject(AppUploadResponse.class);
 
-      if (appUploadResponse.getAppUrl() != null) {
-        return appUploadResponse.getAppUrl();
+      if (appUploadResponse == null || Tools.isStringEmpty(appUploadResponse.getAppUrl())) {
+        throw new AppAutomateException("App upload failed!", 0);
       }
+      return appUploadResponse;
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
-    return null;
   }
 
   /**
@@ -98,38 +99,13 @@ public String uploadApp(String filePath)
    * @return List of {@link Build} objects.
    * @throws AppAutomateException
    */
-  public final List<Build> getBuilds(final BuildStatus status, final int limit)
+  public List<Build> getBuilds(final BuildStatus status, final int limit)
       throws AppAutomateException {
-    BrowserStackRequest httpRequest;
     try {
-      httpRequest = newRequest(Method.GET, "/builds.json");
+      return super.getBuilds(status, limit);
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
-
-    if (limit > 0) {
-      httpRequest.queryString(Constants.Filter.LIMIT, limit);
-    }
-
-    if (status != null) {
-      httpRequest.queryString(Constants.Filter.FILTER, status.name().toLowerCase());
-    }
-
-    List<BuildNode> buildNodes;
-    try {
-      buildNodes = Arrays.asList(httpRequest.asObject(BuildNode[].class));
-    } catch (BrowserStackException e) {
-      throw new AppAutomateException(e);
-    }
-
-    final List<Build> builds = new ArrayList<Build>();
-    for (BuildNode buildNode : buildNodes) {
-      if (buildNode != null && buildNode.getBuild() != null) {
-        builds.add(buildNode.getBuild().<Build>setClient(this));
-      }
-    }
-
-    return builds;
   }
 
   /**
@@ -142,7 +118,7 @@ public final List<Build> getBuilds(final BuildStatus status, final int limit)
    * @return List of {@link Build} objects.
    * @throws AppAutomateException
    */
-  public final List<Build> getBuilds() throws AppAutomateException {
+  public List<Build> getBuilds() throws AppAutomateException {
     return getBuilds(null, 0);
   }
 
@@ -157,7 +133,7 @@ public final List<Build> getBuilds() throws AppAutomateException {
    * @return List of {@link Build} objects.
    * @throws AppAutomateException
    */
-  public final List<Build> getBuilds(final int limit) throws AppAutomateException {
+  public List<Build> getBuilds(final int limit) throws AppAutomateException {
     return getBuilds(null, limit);
   }
 
@@ -172,7 +148,7 @@ public final List<Build> getBuilds(final int limit) throws AppAutomateException
    * @return List of {@link Build} objects.
    * @throws AppAutomateException
    */
-  public final List<Build> getBuilds(final BuildStatus status) throws AppAutomateException {
+  public List<Build> getBuilds(final BuildStatus status) throws AppAutomateException {
     return getBuilds(status, 0);
   }
 
@@ -184,18 +160,9 @@ public final List<Build> getBuilds(final BuildStatus status) throws AppAutomateE
    * @throws BuildNotFound
    * @throws AppAutomateException
    */
-  public final Build getBuild(final String buildId) throws BuildNotFound, AppAutomateException {
+  public Build getBuild(final String buildId) throws BuildNotFound, AppAutomateException {
     try {
-      BuildNode buildNode = newRequest(Method.GET, "/builds/{buildId}.json")
-          .routeParam("buildId", buildId).asObject(BuildNode.class);
-
-      if (buildNode == null) {
-        throw new BuildNotFound("Build not found: " + buildId);
-      }
-
-      return buildNode.getBuild().setClient(this);
-    } catch (BrowserStackObjectNotFound e) {
-      throw new BuildNotFound("Build not found: " + buildId);
+      return super.getBuild(buildId);
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
@@ -208,13 +175,9 @@ public final Build getBuild(final String buildId) throws BuildNotFound, AppAutom
    * @return true or false based on successful deletion of the build.
    * @throws AppAutomateException
    */
-  public final boolean deleteBuild(final String buildId) throws AppAutomateException {
+  public boolean deleteBuild(final String buildId) throws AppAutomateException {
     try {
-      ObjectNode result = newRequest(BrowserStackClient.Method.DELETE, "/builds/{buildId}.json")
-          .routeParam("buildId", buildId).asJsonObject();
-
-      String status = (result != null) ? result.path("status").asText() : null;
-      return (status != null && status.equals("ok"));
+      return super.deleteBuild(buildId);
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
@@ -230,42 +193,13 @@ public final boolean deleteBuild(final String buildId) throws AppAutomateExcepti
    * @throws BuildNotFound
    * @throws AppAutomateException
    */
-  public final List<Session> getSessions(final String buildId, final BuildStatus status,
-      final int limit) throws BuildNotFound, AppAutomateException {
-
-    BrowserStackRequest httpRequest = null;
-    try {
-      httpRequest =
-          newRequest(Method.GET, "/builds/{buildId}/sessions.json").routeParam("buildId", buildId);
-    } catch (BrowserStackException e) {
-      throw new AppAutomateException(e);
-    }
-
-    if (limit > 0) {
-      httpRequest.queryString(Constants.Filter.LIMIT, limit);
-    }
-
-    if (status != null) {
-      httpRequest.queryString(Constants.Filter.FILTER, status);
-    }
-
-    List<SessionNode> sessionNodes;
+  public List<Session> getSessions(final String buildId, final BuildStatus status, final int limit)
+      throws BuildNotFound, AppAutomateException {
     try {
-      sessionNodes = Arrays.asList(httpRequest.asObject(SessionNode[].class));
-    } catch (BrowserStackObjectNotFound e) {
-      throw new BuildNotFound("Build not found: " + buildId);
+      return super.getSessions(buildId, status, limit);
     } catch (BrowserStackException e) {
       throw new AppAutomateException(e);
     }
-
-    List<Session> sessions = new ArrayList<Session>();
-    for (SessionNode sessionNode : sessionNodes) {
-      if (sessionNode != null && sessionNode.getSession() != null) {
-        sessions.add(sessionNode.getSession().<Session>setClient(this));
-      }
-    }
-
-    return sessions;
   }
 
   /**
@@ -276,7 +210,7 @@ public final List<Session> getSessions(final String buildId, final BuildStatus s
    * @throws BuildNotFound
    * @throws AppAutomateException
    */
-  public final List<Session> getSessions(final String buildId)
+  public List<Session> getSessions(final String buildId)
       throws BuildNotFound, AppAutomateException {
     return getSessions(buildId, null, 0);
   }
@@ -290,7 +224,7 @@ public final List<Session> getSessions(final String buildId)
    * @throws BuildNotFound
    * @throws AppAutomateException
    */
-  public final List<Session> getSessions(final String buildId, final int limit)
+  public List<Session> getSessions(final String buildId, final int limit)
       throws BuildNotFound, AppAutomateException {
     return getSessions(buildId, null, limit);
   }
@@ -304,7 +238,7 @@ public final List<Session> getSessions(final String buildId, final int limit)
    * @throws BuildNotFound
    * @throws AppAutomateException
    */
-  public final List<Session> getSessions(final String buildId, final BuildStatus status)
+  public List<Session> getSessions(final String buildId, final BuildStatus status)
       throws BuildNotFound, AppAutomateException {
     return getSessions(buildId, status, 0);
   }

src/main/java/com/browserstack/automate/Automate.java

@@ -27,29 +27,6 @@ public interface Automate {
 
     boolean deleteProject(int projectId) throws AutomateException;
 
-    List<Build> getBuilds(BuildStatus status, int limit) throws AutomateException;
-
-    List<Build> getBuilds(int limit) throws AutomateException;
-
-    List<Build> getBuilds(BuildStatus status) throws AutomateException;
-
-    List<Build> getBuilds() throws AutomateException;
-
-    Build getBuild(String buildId) throws BuildNotFound, AutomateException;
-
-    boolean deleteBuild(String buildId) throws AutomateException;
-
-    List<Session> getSessions(String buildId, BuildStatus status,
-                              int limit) throws BuildNotFound, AutomateException;
-
-    List<Session> getSessions(String buildId) throws BuildNotFound, AutomateException;
-
-    List<Session> getSessions(String buildId, int limit) throws BuildNotFound, AutomateException;
-
-    List<Session> getSessions(String buildId, BuildStatus status) throws BuildNotFound, AutomateException;
-
-    Session getSession(String sessionId) throws SessionNotFound, AutomateException;
-
     Session updateSessionStatus(String sessionId, Map<String, Object> data) throws AutomateException;
 
     Session updateSessionStatus(String sessionId,