Web: Add discord bot integration

[owocki]

Continuation of https://github.com/gitcoinco/web/issues/259

Description

It would be nice to be able to have a discord integration that would notify our team when bounties have been posted to one of our repositories.

What

• An area in my settings where I can specify a discord API key (or key pair)
• an area in the settings where I can define what repos I want discord updates on
• An area in my settings where I can define what channel I want discord updates in

then

Any updates to github that hit maybe_market_to_slack() will also hit my discord channel

Discord API: https://discordapp.com/developers/docs/resources/channel#create-message

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

__This issue now has a funding of 0.12 ETH (80.93 USD @ $674.4/ETH) attached to it.__

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $6,280.11 more funded OSS Work available on the Gitcoin Issue Explorer

[farhaanbukhsh]

Hey I would like to take this up !

[SaptakS]

@farhaanbukhsh You can start work here

[farhaanbukhsh]

So here is what I am thinking about, we can have a config file that stores all the information that you want, since we already have a end point that gets information to hit slack, we can just relay that information and be done with it.

Your thoughts @SaptakS and @owocki

[farhaanbukhsh]

So I saw the slack bot and how it is done, and there is discord library in python this should be straight forward, where there is a setting page to configure all the api keys, channels and all the required information. This can be stored in the Database.

A similar function as maybe_market_to_slack we can have maybe_market_to_discord and we can have it working.

[mbeacom]

I think it might be a good idea for us to move the slack and discord integration types to an Integration model with a FK to Profile, CharField of type choices or integration type models (slack, discord, etc). This will allow us to add more integrations in the future without adding additional fields to Profile and we could just access them via profile.integrations.

[owocki]

A similar function as maybe_market_to_slack we can have maybe_market_to_discord and we can have it working.

yes pls!

I think it might be a good idea for us to move the slack and discord integration types to an Integration model with a FK to Profile, CharField of type choices or integration type models (slack, discord, etc)

I agree with this in princdiple, but unfortunately I didn't fund the bounty to account for the refactor. I vote we let @farhaanbukhsh complete the task as scoped and then update the model as you proposed in a follow on ticket.

[gitcoinbot]

@farhaanbukhsh Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• [x] warning (3 days)
• [ ] auto removal (6 days)

[farhaanbukhsh]

Yeah I am working on it!

[vs77bb]

@farhaanbukhsh Any chance you can submit a WIP PR here soon? We'd like to get this one moving ASAP 👍

[mbeacom]

@farhaanbukhsh If you're not able to pick it up at this time, that's fine! Just Stop Work on the issue if you can.
I can probably put this together in the integration branch I have out. @vs77bb ?

[gitcoinbot]

@farhaanbukhsh Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• [x] warning (3 days)
• [ ] escalation to mods (6 days)

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

@farhaanbukhsh due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

• [x] warning (3 days)
• [x] escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[owocki]

@farhaanbukhsh i am removing you from the task. FYI - you will be blocked from claiming work on Gitcoin for a few weeks due to this abandonment.

[kelvintyb]

@owocki I'm new to Django, but would like to pick this up for learning purposes. Just checking how urgent this feature might be as I do not want to slow down the team while I'm implementing this.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

__Work has been started__.

These users each claimed they can complete the work by 1 month, 1 week ago. Please review their questions below:

1. kelvintyb has started work.
   
   
   
   • Q: I think farhaan's initial approach works for the scope of this feature, will work along those lines without the refactor. Is there a specific branch I should be working off of?
   
   

[thelostone-mc]

@mbeacom any idea on the deadline for this ?

@kelvintyb hey ^_^
master branch is the latest and greatest

[kelvintyb]

@owocki @mbeacom

I was wondering if it would make sense to implement this feature for a webhook URL instead? This would be less fiddly for the user. Compare the process for creating webhooks vs creating a bot. Users wouldn't need to enter a channel name in the free-text field on the gitcoin settings page either, just the webhook url and the repos they want monitored.

On the Discord side of the table, there's no visible difference between a message that originated from a bot or a webhook. See the pic for reference below on how a webhook message looks like.

[kelvintyb]

I have created a WIP PR for this with an implementation for the webhook integration. I would think a webhook is preferable for the use case of sending notifications, but if needed, can revert to a previous commit that's more aligned with a bot integration.

[mbeacom]

👍 for the webhook integration.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

__Work for 0.12 ETH (69.21 USD @ $576.76/ETH) has been submitted by__:

1. @kelvintyb

@owocki please take a look at the submitted work:

• PR by @kelvintyb

---

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
  $29,029.53 more funded OSS Work available on the Gitcoin Issue Explorer

[kelvintyb]

@owocki btw if there's any additional work for this particular feature to bring it up to feature parity with the slack integration (e.g. a Test button for users to manually trigger the webhook, auto-setting of the gitcoin discord bot's profile pic on creation), I would be keen to work on those too. A really good experience with this platform so far! :)

[owocki]

PR looks good to me. @mbeacom once you 👍 i will approve and lets merge it.

@kelvintyb heres a issue scope for the scope you suggested. look ok? https://github.com/gitcoinco/web/issues/1434

[mbeacom]

This should be good for payout! Thanks again @kelvintyb !

[kelvintyb]

Thanks @mbeacom, appreciate it!

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

__The funding of 0.12 ETH (56.75 USD @ $472.88/ETH) attached to this issue has been approved & issued to @kelvintyb.__

• Learn more at on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $19,033.61 more funded OSS Work available on the Gitcoin Issue Explorer