twitter

Documentation

Overview

Package twitter implements the OAuth protocol for authenticating users through Twitter. This package can be used as a reference implementation of an OAuth provider for Goth.

Index

• type Provider
  • func New(clientKey, secret, callbackURL string) *Provider
  • func NewAuthenticate(clientKey, secret, callbackURL string) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) BeginAuthCtx(ctx context.Context, state string) (goth.Session, error)
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) FetchUserCtx(ctx context.Context, session goth.Session) (goth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) RefreshTokenCtx(ctx context.Context, refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
• type Session
  • func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)
  • func (s *Session) AuthorizeCtx(ctx context.Context, provider goth.Provider, params goth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

Types

type Provider

type Provider struct {
	ClientKey   string
	Secret      string
	CallbackURL string
	// contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing Twitter.

func New

func New(clientKey, secret, callbackURL string) *Provider

New creates a new Twitter provider, and sets up important connection details. You should always call `twitter.New` to get a new Provider. Never try to create one manually.

If you'd like to use authenticate instead of authorize, use NewAuthenticate instead.

func NewAuthenticate

func NewAuthenticate(clientKey, secret, callbackURL string) *Provider

NewAuthenticate is the almost same as New. NewAuthenticate uses the authenticate URL instead of the authorize URL.

func (*Provider) BeginAuth

func (p *Provider) BeginAuth(state string) (goth.Session, error)

func (*Provider) BeginAuthCtx

func (p *Provider) BeginAuthCtx(ctx context.Context, state string) (goth.Session, error)

BeginAuthCtx asks Twitter for an authentication end-point and a request token for a session. Twitter does not support the "state" variable.

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug sets the logging of the OAuth client to verbose.

func (*Provider) FetchUser

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

func (*Provider) FetchUserCtx

func (p *Provider) FetchUserCtx(ctx context.Context, session goth.Session) (goth.User, error)

FetchUserCtx will go to Twitter and access basic information about the user.

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by twitter

func (*Provider) RefreshTokenCtx

func (p *Provider) RefreshTokenCtx(ctx context.Context, refreshToken string) (
	*oauth2.Token, error)

RefreshTokenCtx refresh token is not provided by twitter

func (*Provider) UnmarshalSession

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session

type Session struct {
	AuthURL      string
	AccessToken  *oauth.AccessToken
	RequestToken *oauth.RequestToken
}

Session stores data during the auth process with Twitter.

func (*Session) Authorize

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

func (*Session) AuthorizeCtx

func (s *Session) AuthorizeCtx(ctx context.Context, provider goth.Provider, params goth.Params) (string, error)

AuthorizeCtx the session with Twitter and return the access token to be stored for future use.

func (Session) GetAuthURL

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Twitter provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string