From 2fad7f134fa8cf871cdf6ccdcedc6df0d62c2f64 Mon Sep 17 00:00:00 2001 From: Juan Carlos Date: Tue, 21 Jan 2020 15:34:47 -0300 Subject: [PATCH] httpclient, maxredirects to Natural, newHttpClient/newAsyncHttpClient add headers argument instead of hardcoded empty (#13207) --- changelog.md | 3 +++ lib/pure/httpclient.nim | 14 +++++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/changelog.md b/changelog.md index 71a77b86f932..7e08133a05c9 100644 --- a/changelog.md +++ b/changelog.md @@ -68,6 +68,9 @@ - `htmlgen.html` allows `lang` on the `` tag and common valid attributes. - `macros.basename` and `basename=` got support for `PragmaExpr`, so that an expression like `MyEnum {.pure.}` is handled correctly. +- `httpclient.maxredirects` changed from `int` to `Natural`, because negative values serve no purpose whatsoever. +- `httpclient.newHttpClient` and `httpclient.newAsyncHttpClient` added `headers` argument to set initial HTTP Headers, + instead of a hardcoded empty `newHttpHeader()`. ## Language additions diff --git a/lib/pure/httpclient.nim b/lib/pure/httpclient.nim index d9a6192a7f20..7c062c2e10a2 100644 --- a/lib/pure/httpclient.nim +++ b/lib/pure/httpclient.nim @@ -486,7 +486,7 @@ type connected: bool currentURL: Uri ## Where we are currently connected. headers*: HttpHeaders ## Headers to send in requests. - maxRedirects: int + maxRedirects: Natural ## Maximum redirects, set to ``0`` to disable. userAgent: string timeout*: int ## Only used for blocking HttpClient for now. proxy: Proxy @@ -513,7 +513,7 @@ type proc newHttpClient*(userAgent = defUserAgent, maxRedirects = 5, sslContext = getDefaultSSL(), proxy: Proxy = nil, - timeout = -1): HttpClient = + timeout = -1, headers = newHttpHeaders()): HttpClient = ## Creates a new HttpClient instance. ## ## ``userAgent`` specifies the user agent that will be used when making @@ -529,8 +529,10 @@ proc newHttpClient*(userAgent = defUserAgent, ## ## ``timeout`` specifies the number of milliseconds to allow before a ## ``TimeoutError`` is raised. + ## + ## ``headers`` specifies the HTTP Headers. new result - result.headers = newHttpHeaders() + result.headers = headers result.userAgent = userAgent result.maxRedirects = maxRedirects result.proxy = proxy @@ -546,7 +548,7 @@ type proc newAsyncHttpClient*(userAgent = defUserAgent, maxRedirects = 5, sslContext = getDefaultSSL(), - proxy: Proxy = nil): AsyncHttpClient = + proxy: Proxy = nil, headers = newHttpHeaders()): AsyncHttpClient = ## Creates a new AsyncHttpClient instance. ## ## ``userAgent`` specifies the user agent that will be used when making @@ -559,8 +561,10 @@ proc newAsyncHttpClient*(userAgent = defUserAgent, ## ## ``proxy`` specifies an HTTP proxy to use for this HTTP client's ## connections. + ## + ## ``headers`` specifies the HTTP Headers. new result - result.headers = newHttpHeaders() + result.headers = headers result.userAgent = userAgent result.maxRedirects = maxRedirects result.proxy = proxy