release 0.5.1

Tieske · Tieske · commit e2a3f4cb1fc8 · 2022-06-01T15:40:52.000+02:00
diff --git a/README.md b/README.md
@@ -145,10 +145,10 @@ Release process:
 1. test installing the rock from LuaRocks
 
 
-### unreleased
+### 0.5.1 (01-Jun-2022)
 
  - feat: socket compatibility; overriding luasocket use in phases now returns
-   the existin g setting
+   the existing setting
 
 ### 0.5.0 (01-Jun-2022)
 
diff --git a/docs/classes/AWS.html b/docs/classes/AWS.html
@@ -144,7 +144,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/ChainedTemporaryCredentials.html b/docs/classes/ChainedTemporaryCredentials.html
@@ -145,7 +145,7 @@ <h3>Usage:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/CredentialProviderChain.html b/docs/classes/CredentialProviderChain.html
@@ -129,7 +129,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/Credentials.html b/docs/classes/Credentials.html
@@ -264,7 +264,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/EC2MetadataCredentials.html b/docs/classes/EC2MetadataCredentials.html
@@ -111,7 +111,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/EnvironmentCredentials.html b/docs/classes/EnvironmentCredentials.html
@@ -120,7 +120,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/RemoteCredentials.html b/docs/classes/RemoteCredentials.html
@@ -111,7 +111,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/classes/TokenFileWebIdentityCredentials.html b/docs/classes/TokenFileWebIdentityCredentials.html
@@ -126,7 +126,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/index.html b/docs/index.html
@@ -120,7 +120,7 @@ <h2>Topics</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/modules/resty.aws.config.html b/docs/modules/resty.aws.config.html
@@ -349,7 +349,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/modules/resty.aws.request.http.socket.html b/docs/modules/resty.aws.request.http.socket.html
@@ -30,6 +30,10 @@ <h1>lua-resty-aws</h1>
   <li><a href="../index.html">Index</a></li>
 </ul>
 
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
 
 
 <h2>Modules</h2>
@@ -60,24 +64,184 @@ <h2>Topics</h2>
 
 <h1>Module <code>resty.aws.request.http.socket</code></h1>
 <p>Socket compatibility module to enable the init-phase, by falling back to LuaSocket.</p>
-<p> File copied from <a href="https://github.com/thibaultcha/lua-resty-socket/pull/18">lua-resty-socket</a>.
+<p> File originally copied from <a href="https://github.com/thibaultcha/lua-resty-socket/pull/18">lua-resty-socket</a>.
  There should be no need to invoke anything in this module from user code.</p>
 
 <p> NOTE: see comments in the http module regarding compatibility!!</p>
 
 
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#disable_luasocket">disable_luasocket (phase, disable)</a></td>
+	<td class="summary">disables LuaSocket use for a specific phase.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#force_luasocket">force_luasocket (phase, force)</a></td>
+	<td class="summary">forces LuaSocket use for a specific phase.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#set_luasec_defaults">set_luasec_defaults (defaults)</a></td>
+	<td class="summary">Sets LuaSec defaults to use for tls connections.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#tcp">tcp (...)</a></td>
+	<td class="summary">creates a tcp socket compatible with <code>ngx.socket.tcp</code>.</td>
+	</tr>
+</table>
 
 <br/>
 <br/>
 
 
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "disable_luasocket"></a>
+    <strong>disable_luasocket (phase, disable)</strong>
+    </dt>
+    <dd>
+    disables LuaSocket use for a specific phase.
+ An override for the automatic phase/socket-type detection. This setting is
+ a module global setting.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">phase</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         the phase name
+        </li>
+        <li><span class="parameter">disable</span>
+            <span class="types"><span class="type">bool</span></span>
+         set to <code>true</code> to disable, or <code>false/nil</code> to enable
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+        the previous value of this setting.
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> old_setting = sock.disable_luasocket(<span class="string">"init"</span>, <span class="keyword">true</span>)
+<span class="comment">-- do something
+</span>sock.disable_luasocket(<span class="string">"init"</span>, old_setting)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "force_luasocket"></a>
+    <strong>force_luasocket (phase, force)</strong>
+    </dt>
+    <dd>
+    forces LuaSocket use for a specific phase.
+ An override for the automatic phase/socket-type detection. This setting is
+ a module global setting.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">phase</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+         the phase name
+        </li>
+        <li><span class="parameter">force</span>
+            <span class="types"><span class="type">bool</span></span>
+         set to <code>true</code> to force, or <code>false/nil</code> to auto-detect
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+        the previous value of this setting.
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> old_setting = sock.force_luasocket(<span class="string">"timer"</span>, <span class="keyword">true</span>)
+<span class="comment">-- do something
+</span>sock.force_luasocket(<span class="string">"timer"</span>, old_setting)</pre>
+    </ul>
+
+</dd>
+    <dt>
+    <a name = "set_luasec_defaults"></a>
+    <strong>set_luasec_defaults (defaults)</strong>
+    </dt>
+    <dd>
+    Sets LuaSec defaults to use for tls connections.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">defaults</span> a table with the following fields:
+        <ul>
+        <li><span class="parameter">protocol</span>
+         see luasec docs <code>protocol</code>
+        </li>
+        <li><span class="parameter">key</span>
+         see luasec docs <code>key</code>
+        </li>
+        <li><span class="parameter">cert</span>
+         see luasec docs <code>certificate</code>
+        </li>
+        <li><span class="parameter">cafile</span>
+         see luasec docs <code>cafile</code>
+        </li>
+        <li><span class="parameter">options</span>
+         see luasec docs <code>options</code>
+        </li>
+        </li></ul>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "tcp"></a>
+    <strong>tcp (...)</strong>
+    </dt>
+    <dd>
+    creates a tcp socket compatible with <code>ngx.socket.tcp</code>.  The socket will fall back to
+ LuaSocket where cosockets are not supported.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">...</span>
+         same as <code>ngx.socket.tcp</code>
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+        a co-sockets compatible TCP socket
+    </ol>
+
+
+
+
+</dd>
+</dl>
 
 
 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/modules/resty.aws.utils.html b/docs/modules/resty.aws.utils.html
