Hercules.CLI.Credentials

Manages the ~.confighercules-ci/credentials.json

Documentation

data Credentials

Constructors

Credentials

Fields

• domains :: Map Text DomainCredentials

Instances

FromJSON Credentials

Defined in Hercules.CLI.Credentials

Methods

parseJSON :: Value -> Parser Credentials

parseJSONList :: Value -> Parser [Credentials]

ToJSON Credentials

Defined in Hercules.CLI.Credentials

Methods

toJSON :: Credentials -> Value

toEncoding :: Credentials -> Encoding

toJSONList :: [Credentials] -> Value

toEncodingList :: [Credentials] -> Encoding

Generic Credentials

Defined in Hercules.CLI.Credentials

Associated Types

type Rep Credentials :: Type -> Type

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

Eq Credentials

Defined in Hercules.CLI.Credentials

Methods

(==) :: Credentials -> Credentials -> Bool

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

type Rep Credentials

Defined in Hercules.CLI.Credentials

type Rep Credentials = D1 ('MetaData "Credentials" "Hercules.CLI.Credentials" "hercules-ci-cli-0.3.5-inplace" 'False) (C1 ('MetaCons "Credentials" 'PrefixI 'True) (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text DomainCredentials))))

data DomainCredentials

Constructors

DomainCredentials

Fields

• personalToken :: Text

Instances

FromJSON DomainCredentials

Defined in Hercules.CLI.Credentials

Methods

parseJSON :: Value -> Parser DomainCredentials

parseJSONList :: Value -> Parser [DomainCredentials]

ToJSON DomainCredentials

Defined in Hercules.CLI.Credentials

Methods

toJSON :: DomainCredentials -> Value

toEncoding :: DomainCredentials -> Encoding

toJSONList :: [DomainCredentials] -> Value

toEncodingList :: [DomainCredentials] -> Encoding

Generic DomainCredentials

Defined in Hercules.CLI.Credentials

Associated Types

type Rep DomainCredentials :: Type -> Type

Methods

from :: DomainCredentials -> Rep DomainCredentials x

to :: Rep DomainCredentials x -> DomainCredentials

Eq DomainCredentials

Defined in Hercules.CLI.Credentials

Methods

(==) :: DomainCredentials -> DomainCredentials -> Bool

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

type Rep DomainCredentials

Defined in Hercules.CLI.Credentials

type Rep DomainCredentials = D1 ('MetaData "DomainCredentials" "Hercules.CLI.Credentials" "hercules-ci-cli-0.3.5-inplace" 'False) (C1 ('MetaCons "DomainCredentials" 'PrefixI 'True) (S1 ('MetaSel ('Just "personalToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data CredentialsParsingException

Constructors

CredentialsParsingException

Fields

• filePath :: FilePath
• message :: Text

Instances

Exception CredentialsParsingException

Defined in Hercules.CLI.Credentials

Methods

toException :: CredentialsParsingException -> SomeException

fromException :: SomeException -> Maybe CredentialsParsingException

displayException :: CredentialsParsingException -> String

Show CredentialsParsingException

Defined in Hercules.CLI.Credentials

Methods

showsPrec :: Int -> CredentialsParsingException -> ShowS

show :: CredentialsParsingException -> String

showList :: [CredentialsParsingException] -> ShowS

Eq CredentialsParsingException

Defined in Hercules.CLI.Credentials

Methods

(==) :: CredentialsParsingException -> CredentialsParsingException -> Bool

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

data NoCredentialException

Constructors

NoCredentialException

Fields

• noCredentialDomain :: Text

Instances

Exception NoCredentialException

Defined in Hercules.CLI.Credentials

Methods

toException :: NoCredentialException -> SomeException

fromException :: SomeException -> Maybe NoCredentialException

displayException :: NoCredentialException -> String

Show NoCredentialException

Defined in Hercules.CLI.Credentials

Methods

showsPrec :: Int -> NoCredentialException -> ShowS

show :: NoCredentialException -> String

showList :: [NoCredentialException] -> ShowS

Eq NoCredentialException

Defined in Hercules.CLI.Credentials

Methods

(==) :: NoCredentialException -> NoCredentialException -> Bool

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

data ApiBaseUrlParsingException

Constructors

ApiBaseUrlParsingException

Fields

• apiBaseUrlParsingMessage :: Text

Instances

Exception ApiBaseUrlParsingException

Defined in Hercules.CLI.Credentials

Methods

toException :: ApiBaseUrlParsingException -> SomeException

fromException :: SomeException -> Maybe ApiBaseUrlParsingException

displayException :: ApiBaseUrlParsingException -> String

Show ApiBaseUrlParsingException

Defined in Hercules.CLI.Credentials

Methods

showsPrec :: Int -> ApiBaseUrlParsingException -> ShowS

show :: ApiBaseUrlParsingException -> String

showList :: [ApiBaseUrlParsingException] -> ShowS

Eq ApiBaseUrlParsingException

Defined in Hercules.CLI.Credentials

Methods

(==) :: ApiBaseUrlParsingException -> ApiBaseUrlParsingException -> Bool

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

getCredentialsFilePath :: IO FilePath

readCredentials :: IO Credentials

parseCredentials :: FilePath -> ByteString -> Either CredentialsParsingException Credentials

writeCredentials :: Credentials -> IO ()

urlDomain :: Text -> Either Text Text

determineDomain :: IO Text

writePersonalToken :: Text -> Text -> IO ()

readPersonalToken :: Text -> IO Text

tryReadEffectToken :: IO (Maybe Text)

Try to get a token from the local environment.

1. HERCULES_CI_API_TOKEN
2. HERCULES_CI_SECRETS_JSON

tryReadEffectTokenFromEnv :: MaybeT IO Text

tryReadEffectTokenFromFile :: MaybeT IO Text

readToken :: IO Text -> IO Text