Refactor and update disclaimers (including user-agent header info)

Author: csessh

README.md

@@ -9,17 +9,28 @@ If you're like me and you don't want to copy and paste puzzle input from the web
 There are other CLI tools that accomplish the same task, none I could see for Neovim. Inspirations include:
 
 - [CLI written in Rust](https://github.com/scarvalhojr/aoc-cli)
-- [CLI written in Python](https://github.com/emilkloeden/aoc-cli-python)
+- [CLI written in Python](https://github.com/wimglenn/advent-of-code-data)
 
 I'd like to stay within Neovim for as long as I could possibly get away with doing so. Hence, this plugin.
 
 In the true developer fashion, I started with one task to solve Advent of Code puzzles, I ended up talking myself into "Let's spend a day or two to write a tool that saves me ... 5s of copy and paste task". Here we are.
 
+
+## Disclaimer
+
+This plugin follows the automation guidelines on the `r/adventofcode` [community wiki](https://www.reddit.com/r/adventofcode/wiki/faqs/automation). 
+
+Specifically:
+
+- Outbound calls are throttled to every 5 minutes.
+- Once inputs are downloaded, they are cached locally.
+- If you suspect your input is corrupted, you can manually clear cache and request new input with `:AocClearCache`
+- The User-Agent header used in HTTP requests is set to me since I maintain this tool.
+
 ### Other features in the work 
 
 There are a number of features I'd like to add in the coming days/weeks to get to v1.0.0
 
-- `:AocSubmitAnswer` to submit your answer.
 - `:AocGetSampleInput` to write puzzle's sample input to file.
 - `:AocYankSampleInput` to yank a puzzle's sample input to a register.
 
@@ -50,7 +61,7 @@ return {
 },
 ```
 
-Should you want to lazy load this plugin, you could add a condition check in its config:
+Should you want to lazy load this plugin, you could add a condition check in its config like so:
 
 ``` lua
 cond = vim.fn.getcwd() == vim.fn.expand("your AOC directory path"),
@@ -65,7 +76,8 @@ local default_opts = {
    session_filepath = "/var/tmp/aoc.txt", -- Default filepath to your AOC session token
    puzzle_input = { 
       filename = "puzzle.txt",            -- Default puzzle input filename
-      save_to_current_dir = true,         -- Save puzzle input file to your current buffer's cwd() using {filename} attribute above
+      save_to_current_dir = true,         -- Save puzzle input file to your current buffer's cwd() 
+                                          -- using {filename} attribute listed above.
       alternative_filepath = nil,         -- This option is ONLY used when save_to_current_dir is set to false
                                           -- This option allows you to set a generic filepath for your puzzle input
                                           -- For example: ~/aoc/input.txt or ~/aoc/puzzle ...

lua/aoc/api.lua

@@ -1,9 +1,12 @@
+local inspect = require "vim.inspect"
 local cache = require "aoc.cache"
 local curl = require "plenary.curl"
 local cfg = require "aoc.config"
 
 ---@class APIWrapper
 local M = {}
+M.session_id = nil
+M.user_agent = "github.com/csessh/aoc.nvim by csessh@hey.com"
 
 ---@param day string|osdate
 ---@param year string|osdate
@@ -34,6 +37,25 @@ local validate_args = function(day, year)
    return true
 end
 
+---Load session token from file
+---@return string?
+local get_session_id = function()
+   if M.session_id then
+      return M.session_id
+   end
+
+   local f = io.open(cfg.options.session_filepath, "r")
+   if not f then
+      return nil
+   end
+
+   local sid = f:read "*a"
+   M.session_id = sid
+   f:close()
+
+   return sid
+end
+
 -- Effectively send a curl request like so:
 -- curl -X GET https://adventofcode.com/{year}/day/{day}/input -H "Cookie: session={session_token_path}"
 -- Always check and validate cache before sending out requests. It's best to polite.
@@ -50,59 +72,28 @@ M.save_puzzle_input = function(day, year)
       local content = cf:read "*a"
       cf:close()
 
-      local f = io.open(vim.uv.cwd() .. "/" .. cfg.options.puzzle_input.filename, "w")
-      if not f then
-         vim.api.nvim_err_writeln("Unable to write puzzle input to file at " .. cfg.options.puzzle_input.filename)
-         return
-      end
-
-      f:write(content)
-      f:close()
-
-      vim.notify("Successfully retrieved puzzle input for Day " .. day .. " (" .. year .. ")")
+      cache.write_to_file(day, year, content)
       return
    end
 
    -- Proceed to send GET request to AOC server for the puzzle input
-   local f = io.open(cfg.options.session_filepath, "r")
-   if not f then
+   local sid = get_session_id()
+   if not sid then
       vim.api.nvim_err_writeln "Advent Of Code session token is missing. See :help aoc.nvim-requirements"
       return
    end
 
-   local sid = f:read "*a"
-   f:close()
-
    local response = curl.get {
       url = "https://adventofcode.com/" .. year .. "/day/" .. day .. "/input",
       headers = {
          cookie = "session=" .. sid,
+         user_agent = M.user_agent,
       },
    }
 
    if response.status == 200 then
-      -- Cache the puzzle input for future use
-      cache.write(day, year, response.body)
-
-      -- Write puzzle input to user's cwd() or where they specify it otherwise
-      local filename = ""
-      if cfg.options.puzzle_input.save_to_current_dir then
-         filename = vim.uv.cwd() .. "/" .. cfg.options.puzzle_input.filename
-      else
-         filename = cfg.options.puzzle_input.alternative_filepath
-      end
-
-      ---@diagnostic disable-next-line: param-type-mismatch
-      f = io.open(filename, "w")
-      if not f then
-         vim.api.nvim_err_writeln("Unable to write puzzle input to file at " .. filename)
-         return
-      end
-
-      f:write(response.body)
-      f:close()
-
-      vim.notify("Successfully downloaded puzzle input for Day " .. day .. " (" .. year .. ")")
+      cache.write_to_cache(day, year, response.body)
+      cache.write_to_file(day, year, response.body)
    else
       vim.api.nvim_err_writeln(response.body)
    end

lua/aoc/cache.lua

@@ -1,3 +1,5 @@
+local cfg = require "aoc.config"
+
 ---@class PuzzleCache
 local M = {}
 
@@ -35,8 +37,7 @@ end
 ---Write cached content to file
 ---@param day string|osdate
 ---@param year string|osdate
----@return boolean
-M.write = function(day, year, content)
+M.write_to_cache = function(day, year, content)
    -- Create a cache directory if one doesn't exist
    -- Quite a clevery hacky way to check if a directory exists without relying on external packages
    local ok, err = os.rename(cache_path, cache_path)
@@ -49,13 +50,35 @@ M.write = function(day, year, content)
    local f = io.open(filename, "w")
    if not f then
       vim.api.nvim_err_writeln("Unable to write puzzle input to cache at " .. filename)
-      return false
+   else
+      f:write(content)
    end
 
-   f:write(content)
    f:close()
+end
 
-   return true
+---Write puzzle input to user's cwd() or where they specify it otherwise
+---@param day string|osdate
+---@param year string|osdate
+---@param content string
+M.write_to_file = function(day, year, content)
+   local filename = ""
+   if cfg.options.puzzle_input.save_to_current_dir then
+      filename = vim.uv.cwd() .. "/" .. cfg.options.puzzle_input.filename
+   else
+      filename = cfg.options.puzzle_input.alternative_filepath
+   end
+
+   ---@diagnostic disable-next-line: param-type-mismatch
+   local f = io.open(filename, "w")
+   if not f then
+      vim.api.nvim_err_writeln("Unable to write puzzle input to file at " .. filename)
+   else
+      f:write(content)
+      f:close()
+   end
+
+   vim.notify("Successfully downloaded puzzle input for Day " .. day .. " (" .. year .. ")")
 end
 
 return M

lua/aoc/init.lua

@@ -1,18 +1,11 @@
 local api = require "aoc.api"
 local cfg = require "aoc.config"
 local cache = require "aoc.cache"
+local utils = require "aoc.utils"
 
 ---@class AOC
 local M = {}
 
----Strip input of any leading/trailing spaces
----@param s string
----@return string
-local trim = function(s)
-   s, _ = string.gsub(s, "%s+", "")
-   return s
-end
-
 ---@param args any
 M.setup = function(args)
    cfg.init(args)
@@ -22,8 +15,8 @@ M.setup = function(args)
       local year = vim.fn.input "Year: "
       vim.api.nvim_out_write "\n"
 
-      day = trim(day)
-      year = trim(year)
+      day = utils.trim(day)
+      year = utils.trim(year)
       api.save_puzzle_input(day, year)
    end, {})
 
@@ -34,6 +27,29 @@ M.setup = function(args)
       api.save_puzzle_input(day, year)
    end, {})
 
+   vim.api.nvim_create_user_command("AocSubmitAnswer", function()
+      local day = vim.fn.input "Day: "
+      local year = vim.fn.input "Year: "
+      local answer = vim.fn.input "Answer: "
+      vim.api.nvim_out_write "\n"
+
+      day = utils.trim(day)
+      year = utils.trim(year)
+      answer = utils.trim(answer)
+
+      api.submit_answer(day, year, answer)
+   end, {})
+
+   vim.api.nvim_create_user_command("AocSubmitTodayAnswer", function()
+      local day = os.date "%d"
+      local year = os.date "%Y"
+
+      local answer = vim.fn.input "Answer: "
+      vim.api.nvim_out_write "\n"
+
+      api.submit_answer(day, year, answer)
+   end, {})
+
    vim.api.nvim_create_user_command("AocClearCache", cache.clear_cache, {})
    vim.api.nvim_create_user_command("AocInspectConfig", cfg.debug, {})
 end

lua/aoc/notification.lua lua/aoc/utils.lua

@@ -1,11 +1,19 @@
----@class Notification
+---@class Utility
 local M = {}
 
+---Strip a string of any leading/trailing spaces
+---@param s string
+---@return string
+M.trim = function(s)
+   s, _ = string.gsub(s, "%s+", "")
+   return s
+end
+
 --- Create a simple popup message, positioned in the bottom right corner of the buffer
 --- Automatically close this popup after timeout_ms milliseconds
 ---@param message string
----@param timeout_ms number
-M.show = function(message, timeout_ms)
+---@param timeout_ms integer
+M.popup = function(message, timeout_ms)
    local width = #message
    local height = 1
    local buf = vim.api.nvim_create_buf(false, true)