Advent.API

Raw Servant API for Advent of Code. Can be useful for building mock servers, generating documentation and other servanty things, or low-level raw requests.

If you use this to make requests directly, please use responsibly: do not make automated requests more than once per day and throttle all manual requestes. See notes in Advent.

Since: 0.2.0.0

Servant API

type AdventAPI = Capture "year" Integer :> (Get '[Scripts] NextDayTime :<|> (("day" :> (Capture "day" Day :> (Get '[Articles] (Map Part Text) :<|> (("input" :> Get '[RawText] Text) :<|> ("answer" :> (ReqBody '[FormUrlEncoded] SubmitInfo :> Post '[Articles] (Text :<|> SubmitRes))))))) :<|> ("leaderboard" :> (Get '[Divs] GlobalLeaderboard :<|> (("day" :> (Capture "day" Day :> Get '[Divs] DailyLeaderboard)) :<|> ("private" :> ("view" :> (Capture "code" PublicCode :> Get '[JSON] Leaderboard))))))))

REST API of Advent of Code.

Note that most of these requests assume a "session=" cookie.

adventAPI :: Proxy AdventAPI

Proxy used for servant functions.

adventAPIClient :: Integer -> ClientM NextDayTime :<|> ((Day -> ClientM (Map Part Text) :<|> (ClientM Text :<|> (SubmitInfo -> ClientM (Text :<|> SubmitRes)))) :<|> (ClientM GlobalLeaderboard :<|> ((Day -> ClientM DailyLeaderboard) :<|> (PublicCode -> ClientM Leaderboard))))

ClientM requests based on AdventAPI, generated by servant.

adventAPIPuzzleClient :: Integer -> Day -> ClientM (Map Part Text) :<|> (ClientM Text :<|> (SubmitInfo -> ClientM (Text :<|> SubmitRes)))

A subset of adventAPIClient for only puzzle-related API routes, not leaderboard ones.

Types

data HTMLTags (tag :: Symbol)

Interpret repsonse as a list of HTML Text found in the given type of tag

Since: 0.2.3.0

Instances

Accept (HTMLTags cls :: Type)

Defined in Advent.API

Methods

contentType :: Proxy (HTMLTags cls) -> MediaType

contentTypes :: Proxy (HTMLTags cls) -> NonEmpty MediaType

(FromTags tag a, KnownSymbol tag) => MimeUnrender (HTMLTags tag :: Type) a

Defined in Advent.API

Methods

mimeUnrender :: Proxy (HTMLTags tag) -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy (HTMLTags tag) -> MediaType -> ByteString -> Either String a

class FromTags tag a where

Class for interpreting a list of Text in tags to some desired output.

Since: 0.2.3.0

Methods

fromTags :: p tag -> [Text] -> Maybe a

Instances

FromTags "article" SubmitRes

Defined in Advent.API

Methods

fromTags :: p "article" -> [Text] -> Maybe SubmitRes

FromTags "div" DailyLeaderboard

Defined in Advent.API

Methods

fromTags :: p "div" -> [Text] -> Maybe DailyLeaderboard

FromTags "div" GlobalLeaderboard

Defined in Advent.API

Methods

fromTags :: p "div" -> [Text] -> Maybe GlobalLeaderboard

FromTags "script" NextDayTime

Defined in Advent.API

Methods

fromTags :: p "script" -> [Text] -> Maybe NextDayTime

FromTags (cls :: k) Text

Defined in Advent.API

Methods

fromTags :: p cls -> [Text] -> Maybe Text

FromTags (cls :: k) [Text]

Defined in Advent.API

Methods

fromTags :: p cls -> [Text] -> Maybe [Text]

(Ord a, Enum a, Bounded a) => FromTags (cls :: k) (Map a Text)

Defined in Advent.API

Methods

fromTags :: p cls -> [Text] -> Maybe (Map a Text)

(FromTags cls a, FromTags cls b) => FromTags (cls :: k) (a :<|> b)

Defined in Advent.API

Methods

fromTags :: p cls -> [Text] -> Maybe (a :<|> b)

type Articles = HTMLTags "article"

Interpret a response as a list of HTML Text found in article tags.

type Divs = HTMLTags "div"

Interpret a response as a list of HTML Text found in div tags.

Since: 0.2.3.0

type Scripts = HTMLTags "script"

Interpret a response as a list of HTML Text found in script tags.

data RawText

Raw "text/plain" MIME type

Instances

Accept RawText

Defined in Advent.API

Methods

contentType :: Proxy RawText -> MediaType

contentTypes :: Proxy RawText -> NonEmpty MediaType

MimeUnrender RawText Text

Defined in Advent.API

Methods

mimeUnrender :: Proxy RawText -> ByteString -> Either String Text

mimeUnrenderWithType :: Proxy RawText -> MediaType -> ByteString -> Either String Text

Internal

processHTML

Arguments

:: String

tag type

-> Text

html

-> [Text]

Process an HTML webpage into a list of all contents in the given tag type