GoPro.Plus.Auth

GoPro Plus authentication.

Documentation

authenticate

Arguments

:: MonadIO m

=> String

Email/username

-> String

Password

-> m AuthInfo

Authenticate against the GoPro Plus service.

refreshAuth :: MonadIO m => AuthInfo -> m AuthInfo

Refresh authentication credentials using a refresh token.

data AuthInfo

An Authentication response.

Constructors

AuthInfo

Fields

• _access_token :: Token
• _expires_in :: Int
• _refresh_token :: Text
• _resource_owner_id :: Text

Instances

Show AuthInfo

Defined in GoPro.Plus.Auth

Methods

showsPrec :: Int -> AuthInfo -> ShowS

show :: AuthInfo -> String

showList :: [AuthInfo] -> ShowS

Generic AuthInfo

Defined in GoPro.Plus.Auth

Associated Types

type Rep AuthInfo :: Type -> Type

Methods

from :: AuthInfo -> Rep AuthInfo x

to :: Rep AuthInfo x -> AuthInfo

FromJSON AuthInfo

Defined in GoPro.Plus.Auth

Methods

parseJSON :: Value -> Parser AuthInfo

parseJSONList :: Value -> Parser [AuthInfo]

Monad m => HasGoProAuth (AuthReader m)

Defined in GoPro.Plus.Auth

Methods

goproAuth :: AuthReader m AuthInfo

type Rep AuthInfo

Defined in GoPro.Plus.Auth

type Rep AuthInfo = D1 ('MetaData "AuthInfo" "GoPro.Plus.Auth" "gopro-plus-0.6.5.1-HVJKZeAiyIm3QmNtFVFBIT" 'False) (C1 ('MetaCons "AuthInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_access_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token) :*: S1 ('MetaSel ('Just "_expires_in") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "_refresh_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_resource_owner_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

access_token :: Lens' AuthInfo Token

expires_in :: Lens' AuthInfo Int

refresh_token :: Lens' AuthInfo Text

resource_owner_id :: Lens' AuthInfo Text

class Monad m => HasGoProAuth m where

A Monad may have a HasGoProAuth instance to indicate it knows how to authenticate against the GoPro Plus service.

Methods

goproAuth :: m AuthInfo

Get the GoPro AuthInfo to use.

Instances

Monad m => HasGoProAuth (AuthReader m)

Defined in GoPro.Plus.Auth

Methods

goproAuth :: AuthReader m AuthInfo

HasGoProAuth m => HasGoProAuth (Uploader m)

Defined in GoPro.Plus.Upload

Methods

goproAuth :: Uploader m AuthInfo

withAuth :: AuthInfo -> AuthReader m a -> m a

Convenient function for passing around auth info. You probably don't want to uset his, but it can be convenient when experimenting.

type AuthReader = ReaderT AuthInfo

AuthReader is a convenience type that's useful for doing small experiments where you don't already have your own Reader or similar. e.g., in ghci you might type:

(m :: Medium) <- withAuth (AuthInfo accessToken 0 "" "") $ medium mediumID

type Token = Text