Create embed type.

This commit is contained in:
SeanOMik 2020-06-20 01:20:58 -05:00
parent 24fea025a1
commit 8fb6fda602
No known key found for this signature in database
GPG Key ID: FA4D55AC05268A88
1 changed files with 165 additions and 0 deletions

165
src/embed.nim Normal file
View File

@ -0,0 +1,165 @@
import json
type
Embed* = ref object
embedJson: JsonNode
EmbedFieldException* = object of CatchableError
proc setTitle*(embed: var Embed, title: string): Embed =
## Set the title of the embed.
##
## Contstraints:
## * `title` must be set and cannot be larger than 256 characters.
if (title.len < 0 or title.len > 256):
raise newException(EmbedFieldException, "Embed title can only be 0-256 characters")
embed.embedJson.add("title", %title)
return embed
proc setDescription*(embed: var Embed, description: string): Embed =
## Set the description of the embed.
##
## Contstraints:
## * `description` must be set and cannot be larger than 2048 characters.
if (description.len < 0 or description.len > 2048):
raise newException(EmbedFieldException, "Embed description can only be 0-2048 characters")
embed.embedJson.add("description", %description)
return embed
proc setURL*(embed: var Embed, url: string): Embed =
## Set the url of the embed.
embed.embedJson.add("url", %url)
return embed
proc setTimestamp*(embed: var Embed, timestamp: string): Embed =
## Set the timestamp of the embed.
## The timestamp is in `ISO8601` format.
embed.embedJson.add("timestamp", %timestamp)
return embed
proc setColor*(embed: var Embed, color: uint): Embed =
## Set the color of the embed.
embed.embedJson.add("color", %color)
return embed
proc setFooter*(embed: var Embed, text: string, iconURL: string = "", proxyIconURL: string = ""): Embed =
## Set the footer of the embed.
## The `text` field cannot be longer than 2048 characters.
## The `proxyIconURL` field is the proxied url for the footer icon.
##
## Contstraints:
## * `text` must be set and cannot be larger than 2048 characters.
if (text.len < 0 or text.len > 2048):
raise newException(EmbedFieldException, "Embed's footer text can only be 0-2048 characters")
let footer = %* {
"text": text,
"icon_url": iconURL,
"proxy_icon_url": proxyIconURL
}
embed.embedJson.add("footer", footer)
return embed
proc setImage*(embed: var Embed, url: string, proxyIconURL: string = "", height: int = -1, width: int = -1): Embed =
## Set the image of the embed.
## The `proxyIconURL` field is the proxied url for the image.
var image = %* {
"url": url,
"proxy_icon_url": proxyIconURL
}
if (height != -1):
image.add("height", %height)
if (width != -1):
image.add("width", %width)
embed.embedJson.add("image", image)
return embed
proc setThumbnail*(embed: var Embed, url: string, proxyIconURL: string = "", height: int = -1, width: int = -1): Embed =
## Set the thumbnail of the embed.
## The `proxyIconURL` field is the proxied url for the thumbnail.
var thumbnail = %* {
"url": url,
"proxy_icon_url": proxyIconURL
}
if (height != -1):
thumbnail.add("height", %height)
if (width != -1):
thumbnail.add("width", %width)
embed.embedJson.add("thumbnail", thumbnail)
return embed
proc setVideo*(embed: var Embed, url: string, height: int = -1, width: int = -1): Embed =
## Set the video of the embed.
var video = %* {
"url": url
}
if (height != -1):
video.add("height", %height)
if (width != -1):
video.add("width", %width)
embed.embedJson.add("video", video)
return embed
proc setProvider*(embed: var Embed, name: string, url: string = ""): Embed =
## Set the embed's provider.
let provider = %* {
"name": name,
"url": url
}
embed.embedJson.add("provider", provider)
return embed
proc setAuthor*(embed: var Embed, name: string, url: string = "", iconURL: string = "", proxyIconURL: string = ""): Embed =
## Set the embed's author.
## The `url` field referes to the url of the author.
##
## Contstraints:
## * `name` cannot be larger than 256 characters
if (name.len < 0 or name.len > 256):
raise newException(EmbedFieldException, "Embed's author name can only be 0-256 characters")
let author = %* {
"name": name,
"url": url,
"icon_url": iconURL,
"proxy_icon_url": proxyIconURL
}
embed.embedJson.add("author", author)
return embed
proc addField*(embed: var Embed, name: string, value: string, inline: bool = false): Embed =
## Add an embed field.
##
## Contstraints:
## * `name` must be set and cannot be larger than 256 characters
## * `value` must be set and cannot be larger than 1024 characters
if (name.len == 0 or value.len == 0):
raise newException(EmbedFieldException, "Embed's field name or values must be set")
elif (name.len > 256):
raise newException(EmbedFieldException, "Embed's field name can only be 0-256 characters")
elif (value.len > 1024):
raise newException(EmbedFieldException, "Embed's field value can only be 0-1024 characters")
let field = %* {
"name": name,
"value": value,
"inline": inline
}
if embed.embedJson.contains("fields"):
if (embed.embedJson["fields"].len > 25):
raise newException(EmbedFieldException, "Embeds can only have upto 25 fields")
embed.embedJson["fields"].add(field)
else:
embed.embedJson.add("fields", %*[field])