aboutsummaryrefslogtreecommitdiffstats
path: root/bot/seasons/evergreen/issues.py
blob: b32b8548c976fc4f01677b80158c1a441978591d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
import logging

import discord
from discord.ext import commands

from bot.constants import Colours, Emojis
from bot.decorators import override_in_channel

log = logging.getLogger(__name__)

ICONS = {"ISSUE": Emojis.issue,
         "ISSUE_CLOSED": Emojis.issue_closed,
         "PULL_REQUEST": Emojis.pull_request,
         "PULL_REQUEST_CLOSED": Emojis.pull_request_closed,
         "MERGE": Emojis.merge}

RESP_VALUE = {404: "Issue/pull request not located! Please enter a valid number!",
              403: "Rate limit has been hit! Please try again later!"}


class Issues(commands.Cog):
    """Cog that allows users to retrieve issues from GitHub."""

    def __init__(self, bot: commands.Bot):
        self.bot = bot

    @commands.command(aliases=("pr",))
    @override_in_channel()
    async def issue(self, ctx: commands.Context, number: int, repository: str = "seasonalbot",
                    user: str = "python-discord") -> None:
        """Command to get issues/pull request from GitHub."""
        url = f"https://api.github.com/repos/{user}/{repository}/issues/{number}"
        mergeURL = f"https://api.github.com/repos/{user}/{repository}/pulls/{number}/merge"

        async with self.bot.http_session.get(url) as r:
            json_data = await r.json()

        if r.status in RESP_VALUE:
            return await ctx.send(f"[{str(r.status)}] {RESP_VALUE.get(r.status)}")
        # the original call is made to the issues API endpoint
        # if a issue or PR exists then there will be something returned
        # if the word 'issues' is present within the response then we can simply pull the data we need from the
        # return data received from the API
        if "issues" in json_data.get("html_url"):
            if json_data.get("state") == "open":
                iconURL = ICONS.get("ISSUE")
            else:
                iconURL = ICONS.get("ISSUE_CLOSED")
        # if the word 'issues' is not contained within the returned data and there is no error code then we know that
        # the requested data is a pr, hence to get the specifics on it we have to call the PR API endpoint allowing us
        # to get the specific information in relation to the PR that is not provided via the issues endpoint
        else:
            async with self.bot.http_session.get(mergeURL) as m:
                if json_data.get("state") == "open":
                    iconURL = ICONS.get("PULL_REQUEST")
                # when the status is 204 this means that the state of the PR is merged
                elif m.status == 204:
                    iconURL = ICONS.get("MERGE")
                # else by the process of elimination, the pull request has been closed
                else:
                    iconURL = ICONS.get("PULL_REQUEST_CLOSED")

        issue_url = json_data.get("html_url")
        description_text = f"[{repository}] #{number} {json_data.get('title')}"
        resp = discord.Embed(
            colour=Colours.bright_green,
            description=f"{iconURL} [{description_text}]({issue_url})"
        )
        resp.set_author(name="GitHub", url=issue_url)
        await ctx.send(embed=resp)


def setup(bot: commands.Bot) -> None:
    """Cog Retrieves Issues From Github."""
    bot.add_cog(Issues(bot))
    log.info("Issues cog loaded")