99 lines
2.4 KiB
Go
99 lines
2.4 KiB
Go
package reddit
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
|
|
|
|
"golang.org/x/oauth2"
|
|
)
|
|
|
|
// Opt is used to further configure a client upon initialization.
|
|
type Opt func(*Client) error
|
|
|
|
// WithHTTPClient sets the HTTP client which will be used to make requests.
|
|
func WithHTTPClient(httpClient *http.Client) Opt {
|
|
return func(c *Client) error {
|
|
if httpClient == nil {
|
|
return errors.New("*http.Client: cannot be nil")
|
|
}
|
|
c.client = httpClient
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithUserAgent sets the User-Agent header for requests made with the client.
|
|
// Reddit recommends the following format for the user agent:
|
|
// <platform>:<app ID>:<version string> (by /u/<reddit username>)
|
|
func WithUserAgent(ua string) Opt {
|
|
return func(c *Client) error {
|
|
c.userAgent = ua
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithBaseURL sets the base URL for the client to make requests to.
|
|
func WithBaseURL(u string) Opt {
|
|
return func(c *Client) error {
|
|
url, err := url.Parse(u)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
c.BaseURL = url
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithTokenURL sets the url used to get access tokens.
|
|
func WithTokenURL(u string) Opt {
|
|
return func(c *Client) error {
|
|
url, err := url.Parse(u)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
c.TokenURL = url
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithApplicationOnlyOAuth sets authentication flow to "Application Only OAuth".
|
|
// Only ID and Secret are required to be set in client. Username and Password are ignored.
|
|
// The flow is described here: https://github.com/reddit-archive/reddit/wiki/OAuth2#application-only-oauth
|
|
func WithApplicationOnlyOAuth(o bool) Opt {
|
|
return func(c *Client) error {
|
|
c.applicationOnlyOAuth = o
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func WithOAuthTokenSource(tkn oauth2.TokenSource) Opt {
|
|
return func(c *Client) error {
|
|
c.tknSource = tkn
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// FromEnv configures the client with values from environment variables.
|
|
// Supported environment variables:
|
|
// GO_REDDIT_CLIENT_ID to set the client's id.
|
|
// GO_REDDIT_CLIENT_SECRET to set the client's secret.
|
|
// GO_REDDIT_CLIENT_USERNAME to set the client's username.
|
|
// GO_REDDIT_CLIENT_PASSWORD to set the client's password.
|
|
func FromEnv(c *Client) error {
|
|
if v := os.Getenv("GO_REDDIT_CLIENT_ID"); v != "" {
|
|
c.ID = v
|
|
}
|
|
if v := os.Getenv("GO_REDDIT_CLIENT_SECRET"); v != "" {
|
|
c.Secret = v
|
|
}
|
|
if v := os.Getenv("GO_REDDIT_CLIENT_USERNAME"); v != "" {
|
|
c.Username = v
|
|
}
|
|
if v := os.Getenv("GO_REDDIT_CLIENT_PASSWORD"); v != "" {
|
|
c.Password = v
|
|
}
|
|
return nil
|
|
}
|