advent-of-code-api
Advent of Code REST API bindings and servant API
https://github.com/mstksg/advent-of-code-api#readme
Version on this page: | 0.2.8.1 |
LTS Haskell 21.25: | 0.2.9.1 |
Stackage Nightly 2024-10-31: | 0.2.9.1 |
Latest on Hackage: | 0.2.9.1 |
advent-of-code-api-0.2.8.1@sha256:00a7b1fe76bdbba0ad705d906402fbb35eb35ccb6f9a7adec488a65bb8147ad4,2352
Module documentation for 0.2.8.1
advent-of-code-api
Haskell bindings for Advent of Code REST API. Caches and throttles requests automatically, and parses responses into meaningful data types.
Specify your requests with AoC
and AoCOpts
, and run them with
runAoC
.
Examples:
-- Fetch prompts for day 5
runAoC myOpts $ AoCPrompt (mkDay_ 5)
-- Fetch input for day 8
runAoC myOpts $ AoCInput (mkDay_ 8)
-- Submit answer "hello" for Day 10, Part 1
runAoC myOpts $ AoCSubmit (mkDay_ 10) Part1 "hello"
Please use responsibly. All actions are rate-limited to a default of one request every three seconds, with ability to adjust up to as fast as a hard-coded limit of one request per second.
The neatly exported bindings (handling cookies/authentication, cacheing, throttling) are in Advent.
Session Keys
Session keys are required for most commands, but if you enter a bogus key
you should be able to get at least Part 1 from AoCPrompt
. Session keys are
also not needed for daily and global leaderboards.
The session key can be found by logging in on a web client and checking the cookies. You can usually check these with in-browser developer tools.
Servant API
A Servant API (for integrating with servant for features like mock servers, documentation and low-level client methods) is also exported in Advent.API. The Servant API also parses into meaningful types, but lacks management of cookies/auth, cacheing, and throttling. Please use especially responsibly.
Changes
Changelog
Version 0.2.8.1
November 30, 2021
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.8.1
- Account for new json schema for private leaderboard stats
Version 0.2.8.0
December 14, 2020
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.8.0
- Add servant endpoint to query calendar page for a year to infer next puzzle
and time to puzzle in seconds, backed by the
NextDayTime
data type. - Add
AoCNextDayTime
toAoC
to support the above operation.
Version 0.2.7.1
November 28, 2020
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.7.1
- Work with servant 0.17 and above.
Version 0.2.7.0
December 4, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.7.0
- Throughout the library, change from
UTCTime
toZonedTime
, except for situations where the official site uses actual UTCTime. The main change is inchallengeReleaseTime
. challengeReleaseTime
moved to Advent.Types but re-exported from Advent.dlbmTime
changed fromUTCTime
toNominalDiffTime
dlbmDecTime
, which is time from December 1st. This is because we don’t have information about the year from the HTML returned alone. This fixes a bug where the time would always be in 1970.- To convert
dlbmDecTime
back into a useful time,addeddlbmCompleteTime
to get the actual time of completion (as aZonedTime
), anddlbmTime
to get theNominalDiffTime
representing how long the challenge took.
Version 0.2.6.0
December 3, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.6.0
- Add
aocServerTime
to get the current time for AoC servers. - Fix cacheing rules for global leaderboard (was previously not saving or invalidating cache properly) also for prompt (will not invalidate part1-only caches if there is no session key)
- 0.2.6.1 Bugfix: Fix bug in prompt cache invalidation
- 0.2.6.2 Bugfix: HTML parser for articles (for prompt API calls) now more robust, adjusting for more malformed HTML from site.
Version 0.2.5.0
December 2, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.5.0
- Add
runAoC_
, which isrunAoC
but throwing an IO exception instead of returning anEither
.
Version 0.2.4.2
November 23, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.4.2
- Added instances of
ToJSONKey Day
,ToJSON Day
,ToJSONKey Part
,ToJSON Part
.
Version 0.2.4.1
November 21, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.4.1
- Export
DayInt
and_DayInt
from Advent module
Version 0.2.4.0
November 21, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.4.0
- Fixed caching behavior and documentation to reflect that Day 25 actually does have 2 stars, like normal.
- Some extra smart constructors for moving between
Day
andInteger
, in the form of aPrism
and a pattern synonym.
Version 0.2.3.0
November 21, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.3.0
- Add API commands for daily and global leaderboards.
- In the process, the Servant API is reshuffled a bit:
Articles
has been generalized toHTMLTags "article"
, to also supportHTMLTags "div"
.FromArticle
is nowFromTags "article"
. - Move some of the data types to be in their own module, Advent.Types.
Version 0.2.2.1
November 19, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.2.1
- Fixed prompt parser that would fail on 2016 Day 2 Part 2 because of a
malformed
<span>...</title>
tag pair in the prompt HTML
Version 0.2.2.0
November 9, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.2.0
- Rewrote submission response parser using megaparsec for better errors
Version 0.2.1.0
November 5, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.1.0
- Export
Day
constructor from Advent
Version 0.2.0.0
November 4, 2019
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.2.0.0
- Switch from libcurl to servant, which allows for shedding of external dependencies.
- Support leaderboard API with data type.
- Expose raw servant API and client functions, for those who want to build documentation or a mock server or low-level client.
Version 0.1.2.X
-
December 8, 2018: BUGFIX Switched from taggy to tagsoup, after observing that taggy had some issues parsing 2018’s Day 8 challenge prompt.
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.2.1
-
December 8, 2018: BUGFIX Add CPP to deal with building issues on GHC 8.2
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.2.2
-
December 8, 2018: BUGFIX Fix cache directory to separate by year
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.2.3
Version 0.1.2.0
December 7, 2018
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.2.0
- Fixed cache to store prompts at
.html
instead of.yaml
SubIncorrect
andSubWait
now include fields for wait times.- Re-implemented submission result parsers using attoparsec
Version 0.1.1.0
December 7, 2018
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.1.0
- More robust parser for submission results. Also now reports “hints” if possible.
Version 0.1.0.0
December 5, 2018
https://github.com/mstksg/advent-of-code-api/releases/tag/v0.1.0.0
- Initial Release