lastfm

Documentation

Overview

Package lastfm implements the OAuth protocol for authenticating users through LastFM. This package can be used as a reference impleentation of an OAuth provider for Goth.

Index

• type Provider
  • func New(clientKey string, secret string, callbackURL string) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) GetSession(token string) (map[string]string, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • 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) 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
	UserAgent   string
}

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

func New

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

New creates a new LastFM provider, and sets up important connection details. You should always call `lastfm.New` to get a new Provider. Never try to craete one manullay.

func (*Provider) BeginAuth

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

BeginAuth asks LastFm for an authentication end-point

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the lastfm package.

func (*Provider) FetchUser

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

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

func (*Provider) GetSession

func (p *Provider) GetSession(token string) (map[string]string, error)

GetSession token from LastFM

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrive this provider later.

func (*Provider) RefreshToken

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

RefreshToken refresh token is not provided by lastfm

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by lastfm

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 string
	Login       string
}

Session stores data during the auth process with Lastfm.

func (*Session) Authorize

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

Authorize the session with LastFM 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 LastFM provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string