Merge pull request #16 from uw-asa/shadowimmage/issue10

v.2.4.0 - Add "now" command

Author: shadowimmage

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## Version 2.4.0
+
+### Feature added: "now" command suffix
+
+Users can now ask for exactly what is happening at the time of command invocation by suffixing the room number with "now". This returns one of several kinds of message: If there is one event (or multiple cross listed events) then they will be returned to the user, along with the overall day's totals. If all events are in the future/past in relation to "now", then the returned info will say how long until the next event is, or how long since the last event ended (and what those events are). Finally, if "now" is a break in between events, then the command will return both the preceding and succeeding events are and how long it will be until the next event.
+
 ## Version 2.3.7
 
 ### Dependencies

README.md

@@ -10,6 +10,7 @@ From within any Slack channel where the integration has been enabled, the follow
 
 - `/r25 help`
 - `/r25 [building code] [room number]`
+- `/r25 [building code] [room number] now`
 - `/r25 [building code] [room number] tomorrow`
 - `/r25 [building code] [room number] +1`
 - `/r25 [building code] [room number] +2`
@@ -88,6 +89,10 @@ Automated testing implemented with [Mocha](https://mochajs.org/), [Chai](http://
 
 > `npm run test`
 
+#### Code Coverage
+
+> `npm run coverage`
+
 #### Github Actions
 
 Automated testing enabled on github actions. Secrets are saved on github under the repository settings and are retrieved at runtime by the test runner environment.

handler.js

@@ -2,15 +2,17 @@
 
 /* AWS Lambda function handler.js
  * Chase Sawyer
- * University of Washington, 2018
+ * University of Washington, 2018-2020
  * 
  * Defines two Lambda functions that make up two halves of the UW-SlackR25Bot slash command, '/r25'.
  * The parse handler parses an incoming Slack slash command through the AWS Gateway, and processes/validates
  * it. The parse handler ends with a confirmation to Slack that the command was received/processed, and if
  * the command is valid, will fire off a SNS message that will trigger the second Lambda function.
  * The getTimes handler is triggered by the SNS message and takes the processed JSON command and response 
  * URL in it's event parameter. It fires off a function to the r25ws function which contacts the web service
- * to fulfill the command.
+ * to fulfill the command. The results from the R25 web service are then handed to a post-processing utility
+ * in r25wsResponseHandler.js which will look through the results and give back formatted JSON for the handler
+ * function here to pass back to Slack via postData().
  * 
  * Console is used to log data to AWS CloudWatch by default.
  */
@@ -149,6 +151,7 @@ function getTimes(event, context, callback) {
       command.resolvedCommandText = responseText.text['ERROR-R25WS-DOWN']
       data = responseHandler.processEmpty(command)
     } else {
+      // Here's where processor utilities get called based on the determined command
       if (command.resolvedCommand == 'SCHEDULE') {
         data = responseHandler.processSchedule(results, command)
       } else if (command.resolvedCommand == 'BREAKS') {