Network.Google.Auth.Scope

Helpers for specifying and using Scopes with Network.Google.

Documentation

allow :: proxy s -> k s -> k s

Annotate credentials with the specified scopes. This exists to allow users to choose between using newEnv with a Proxy constructed by !, or explicitly specifying scopes via a type annotation.

See: !, envScopes, and the scopes available for each service.

forbid :: k `[]` -> k `[]`

Annotate credentials with no scope authorization.

(!) :: proxy xs -> proxy ys -> Proxy (Nub (xs ++ ys))

Append two sets of scopes.

See: allow.

type family HasScope s a :: Constraint

Determine if _any_ of the scopes a request requires is listed in the scopes the credentials supports.

For error message/presentation purposes, this wraps the result of the HasScope membership check to show both lists of scopes before reduction.

Equations

HasScope s a = (s `HasScope'` Scopes a) ~ True

type family HasScope' s a

Check if any of actual supplied scopes s exist in the required set a. If the required set a is empty, then succeed.

Equations

HasScope' s `[]` = True

HasScope' (x : xs) a = (x ∈ a) || HasScope' xs a

type family a ∈ b

Membership predicate.

Equations

x ∈ `[]` = False

x ∈ (y : xs) = (x == y) || (x ∈ xs)

type family xs ++ ys

Append two lists.

Equations

xs ++ `[]` = xs

`[]` ++ ys = ys

(x : xs) ++ ys = x : (xs ++ ys)

type family Nub xs

Remove duplicates from a list.

Equations

Nub `[]` = `[]`

Nub (x : xs) = x : Nub (Delete x xs)

type family Delete x xs

Remove a specific element from a list.

Equations

Delete x `[]` = `[]`

Delete x (x : ys) = Delete x ys

Delete x (y : ys) = y : Delete x ys

class AllowScopes a where

Methods

allowScopes :: proxy a -> [OAuthScope]

Obtain a list of supported OAuthScope values from a proxy.

Instances

AllowScopes [Symbol] s => AllowScopes * (Credentials s)

AllowScopes [k] ([] k)

(KnownSymbol x, AllowScopes [Symbol] xs) => AllowScopes [Symbol] ((:) Symbol x xs)

concatScopes :: [OAuthScope] -> Text

Concatenate a list of scopes using spaces.

queryEncodeScopes :: [OAuthScope] -> ByteString

Encode a list of scopes suitable for embedding in a query string.