oura

Documentation

Overview

Package oura implements the OAuth protocol for authenticating users through Oura API (for OuraRing).

Index

• Constants
• type APIError
  • func NewAPIError(code int, description string) APIError
  • func (e APIError) Error() string
• type Provider
  • func New(clientKey, secret, callbackURL string, scopes ...string) *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
  • 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

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"
)

Types

type APIError

type APIError struct {
	Code        int
	Description string
}

APIError describes an error from the Oura API

func NewAPIError

func NewAPIError(code int, description string) APIError

NewAPIError initializes an Oura APIError

func (APIError) Error

func (e APIError) Error() string

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

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

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) BeginAuth

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

BeginAuth asks Oura for an authentication end-point.

func (*Provider) Client

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

Client for making requests on the provider

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the oura package.

func (*Provider) FetchUser

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

FetchUser will go to Oura 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 oura

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

func (*Session) Authorize

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

Authorize completes the authorization with Oura 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 Oura 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.