bump to 1.14.0

Author: benoitc

NEWS.md

@@ -1,5 +1,17 @@
 # NEWS
 
+1.14.0 - 2018-09-12
+-------------------
+
+- bump to certifi 2.4.2
+- bump to idna 0.6.0
+- fix support of rebar2
+- fix specs
+- add `hackney:sockname/1` adn `hackney:peername/1` functions
+- add new `checkout_timeout` option for clarity
+- improve `hackney_url:parse_qs/1` to trim leading and trailing empty values
+
+
 1.13.0 - 2018-06-22
 -------------------
 

README.md

@@ -4,7 +4,7 @@
 
 Copyright (c) 2012-2018 Benoît Chesneau.
 
-__Version:__ 1.13.0
+__Version:__ 1.14.0
 
 # hackney
 
@@ -196,7 +196,6 @@ Options = [],
 > To create a connection that will use an HTTP proxy use
 > `hackney_http_proxy:connect_proxy/5` instead.
 
-
 #### To get local and remote ip and port information of a connection:
 
 ```erlang
@@ -212,12 +211,12 @@ to make a request:
 
 ```erlang
 
-ReqBody = << "{\"snippet\": \"some snippet\"}" >>,
+ReqBody = << "{	\"snippet\": \"some snippet\" }" >>,
 ReqHeaders = [{<<"Content-Type">>, <<"application/json">>}],
 NextPath = <<"/">>,
 NextMethod = post,
 NextReq = {NextMethod, NextPath, ReqHeaders, ReqBody},
-{ok, _, _, ConnRef} = hackney:send_request(ConnRef, NextReq).
+{ok, _, _, ConnRef} = hackney:send_request(ConnRef, NextReq),
 {ok, Body1} = hackney:body(ConnRef).
 ```
 

doc/README.md

@@ -4,7 +4,7 @@
 
 Copyright (c) 2012-2018 Benoît Chesneau.
 
-__Version:__ 1.13.0
+__Version:__ 1.14.0
 
 # hackney
 
@@ -196,7 +196,6 @@ Options = [],
 > To create a connection that will use an HTTP proxy use
 > `hackney_http_proxy:connect_proxy/5` instead.
 
-
 #### To get local and remote ip and port information of a connection:
 
 ```erlang
@@ -217,7 +216,7 @@ ReqHeaders = [{<<"Content-Type">>, <<"application/json">>}],
 NextPath = <<"/">>,
 NextMethod = post,
 NextReq = {NextMethod, NextPath, ReqHeaders, ReqBody},