@@ -78,7 +78,7 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Fetches ECS Task Metadata.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#Utils.getIDMSMetadata">Utils.getIDMSMetadata (path, version)</a></td>
+	<td class="name" nowrap><a href="#Utils.getIDMSMetadata">Utils.getIDMSMetadata (subpath, version)</a></td>
 	<td class="summary">Fetches IDMS Metadata (EC2 and EKS).</td>
 	</tr>
 </table>
@@ -158,7 +158,7 @@ <h3>Returns:</h3>
 </dd>
     <dt>
     <a name = "Utils.getIDMSMetadata"></a>
-    <strong>Utils.getIDMSMetadata (path, version)</strong>
+    <strong>Utils.getIDMSMetadata (subpath, version)</strong>
     </dt>
     <dd>
     Fetches IDMS Metadata (EC2 and EKS).
@@ -169,8 +169,8 @@ <h3>Returns:</h3>
 
     <h3>Parameters:</h3>
     <ul>
-        <li><span class="parameter">path</span>
-         (optional) path to return data from, default <code>/latest/meta-data/</code>
+        <li><span class="parameter">subpath</span>
+         (optional) subpath to return data from, default <code>/latest/meta-data/</code>
         </li>
         <li><span class="parameter">version</span>
          (optional) version of IDMS to use, either "V1" or "V2" (case insensitive, default "V2")
@@ -194,7 +194,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html
@@ -248,7 +248,15 @@ <h2>History</h2>
     <li>test installing the rock from LuaRocks</li>
 </ol>
 
-<h3>0.5.0 (01-jun-2022)</h3>
+
+<h3>0.5.1 (01-Jun-2022)</h3>
+
+<ul>
+    <li>feat: socket compatibility; overriding luasocket use in phases now returns
+    the existing setting</li>
+</ul>
+
+<h3>0.5.0 (01-Jun-2022)</h3>
 
 <ul>
     <li><p>feat: enable use of regional STS endpoints</p></li>
@@ -275,7 +283,7 @@ <h3>0.5.0 (01-jun-2022)</h3>
 Behaviour might change, but is expected to be very rare.
 </pre>
 
-<h3>0.4.0 (06-dec-2021)</h3></li>
+<h3>0.4.0 (06-Dec-2021)</h3></li>
     <li><p>feat: added TokenFileWebIdentityCredentials. This adds default IAM credentials
     to be picked up on EKS. The default AWS instance creates a CredentialProviderChain
     which includes TokenFileWebIdentity. So on EKS it will now pick up container
@@ -311,7 +319,7 @@ <h3>0.1 (03-Feb-2021) Initial released version</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-06-01 07:33:03 </i>
+<i style="float:right;">Last updated 2022-06-01 15:40:38 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
