stulbe

package module

v0.7.2 Latest Latest Go to latest Published: Jan 31, 2022 License: ISC Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrNotAuthenticated     = errors.New("not authenticated")
	ErrSubscriptionNotFound = errors.New("subscription not found")
)

This section is empty.

type AuthRequest struct {
	User    string `json:"user"`
	AuthKey string `json:"key"`
}

type AuthResponse struct {
	Ok    bool   `json:"ok"`
	User  string `json:"username"`
	Level string `json:"level"`
	Token string `json:"token"`
}

type Client struct {
	Endpoint string
	Logger   *zap.Logger
	KV       *kvclient.Client
	// contains filtered or unexported fields
}

Client is a HTTP/Websocket client for the Stulbe API.

func NewClient(options ClientOptions) (*Client, error)

NewClient creates a new client for the Stulbe API

func (s *Client) Authenticate(user string, authKey string) error

func (s *Client) Close()

func (s *Client) NewAuthRequest(method string, path string, body io.Reader) (*http.Request, error)

func (s *Client) TwitchGetAuthenticationURL() (string, error)

func (s *Client) TwitchUserInfo() (helix.User, error)

type ClientOptions struct {
	Endpoint string
	Username string
	AuthKey  string

	Logger *zap.Logger
}

type ResponseError struct {
	Ok    bool   `json:"ok"`
	Error string `json:"error"`
}

type StatusResponse struct {
	Ok bool `json:"ok"`
}