-{ok, _, _, ConnRef} = hackney:send_request(ConnRef, NextReq).
+{ok, _, _, ConnRef} = hackney:send_request(ConnRef, NextReq),
 {ok, Body1} = hackney:body(ConnRef).
 ```
 

doc/hackney.md

@@ -15,7 +15,9 @@
 ### <a name="type-client">client()</a> ###
 
 
-__abstract datatype__: `client()`
+<pre><code>
+client() = #client{}
+</code></pre>
 
 
 
@@ -351,6 +353,9 @@ redirection even on POST
 * `insecure`: to perform "insecure" SSL connections and
 transfers without checking the certificate
 
+* `{checkout_timeout, infinity | integer()}`: timeout used when
+checking out a socket from the pool, in milliseconds. Default is 8000
+
 * `{connect_timeout, infinity | integer()}`: timeout used when
 establishing a connection, in milliseconds. Default is 8000
 

doc/hackney_bstr.md

@@ -1,15 +1,40 @@
 
 
 # Module hackney_bstr #
+* [Data Types](#types)
 * [Function Index](#index)
 * [Function Details](#functions)
 
+<a name="types"></a>
+
+## Data Types ##
+
+
+
+
+### <a name="type-cp">cp()</a> ###
+
+
+__abstract datatype__: `cp()`
+
+
+
+
+### <a name="type-part">part()</a> ###
+
+
+<pre><code>
+part() = {Start::non_neg_integer(), Length::integer()}
+</code></pre>
+
+ END: Remove when OTP 17 not officially supported
+
 <a name="index"></a>
 
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#alpha-2">alpha/2</a></td><td>Parse a list of case-insensitive alpha characters.</td></tr><tr><td valign="top"><a href="#char_to_lower-1">char_to_lower/1</a></td><td>Convert [A-Z] characters to lowercase.</td></tr><tr><td valign="top"><a href="#char_to_upper-1">char_to_upper/1</a></td><td>Convert [a-z] characters to uppercase.</td></tr><tr><td valign="top"><a href="#digits-1">digits/1</a></td><td>Parse a list of digits as a non negative integer.</td></tr><tr><td valign="top"><a href="#digits-2">digits/2</a></td><td></td></tr><tr><td valign="top"><a href="#digits-3">digits/3</a></td><td></td></tr><tr><td valign="top"><a href="#join-2">join/2</a></td><td></td></tr><tr><td valign="top"><a href="#list-2">list/2</a></td><td>Parse a list of the given type.</td></tr><tr><td valign="top"><a href="#nonempty_list-2">nonempty_list/2</a></td><td>Parse a non-empty list of the given type.</td></tr><tr><td valign="top"><a href="#parameterized_tokens-1">parameterized_tokens/1</a></td><td>Parse a non empty list of tokens followed with optional parameters.</td></tr><tr><td valign="top"><a href="#params-2">params/2</a></td><td>Parse a list of parameters (a=b;c=d).</td></tr><tr><td valign="top"><a href="#quoted_string-2">quoted_string/2</a></td><td></td></tr><tr><td valign="top"><a href="#to_binary-1">to_binary/1</a></td><td></td></tr><tr><td valign="top"><a href="#to_hex-1">to_hex/1</a></td><td></td></tr><tr><td valign="top"><a href="#to_lower-1">to_lower/1</a></td><td>Convert a binary string to lowercase.</td></tr><tr><td valign="top"><a href="#to_upper-1">to_upper/1</a></td><td></td></tr><tr><td valign="top"><a href="#token-2">token/2</a></td><td>Parse a token.</td></tr><tr><td valign="top"><a href="#token_ci-2">token_ci/2</a></td><td>Parse a case-insensitive token.</td></tr><tr><td valign="top"><a href="#trim-1">trim/1</a></td><td></td></tr><tr><td valign="top"><a href="#whitespace-2">whitespace/2</a></td><td>Skip whitespace.</td></tr><tr><td valign="top"><a href="#word-2">word/2</a></td><td>Parse either a token or a quoted string.</td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#alpha-2">alpha/2</a></td><td>Parse a list of case-insensitive alpha characters.</td></tr><tr><td valign="top"><a href="#char_to_lower-1">char_to_lower/1</a></td><td>Convert [A-Z] characters to lowercase.</td></tr><tr><td valign="top"><a href="#char_to_upper-1">char_to_upper/1</a></td><td>Convert [a-z] characters to uppercase.</td></tr><tr><td valign="top"><a href="#digits-1">digits/1</a></td><td>Parse a list of digits as a non negative integer.</td></tr><tr><td valign="top"><a href="#digits-2">digits/2</a></td><td></td></tr><tr><td valign="top"><a href="#digits-3">digits/3</a></td><td></td></tr><tr><td valign="top"><a href="#join-2">join/2</a></td><td></td></tr><tr><td valign="top"><a href="#list-2">list/2</a></td><td>Parse a list of the given type.</td></tr><tr><td valign="top"><a href="#nonempty_list-2">nonempty_list/2</a></td><td>Parse a non-empty list of the given type.</td></tr><tr><td valign="top"><a href="#parameterized_tokens-1">parameterized_tokens/1</a></td><td>Parse a non empty list of tokens followed with optional parameters.</td></tr><tr><td valign="top"><a href="#params-2">params/2</a></td><td>Parse a list of parameters (a=b;c=d).</td></tr><tr><td valign="top"><a href="#quoted_string-2">quoted_string/2</a></td><td></td></tr><tr><td valign="top"><a href="#split-3">split/3</a></td><td></td></tr><tr><td valign="top"><a href="#to_binary-1">to_binary/1</a></td><td></td></tr><tr><td valign="top"><a href="#to_hex-1">to_hex/1</a></td><td></td></tr><tr><td valign="top"><a href="#to_lower-1">to_lower/1</a></td><td>Convert a binary string to lowercase.</td></tr><tr><td valign="top"><a href="#to_upper-1">to_upper/1</a></td><td></td></tr><tr><td valign="top"><a href="#token-2">token/2</a></td><td>Parse a token.</td></tr><tr><td valign="top"><a href="#token_ci-2">token_ci/2</a></td><td>Parse a case-insensitive token.</td></tr><tr><td valign="top"><a href="#trim-1">trim/1</a></td><td></td></tr><tr><td valign="top"><a href="#whitespace-2">whitespace/2</a></td><td>Skip whitespace.</td></tr><tr><td valign="top"><a href="#word-2">word/2</a></td><td>Parse either a token or a quoted string.</td></tr></table>
 
 
 <a name="functions"></a>
@@ -139,6 +164,16 @@ quoted_string(X1::binary(), Fun::function()) -&gt; any()
 </code></pre>
 <br />
 
+<a name="split-3"></a>
+
+### split/3 ###
+
+<pre><code>
+split(Subject, Pattern, Options) -&gt; Parts
+</code></pre>
+
+<ul class="definitions"><li><code>Subject = binary()</code></li><li><code>Pattern = binary() | [binary()] | <a href="#type-cp">cp()</a></code></li><li><code>Options = [Option]</code></li><li><code>Option = {scope, <a href="#type-part">part()</a>} | trim | global | trim_all</code></li><li><code>Parts = [binary()]</code></li></ul>
+
 <a name="to_binary-1"></a>
 
 ### to_binary/1 ###

doc/hackney_http.md

@@ -65,7 +65,17 @@ given correpond to the non parsed part of the internal buffer.
 
 
 <pre><code>
-body_result() = {more, <a href="#type-parser">parser()</a>, binary()} | {ok, binary(), <a href="#type-parser">parser()</a>} | {done, binary()}
+body_result() = {more, <a href="#type-parser">parser()</a>, binary()} | {ok, binary(), <a href="#type-parser">parser()</a>} | {done, binary()} | done
+</code></pre>
+
+
+
+
+### <a name="type-header_result">header_result()</a> ###
+
+
+<pre><code>
+header_result() = {headers_complete, <a href="#type-parser">parser()</a>} | {header, {binary(), binary()}, <a href="#type-parser">parser()</a>}
 </code></pre>
 
 
@@ -104,7 +114,9 @@ http_version() = {integer(), integer()}
 ### <a name="type-parser">parser()</a> ###
 
 
-__abstract datatype__: `parser()`
+<pre><code>
+parser() = #hparser{}
+</code></pre>
 
 
 
@@ -133,7 +145,7 @@ parser_options() = [<a href="#type-parser_option">parser_option()</a>]
 
 
 <pre><code>
-parser_result() = {response, <a href="#type-http_version">http_version()</a>, <a href="#type-status">status()</a>, <a href="#type-http_reason">http_reason()</a>, <a href="#type-parser">parser()</a>} | {request, <a href="#type-http_version">http_version()</a>, <a href="#type-http_method">http_method()</a>, <a href="#type-uri">uri()</a>, <a href="#type-parser">parser()</a>} | {more, <a href="#type-parser">parser()</a>} | <a href="#type-body_result">body_result()</a> | {error, term()}
+parser_result() = {response, <a href="#type-http_version">http_version()</a>, <a href="#type-status">status()</a>, <a href="#type-http_reason">http_reason()</a>, <a href="#type-parser">parser()</a>} | {request, <a href="#type-http_method">http_method()</a>, <a href="#type-uri">uri()</a>, <a href="#type-http_version">http_version()</a>, <a href="#type-parser">parser()</a>} | {more, <a href="#type-parser">parser()</a>} | <a href="#type-header_result">header_result()</a> | <a href="#type-body_result">body_result()</a> | {error, term()}
 </code></pre>
 
 

doc/hackney_response.md

@@ -90,7 +90,7 @@ handle Expect header
 ### skip_body/1 ###
 
 <pre><code>
-skip_body(Client::#client{}) -&gt; {ok, #client{}} | {error, atom()}
+skip_body(Client::#client{}) -&gt; {ok, #client{}} | {skip, #client{}} | {error, atom()}
 </code></pre>
 <br />
 

doc/hackney_url.md

@@ -15,6 +15,16 @@ module to manage urls.
 
 
 
+### <a name="type-qs_opt">qs_opt()</a> ###
+
+
+<pre><code>
+qs_opt() = noplus | upper
+</code></pre>
+
+
+
+
 ### <a name="type-qs_vals">qs_vals()</a> ###
 
 
@@ -129,7 +139,7 @@ encode query properties to binary
 ### qs/2 ###
 
 <pre><code>
-qs(KVs::<a href="#type-qs_vals">qs_vals()</a>, Opts::[atom]) -&gt; binary()
+qs(KVs::<a href="#type-qs_vals">qs_vals()</a>, Opts::[<a href="#type-qs_opt">qs_opt()</a>]) -&gt; binary()
 </code></pre>
 <br />
 
@@ -191,7 +201,7 @@ URL encode a string binary.
 ### urlencode/2 ###
 
 <pre><code>
-urlencode(Bin::binary() | string(), Opts::[noplus | upper]) -&gt; binary()
+urlencode(Bin::binary() | string(), Opts::[<a href="#type-qs_opt">qs_opt()</a>]) -&gt; binary()
 </code></pre>
 <br />
 

doc/overview.edoc

@@ -17,7 +17,7 @@
 
 
 @copyright 2012-2018 Benoît Chesneau.
-@version 1.13.0
+@version 1.14.0
 @title hackney - HTTP client library in Erlang
 
 @doc

src/hackney.app.src

@@ -4,7 +4,7 @@
 {application, hackney,
   [
     {description, "simple HTTP client"},
-    {vsn, "1.13.0"},
+    {vsn, "1.14.0"},
     {registered, [hackney_pool]},
     {applications, [kernel,
       stdlib,