Network.Goggles

Google Cloud Storage

getObject :: Text -> Text -> Cloud GCP LbsResponse

`getObject b p` retrieves the contents of a GCS object (of full path p) in bucket b

listObjects :: Text -> Cloud GCP LbsResponse

`listObjects b` retrieves a list of objects stored in bucket b

putObject :: Text -> Text -> ByteString -> Cloud GCP LbsResponse

`putObject b p body` uploads a bytestring body into a GCS object (of full path p) in bucket b

GCP Authentication scopes

scopesDefault :: [Text]

OAuth2 scopes for the various Google Cloud Platform services.

Please refer to

https://developers.google.com/identity/protocols/googlescopes

for the full list

Running Cloud programs

evalCloudIO :: Handle c -> Cloud c a -> IO a

Evaluate a Cloud action, given a Handle.

NB : Assumes all exceptions are handled by throwM

liftCloudIO :: HasCredentials c => IO a -> Cloud c a

Lift an `IO a` action into the Cloud monad, and catch synchronous exceptions, while rethrowing the asynchronous ones to IO

createHandle :: HasCredentials c => Credentials c -> Options c -> IO (Handle c)

Create a Handle with an empty token

Types

data GCP

Instances

HasCredentials GCP

Associated Types

type Credentials GCP :: *

type Options GCP :: *

type TokenContent GCP :: *

Methods

tokenFetch :: Cloud GCP (Token GCP)

Show (Token GCP)

Methods

showsPrec :: Int -> Token GCP -> ShowS

show :: Token GCP -> String

showList :: [Token GCP] -> ShowS

MonadHttp (Cloud GCP)

We can provide a custom http exception handler rather than throwing exceptions with this instance

Methods

handleHttpException :: HttpException -> Cloud GCP a

getHttpConfig :: Cloud GCP HttpConfig

type Credentials GCP

type Credentials GCP = GCPServiceAccount

type Options GCP

type Options GCP = [Text]

type TokenContent GCP

type TokenContent GCP = Text

data GCPServiceAccount

Credentials for Google Cloud Platform

Constructors

GCPServiceAccount

Fields

• _servicePrivateKey :: PrivateKey

  Private key (i.e. the PEM string obtained from the Google API Console)

• _serviceEmail :: Text

  Email address of the service account (ending in .gserviceaccount.com )

• _serviceAccountUser :: Maybe Text

  email address of the user for which the application is requesting delegated access (defaults to the service account email if Nothing)

• _gcpServiceAcctSecret :: Text

  Service account secret

Instances

Eq GCPServiceAccount

Methods

(==) :: GCPServiceAccount -> GCPServiceAccount -> Bool

(/=) :: GCPServiceAccount -> GCPServiceAccount -> Bool

Show GCPServiceAccount

Methods

showsPrec :: Int -> GCPServiceAccount -> ShowS

show :: GCPServiceAccount -> String

showList :: [GCPServiceAccount] -> ShowS

newtype Cloud c a

The main type of the library. It can easily be re-used in libraries that interface with more than one cloud API provider because its type parameter c lets us be declare distinct behaviours for each.

Constructors

Cloud

Fields

• runCloud :: ReaderT (Handle c) IO a

Instances

Monad (Cloud c)

Methods

(>>=) :: Cloud c a -> (a -> Cloud c b) -> Cloud c b

(>>) :: Cloud c a -> Cloud c b -> Cloud c b

return :: a -> Cloud c a

fail :: String -> Cloud c a

Functor (Cloud c)

Methods

fmap :: (a -> b) -> Cloud c a -> Cloud c b

(<$) :: a -> Cloud c b -> Cloud c a

Applicative (Cloud c)

Methods

pure :: a -> Cloud c a

(<*>) :: Cloud c (a -> b) -> Cloud c a -> Cloud c b

(*>) :: Cloud c a -> Cloud c b -> Cloud c b

(<*) :: Cloud c a -> Cloud c b -> Cloud c a

HasCredentials c => Alternative (Cloud c)

Methods

empty :: Cloud c a

(<|>) :: Cloud c a -> Cloud c a -> Cloud c a

some :: Cloud c a -> Cloud c [a]

many :: Cloud c a -> Cloud c [a]

HasCredentials c => MonadIO (Cloud c)

Methods

liftIO :: IO a -> Cloud c a

HasCredentials c => MonadRandom (Cloud c)

the whole point of this parametrization is to have a distinct MonadHttp for each API provider/DSP

