goth: github.com/markbates/goth/providers/twitter Index | Files

package twitter

import "github.com/markbates/goth/providers/twitter"

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

Package Files

session.go twitter.go

type Provider Uses

type Provider struct {
    ClientKey   string
    Secret      string
    CallbackURL string
    HTTPClient  *http.Client
    // contains filtered or unexported fields
}

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

func New Uses

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 Uses

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 Uses

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

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

func (*Provider) Client Uses

func (p *Provider) Client() *http.Client

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug sets the logging of the OAuth client to verbose.

func (*Provider) FetchUser Uses

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

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

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

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

RefreshToken refresh token is not provided by twitter

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by twitter

func (*Provider) SetName Uses

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession Uses

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

UnmarshalSession will unmarshal a JSON string into a session.

type Session Uses

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

Session stores data during the auth process with Twitter.

func (*Session) Authorize Uses

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

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

func (Session) GetAuthURL Uses

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

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

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package twitter imports 10 packages (graph) and is imported by 35 packages. Updated 2017-07-08. Refresh now. Tools for package owners.