Activities

1. Create a web server for backend communication
2. Implement authorization process between CollabyBot and GitHub account using GitHub’s OAuth API.
3. Implement authorization process between CollabyBot and Jira account using Jira’s OAuth 2.0
4. Create an event logging process for notifications using MongoDB
5. Configure the bot to handle events in messaging apps
6. Develop an interactive personal task list tool
7. Develop an interactive tool for viewing and scheduling team events/meetings
8. Configure the server to handle POST requests from GitHub and Jira to receive notifications
9. Create the CollabyBot’s slash commands
10. Implement a way for users to configure which GitHub notifications they want to receive

Requirements Gathering

In order to gather requirements for this project, we started by researching a similar app called Axolo which is a Slack-GitHub integrated notification app. We contacted one of the app's developers and scheduled a Zoom meeting to ask questions regarding GitHub OAuth and JSON payloads for configuration files. He provided specific Python libraries and GitHub documentation that would help us and explained how to authorize the Slack app on GitHub.

Second, we created use cases to identify the main features that our app will have and possible ways to implement them.

Third, we did event brainstorming to identify user commands that will trigger certain events in the app. That helped us to identify an approximate timeline of events that users will follow when using our app.

In the future, we plan to keep in touch with the Axolo developer in case we need further help with the technical requirements. We also plan to research the GitHub, Slack, Discord, and Jira API documentation to understand the scope of each API and as guidance when developing CollabyBot.

Top Level Design

1. Create a web server for backend communication
2. Implement authorization process between CollabyBot and GitHub account using GitHub’s OAuth API.
3. Implement authorization process between CollabyBot and Jira account using Jira’s OAuth 2.0
4. Create an event logging process for notifications using MongoDB
5. Configure the bot to handle events in messaging apps
6. Develop an interactive personal task list tool
7. Develop an interactive tool for viewing and scheduling team events/meetings
8. Configure the server to handle POST requests from GitHub and Jira to receive notifications
9. Create the CollabyBot’s slash commands
10. Implement a way for users to configure which GitHub notifications they want to receive

Tests

Our testing process for CollabyBot will consist of functional testing and performance testing.

1. Functional

   • The UnitTest and PyTest Python libraries will be used for testing methods and classes to ensure that the bot functions properly.

2. Performance

   • FunkLoad will be used to perform stress, load, and performance tests on our web server.

Detailed Design

1. Create a web server for backend communication
   1. Web server will handle all GET and POST requests sent by GitHub, Jira, and Slack
2. Implement authorization process between CollabyBot and GitHub account using GitHub’s OAuth API.
   1. Users will be redirected to GitHub OAuth App to enter credentials and grant permission to the CollabyBot
   2. Then they will be redirected back to messaging app upon successful authorization
3. Implement authorization process between CollabyBot and Jira account using Jira’s OAuth 2.0
   1. Users will be redirected to the Jira login page to enter credentials and grant permission to the CollabyBot
   2. Then they will be redirected back to Slack upon successful authorization
4. Create an event logging process for notifications and store them in MongoDB
   1. Every time the web server will get any type of request, it will be recorded in MongoDB
   2. In case of unsuccessful notification delivery, the web server will pull up the event log from the database and resend the notification to the user
   3. New events are sent to the user via the bot and stored in MongoDB. The listener should disconnect after a period of inactivity or if terminated.
   4. A set amount of recent events are cached to be shown to the user upon request without fetching from the database
5. Develop an interactive personal task list tool in messaging app
   1. Users can create a new list by messaging CollabyBot
   2. After creating and naming a list, users can add new tasks with the /todo command
   3. Lists will be made interactive with Block Kit or other UI
6. Develop an interactive tool for viewing and scheduling team events/meetings
   1. User will be able to open the team’s calendar on slack and see scheduled meetings
   2. Whenever the team wants to schedule a meeting
7. Configure the server to handle POST requests from GitHub and Jira to receive notifications
   1. The server domain will have URLs to receive JSON payloads from GitHub and Jira
   2. The URLs will be registered with GitHub and Jira as webhooks
8. Create the CollabyBot’s slash commands
   1. The bot will support slash commands for fetching notifications from GitHub and Jira
      1. Notifications can be filtered by date, the type of event that triggered them, and the username of the user that triggered them
   2. The bot will show all slash commands when the user sends /commands help
   3. Users will be able to use /remind, /search, /invite, and other built-in slack slash commands.
   4. Users will be able to use our custom slash commands such as but not limited to receiving recent tasks in Jira, listing recent pull requests in GitHub and etc.
9. Implement a way for users to configure which GitHub notifications they want to receive
   1. Users can limit notifications to certain event types by messaging CollabyBot
   2. Every time a user wants to change notification types to receive, CollabyBot will send a checklist message with all the GitHub events that will override the user's previous choice.
   3. Users will get a success/fail message from the bot after attempting to change notification settings