instance HasCredentials c => MonadHttp (Boo c) where handleHttpException = throwM

Methods

getRandomBytes :: ByteArray byteArray => Int -> Cloud c byteArray

HasCredentials c => MonadThrow (Cloud c)

Methods

throwM :: Exception e => e -> Cloud c a

HasCredentials c => MonadCatch (Cloud c)

Methods

catch :: Exception e => Cloud c a -> (e -> Cloud c a) -> Cloud c a

MonadHttp (Cloud GCP)

We can provide a custom http exception handler rather than throwing exceptions with this instance

Methods

handleHttpException :: HttpException -> Cloud GCP a

getHttpConfig :: Cloud GCP HttpConfig

HasCredentials c => MonadReader (Handle c) (Cloud c)

Methods

ask :: Cloud c (Handle c)

local :: (Handle c -> Handle c) -> Cloud c a -> Cloud c a

reader :: (Handle c -> a) -> Cloud c a

Authentication

class HasCredentials c where

Minimal complete definition

tokenFetch

Associated Types

type Credentials c

type Options c

type TokenContent c

Methods

tokenFetch :: Cloud c (Token c)

Instances

HasCredentials GCP

Associated Types

type Credentials GCP :: *

type Options GCP :: *

type TokenContent GCP :: *

Methods

tokenFetch :: Cloud GCP (Token GCP)

data Token c

A Token with an expiry date

Constructors

Token

Fields

• tToken :: TokenContent c
• tTime :: UTCTime

Instances

Show (Token GCP)

Methods

showsPrec :: Int -> Token GCP -> ShowS

show :: Token GCP -> String

showList :: [Token GCP] -> ShowS

data Handle c

Constructors

Handle

Fields

• credentials :: Credentials c
• token :: TVar (Maybe (Token c))
• options :: Options c

Instances

HasCredentials c => MonadReader (Handle c) (Cloud c)

Methods

ask :: Cloud c (Handle c)

local :: (Handle c -> Handle c) -> Cloud c a -> Cloud c a

reader :: (Handle c -> a) -> Cloud c a

Private key

parseRSAPrivateKey :: MonadThrow m => Text -> m PrivateKey

Parse a chunk of text into an RSA private key. For Google Cloud Platform , this is the private key associated with the user's "service account" (for server-to-server API use)

https://console.cloud.google.com/apis/credentials

Note: do not supply the RSA header and footer or any newlines (they will be inserted by this function).

Exceptions

data KeyException

Authentication key exceptions

Constructors

NoSecretFound !String

NoParsePK !String

NoRSAKey !String

Instances

Eq KeyException

Methods

(==) :: KeyException -> KeyException -> Bool

(/=) :: KeyException -> KeyException -> Bool

Show KeyException

Methods

showsPrec :: Int -> KeyException -> ShowS

show :: KeyException -> String

showList :: [KeyException] -> ShowS

Exception KeyException

Methods

toException :: KeyException -> SomeException

fromException :: SomeException -> Maybe KeyException

displayException :: KeyException -> String

data JWTError

Errors associated with JWT-encoded token request

Constructors

BadExpirationTime !String

CryptoSignError !String

Instances

Show JWTError

Methods

showsPrec :: Int -> JWTError -> ShowS

show :: JWTError -> String

showList :: [JWTError] -> ShowS

Exception JWTError

Methods

toException :: JWTError -> SomeException

fromException :: SomeException -> Maybe JWTError

displayException :: JWTError -> String

data TokenExchangeException

Token exchange exceptions

Constructors

NotFound !String

Something went wrong with the request, token not found

APICredentialsNotFound !String

Instances

Show TokenExchangeException

Methods

showsPrec :: Int -> TokenExchangeException -> ShowS

show :: TokenExchangeException -> String

showList :: [TokenExchangeException] -> ShowS

Exception TokenExchangeException

Methods

toException :: TokenExchangeException -> SomeException

fromException :: SomeException -> Maybe TokenExchangeException

displayException :: TokenExchangeException -> String

data CloudException

Cloud API exception

Constructors

UnknownError !String

IOError !String

TimeoutError !String

JsonDecodeError !String

Instances

Show CloudException

Methods

showsPrec :: Int -> CloudException -> ShowS

show :: CloudException -> String

showList :: [CloudException] -> ShowS

Exception CloudException

Methods

toException :: CloudException -> SomeException

fromException :: SomeException -> Maybe CloudException

displayException :: CloudException -> String