Added CryptoStatsSource project documentation

Author: topnax

CryptoStatsSource/CoingeckoSource.cs

@@ -10,20 +10,27 @@ namespace CryptoStatsSource
 {
     public class CoingeckoSource : ICryptoStatsSource
     {
+        // coingecko URL
         private const string BaseUrl = "https://api.coingecko.com/api/";
+        
+        // API version
         private const string ApiVersion = "v3";
 
+        // initialise a HTTP client
         private readonly TinyRestClient _client = new(new HttpClient(), $"{BaseUrl}{ApiVersion}/");
 
         public CoingeckoSource()
         {
+            // set JSON attribute name formatting to snake case
             _client.Settings.Formatters.OfType<JsonFormatter>().First().UseSnakeCase();
         }
 
+        // make a call to the coins/markets API endpoint
         public async Task<List<MarketEntry>> GetMarketEntries(string currency, params string[] ids) => await _client
                 .GetRequest("coins/markets").AddQueryParameter("vs_currency", currency)
                 .AddQueryParameter("ids", String.Join(",", ids)).ExecuteAsync<List<MarketEntry>>();
 
+        // make a call to the coins/list API endpoint
         public async Task<List<Cryptocurrency>> GetAvailableCryptocurrencies() => await _client
                 .GetRequest("coins/list").ExecuteAsync<List<Cryptocurrency>>();
     }

CryptoStatsSource/CryptoNameResolver.cs

@@ -7,31 +7,48 @@ namespace CryptoStatsSource
 {
     public interface ICryptocurrencyResolver
     {
+        /// <summary>
+        /// Resolves a cryptocurrency based on the given cryptocurrency symbol. Returns null value when the symbol does
+        /// not map to any cryptocurrency.
+        /// </summary>
+        /// <param name="symbol">Symbol based on which the cryptocurrency should be resolved</param>
+        /// <returns>A task containing resolved cryptocurrency when finished</returns>
         public Task<Cryptocurrency> Resolve(string symbol);
 
+        /// <summary>
+        /// Refreshes the database of cryptocurrencies mapped to their symbols
+        /// </summary>
+        /// <returns>A task that is finished when all cryptocurrencies are fetched and mapped to their symbols</returns>
         public Task Refresh();
     }
 
     public class CryptocurrencyResolverImpl : ICryptocurrencyResolver
     {
+        // used for retrieving cryptocurrency info
         private ICryptoStatsSource _cryptoStatsSource;
+        
+        // a dictionary mapping symbols to cryptocurrencies
         private Dictionary<String, Cryptocurrency> _nameToCryptocurrencyDictionary;
 
+        /// <param name="cryptoStatsSource">CryptoStatsSource interface to be used</param>
         public CryptocurrencyResolverImpl(ICryptoStatsSource cryptoStatsSource)
         {
             _cryptoStatsSource = cryptoStatsSource;
         }
 
         public async Task Refresh()
         {
-            // TODO improve this
+            // initialize the dictionary
             _nameToCryptocurrencyDictionary = new();
+            
+            // fetch all cryptocurrencies and add them to the dictionary using the symbol as a key
             (await _cryptoStatsSource.GetAvailableCryptocurrencies()).ForEach(c =>
                 _nameToCryptocurrencyDictionary.TryAdd(c.Symbol, c));
         }
 
         public async Task<Cryptocurrency> Resolve(string symbol)
         {
+            // refresh the dictionary if the symbol was not found in it
             if (_nameToCryptocurrencyDictionary?.GetValueOrDefault(symbol) == null) await Refresh();
 
             return _nameToCryptocurrencyDictionary.GetValueOrDefault(symbol, null);

CryptoStatsSource/CryptoStatsSource.cs

@@ -6,8 +6,18 @@ namespace CryptoStatsSource
 {
     public interface ICryptoStatsSource
     {
+        /// <summary>
+        /// Gets all market entries matching the given IDs, price values are relative to the currency specified.
+        /// </summary>
+        /// <param name="currency">Code ("usd", "eur", "czk",...) of the currency the market entry prices should be relative to</param>
+        /// <param name="ids">IDs of the market entries to be fetched</param>
+        /// <returns>List of loaded market entries</returns>
         public Task<List<MarketEntry>> GetMarketEntries(string currency, params string[] ids);
 
+        /// <summary>
+        /// Gets a list of all available cryptocurrencies
+        /// </summary>
+        /// <returns>List of all available cryptocurrencies</returns>
         public Task<List<Cryptocurrency>> GetAvailableCryptocurrencies();
     }
 }

CryptoStatsSource/Model/MarketEntry.cs

@@ -0,0 +1,46 @@
+using Newtonsoft.Json;
+
+namespace CryptoStatsSource.model
+{
+    /// <summary>
+    /// A record representing a market entry (market evaluation of a given cryptocurrency)
+    /// </summary>
+    /// <param name="Id">
+    /// Id of the market entry 
+    /// </param>
+    /// <param name="Symbol">
+    /// Symbol of the market entry 
+    /// </param>
+    /// <param name="CurrentPrice">
+    /// Price of the entry evaluated at the time of creation
+    /// </param>
+    /// <param name="MarketCap">
+    /// Market cap of the entry
+    /// </param>
+    /// <param name="PriceChange24H">
+    /// Price change of the entry in the last 24 hours
+    /// </param>>
+    /// <param name="PriceChangePercentage24H">
+    /// Relative price change of the entry in the last 24 hours
+    /// </param>
+    public record MarketEntry(string Id, string Symbol, string Name, decimal CurrentPrice, long MarketCap,
+        [JsonProperty("price_change_24h", NullValueHandling = NullValueHandling.Ignore)]
+        float? PriceChange24H = 0f,
+        [JsonProperty("price_change_percentage_24h", NullValueHandling = NullValueHandling.Ignore)]
+        float? PriceChangePercentage24H = 0f
+    );
+
+    /// <summary>
+    /// A record containing a basic information about a cryptocurrency
+    /// </summary>
+    /// <param name="Id">
+    /// ID of the cryptocurrency
+    /// </param>
+    /// <param name="Symbol">
+    /// Symbol of the cryptocurrency
+    /// </param>
+    /// <param name="Name">
+    /// Name of the cryptocurrency
+    /// </param>
+    public record Cryptocurrency(string Id, string Symbol, string Name);
+}