Codeforces.Config

Documentation

data UserConfig

Represents the user's configuration settings.

The API key must first be generated on the Codeforces API page. An API key consists of two parameters: key and secret.

To use the API key in a request, some parameters need to be generated from this configuration.

Constructors

UserConfig

Fields

• cfgHandle :: Handle

  Codeforces handle of the user

• cfgKey :: Text

  First part of the API key

• cfgSecret :: Text

  Second part of the API key

Instances

Show UserConfig

Defined in Codeforces.Config

Methods

showsPrec :: Int -> UserConfig -> ShowS

show :: UserConfig -> String

showList :: [UserConfig] -> ShowS

ToJSON UserConfig

Defined in Codeforces.Config

Methods

toJSON :: UserConfig -> Value

toEncoding :: UserConfig -> Encoding

toJSONList :: [UserConfig] -> Value

toEncodingList :: [UserConfig] -> Encoding

FromJSON UserConfig

Defined in Codeforces.Config

Methods

parseJSON :: Value -> Parser UserConfig

parseJSONList :: Value -> Parser [UserConfig]

data AuthQuery

Contains the data needed to make an authorized GET request. See generateRequestParams.

Constructors

AuthQuery

Fields

• aqOriginalQuery :: Query
• aqMethodName :: String
• aqKey :: Text
• aqSecret :: Text
• aqTime :: POSIXTime
• aqRand :: Int

generateRequestParams :: UserConfig -> String -> Query -> IO Query

generateRequestParams config path query returns a query string with extra query items that are generated to allow for authorized access.

The parameters are of the form: ?paramI=valueI&apiKey=key&time=time&apiSig=randhash

Where

• rand is a random 6-digit integer
• time is current time since epoch in seconds
• hash is the SHA-512 hashcode of the UTF-8 encoded string:

rand/methodName?paramI=valueI&apiKey=key&time=time#secret