Skip to content

Commit

Permalink
minor code changes + major documentation changes
Browse files Browse the repository at this point in the history 
code changes:
- bug fixed response of SubmitAnswerAsync
- changed every Regex to GeneratedRegexAttributes

documentation changes:
- added documentation to code
- updated README.md documentation
  • Loading branch information
@antoniosubasic
antoniosubasic committed Dec 9, 2023
1 parent f567d6e commit a3cb691
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 32 deletions.
123 changes: 100 additions & 23 deletions APIHandler.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,45 @@

namespace AoC.API;

public class Session
public partial class Session
{
private string _rawCookie { get; }
private string _cookie => $"session={_rawCookie}";
/// <summary>
/// The cookie value for authentication.
/// </summary>
private string _cookie { get; }

/// <summary>
/// The year of the Advent of Code puzzle.
/// </summary>
private int _year { get; }

/// <summary>
/// The day of the Advent of Code puzzle.
/// </summary>
private int _day { get; }

/// <summary>
/// Initializes a new instance of the session class with a specified cookie, year and day.
/// </summary>
/// <param name="cookie">The session cookie - How to obtain the session cookie: https://mmhaskell.com/blog/2023/1/30/advent-of-code-fetching-puzzle-input-using-the-api#authentication</param>
/// <param name="year">The year of the Advent of Code puzzle.</param>
/// <param name="day">The day of the Advent of Code puzzle.</param>
public Session(string cookie, int year, int day)
{
_rawCookie = cookie;
_cookie = cookie;
_year = year;
_day = day;
}

/// <summary>
/// Initializes a new instance of the session class with a specified cookie, input string and regex pattern.
/// </summary>
/// <param name="cookie">The session cookie - How to obtain the session cookie: https://mmhaskell.com/blog/2023/1/30/advent-of-code-fetching-puzzle-input-using-the-api#authentication</param>
/// <param name="input">The input string.</param>
/// <param name="pattern">The regex pattern - group containing year must be named "year" and group containing day must be named "day". How to name regex groups: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_capturing_group</param>
public Session(string cookie, string input, Regex pattern)
{
_rawCookie = cookie;
_cookie = cookie;

var match = pattern.Match(input);
if (match.Success)
Expand All @@ -31,14 +53,21 @@ public Session(string cookie, string input, Regex pattern)
}


/// <summary>
/// Sends an HTTP request.
/// </summary>
/// <param name="method">The HTTP method to use for the request.</param>
/// <param name="uri">The URI of the request.</param>
/// <param name="content">The HTTP content to send with the request (optional).</param>
/// <returns>The response content as a string.</returns>
private async Task<string> SendRequestAsync(HttpMethod method, string uri, HttpContent? content = null)
{
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = method,
RequestUri = new Uri(uri),
Headers = { { "Cookie", _cookie } }
Headers = { { "Cookie", $"session={_cookie}" } }
};
if (content != null) { request.Content = content; }

Expand All @@ -49,21 +78,43 @@ private async Task<string> SendRequestAsync(HttpMethod method, string uri, HttpC
}
}

public async Task<string> GetSampleInputTextAsync(int part = 1)
/// <summary>
/// Retrieves the nth sample input text of the Advent of Code puzzle.
/// </summary>
/// <param name="nth">The nth sample of the Advent of Code puzzle.</param>
/// <returns>The sample input text as a string.</returns>
public async Task<string> GetSampleInputTextAsync(int nth)
{
var response = await SendRequestAsync(HttpMethod.Get, $"https://adventofcode.com/{_year}/day/{_day}");
var matches = SampleRegex().Matches(response);

var regex = new Regex(@"<pre><code>(?<sample>(.*?\n)*?)<\/code><\/pre>");
var matches = regex.Matches(response);

if (matches.Count >= part) { return matches[part - 1].Groups["sample"].Value.TrimEnd('\n'); }
if (matches.Count >= nth) { return matches[nth - 1].Groups["sample"].Value.TrimEnd('\n'); }
else { throw new Exception("sample could not be found"); }
}
public async Task<string[]> GetSampleInputLinesAsync(int part = 1) => (await GetSampleInputTextAsync(part)).Split('\n');

/// <summary>
/// Retrieves the nth sample input lines of the Advent of Code puzzle.
/// </summary>
/// <param name="nth">The nth sample of the Advent of Code puzzle.</param>
/// <returns>The sample input lines as a string array.</returns>
public async Task<string[]> GetSampleInputLinesAsync(int nth) => (await GetSampleInputTextAsync(nth)).Split('\n');

/// <summary>
/// Retrieves the input text for the Advent of Code puzzle.
/// </summary>
/// <returns>The input text as a string.</returns>
public async Task<string> GetInputTextAsync() => (await SendRequestAsync(HttpMethod.Get, $"https://adventofcode.com/{_year}/day/{_day}/input")).TrimEnd('\n');

/// <summary>
/// Retrieves the input lines for the Advent of Code puzzle.
/// </summary>
/// <returns>The input lines as a string array.</returns>
public async Task<string[]> GetInputLinesAsync() => (await GetInputTextAsync()).Split('\n');

/// <summary>
/// Retrieves the number of stars earned for each year's Advent of Code.
/// </summary>
/// <returns>A dictionary containing the year as the key and the number of stars earned as the value.</returns>
public async Task<Dictionary<int, int>> GetAllStarsAsync()
{
var response = (await SendRequestAsync(HttpMethod.Get, $"https://adventofcode.com/events"))
Expand All @@ -83,6 +134,12 @@ public async Task<Dictionary<int, int>> GetAllStarsAsync()
}).ToDictionary(x => x.Year, x => x.Stars);
}

