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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
import logging
import random
import re
import typing as t
import discord
from discord.ext import commands
from bot.constants import Channels, Colours, ERROR_REPLIES, Emojis, Tokens, WHITELISTED_CHANNELS
from bot.utils.decorators import override_in_channel
log = logging.getLogger(__name__)
BAD_RESPONSE = {
404: "Issue/pull request not located! Please enter a valid number!",
403: "Rate limit has been hit! Please try again later!"
}
MAX_REQUESTS = 10
REQUEST_HEADERS = dict()
if GITHUB_TOKEN := Tokens.github:
REQUEST_HEADERS["Authorization"] = f"token {GITHUB_TOKEN}"
class Issues(commands.Cog):
"""Cog that allows users to retrieve issues from GitHub."""
def __init__(self, bot: commands.Bot):
self.bot = bot
async def fetch_issues(
self,
numbers: set,
repository: str,
user: str
) -> t.Union[str, list]:
"""Retrieve issue(s) from a GitHub repository."""
links = []
if not numbers:
return "Numbers not found."
if len(numbers) > MAX_REQUESTS:
return "Max requests hit."
for number in numbers:
url = f"https://api.github.com/repos/{user}/{repository}/issues/{number}"
merge_url = f"https://api.github.com/repos/{user}/{repository}/pulls/{number}/merge"
log.trace(f"Querying GH issues API: {url}")
async with self.bot.http_session.get(url, headers=REQUEST_HEADERS) as r:
json_data = await r.json()
if r.status in BAD_RESPONSE:
log.warning(f"Received response {r.status} from: {url}")
return f"[{str(r.status)}] #{number} {BAD_RESPONSE.get(r.status)}"
# The initial API request is made to the issues API endpoint, which will return information
# if the issue or PR is present. However, the scope of information returned for PRs differs
# from issues: if the 'issues' key is present in the response then we can pull the data we
# need from the initial API call.
if "issues" in json_data.get("html_url"):
if json_data.get("state") == "open":
icon_url = Emojis.issue
else:
icon_url = Emojis.issue_closed
# If the 'issues' key is not contained in the API response and there is no error code, then
# we know that a PR has been requested and a call to the pulls API endpoint is necessary
# to get the desired information for the PR.
else:
log.trace(f"PR provided, querying GH pulls API for additional information: {merge_url}")
async with self.bot.http_session.get(merge_url) as m:
if json_data.get("state") == "open":
icon_url = Emojis.pull_request
# When the status is 204 this means that the state of the PR is merged
elif m.status == 204:
icon_url = Emojis.merge
else:
icon_url = Emojis.pull_request_closed
issue_url = json_data.get("html_url")
links.append([icon_url, f"[{repository}] #{number} {json_data.get('title')}", issue_url])
return links
@staticmethod
def get_embed(result: list, user: str = "python-discord", repository: str = "") -> discord.Embed:
"""Get Response Embed."""
description_list = ["{0} [{1}]({2})".format(*link) for link in result]
resp = discord.Embed(
colour=Colours.bright_green,
description='\n'.join(description_list)
)
resp.set_author(name="GitHub", url=f"https://github.com/{user}/{repository}")
return resp
@commands.command(aliases=("pr",))
@override_in_channel(WHITELISTED_CHANNELS + (Channels.dev_contrib, Channels.dev_branding))
async def issue(
self,
ctx: commands.Context,
numbers: commands.Greedy[int],
repository: str = "sir-lancebot",
user: str = "python-discord"
) -> None:
"""Command to retrieve issue(s) from a GitHub repository."""
print(numbers)
result = await self.fetch_issues(set(numbers), repository, user)
if result == "Numbers not found.":
await ctx.invoke(self.bot.get_command('help'), 'issue')
elif result == "Max requests hit.":
embed = discord.Embed(
title=random.choice(ERROR_REPLIES),
color=Colours.soft_red,
description=f"Too many issues/PRs! (maximum of {MAX_REQUESTS})"
)
await ctx.send(embed=embed)
elif isinstance(result, list):
# Issue/PR format: emoji to show if open/closed/merged, number and the title as a singular link.
resp = self.get_embed(result, user, repository)
await ctx.send(embed=resp)
elif isinstance(result, str):
await ctx.send(result)
@commands.Cog.listener()
async def on_message(self, message: discord.Message) -> None:
"""Command to retrieve issue(s) from a GitHub repository using automatic linking if matching <repo>#<issue>."""
message_repo_issue_map = re.findall(r".+?(bot|meta|sir-lancebot|logcord)#(\d+)", message.content)
links = []
if message_repo_issue_map:
for repo_issue in message_repo_issue_map:
result = await self.fetch_issues({repo_issue[1]}, repo_issue[0], "python-discord")
if isinstance(result, list):
links.append(*result)
if not links:
return
resp = self.get_embed(links, "python-discord")
await message.channel.send(embed=resp)
def setup(bot: commands.Bot) -> None:
"""Cog Retrieves Issues From Github."""
bot.add_cog(Issues(bot))
|
