1
0
matterbridge/vendor/github.com/slack-go/slack/slack.go

175 lines
4.5 KiB
Go
Raw Normal View History

2016-09-05 07:34:37 -07:00
package slack
import (
2017-07-16 05:29:46 -07:00
"context"
2018-01-08 13:41:38 -08:00
"fmt"
2016-09-05 07:34:37 -07:00
"log"
2018-08-09 15:38:19 -07:00
"net/http"
2016-09-05 07:34:37 -07:00
"net/url"
"os"
)
2019-09-07 13:46:58 -07:00
const (
// APIURL of the slack api.
APIURL = "https://slack.com/api/"
// WEBAPIURLFormat ...
WEBAPIURLFormat = "https://%s.slack.com/api/users.admin.%s?t=%d"
)
2018-08-09 15:38:19 -07:00
2018-12-01 10:55:35 -08:00
// httpClient defines the minimal interface needed for an http.Client to be implemented.
type httpClient interface {
2018-08-09 15:38:19 -07:00
Do(*http.Request) (*http.Response, error)
}
// ResponseMetadata holds pagination metadata
type ResponseMetadata struct {
2020-10-11 14:07:00 -07:00
Cursor string `json:"next_cursor"`
Messages []string `json:"messages"`
Warnings []string `json:"warnings"`
2018-08-09 15:38:19 -07:00
}
func (t *ResponseMetadata) initialize() *ResponseMetadata {
if t != nil {
return t
}
return &ResponseMetadata{}
2016-09-05 07:34:37 -07:00
}
2018-12-01 10:55:35 -08:00
// AuthTestResponse ...
2016-09-05 07:34:37 -07:00
type AuthTestResponse struct {
URL string `json:"url"`
Team string `json:"team"`
User string `json:"user"`
TeamID string `json:"team_id"`
UserID string `json:"user_id"`
2019-09-07 13:46:58 -07:00
// EnterpriseID is only returned when an enterprise id present
EnterpriseID string `json:"enterprise_id,omitempty"`
2020-10-11 14:07:00 -07:00
BotID string `json:"bot_id"`
2016-09-05 07:34:37 -07:00
}
type authTestResponseFull struct {
SlackResponse
AuthTestResponse
}
2018-12-01 10:55:35 -08:00
// Client for the slack api.
2019-09-07 13:46:58 -07:00
type ParamOption func(*url.Values)
2016-09-05 07:34:37 -07:00
type Client struct {
token string
appLevelToken string
configToken string
configRefreshToken string
endpoint string
debug bool
log ilogger
httpclient httpClient
2016-09-05 07:34:37 -07:00
}
2018-08-09 15:38:19 -07:00
// Option defines an option for a Client
type Option func(*Client)
2018-01-08 13:41:38 -08:00
2018-08-09 15:38:19 -07:00
// OptionHTTPClient - provide a custom http client to the slack client.
2018-12-01 10:55:35 -08:00
func OptionHTTPClient(client httpClient) func(*Client) {
return func(c *Client) {
c.httpclient = client
}
}
// OptionDebug enable debugging for the client
func OptionDebug(b bool) func(*Client) {
return func(c *Client) {
c.debug = b
}
}
// OptionLog set logging for client.
func OptionLog(l logger) func(*Client) {
return func(c *Client) {
c.log = internalLog{logger: l}
2018-08-09 15:38:19 -07:00
}
2018-01-08 13:41:38 -08:00
}
2019-09-07 13:46:58 -07:00
// OptionAPIURL set the url for the client. only useful for testing.
func OptionAPIURL(u string) func(*Client) {
return func(c *Client) { c.endpoint = u }
}
2020-10-19 14:40:00 -07:00
// OptionAppLevelToken sets an app-level token for the client.
func OptionAppLevelToken(token string) func(*Client) {
return func(c *Client) { c.appLevelToken = token }
}
// OptionConfigToken sets a configuration token for the client.
func OptionConfigToken(token string) func(*Client) {
return func(c *Client) { c.configToken = token }
}
// OptionConfigRefreshToken sets a configuration refresh token for the client.
func OptionConfigRefreshToken(token string) func(*Client) {
return func(c *Client) { c.configRefreshToken = token }
}
2018-08-09 15:38:19 -07:00
// New builds a slack client from the provided token and options.
func New(token string, options ...Option) *Client {
s := &Client{
token: token,
2019-09-07 13:46:58 -07:00
endpoint: APIURL,
2018-12-01 10:55:35 -08:00
httpclient: &http.Client{},
log: log.New(os.Stderr, "slack-go/slack", log.LstdFlags|log.Lshortfile),
2018-08-09 15:38:19 -07:00
}
for _, opt := range options {
opt(s)
}
2016-09-05 07:34:37 -07:00
return s
}
// AuthTest tests if the user is able to do authenticated requests or not
func (api *Client) AuthTest() (response *AuthTestResponse, error error) {
2017-07-16 05:29:46 -07:00
return api.AuthTestContext(context.Background())
}
// AuthTestContext tests if the user is able to do authenticated requests or not with a custom context
2018-12-01 10:55:35 -08:00
func (api *Client) AuthTestContext(ctx context.Context) (response *AuthTestResponse, err error) {
2018-08-09 15:38:19 -07:00
api.Debugf("Challenging auth...")
2016-09-05 07:34:37 -07:00
responseFull := &authTestResponseFull{}
2019-09-07 13:46:58 -07:00
err = api.postMethod(ctx, "auth.test", url.Values{"token": {api.token}}, responseFull)
2016-09-05 07:34:37 -07:00
if err != nil {
return nil, err
}
2018-08-09 15:38:19 -07:00
2018-12-01 10:55:35 -08:00
return &responseFull.AuthTestResponse, responseFull.Err()
2016-09-05 07:34:37 -07:00
}
2018-08-09 15:38:19 -07:00
// Debugf print a formatted debug line.
2016-09-05 07:34:37 -07:00
func (api *Client) Debugf(format string, v ...interface{}) {
if api.debug {
2018-12-01 10:55:35 -08:00
api.log.Output(2, fmt.Sprintf(format, v...))
2016-09-05 07:34:37 -07:00
}
}
2018-08-09 15:38:19 -07:00
// Debugln print a debug line.
2016-09-05 07:34:37 -07:00
func (api *Client) Debugln(v ...interface{}) {
if api.debug {
2018-12-01 10:55:35 -08:00
api.log.Output(2, fmt.Sprintln(v...))
2016-09-05 07:34:37 -07:00
}
}
2018-12-01 10:55:35 -08:00
// Debug returns if debug is enabled.
func (api *Client) Debug() bool {
return api.debug
}
2019-09-07 13:46:58 -07:00
// post to a slack web method.
func (api *Client) postMethod(ctx context.Context, path string, values url.Values, intf interface{}) error {
return postForm(ctx, api.httpclient, api.endpoint+path, values, intf, api)
}
// get a slack web method.
func (api *Client) getMethod(ctx context.Context, path string, token string, values url.Values, intf interface{}) error {
return getResource(ctx, api.httpclient, api.endpoint+path, token, values, intf, api)
2019-09-07 13:46:58 -07:00
}