Version: v1.38.0 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Mar 1, 2017 License: MIT Imports: 8 Imported by: 0



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



View Source
const (
	// ScopeActivity includes activity data and exercise log related features, such as steps, distance, calories burned, and active minutes
	ScopeActivity = "activity"
	// ScopeHeartRate includes the continuous heart rate data and related analysis
	ScopeHeartRate = "heartrate"
	// ScopeLocation includes the GPS and other location data
	ScopeLocation = "location"
	// ScopeNutrition includes calorie consumption and nutrition related features, such as food/water logging, goals, and plans
	ScopeNutrition = "nutrition"
	// ScopeProfile is the basic user information
	ScopeProfile = "profile"
	// ScopeSettings includes user account and device settings, such as alarms
	ScopeSettings = "settings"
	// ScopeSleep includes sleep logs and related sleep analysis
	ScopeSleep = "sleep"
	// ScopeSocial includes friend-related features, such as friend list, invitations, and leaderboard
	ScopeSocial = "social"
	// ScopeWeight includes weight and related information, such as body mass index, body fat percentage, and goals
	ScopeWeight = "weight"


This section is empty.


This section is empty.


type Provider

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 Fitbit.

func New

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

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

func (*Provider) BeginAuth

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

BeginAuth asks Fitbit for an authentication end-point.

func (*Provider) Client

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

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the fitbit package.

func (*Provider) FetchUser

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

FetchUser will go to Fitbit 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)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by fitbit

func (*Provider) SetName

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

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
	RefreshToken string
	ExpiresAt    time.Time
	UserID       string

Session stores data during the auth process with Fitbit.

func (*Session) Authorize

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

Authorize completes the the authorization with Fitbit and returns 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 Fitbit provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal marshals a session into a JSON string.

func (Session) String

func (s Session) String() string

String is equivalent to Marshal. It returns a JSON representation of the session.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL