Feature/poet 61 query issues based on status

client/scripts/bot.js

@@ -6,7 +6,7 @@
 
   module.exports = function (robot) {
 
-    return robot.hear(/[A-Za-z] (.*)/i, function (res) {
+    return robot.hear(/poet-slack-bot (.*)/i, function (res) {
 
       if (jiraIgnoreUsers && res.envelope.user.name.match(new RegExp(jiraIgnoreUsers, "gi"))) {
         return;
@@ -15,6 +15,10 @@
       var message = res.match[1];
 
       httpRequest().doGET(message).then(function (response) {
+        /*
+        The response type is not checked here as we want the BOT
+        to respond back to the user whenever a question is asked.
+        */
         if (response) {
             return res.send("@" + res.envelope.user.name + " " + response.message);
 
@@ -26,8 +30,6 @@
 
 }).call(this);
 
-///
-
 
 // Connect to JIRA through httprequest
 

server/app/controllers/Application.java

@@ -2,8 +2,7 @@
 
 import play.libs.ws.WSClient;
 import play.mvc.*;
-
-import services.queryHandler.QueryHandler;
+import services.ServicesManager;
 
 import javax.inject.Inject;
 import java.io.IOException;
@@ -12,18 +11,19 @@
 
 public class Application extends Controller {
 
-  @Inject
-  WSClient ws;
+    @Inject
+    WSClient ws;
 
-  public Result index() {
-    return ok("Hi!");
-  }
+    public Result index() {
+        return ok("Hi!");
+    }
 
-  public CompletionStage<Result> getAnwser(String query) throws IOException,
-    ClassNotFoundException, NoSuchMethodException,
-    InvocationTargetException, IllegalAccessException {
+    public CompletionStage<Result> show(String query)
+            throws IOException, ClassNotFoundException,
+            NoSuchMethodException, InvocationTargetException,
+            IllegalAccessException {
 
-    QueryHandler queryHandler = new QueryHandler(query, ws);
-    return queryHandler.handleQuery();
-  }
+        ServicesManager servicesManager = new ServicesManager(ws);
+        return servicesManager.interpretQueryAndActOnJira(query);
+    }
 }

server/app/models/JiraAuth.java

@@ -0,0 +1,15 @@
+package models;
+
+/**
+ * @author dxli
+ */
+
+public class JiraAuth {
+    public String username;
+    public String password;
+
+    public JiraAuth(String username, String password) {
+        this.username = username;
+        this.password = password;
+    }
+}

server/app/models/LuisResponse.java

@@ -0,0 +1,18 @@
+package models;
+
+/**
+ * @author sabinapokhrel
+ *
+ */
+
+public class LuisResponse {
+    public String intent;
+    public String entityType;
+    public String entityName;
+
+    public LuisResponse(String intent, String entityType, String entityName) {
+        this.intent = intent;
+        this.entityType = entityType;
+        this.entityName = entityName;
+    }
+}

server/app/models/ResponseToClient.java

@@ -0,0 +1,16 @@
+package models;
+
+/**
+ * @author sabinapokhrel
+ *
+ */
+
+public class ResponseToClient {
+    public String status;
+    public String message;
+
+    public ResponseToClient(String status, String message) {
+        this.status = status;
+        this.message = message;
+    }
+}

server/app/modules/PoetModule.java

@@ -0,0 +1,7 @@
+package modules;
+
+/**
+ * Created by dxli on 30/03/17.
+ */
+public class PoetModule {
+}

server/app/services/JiraReaderService.java

@@ -0,0 +1,264 @@
+package services;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import models.JiraAuth;
+import models.ResponseToClient;
+import play.libs.Json;
+import play.libs.ws.WSAuthScheme;
+import play.libs.ws.WSClient;
+import play.libs.ws.WSRequest;
+import play.libs.ws.WSResponse;
+import utils.ConfigUtilities;
+
+import java.util.concurrent.CompletionStage;
+
+/**
+ * The class is for all "reading actions" on JIRA.
+ * Extracting fields from raw response on need.
+ */
+public class JiraReaderService {
+  private String messageToReturn;
+  private WSClient ws;
+  private JiraAuth jiraAuth;
+
+
+  public JiraReaderService(WSClient ws, JiraAuth jiraAuth) {
+    this.ws = ws;
+    this.jiraAuth = jiraAuth;
+  }
+
+  /**
+   * To request for JIRA ticket info page via REST API. A non-blocking call.
+   *
+   * @param ticketId ticket ID in string.
+   * @return info page encoded in JSON.
+   */
+  public CompletionStage<JsonNode> fetchTicketByApi(String ticketId) {
+
+    System.out.println(ConfigUtilities.getString("jira.baseUrl")
+      + ConfigUtilities.getString("jira.issueEndpoint")
+      + ticketId);
+
+    WSRequest request = ws.url(ConfigUtilities.getString("jira.baseUrl")
+      + ConfigUtilities.getString("jira.issueEndpoint")
+      + ticketId);
+    WSRequest complexRequest = request.setAuth(jiraAuth.username, jiraAuth.password, WSAuthScheme.BASIC);
+
+    return complexRequest.get().thenApply(WSResponse::asJson);
+  }
+
+  /**
+   * To request information based on username via REST API. A non-blocking call.
+   *
+   * @param jiraUsername jira username in string.
+   * @return info page encoded in JSON.
+   */
+  public CompletionStage<JsonNode> fetchAssigneeInfoByApi(String jiraUsername) {
+
+    WSRequest request = ws.url("https://jira.agiledigital.com.au/rest/api/2/search")
+      .setQueryParameter("jql", "assignee=" + jiraUsername + " and status='in progress'");
+    WSRequest complexRequest = request.setAuth(jiraAuth.username, jiraAuth.password, WSAuthScheme.BASIC);
+    return complexRequest.get().thenApply(WSResponse::asJson);
+  }
+
+  /**
+   * To request information based on status via REST API. A non-blocking call.
+   *
+   * @param status status of issue in string.
+   * @return info page encoded in JSON.
+   */
+  public CompletionStage<JsonNode> fetchIssuesForStatusByApi(String status) {
+
+    WSRequest request = ws.url("https://jira.agiledigital.com.au/rest/api/2/search")
+      .setQueryParameter("jql", "status='" + status +"'");
+    WSRequest complexRequest = request.setAuth(jiraAuth.username, jiraAuth.password, WSAuthScheme.BASIC);
+    return complexRequest.get().thenApply(WSResponse::asJson);
+  }
+
+  /**
+   * //TODO : comment this.
+   *
+   * @param response
+   * @param intent
+   * @param entity
+   * @return
+   */
+  public JsonNode read(JsonNode response, String intent, String entity) {
+    Boolean isSuccess = false;
+    System.out.println(intent + " " + entity);
+    switch (intent) {
+      case "IssueDescription":
+        isSuccess = readDescription(entity, response);
+        break;
+      case "IssueAssignee":
+        isSuccess = readAssignee(entity, response);
+        break;
+      case "IssueStatus":
+        isSuccess = readStatus(entity, response);
+        break;
+      case "AssigneeIssues":
+        isSuccess = readIssues(entity, response);
+        break;
+      case "IssuesForStatus":
+        isSuccess = readIssuesForStatus(entity, response);
+        break;
+    }
+
+    if (isSuccess) {
+      return Json.toJson(new ResponseToClient(JiraServiceProvider.REQUEST_SUCCESS, messageToReturn));
+    } else {
+      return Json.toJson(new ResponseToClient(JiraServiceProvider.REQUEST_FAILURE,
+        ConfigUtilities.getString("error-message.issue-not-found")));
+    }
+  }
+
+  /**
+   * This method reads assignee of the ticket.
+   *
+   * @param ticketNo     is the IssueID of type string which was mentioned in the query by the user.
+   * @param responseBody is the JSON object received from JIRA Rest API.
+   * @return true if success, otherwise if no such ticket exists, false.
+   */
+  private Boolean readAssignee(String ticketNo, JsonNode responseBody) {
+    if (responseBody.get("errorMessages") != null) {
+      return false;
+    } else {
+      this.messageToReturn = responseBody.get("fields").get("assignee").get("displayName").textValue()
+        + " is working on "
+        + ticketNo + ".";
+      return true;
+    }
+  }
+
+  /**
+   * This method reads description of the ticket.
+   *
+   * @param responseBody is the JSON object received from JIRA Rest API.
+   * @return true if success, otherwise if no such ticket exists, false.
+   */
+  private Boolean readDescription(String ticketNo, JsonNode responseBody) {
+    if (responseBody.get("errorMessages") != null) {
+      return false;
+    } else {
+      this.messageToReturn = hyperlinkTicketNo("Description of "
+        //  + '<' + "http://google.com" +'|' +ticketNo+  '>' // replace google by the actual ticket page
+        + ticketNo
+        + " is as follows: \n"
+        + responseBody.get("fields").get("description").textValue());
+
+      return true;
+    }
+  }
+
+  /**
+   * This method reads status of the ticket.
+   *
+   * @param ticketNo     is the IssueID of type string which was mentioned in the query by the user.
+   * @param responseBody is the JSON object received from JIRA Rest API.
+   * @return true if success, otherwise if no such ticket exists, false.
+   */
+  private Boolean readStatus(String ticketNo, JsonNode responseBody) {
+    if (responseBody.get("errorMessages") != null) {
+      return false;
+    } else {
+      this.messageToReturn = hyperlinkTicketNo("The status of "
+        + ticketNo
+        + " is "
+        + responseBody.get("fields").get("status").get("name").textValue());
+      return true;
+    }
+  }
+
+  /**
+   * This method reads status of the ticket.
+   *
+   * @param assignee is the username of assignee of type string which was mentioned in the query by the user.
+   * @param responseBody is the JSON object received from JIRA Rest API.
+   * @return true if success, otherwise if no such ticket exists, false.
+   */
+  private Boolean readIssues(String assignee, JsonNode responseBody) {
+    if (responseBody.get("errorMessages") != null) {
+      return false;
+    } else {
+      int issueCount = Integer.parseInt(responseBody.get("total").toString());
+      if (issueCount > 0) {
+        StringBuffer issues = new StringBuffer();
+        for (int i = 0, j = 0; i < issueCount; i++) {
+          String string = responseBody.get("issues").findValues("key").get(j).textValue();
+          StringBuffer tmp;
+          if (i < issueCount - 1)
+            tmp = new StringBuffer(string + ", ");
+          else
+            tmp = new StringBuffer(string + ".");
+          issues.append(tmp);
+          j = j + 6;
+        }
+        this.messageToReturn = hyperlinkTicketNo(assignee + " is working on " + issues.toString());
+      } else {
+        this.messageToReturn = assignee + " is currently not working on any issue.";
+      }
+    }
+    return true;
+  }
+
+  /**
+   * This method reads status of the ticket.
+   *
+   * @param assignee is the username of assignee of type string which was mentioned in the query by the user.
+   * @param responseBody is the JSON object received from JIRA Rest API.
+   * @return true if success, otherwise if no such ticket exists, false.
+   */
+  private Boolean readIssuesForStatus(String status, JsonNode responseBody) {
+    System.out.println(responseBody);
+    if (responseBody.get("errorMessages") != null) {
+      return false;
+    } else {
+      //System.out.println(responseBody);
+      int issueCount = Integer.parseInt(responseBody.get("total").toString());
+      if (issueCount > 0) {
+        StringBuffer issues = new StringBuffer();
+        for (int i = 0, j = 0; i < issueCount; i++) {
+          String string = responseBody.get("issues").findValues("key").get(j).textValue();
+          StringBuffer tmp;
+          if (i < issueCount - 1)
+            tmp = new StringBuffer(string + ", ");
+          else
+            tmp = new StringBuffer(string + ".");
+          issues.append(tmp);
+          j = j + 6;
+        }
+        this.messageToReturn = hyperlinkTicketNo(status + " issues are " + issues.toString());
+      } else {
+        this.messageToReturn = "There are no issues " + status + ".";
+      }
+    }
+    return true;
+  }
+
+
+
+
+  /**
+   * The methods hyperlinks the ticket number appearing in the
+   * description, or actually, any string fed into. This is implemented
+   * by first checking the project name configured in the application.conf
+   * and then use the slack formatting to wrap around the ticket number.
+   *
+   * @param issueDescription the description of the ticket queried.
+   *                         This can also be applied to any other strings.
+   * @return the issue description after formatting. This
+   * should hyperlink the ticket numbers appearing in
+   * the input string.
+   * @Reference: https://api.slack.com/docs/message-formatting
+   */
+  private static String hyperlinkTicketNo(String issueDescription) {
+    String jiraIssueName = ConfigUtilities.getString("jira.issueName");
+    String pattern = "((?i)" + jiraIssueName + "-\\d+)";
+    String issueUrl = ConfigUtilities.getString("jira.baseUrl") + "/browse/";
+    String hyperlink = "<" + issueUrl + "$1|$1>";
+
+    issueDescription = issueDescription.replaceAll(pattern, hyperlink);
+    return issueDescription;
+  }
+
+}