Feature: API to check remaining war attacks on current war

[josephwccheng]

Notes on Response body

Can use the following endpoint to determine the clans that are participating in the riverwar respective to the clan tag as the input:

https://api.clashroyale.com/v1/clans/<clan_tag>/currentriverrace

example: where <clan_tag> is %239GULPJ9L for ausclan

Note:

• endpoint is from official Royale API
• grab the clans item from the response
• participants for each clan could be greater than 50 because people come and go

How to get remainingPlayer

• out of the participants, grab all who has decksUsedToday != 0, and then count up deckUsedToday != 4.
• from the result, do 50 - the result to find out the # of participants who hasnt done their war.

Note: != 0 can tell us how many minis we can bring into the clan

Output requirements

• A list of Clans (5 max) - ordered by Medals (highest to lowest)
• Right before table output, explain what each column represents (follow similar format/bold/spacing as other command outputs)

  Clan        | Medals | Participated | DecksRemaining  | PlayersRemaining |
  --------------+--------+--------------+-----------------+------------------|
  Ausclan     | 29860  |    44/50     | 10 decks        |  6 players       |
  ifTrashClan | 28000  |    40/50     | 30 decks        | 10 players       |
  soClanYou   | 26400  |    30/50     | 70 decks        | 20 players       |
  otherClan   |  5000  |    50/50     | 150 decks       | 50 players       |

  Note:

• can call the endpoint /clans/{clanTag} to get list of current 50 players in clan
• Medals corresponds to periodPoints in the API response. It is the number of medals won in current war day (NOT the total movement points over the week)
• PlayersRemaining : players who haven't used all 4 attacks AND are currently in clan (deckUsedToday != 4 and CURRENTLY in clan)
• DecksRemaining: the amount of decks that hasn't been used:
  • (50 - num_players_used_deck_left_clan) * 4 - sum_of("deckUsedToday for all CURRENT clan members")
• Participated: players who used any attacks even if they're no longer in clan this week ( deckUsedToday != 0)

Steps:

1. Ingest clash royale currentriverrace and clan API and format it into appropriate data structure
2. Transform the ingested data into the summary table above
3. Display table into discord bot

[josephwccheng]