pothtonswer/discordmuffin
1
0
Fork 1
Code Issues 2 Pull requests 1 Projects 2 Releases Packages Wiki Activity Actions

Large additions to REST API and Websocket API.

Browse source
This commit is contained in:
Bruce Marriner 2015-11-16 13:05:56 -06:00
parent a3903aaa50
commit 91207ece15
4 changed files with 331 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
guild.go
View file

@ -53,23 +53,9 @@ type Member struct {
Deaf bool `json:"deaf"` Deaf bool `json:"deaf"`
mute bool `json:"mute"` mute bool `json:"mute"`
User User `json:"user"` User User `json:"user"`
Roles []string `json:"roles"` // TODO: See below Roles []string `json:"roles"`
} }
//Roles []string `json:"roles"` // TODO: Should be ints, see below
// Above "Roles" should be an array of ints
// TODO: Figure out how to make it be one.
/*
{
"roles": [
"89544728336416768",
"110429733396676608"
],
}
*/
// Channels returns an array of Channel structures for channels within
// this Server
/* /*
TODO: How to name these? If we make a variable to store TODO: How to name these? If we make a variable to store
channels from READY packet, etc. We can't have a Channel channels from READY packet, etc. We can't have a Channel

367
restapi.go
View file

@ -21,7 +21,12 @@ import (
// Constants of all known Discord API Endpoints // Constants of all known Discord API Endpoints
// Please let me know if you know of any others. // Please let me know if you know of any others.
const ( const (
DISCORD = "http://discordapp.com" STATUS = "https://status.discordapp.com/api/v2/"
SM = STATUS + "scheduled-maintenances/"
SM_ACTIVE = SM + "active.json"
SM_UPCOMING = SM + "upcoming.json"
DISCORD = "http://discordapp.com" // TODO consider removing
API = DISCORD + "/api/" API = DISCORD + "/api/"
GUILDS = API + "guilds/" GUILDS = API + "guilds/"
CHANNELS = API + "channels/" CHANNELS = API + "channels/"
@ -37,14 +42,13 @@ const (
RESET_PASSWORD = AUTH + "reset" RESET_PASSWORD = AUTH + "reset"
REGISTER = AUTH + "register" REGISTER = AUTH + "register"
VOICE = API + "/voice/" VOICE = API + "/voice/"
REGIONS = VOICE + "regions" VOICE_REGIONS = VOICE + "regions"
ICE = VOICE + "ice" VOICE_ICE = VOICE + "ice"
TUTORIAL = API + "tutorial/" TUTORIAL = API + "tutorial/"
TUTORIAL_INDICATORS = TUTORIAL + "indicators" TUTORIAL_INDICATORS = TUTORIAL + "indicators"
INVITE = API + "invite"
TRACK = API + "track" TRACK = API + "track"
SSO = API + "sso" SSO = API + "sso"
REPORT = API + "report" REPORT = API + "report"
@ -53,32 +57,39 @@ const (
// Almost like the constants above :) Except can't be constants // Almost like the constants above :) Except can't be constants
var ( var (
USER = func(userId string) string { return USERS + userId } USER = func(uId string) string { return USERS + uId }
USER_AVATAR = func(userId, hash string) string { return USERS + userId + "/avatars/" + hash + ".jpg" } USER_AVATAR = func(uId, aId string) string { return USERS + uId + "/avatars/" + aId + ".jpg" }
USER_SETTINGS = func(userId string) string { return USERS + userId + "/settings" } USER_SETTINGS = func(uId string) string { return USERS + uId + "/settings" }
USER_GUILDS = func(userId string) string { return USERS + userId + "/guilds" } USER_GUILDS = func(uId string) string { return USERS + uId + "/guilds" }
USER_CHANNELS = func(userId string) string { return USERS + userId + "/channels" } USER_CHANNELS = func(uId string) string { return USERS + uId + "/channels" }
USER_DEVICES = func(userId string) string { return USERS + userId + "/devices" } USER_DEVICES = func(uId string) string { return USERS + uId + "/devices" }
USER_CONNECTIONS = func(userId string) string { return USERS + userId + "/connections" } USER_CONNECTIONS = func(uId string) string { return USERS + uId + "/connections" }
GUILD = func(guildId string) string { return GUILDS + guildId } GUILD = func(gId string) string { return GUILDS + gId }
GUILD_CHANNELS = func(guildId string) string { return GUILDS + guildId + "/channels" } GUILD_INIVTES = func(gId string) string { return GUILDS + gId + "/invites" }
GUILD_MEMBERS = func(guildId string) string { return GUILDS + guildId + "/members" } GUILD_CHANNELS = func(gId string) string { return GUILDS + gId + "/channels" }
GUILD_INTEGRATIONS = func(guildId string) string { return GUILDS + guildId + "/integrations" } GUILD_MEMBERS = func(gId string) string { return GUILDS + gId + "/members" }
GUILD_BANS = func(guildId string) string { return GUILDS + guildId + "/bans" } GUILD_MEMBER_DEL = func(gId, uId string) string { return GUILDS + gId + "/members/" + uId }
GUILD_ROLES = func(guildId string) string { return GUILDS + guildId + "/roles" } GUILD_BANS = func(gId string) string { return GUILDS + gId + "/bans" }
GUILD_INVITES = func(guildId string) string { return GUILDS + guildId + "/invites" } GUILD_BAN = func(gId, uId string) string { return GUILDS + gId + "/bans/" + uId }
GUILD_EMBED = func(guildId string) string { return GUILDS + guildId + "/embed" } GUILD_INTEGRATIONS = func(gId string) string { return GUILDS + gId + "/integrations" }
GUILD_PRUNE = func(guildId string) string { return GUILDS + guildId + "/prune" } GUILD_ROLES = func(gId string) string { return GUILDS + gId + "/roles" }
GUILD_ICON = func(guildId, hash string) string { return GUILDS + guildId + "/icons/" + hash + ".jpg" } GUILD_INVITES = func(gId string) string { return GUILDS + gId + "/invites" }
GUILD_EMBED = func(gId string) string { return GUILDS + gId + "/embed" }
GUILD_PRUNE = func(gId string) string { return GUILDS + gId + "/prune" }
GUILD_ICON = func(gId, hash string) string { return GUILDS + gId + "/icons/" + hash + ".jpg" }
CHANNEL = func(channelId string) string { return CHANNELS + channelId } CHANNEL = func(cId string) string { return CHANNELS + cId }
CHANNEL_MESSAGES = func(channelId string) string { return CHANNELS + channelId + "/messages" } CHANNEL_PERMISSIONS = func(cId string) string { return CHANNELS + cId + "/permissions" }
CHANNEL_PERMISSIONS = func(channelId string) string { return CHANNELS + channelId + "/permissions" } CHANNEL_INVITES = func(cId string) string { return CHANNELS + cId + "/invites" }
CHANNEL_INVITES = func(channelId string) string { return CHANNELS + channelId + "/invites" } CHANNEL_TYPING = func(cId string) string { return CHANNELS + cId + "/typing" }
CHANNEL_TYPING = func(channelId string) string { return CHANNELS + channelId + "/typing" } CHANNEL_MESSAGES = func(cId string) string { return CHANNELS + cId + "/messages" }
CHANNEL_MESSAGE = func(cId, mId string) string { return CHANNELS + cId + "/messages/" + mId }
CHANNEL_MESSAGE_ACK = func(cId, mId string) string { return CHANNELS + cId + "/messages/" + mId + "/ack" }
INTEGRATIONS_JOIN = func(intId string) string { return API + "integrations/" + intId + "/join" } INVITE = func(iId string) string { return API + "invite/" + iId }
INTEGRATIONS_JOIN = func(iId string) string { return API + "integrations/" + iId + "/join" }
) )
// Request makes a (GET/POST/?) Requests to Discord REST API. // Request makes a (GET/POST/?) Requests to Discord REST API.
@ -149,33 +160,6 @@ func (s *Session) Logout() (err error) {
return return
} }
// Gateway returns the a websocket Gateway address
func (s *Session) Gateway() (gateway string, err error) {
response, err := s.Request("GET", GATEWAY, ``)
var temp map[string]interface{}
err = json.Unmarshal(response, &temp)
gateway = temp["url"].(string)
return
}
// VoiceRegions returns the voice server regions
func (s *Session) VoiceRegions() (st []VoiceRegion, err error) {
body, err := s.Request("GET", REGIONS, ``)
err = json.Unmarshal(body, &st)
return
}
// VoiceIce returns the voice server ICE information
func (s *Session) VoiceIce() (st VoiceIce, err error) {
body, err := s.Request("GET", ICE, ``)
err = json.Unmarshal(body, &st)
return
}
/*************************************************************************************************** /***************************************************************************************************
* Functions related to a specific user * Functions related to a specific user
*/ */
@ -189,6 +173,16 @@ func (s *Session) User(userId string) (st User, err error) {
return return
} }
// UserAvatar returns a ?? of a users Avatar
// userId : A user Id or "@me" which is a shortcut of current user ID
func (s *Session) UserAvatar(userId string) (st User, err error) {
u, err := s.User(userId)
_, err = s.Request("GET", USER_AVATAR(userId, u.Avatar), ``)
// TODO need to figure out how to handle returning a file
return
}
// UserSettings returns the settings for a given user // UserSettings returns the settings for a given user
// userId : A user Id or "@me" which is a shortcut of current user ID // userId : A user Id or "@me" which is a shortcut of current user ID
// This seems to only return a result for "@me" // This seems to only return a result for "@me"
@ -209,6 +203,20 @@ func (s *Session) UserChannels(userId string) (st []Channel, err error) {
return return
} }
// UserChannelCreate creates a new User (Private) Channel with another User
// userId : A user Id or "@me" which is a shortcut of current user ID
// recipientId : A user Id for the user to which this channel is opened with.
func (s *Session) UserChannelCreate(userId, recipientId string) (st []Channel, err error) {
body, err := s.Request(
"POST",
USER_CHANNELS(userId),
fmt.Sprintf(`{"recipient_id": "%s"}`, recipientId))
err = json.Unmarshal(body, &st)
return
}
// UserGuilds returns an array of Guild structures for all guilds for a given user // UserGuilds returns an array of Guild structures for all guilds for a given user
// userId : A user Id or "@me" which is a shortcut of current user ID // userId : A user Id or "@me" which is a shortcut of current user ID
func (s *Session) UserGuilds(userId string) (st []Guild, err error) { func (s *Session) UserGuilds(userId string) (st []Guild, err error) {
@ -223,7 +231,7 @@ func (s *Session) UserGuilds(userId string) (st []Guild, err error) {
*/ */
// Guild returns a Guild structure of a specific Guild. // Guild returns a Guild structure of a specific Guild.
// guildId : The ID of the Guild you want returend. // guildId : The ID of a Guild
func (s *Session) Guild(guildId string) (st []Guild, err error) { func (s *Session) Guild(guildId string) (st []Guild, err error) {
body, err := s.Request("GET", GUILD(guildId), ``) body, err := s.Request("GET", GUILD(guildId), ``)
@ -231,6 +239,63 @@ func (s *Session) Guild(guildId string) (st []Guild, err error) {
return return
} }
// GuildCreate creates a new Guild
// name : A name for the Guild (2-100 characters)
func (s *Session) GuildCreate(name string) (st []Guild, err error) {
body, err := s.Request("POST", GUILDS, fmt.Sprintf(`{"name":"%s"}`, name))
err = json.Unmarshal(body, &st)
return
}
// GuildEdit edits a new Guild
// guildId : The ID of a Guild
// name : A name for the Guild (2-100 characters)
func (s *Session) GuildEdit(guildId, name string) (st []Guild, err error) {
body, err := s.Request("POST", GUILD(guildId), fmt.Sprintf(`{"name":"%s"}`, name))
err = json.Unmarshal(body, &st)
return
}
// GuildDelete deletes or leaves a Guild.
// guildId : The ID of a Guild
func (s *Session) GuildDelete(guildId string) (st []Guild, err error) {
body, err := s.Request("DELETE", GUILD(guildId), ``)
err = json.Unmarshal(body, &st)
return
}
// GuildBans returns an array of User structures for all bans of a
// given guild.
// guildId : The ID of a Guild.
func (s *Session) GuildBans(guildId string) (st []User, err error) {
body, err := s.Request("GET", GUILD_BANS(guildId), ``)
err = json.Unmarshal(body, &st)
return
}
// GuildBanAdd bans the given user from the given guild.
// guildId : The ID of a Guild.
// userId : The ID of a User
func (s *Session) GuildBanAdd(guildId, userId string) (err error) {
_, err = s.Request("PUT", GUILD_BAN(guildId, userId), ``)
return
}
// GuildBanDelete removes the given user from the guild bans
// guildId : The ID of a Guild.
// userId : The ID of a User
func (s *Session) GuildBanDelete(guildId, userId string) (err error) {
_, err = s.Request("DELETE", GUILD_BAN(guildId, userId), ``)
return
}
// GuildMembers returns an array of Member structures for all members of a // GuildMembers returns an array of Member structures for all members of a
// given guild. // given guild.
// guildId : The ID of a Guild. // guildId : The ID of a Guild.
@ -241,6 +306,15 @@ func (s *Session) GuildMembers(guildId string) (st []Member, err error) {
return return
} }
// GuildMemberDelete removes the given user from the given guild.
// guildId : The ID of a Guild.
// userId : The ID of a User
func (s *Session) GuildMemberDelete(guildId, userId string) (err error) {
_, err = s.Request("DELETE", GUILD_MEMBER_DEL(guildId, userId), ``)
return
}
// GuildChannels returns an array of Channel structures for all channels of a // GuildChannels returns an array of Channel structures for all channels of a
// given guild. // given guild.
// guildId : The ID of a Guild. // guildId : The ID of a Guild.
@ -252,6 +326,40 @@ func (s *Session) GuildChannels(guildId string) (st []Channel, err error) {
return return
} }
// GuildChannelCreate creates a new channel in the given guild
// guildId : The ID of a Guild.
// name : Name of the channel (2-100 chars length)
// ctype : Tpye of the channel (voice or text)
func (s *Session) GuildChannelCreate(guildId, name, ctype string) (st []Channel, err error) {
body, err := s.Request("POST", GUILD_CHANNELS(guildId), fmt.Sprintf(`{"name":"%s", "type":"%s"}`, name, ctype))
err = json.Unmarshal(body, &st)
return
}
// GuildInvites returns an array of Invite structures for the given guild
// guildId : The ID of a Guild.
func (s *Session) GuildInvites(guildId string) (st []Invite, err error) {
body, err := s.Request("GET", GUILD_INVITES(guildId), ``)
err = json.Unmarshal(body, &st)
return
}
// GuildInviteCreate creates a new invite for the given guild.
// guildId : The ID of a Guild.
// i : An Invite struct with the values MaxAge, MaxUses, Temporary,
// and XkcdPass defined.
func (s *Session) GuildInviteCreate(guildId string, i Invite) (st Invite, err error) {
payload := fmt.Sprintf(
`{"max_age":%d, "max_uses":%d, "temporary":%t, "xkcdpass":%t}`,
i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass)
body, err := s.Request("POST", GUILD_INVITES(guildId), payload)
err = json.Unmarshal(body, &st)
return
}
/*************************************************************************************************** /***************************************************************************************************
* Functions related to a specific channel * Functions related to a specific channel
*/ */
@ -264,6 +372,34 @@ func (s *Session) Channel(channelId string) (st Channel, err error) {
return return
} }
// ChannelEdit edits the given channel
// channelId : The ID of a Channel
// name : The new name to assign the channel.
func (s *Session) ChannelEdit(channelId, name string) (st []Channel, err error) {
body, err := s.Request("PATCH", CHANNEL(channelId), fmt.Sprintf(`{"name":"%s"}`, name))
err = json.Unmarshal(body, &st)
return
}
// ChannelDelete deletes the given channel
// channelId : The ID of a Channel
func (s *Session) ChannelDelete(channelId string) (st []Channel, err error) {
body, err := s.Request("DELETE", CHANNEL(channelId), ``)
err = json.Unmarshal(body, &st)
return
}
// ChannelTyping broadcasts to all members that authenticated user is typing in
// the given channel.
// channelId : The ID of a Channel
func (s *Session) ChannelTyping(channelId string) (err error) {
_, err = s.Request("POST", CHANNEL_TYPING(channelId), ``)
return
}
// ChannelMessages returns an array of Message structures for messaages within // ChannelMessages returns an array of Message structures for messaages within
// a given channel. // a given channel.
// channelId : The ID of a Channel. // channelId : The ID of a Channel.
@ -299,6 +435,15 @@ func (s *Session) ChannelMessages(channelId string, limit int, beforeId int, aft
return return
} }
// ChannelMessageAck acknowledges and marks the given message as read
// channeld : The ID of a Channel
// messageId : the ID of a Message
func (s *Session) ChannelMessageAck(channelId, messageId string) (err error) {
_, err = s.Request("POST", CHANNEL_MESSAGE_ACK(channelId, messageId), ``)
return
}
// ChannelMessageSend sends a message to the given channel. // ChannelMessageSend sends a message to the given channel.
// channelId : The ID of a Channel. // channelId : The ID of a Channel.
// content : The message to send. // content : The message to send.
@ -308,3 +453,113 @@ func (s *Session) ChannelMessageSend(channelId string, content string) (st Messa
err = json.Unmarshal(response, &st) err = json.Unmarshal(response, &st)
return return
} }
// ChannelMessageEdit edits an existing message, replacing it entirely with
// the given content.
// channeld : The ID of a Channel
// messageId : the ID of a Message
func (s *Session) ChannelMessageEdit(channelId, messageId, content string) (st Message, err error) {
response, err := s.Request("PATCH", CHANNEL_MESSAGE(channelId, messageId), fmt.Sprintf(`{"content":"%s"}`, content))
err = json.Unmarshal(response, &st)
return
}
// ChannelMessageDelete deletes a message from the Channel.
func (s *Session) ChannelMessageDelete(channelId, messageId string) (err error) {
_, err = s.Request("DELETE", CHANNEL_MESSAGE(channelId, messageId), ``)
return
}
// ChannelInvites returns an array of Invite structures for the given channel
// channelId : The ID of a Channel
func (s *Session) ChannelInvites(channelId string) (st []Invite, err error) {
body, err := s.Request("GET", CHANNEL_INVITES(channelId), ``)
err = json.Unmarshal(body, &st)
return
}
// ChannelInviteCreate creates a new invite for the given channel.
// channelId : The ID of a Channel
// i : An Invite struct with the values MaxAge, MaxUses, Temporary,
// and XkcdPass defined.
func (s *Session) ChannelInviteCreate(channelId string, i Invite) (st Invite, err error) {
payload := fmt.Sprintf(
`{"max_age":%d, "max_uses":%d, "temporary":%t, "xkcdpass":%t}`,
i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass)
body, err := s.Request("POST", CHANNEL_INVITES(channelId), payload)
err = json.Unmarshal(body, &st)
return
}
/***************************************************************************************************
* Functions related to an invite
*/
// Inivte returns an Invite structure of the given invite
// inviteId : The invite code (or maybe xkcdpass?)
func (s *Session) Invite(inviteId string) (st Invite, err error) {
body, err := s.Request("GET", INVITE(inviteId), ``)
err = json.Unmarshal(body, &st)
return
}
// InviteDelete deletes an existing invite
// inviteId : the code (or maybe xkcdpass?) of an invite
func (s *Session) InviteDelete(inviteId string) (st Invite, err error) {
body, err := s.Request("DELETE", INVITE(inviteId), ``)
err = json.Unmarshal(body, &st)
return
}
// InivteAccept accepts an Invite to a Guild or Channel
// inviteId : The invite code (or maybe xkcdpass?)
func (s *Session) InviteAccept(inviteId string) (st Invite, err error) {
body, err := s.Request("POST", INVITE(inviteId), ``)
err = json.Unmarshal(body, &st)
return
}
// https://discordapi.readthedocs.org/en/latest/reference/guilds/invites.html#get-and-accept-invite
func (s *Session) InviteValidate(validateId string) (i Invite, err error) {
return
}
/***************************************************************************************************
* Functions related to Voice/Audio
*/
// VoiceRegions returns the voice server regions
func (s *Session) VoiceRegions() (st []VoiceRegion, err error) {
body, err := s.Request("GET", VOICE_REGIONS, ``)
err = json.Unmarshal(body, &st)
return
}
// VoiceIce returns the voice server ICE information
func (s *Session) VoiceIce() (st VoiceIce, err error) {
body, err := s.Request("GET", VOICE_ICE, ``)
err = json.Unmarshal(body, &st)
return
}
/***************************************************************************************************
* Functions related to Websockets
*/
// Gateway returns the a websocket Gateway address
func (s *Session) Gateway() (gateway string, err error) {
response, err := s.Request("GET", GATEWAY, ``)
var temp map[string]interface{}
err = json.Unmarshal(response, &temp)
gateway = temp["url"].(string)
return
}

14
structs.go
View file

@ -39,3 +39,17 @@ type IceServer struct {
Username string `json:"username"` Username string `json:"username"`
Credential string `json:"credential"` Credential string `json:"credential"`
} }
type Invite struct {
MaxAge int `json:"max_age"`
Code string `json:"code"`
Guild Guild `json:"guild"`
Revoked bool `json:"revoked"`
CreatedAt string `json:"created_at"` // TODO make timestamp
Temporary bool `json:"temporary"`
Uses int `json:"uses"`
MaxUses int `json:"max_uses"`
Inviter User `json:"inviter"`
XkcdPass bool `json:"xkcdpass"`
Channel Channel `json:"channel"`
}

5
wsapi.go
View file

@ -220,6 +220,11 @@ func (s *Session) event(messageType int, message []byte) (err error) {
s.OnTypingStart(s, st) s.OnTypingStart(s, st)
return return
} }
/* // Never seen this come in but saw it in another Library.
case "MESSAGE_ACK":
if s.OnMessageAck != nil {
}
*/
case "MESSAGE_CREATE": case "MESSAGE_CREATE":
if s.OnMessageCreate != nil { if s.OnMessageCreate != nil {
var st Message var st Message