CryptoExchange.Net/CryptoExchange.Net/Objects/RequestDefinition.cs

using CryptoExchange.Net.RateLimiting.Interfaces;
using System.Net.Http;

namespace CryptoExchange.Net.Objects
{
    /// <summary>
    /// The definition of a rest request
    /// </summary>
    public class RequestDefinition
    {
        private string? _stringRep;
        private string? _fullUrl;

        // Basics

        /// <summary>
        /// Base address of the request
        /// </summary>
        public string BaseAddress { get; set; }
        /// <summary>
        /// Path of the request
        /// </summary>
        public string Path { get; set; }
        /// <summary>
        /// Http method of the request
        /// </summary>
        public HttpMethod Method { get; set; }
        /// <summary>
        /// Is the request authenticated
        /// </summary>
        public bool Authenticated { get; set; }

        // Formatting

        /// <summary>
        /// The body format for this request
        /// </summary>
        public RequestBodyFormat? RequestBodyFormat { get; set; }
        /// <summary>
        /// The position of parameters for this request
        /// </summary>
        public HttpMethodParameterPosition? ParameterPosition { get; set; }
        /// <summary>
        /// The array serialization type for this request
        /// </summary>
        public ArrayParametersSerialization? ArraySerialization { get; set; }

        // Rate limiting
        
        /// <summary>
        /// Request weight
        /// </summary>
        public int Weight { get; set; } = 1;

        /// <summary>
        /// Rate limit gate to use
        /// </summary>
        public IRateLimitGate? RateLimitGate { get; set; }

        /// <summary>
        /// Individual endpoint rate limit guard to use
        /// </summary>
        public IRateLimitGuard? LimitGuard { get; set; }

        /// <summary>
        /// Whether this request should never be cached
        /// </summary>
        public bool PreventCaching { get; set; }

        /// <summary>
        /// Whether the response to this requests should attempted to be parsed even when the status indicates failure
        /// </summary>
        public bool TryParseOnNonSuccess { get; set; }

        /// <summary>
        /// Connection id
        /// </summary>
        public int? ConnectionId { get; set; }

        /// <summary>
        /// Whether the endpoint path should always include the trailing `/`
        /// </summary>
        public bool? ForcePathEndWithSlash { get; set; }

        /// <summary>
        /// Full url, host + path
        /// </summary>
        public string FullUrl
        {
            get
            {
                if (_fullUrl != null) 
                    return _fullUrl;

                var result = BaseAddress.AppendPath(Path);
                if (ForcePathEndWithSlash == true && !result.EndsWith("/"))
                    result += "/";

                _fullUrl = result;
                return _fullUrl;
            }   
        }

        /// <summary>
        /// Whether concurrent identical requests should be prevented from sharing the same request/response
        /// </summary>
        public bool PreventRequestCoalescing { get; set; }

        /// <summary>
        /// ctor
        /// </summary>
        public RequestDefinition(string baseAddress, string path, HttpMethod method)
        {
            BaseAddress = baseAddress;
            Path = path;
            Method = method;

            if (!Path.StartsWith("/"))
                Path = $"/{Path}";
        }

        /// <inheritdoc />
        public override string ToString()
        {
            return _stringRep ??= $"{Method} {Path}{(Authenticated ? " authenticated" : "")}";
        }
    }
}