Compare commits

..

No commits in common. "main" and "v0.1.0" have entirely different histories.
main ... v0.1.0

9 changed files with 48 additions and 388 deletions

@ -4,11 +4,9 @@ Revoltgo is a go package for writing bots / self-bots in revolt easily.
**NOTE**: This package is still under development and not finished. Create an issue if you found a bug.
**NOTE 2**: This package requires go 1.17.
## Features
- Multiple event listen
- Can listen an event multiple times
- Easy to use
- Supports self-bots
- Simple cache system
@ -20,7 +18,7 @@ Revoltgo is a go package for writing bots / self-bots in revolt easily.
## API Reference
Click [here](https://pkg.go.dev/github.com/5elenay/revoltgo@v0.3.1) for api reference.
Click [here](https://pkg.go.dev/github.com/5elenay/revoltgo@v0.1.0) for api reference.
## Ping Pong Example (Bot)

56
bot.go

@ -1,56 +0,0 @@
package revoltgo
import (
"encoding/json"
"time"
"github.com/oklog/ulid/v2"
)
// Bot struct.
type Bot struct {
Client *Client
CreatedAt time.Time
Id string `json:"_id"`
OwnerId string `json:"owner"`
Token string `json:"token"`
IsPublic bool `json:"public"`
InteractionsUrl string `json:"interactionsURL"`
}
// Fetched bots struct.
type FetchedBots struct {
Bots []*Bot `json:"bots"`
Users []*User `json:"users"`
}
// Calculate creation date and edit the struct.
func (b *Bot) CalculateCreationDate() error {
ulid, err := ulid.Parse(b.Id)
if err != nil {
return err
}
b.CreatedAt = time.UnixMilli(int64(ulid.Time()))
return nil
}
// Edit the bot.
func (b *Bot) Edit(eb *EditBot) error {
data, err := json.Marshal(eb)
if err != nil {
return err
}
_, err = b.Client.Request("PATCH", "/bots/"+b.Id, data)
return err
}
// Delete the bot.
func (b *Bot) Delete() error {
_, err := b.Client.Request("DELETE", "/bots/"+b.Id, []byte{})
return err
}

@ -220,13 +220,3 @@ func (c Channel) DeleteGroupRecipient(user_id string) error {
_, err := c.Client.Request("DELETE", "/channels/"+c.Id+"/recipients/"+user_id, []byte{})
return err
}
// Send a typing start event to the channel.
func (c *Channel) BeginTyping() {
c.Client.Socket.SendText(fmt.Sprintf("{\"type\":\"BeginTyping\",\"channel\":\"%s\"}", c.Id))
}
// End the typing event in the channel.
func (c *Channel) EndTyping() {
c.Client.Socket.SendText(fmt.Sprintf("{\"type\":\"EndTyping\",\"channel\":\"%s\"}", c.Id))
}

133
client.go

@ -9,8 +9,8 @@ import (
)
const (
WS_URL = "wss://ws.divolt.xyz"
API_URL = "https://api.divolt.xyz"
WS_URL = "wss://ws.revolt.chat"
API_URL = "https://api.revolt.chat"
)
// Client struct.
@ -34,9 +34,6 @@ type Client struct {
OnChannelStopTypingFunctions []func(channel_id, user_id string)
OnServerUpdateFunctions []func(server_id, clear string, payload map[string]interface{})
OnServerDeleteFunctions []func(server_id string)
OnServerMemberUpdateFunctions []func(server_id, clear string, payload map[string]interface{})
OnServerMemberJoinFunctions []func(server_id, user_id string)
OnServerMemberLeaveFunctions []func(server_id, user_id string)
}
// Self bot struct.
@ -108,21 +105,6 @@ func (c *Client) OnServerDelete(fn func(server_id string)) {
c.OnServerDeleteFunctions = append(c.OnServerDeleteFunctions, fn)
}
// On server member update will run when a server member updates.
func (c *Client) OnServerMemberUpdate(fn func(server_id, clear string, payload map[string]interface{})) {
c.OnServerMemberUpdateFunctions = append(c.OnServerMemberUpdateFunctions, fn)
}
// On server member join will run when someone joins to the server.
func (c *Client) OnServerMemberJoin(fn func(server_id string, user_id string)) {
c.OnServerMemberJoinFunctions = append(c.OnServerMemberJoinFunctions, fn)
}
// On server member leave will run when someone left from server.
func (c *Client) OnServerMemberLeave(fn func(server_id string, user_id string)) {
c.OnServerMemberLeaveFunctions = append(c.OnServerMemberLeaveFunctions, fn)
}
// Fetch a channel by Id.
func (c *Client) FetchChannel(id string) (*Channel, error) {
channel := &Channel{}
@ -189,7 +171,7 @@ func (c *Client) Auth() error {
return fmt.Errorf("can't auth user (not a self-bot.)")
}
resp, err := c.Request("POST", "/auth/session/login", []byte("{\"email\":\""+c.SelfBot.Email+"\",\"password\":\""+c.SelfBot.Password+"\",\"name\":\"Revoltgo\"}"))
resp, err := c.Request("POST", "/auth/login", []byte("{\"email\":\""+c.SelfBot.Email+"\",\"password\":\""+c.SelfBot.Password+"\",\"captcha\": \"\"}"))
if err != nil {
return err
@ -268,112 +250,3 @@ func (c *Client) CreateGroup(name, description string, users []string) (*Channel
err = json.Unmarshal(resp, groupChannel)
return groupChannel, err
}
// Fetch relationships.
func (c Client) FetchRelationships() ([]*UserRelations, error) {
relationshipDatas := []*UserRelations{}
resp, err := c.Request("GET", "/users/relationships", []byte{})
if err != nil {
return relationshipDatas, err
}
err = json.Unmarshal(resp, &relationshipDatas)
return relationshipDatas, err
}
// Send friend request. / Accept friend request.
// User relations struct only will have status. id is not defined for this function.
func (c Client) AddFriend(username string) (*UserRelations, error) {
relationshipData := &UserRelations{}
resp, err := c.Request("PUT", "/users/"+username+"/friend", []byte{})
if err != nil {
return relationshipData, err
}
err = json.Unmarshal(resp, relationshipData)
return relationshipData, err
}
// Deny friend request. / Remove friend.
// User relations struct only will have status. id is not defined for this function.
func (c Client) RemoveFriend(username string) (*UserRelations, error) {
relationshipData := &UserRelations{}
resp, err := c.Request("DELETE", "/users/"+username+"/friend", []byte{})
if err != nil {
return relationshipData, err
}
err = json.Unmarshal(resp, relationshipData)
return relationshipData, err
}
// Create a new bot.
func (c *Client) CreateBot(name string) (*Bot, error) {
botData := &Bot{}
botData.Client = c
resp, err := c.Request("POST", "/bots/create", []byte("{\"name\":\""+name+"\"}"))
if err != nil {
return botData, err
}
err = json.Unmarshal(resp, botData)
return botData, err
}
// Fetch client bots.
func (c *Client) FetchBots() (*FetchedBots, error) {
bots := &FetchedBots{}
resp, err := c.Request("GET", "/bots/@me", []byte{})
if err != nil {
return bots, err
}
err = json.Unmarshal(resp, bots)
if err != nil {
return bots, err
}
// Add client for bots.
for _, i := range bots.Bots {
i.Client = c
}
// Add client for users.
for _, i := range bots.Users {
i.Client = c
}
return bots, nil
}
// Fetch a bot.
func (c *Client) FetchBot(id string) (*Bot, error) {
bot := &struct {
Bot *Bot `json:"bot"`
}{
Bot: &Bot{
Client: c,
},
}
resp, err := c.Request("GET", "/bots/"+id, []byte{})
if err != nil {
return bot.Bot, err
}
err = json.Unmarshal(resp, bot)
return bot.Bot, err
}

2
go.mod

@ -1,4 +1,4 @@
module git.cesium.pw/matthew/revoltgo
module github.com/5elenay/revoltgo
go 1.17

@ -23,6 +23,7 @@ func (c Client) Request(method, path string, data []byte) ([]byte, error) {
if c.SelfBot == nil {
req.Header.Set("x-bot-token", c.Token)
} else if c.SelfBot.SessionToken != "" && c.SelfBot.UserId != "" {
req.Header.Set("x-user-id", c.SelfBot.UserId)
req.Header.Set("x-session-token", c.SelfBot.SessionToken)
}

@ -1,33 +1,17 @@
package revoltgo
import (
"fmt"
"os"
)
import "fmt"
// Similar to message, but created for send message function.
type SendMessage struct {
Content string `json:"content"`
Nonce string `json:"nonce,omitempty"`
Attachments []string `json:"attachments,omitempty"`
Replies []Replies `json:"replies,omitempty"`
Embeds []SendableEmbed `json:"embeds,omitempty"`
DeleteAfter uint `json:"-"`
}
type SendableEmbed struct {
Type string `json:"type"`
IconUrl string `json:"icon_url,omitempty"`
Url string `json:"url,omitempty"`
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Media string `json:"media,omitempty"`
Colour string `json:"colour,omitempty"`
}
type Replies struct {
Id string `json:"id"`
Mention bool `json:"mention"`
Content string `json:"content,omitempty"`
Attachments []string `json:"attachments,omitempty"`
Nonce string `json:"nonce,omitempty"`
DeleteAfter uint `json:"-"`
Replies []struct {
Id string `json:"id,omitempty"`
Mention bool `json:"mention,omitempty"`
} `json:"replies,omitempty"`
}
// Set content.
@ -56,7 +40,10 @@ func (sms *SendMessage) AddAttachment(attachment string) *SendMessage {
// Add a new reply.
func (sms *SendMessage) AddReply(id string, mention bool) *SendMessage {
sms.Replies = append(sms.Replies, Replies{
sms.Replies = append(sms.Replies, struct {
Id string "json:\"id,omitempty\""
Mention bool "json:\"mention,omitempty\""
}{
Id: id,
Mention: mention,
})
@ -279,46 +266,3 @@ func (eu *EditUser) SetRemove(item string) *EditUser {
eu.Remove = item
return eu
}
// Revoltgo binary struct.
type Binary struct {
Data []byte
}
// Save data to the given path.
func (b Binary) Save(path string) error {
return os.WriteFile(path, b.Data, 0666)
}
// Edit bot struct
// Please see https://developers.revolt.chat/api/#tag/Bots/paths/~1bots~1:bot/patch for more information.
type EditBot struct {
Name string `json:"name,omitempty"`
Public bool `json:"public,omitempty"`
InteractionsUrl string `json:"interactionsURL,omitempty"`
Remove string `json:"remove,omitempty"`
}
// Set name for struct.
func (eb *EditBot) SetName(name string) *EditBot {
eb.Name = name
return eb
}
// Set public value for struct.
func (eb *EditBot) SetPublicValue(is_public bool) *EditBot {
eb.Public = is_public
return eb
}
// Set interaction url for struct.
func (eb *EditBot) SetInteractionsUrl(url string) *EditBot {
eb.InteractionsUrl = url
return eb
}
// Remove interaction url for struct.
func (eb *EditBot) RemoveInteractionsUrl() *EditBot {
eb.Remove = "InteractionsURL"
return eb
}

59
user.go

@ -72,62 +72,3 @@ func (u User) CreateDirectMessage() (*Channel, error) {
err = json.Unmarshal(resp, dmChannel)
return dmChannel, err
}
// Fetch default user avatar.
func (u User) FetchDefaultAvatar() (*Binary, error) {
avatarData := &Binary{}
resp, err := u.Client.Request("GET", "/users/"+u.Id+"/default_avatar", []byte{})
if err != nil {
return avatarData, err
}
avatarData.Data = resp
return avatarData, nil
}
// Fetch user relationship.
func (u User) FetchRelationship() (*UserRelations, error) {
relationshipData := &UserRelations{}
relationshipData.Id = u.Id
resp, err := u.Client.Request("GET", "/users/"+u.Id+"/relationship", []byte{})
if err != nil {
return relationshipData, err
}
err = json.Unmarshal(resp, relationshipData)
return relationshipData, err
}
// Block user.
func (u User) Block() (*UserRelations, error) {
relationshipData := &UserRelations{}
relationshipData.Id = u.Id
resp, err := u.Client.Request("PUT", "/users/"+u.Id+"/block", []byte{})
if err != nil {
return relationshipData, err
}
err = json.Unmarshal(resp, relationshipData)
return relationshipData, err
}
// Un-block user.
func (u User) Unblock() (*UserRelations, error) {
relationshipData := &UserRelations{}
relationshipData.Id = u.Id
resp, err := u.Client.Request("DELETE", "/users/"+u.Id+"/block", []byte{})
if err != nil {
return relationshipData, err
}
err = json.Unmarshal(resp, relationshipData)
return relationshipData, err
}

@ -25,8 +25,6 @@ func (c *Client) Start() {
}
c.Socket.OnTextMessage = func(message string, _ gowebsocket.Socket) {
fmt.Println(message)
// Parse data
rawData := &struct {
Type string `json:"type"`
@ -56,7 +54,7 @@ func (c *Client) handleWebsocketAuth() {
if c.SelfBot == nil {
c.Socket.SendText(fmt.Sprintf("{\"type\":\"Authenticate\",\"token\":\"%s\"}", c.Token))
} else {
c.Socket.SendText(fmt.Sprintf("{\"type\":\"Authenticate\",\"result\":\"Success\",\"_id\":\"%s\",\"token\":\"%s\",\"user_id\":\"%s\",\"name\":\"Revoltgo\"}", c.SelfBot.Id, c.SelfBot.SessionToken, c.SelfBot.UserId))
c.Socket.SendText(fmt.Sprintf("{\"type\":\"Authenticate\",\"id\":\"%s\",\"session_token\":\"%s\",\"user_id\":\"%s\"}", c.SelfBot.Id, c.SelfBot.SessionToken, c.SelfBot.UserId))
}
}
@ -69,7 +67,7 @@ func (c *Client) Destroy() {
func (c *Client) ping() {
for {
time.Sleep(30 * time.Second)
c.Socket.SendText("{\"type\":\"Ping\",\"data\":0}")
c.Socket.SendText(fmt.Sprintf("{\"type\":\"Ping\",\"time\":%d}", time.Now().Unix()))
}
}
@ -90,14 +88,14 @@ func (c *Client) handleEvents(rawData *struct {
} else if rawData.Type == "Message" && c.OnMessageFunctions != nil {
// Message Event
msgData := &Message{}
msgData.Client = c
err := json.Unmarshal([]byte(message), msgData)
if err != nil {
fmt.Printf("Unexcepted Error: %s", err)
}
msgData.Client = c
for _, i := range c.OnMessageFunctions {
i(msgData)
}
@ -120,7 +118,10 @@ func (c *Client) handleEvents(rawData *struct {
}
} else if rawData.Type == "MessageDelete" && c.OnMessageDeleteFunctions != nil {
// Message Delete Event
data := &map[string]string{}
data := &struct {
ChannelId string `json:"channel"`
MessageId string `json:"id"`
}{}
err := json.Unmarshal([]byte(message), data)
@ -129,12 +130,11 @@ func (c *Client) handleEvents(rawData *struct {
}
for _, i := range c.OnMessageDeleteFunctions {
i((*data)["channel"], (*data)["id"])
i(data.ChannelId, data.MessageId)
}
} else if rawData.Type == "ChannelCreate" && c.OnChannelCreateFunctions != nil {
// Channel create event.
channelData := &Channel{}
channelData.Client = c
err := json.Unmarshal([]byte(message), channelData)
@ -142,6 +142,8 @@ func (c *Client) handleEvents(rawData *struct {
fmt.Printf("Unexcepted Error: %s", err)
}
channelData.Client = c
for _, i := range c.OnChannelCreateFunctions {
i(channelData)
}
@ -164,7 +166,9 @@ func (c *Client) handleEvents(rawData *struct {
}
} else if rawData.Type == "ChannelDelete" && c.OnChannelDeleteFunctions != nil {
// Channel delete event.
data := &map[string]string{}
data := &struct {
ChannelId string `json:"id"`
}{}
err := json.Unmarshal([]byte(message), data)
@ -173,11 +177,14 @@ func (c *Client) handleEvents(rawData *struct {
}
for _, i := range c.OnChannelDeleteFunctions {
i((*data)["id"])
i(data.ChannelId)
}
} else if rawData.Type == "ChannelStartTyping" && c.OnChannelStartTypingFunctions != nil {
// Channel start typing event.
data := &map[string]string{}
data := &struct {
ChannelId string `json:"id"`
UserId string `json:"user"`
}{}
err := json.Unmarshal([]byte(message), data)
@ -186,11 +193,14 @@ func (c *Client) handleEvents(rawData *struct {
}
for _, i := range c.OnChannelStartTypingFunctions {
i((*data)["id"], (*data)["user"])
i(data.ChannelId, data.UserId)
}
} else if rawData.Type == "ChannelStopTyping" && c.OnChannelStopTypingFunctions != nil {
// Channel stop typing event.
data := &map[string]string{}
data := &struct {
ChannelId string `json:"id"`
UserId string `json:"user"`
}{}
err := json.Unmarshal([]byte(message), data)
@ -199,7 +209,7 @@ func (c *Client) handleEvents(rawData *struct {
}
for _, i := range c.OnChannelStopTypingFunctions {
i((*data)["id"], (*data)["user"])
i(data.ChannelId, data.UserId)
}
} else if rawData.Type == "ServerUpdate" && c.OnServerUpdateFunctions != nil {
// Server update event.
@ -220,23 +230,8 @@ func (c *Client) handleEvents(rawData *struct {
}
} else if rawData.Type == "ServerDelete" && c.OnServerDeleteFunctions != nil {
// Server delete event.
data := &map[string]string{}
err := json.Unmarshal([]byte(message), data)
if err != nil {
fmt.Printf("Unexcepted Error: %s", err)
}
for _, i := range c.OnServerDeleteFunctions {
i((*data)["id"])
}
} else if rawData.Type == "ServerMemberUpdate" && c.OnServerMemberUpdateFunctions != nil {
// Member update event.
data := &struct {
ServerId string `json:"id"`
Clear string `json:"clear"`
Payload map[string]interface{} `json:"data"`
ServerId string `json:"id"`
}{}
err := json.Unmarshal([]byte(message), data)
@ -245,34 +240,8 @@ func (c *Client) handleEvents(rawData *struct {
fmt.Printf("Unexcepted Error: %s", err)
}
for _, i := range c.OnServerMemberUpdateFunctions {
i(data.ServerId, data.Clear, data.Payload)
}
} else if rawData.Type == "ServerMemberJoin" && c.OnServerMemberJoinFunctions != nil {
// Member join event.
data := &map[string]string{}
err := json.Unmarshal([]byte(message), data)
if err != nil {
fmt.Printf("Unexcepted Error: %s", err)
}
for _, i := range c.OnServerMemberJoinFunctions {
i((*data)["id"], (*data)["user"])
}
} else if rawData.Type == "ServerMemberLeave" && c.OnServerMemberLeaveFunctions != nil {
// Member left event.
data := &map[string]string{}
err := json.Unmarshal([]byte(message), data)
if err != nil {
fmt.Printf("Unexcepted Error: %s", err)
}
for _, i := range c.OnServerMemberLeaveFunctions {
i((*data)["id"], (*data)["user"])
for _, i := range c.OnServerDeleteFunctions {
i(data.ServerId)
}
} else {
// Unknown event.