Documentation
¶
Overview ¶
Package oura implements the OAuth protocol for authenticating users through Oura API (for OuraRing).
Index ¶
- Constants
- type APIError
- type Provider
- func (p *Provider) BeginAuth(state string) (goth.Session, error)
- func (p *Provider) Client() *http.Client
- func (p *Provider) Debug(debug bool)
- func (p *Provider) FetchUser(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) SetName(name string)
- func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
- type Session
Constants ¶
const ( // ScopeEmail includes email address of the user ScopeEmail = "email" // ScopePersonal includes personal information (gender, age, height, weight) ScopePersonal = "personal" // ScopeDaily includes daily summaries of sleep, activity and readiness ScopeDaily = "daily" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIError ¶
APIError describes an error from the Oura API
func NewAPIError ¶
NewAPIError initializes an Oura APIError
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 Oura API.
func New ¶
New creates a new Oura provider (for OuraRing), and sets up important connection details. You should always call `oura.New` to get a new Provider. Never try to create one manually.
func (*Provider) RefreshToken ¶
RefreshToken get new access token based on the refresh token
func (*Provider) RefreshTokenAvailable ¶
RefreshTokenAvailable refresh token is not provided by oura
type Session ¶
type Session struct {
AuthURL string
AccessToken string
RefreshToken string
ExpiresAt time.Time
UserID string
}
Session stores data during the auth process with Oura.
func (*Session) Authorize ¶
Authorize completes the authorization with Oura and returns the access token to be stored for future use.
func (Session) GetAuthURL ¶
GetAuthURL will return the URL set by calling the `BeginAuth` function on the Oura provider.
Source Files