/// <summary>
/// Submits the answer for a specific part of the Advent of Code puzzle.
/// </summary>
/// <param name="part">The part of the puzzle.</param>
/// <param name="answer">The answer to submit.</param>
/// <returns>Returns whether the answer was true or false and a cooldown if existent.</returns>
public async Task<string> SubmitAnswerAsync(int part, object answer)
{
var content = new StringContent($"level={part}&answer={answer}")
Expand All @@ -92,21 +149,41 @@ public async Task<string> SubmitAnswerAsync(int part, object answer)

var response = await SendRequestAsync(HttpMethod.Post, $"https://adventofcode.com/{_year}/day/{_day}/answer", content);

if (response.Contains("That's the right answer!") || response.Contains("You don't seem to be solving the right level. Did you already complete it?")) { return "True"; }
else if (response.Contains("You gave an answer too recently") || response.Contains("before trying again"))
if (response.Contains("That's the right answer!")) { return "True"; }
else if (response.Contains("You don't seem to be solving the right level. Did you already complete it?"))
{
var dayResponse = await SendRequestAsync(HttpMethod.Get, $"https://adventofcode.com/{_year}/day/{_day}");
var matches = PuzzleAnswerRegex().Matches(dayResponse);

if (matches.Count >= part) { return (matches[part - 1].Groups["answer"].Value == answer.ToString()).ToString(); }
else { throw new Exception("answer could not be found"); }
}
else if (response.Contains("You gave an answer too recently"))
{
var regex = (
new Regex(@"You have (?<time>.*?) left to wait"),
new Regex(@"wait (?<time>.*?) before trying again")
);
var match = TimeForAnswerTooRecentRegex().Match(response);

var match = (
regex.Item1.Match(response),
regex.Item2.Match(response)
);
if (match.Success) { return $"cooldown left: {match.Groups["time"].Value}"; }
else { throw new Exception("time could not be found"); }
}
else if (response.Contains("That's not the right answer.") && response.Contains("before trying again."))
{
var match = TimeForWrongAnswerRegex().Match(response);

return $"on cooldown: {(match.Item1.Success ? match.Item1 : match.Item2).Groups["time"].Value}";
if (match.Success) { return $"False\non cooldown: {match.Groups["time"].Value}"; }
else { throw new Exception("time could not be found"); }
}
else { return "False"; }
}

[GeneratedRegex(@"<pre><code>(?<sample>(.*?\n)*?)<\/code><\/pre>")]
private static partial Regex SampleRegex();

[GeneratedRegex(@"<p>Your puzzle answer was <code>(?<answer>.*?)</code>.</p>")]
private static partial Regex PuzzleAnswerRegex();

[GeneratedRegex(@"You have (?<time>.*?) left to wait")]
private static partial Regex TimeForAnswerTooRecentRegex();

[GeneratedRegex(@"wait (?<time>.*?) before trying again")]
private static partial Regex TimeForWrongAnswerRegex();
}
2 changes: 1 addition & 1 deletion AoC.API.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<PackageTags>AoC, Advent-of-Code, API</PackageTags>
<RepositoryUrl>https://github.com/antonio-subasic/AoC.API</RepositoryUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageVersion>2.2.6</PackageVersion>
<PackageVersion>2.2.7</PackageVersion>
</PropertyGroup>

<ItemGroup>
Expand Down
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ using AoC.API;
# Session initialization

```csharp
var client = new Session("session cookie", int year, int day);
var client = new Session("session cookie", int year, int day); // Initializes a new instance of the session class with a specified cookie, year and day.
```

```csharp
var client = new Session("session cookie", string input, Regex pattern);
var client = new Session("session cookie", string input, Regex pattern); // Initializes a new instance of the session class with a specified cookie, input string and regex pattern.
```

> <picture>
Expand All @@ -52,33 +52,33 @@ var client = new Session("session cookie", string input, Regex pattern);
## Get input

```csharp
string inputText = await client.GetInputTextAsync(); // input (raw text)
string inputLines = await client.GetInputLinesAsync(); // input (lines array)
string inputText = await client.GetInputTextAsync(); // Retrieves the input text for the Advent of Code puzzle.
string[] inputLines = await client.GetInputLinesAsync(); // Retrieves the input lines for the Advent of Code puzzle.
```

<br>

## Get sample input

```csharp
string sampleInputText = await client.GetSampleInputTextAsync(int part); // sample input (raw text)
string sampleInputLines = await client.GetSampleInputLinesAsync(int part); // sample input (lines array)
string sampleInputText = await client.GetSampleInputTextAsync(int nth); // Retrieves the nth sample input text of the Advent of Code puzzle.
string[] sampleInputLines = await client.GetSampleInputLinesAsync(int nth); // Retrieves the nth sample input lines of the Advent of Code puzzle.
```

<br>

## Get achieved stars

```csharp
Dictionary<int, int> achievedStars = await client.GetAllStarsAsync(); // all user's achieved stars (key = year, value = stars)
Dictionary<int, int> achievedStars = await client.GetAllStarsAsync(); // Retrieves the number of stars earned for each year's Advent of Code. (key: year, value: stars)
```

<br>

## Submit answer

```csharp
string status = await client.SubmitAnswerAsync(int part, object answer); // submits answer to initialized year and day, returns "True" or "False" or "on cooldown: {cooldown}"
string status = await client.SubmitAnswerAsync(int part, object answer); // Submits the answer for a specific part of the Advent of Code puzzle. Returns whether the answer was true or false and a cooldown if existent.
```

<br><br>
Expand Down

0 comments on commit a3cb691

Please sign in to comment.