Skip to content

Commit ce836c2

Browse files
committed
Update documentation to 0.5.0
1 parent c838502 commit ce836c2

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
3-
<html><head><meta charset="UTF-8" /><title>Ring-Mock 0.3.2</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.3.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="ring.mock.request.html"><div class="inner"><span>ring.mock.request</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.3.2</span></span></h1><h5 class="license">Released under the <a href="http://opensource.org/licenses/MIT">MIT License</a></h5><div class="doc"><p>A library for creating mock Ring request maps.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[ring/ring-mock "0.3.2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="ring.mock.request.html">ring.mock.request</a></h3><div class="doc"><pre class="plaintext">Functions to create mock request maps.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ring.mock.request.html#var-body">body</a> </li><li> <a href="ring.mock.request.html#var-content-length">content-length</a> </li><li> <a href="ring.mock.request.html#var-content-type">content-type</a> </li><li> <a href="ring.mock.request.html#var-default-port">default-port</a> </li><li> <a href="ring.mock.request.html#var-header">header</a> </li><li> <a href="ring.mock.request.html#var-json-body">json-body</a> </li><li> <a href="ring.mock.request.html#var-query-string">query-string</a> </li><li> <a href="ring.mock.request.html#var-request">request</a> </li></ul></div></div></div></body></html>
3+
<html><head><meta charset="UTF-8" /><title>Ring-Mock 0.5.0</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.5.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="ring.mock.request.html"><div class="inner"><span>ring.mock.request</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.5.0</span></span></h1><h5 class="license">Released under the <a href="http://opensource.org/licenses/MIT">MIT License</a></h5><div class="doc"><p>A library for creating mock Ring request maps.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[ring/ring-mock "0.5.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="ring.mock.request.html">ring.mock.request</a></h3><div class="doc"><pre class="plaintext">Functions to create mock request maps.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ring.mock.request.html#var-body">body</a> </li><li> <a href="ring.mock.request.html#var-content-length">content-length</a> </li><li> <a href="ring.mock.request.html#var-content-type">content-type</a> </li><li> <a href="ring.mock.request.html#var-cookie">cookie</a> </li><li> <a href="ring.mock.request.html#var-default-port">default-port</a> </li><li> <a href="ring.mock.request.html#var-header">header</a> </li><li> <a href="ring.mock.request.html#var-json-body">json-body</a> </li><li> <a href="ring.mock.request.html#var-query-string">query-string</a> </li><li> <a href="ring.mock.request.html#var-request">request</a> </li></ul></div></div></div></body></html>

ring.mock.request.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
3-
<html><head><meta charset="UTF-8" /><title>ring.mock.request documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.3.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="ring.mock.request.html"><div class="inner"><span>ring.mock.request</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="ring.mock.request.html#var-body"><div class="inner"><span>body</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-content-length"><div class="inner"><span>content-length</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-content-type"><div class="inner"><span>content-type</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-default-port"><div class="inner"><span>default-port</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-header"><div class="inner"><span>header</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-json-body"><div class="inner"><span>json-body</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-query-string"><div class="inner"><span>query-string</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-request"><div class="inner"><span>request</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">ring.mock.request</h1><div class="doc"><pre class="plaintext">Functions to create mock request maps.
3+
<html><head><meta charset="UTF-8" /><title>ring.mock.request documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Ring-Mock</span> <span class="project-version">0.5.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="ring.mock.request.html"><div class="inner"><span>ring.mock.request</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="ring.mock.request.html#var-body"><div class="inner"><span>body</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-content-length"><div class="inner"><span>content-length</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-content-type"><div class="inner"><span>content-type</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-cookie"><div class="inner"><span>cookie</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-default-port"><div class="inner"><span>default-port</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-header"><div class="inner"><span>header</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-json-body"><div class="inner"><span>json-body</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-query-string"><div class="inner"><span>query-string</span></div></a></li><li class="depth-1"><a href="ring.mock.request.html#var-request"><div class="inner"><span>request</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">ring.mock.request</h1><div class="doc"><pre class="plaintext">Functions to create mock request maps.
44
</pre></div><div class="public anchor" id="var-body"><h3>body</h3><h4 class="type">multimethod</h4><div class="usage"><code>(body request body-value)</code></div><div class="doc"><pre class="plaintext">Set the body of the request. The supplied body value can be a string or
5-
a map of parameters to be url-encoded.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L57">view source</a></div></div><div class="public anchor" id="var-content-length"><h3>content-length</h3><div class="usage"><code>(content-length request length)</code></div><div class="doc"><pre class="plaintext">Set the content length of the request map.
6-
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L26">view source</a></div></div><div class="public anchor" id="var-content-type"><h3>content-type</h3><div class="usage"><code>(content-type request mime-type)</code></div><div class="doc"><pre class="plaintext">Set the content type of the request map.
7-
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L19">view source</a></div></div><div class="public anchor" id="var-default-port"><h3>default-port</h3><div class="usage"></div><div class="doc"><pre class="plaintext">A map of the default ports for a scheme.
8-
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L87">view source</a></div></div><div class="public anchor" id="var-header"><h3>header</h3><div class="usage"><code>(header request header value)</code></div><div class="doc"><pre class="plaintext">Add a HTTP header to the request map.
9-
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L13">view source</a></div></div><div class="public anchor" id="var-json-body"><h3>json-body</h3><div class="usage"><code>(json-body request body-value)</code></div><div class="doc"><pre class="plaintext">Set the body of the request to a JSON structure. The supplied body value
10-
should be a map of parameters to be converted to JSON.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L79">view source</a></div></div><div class="public anchor" id="var-query-string"><h3>query-string</h3><div class="usage"><code>(query-string request params)</code></div><div class="doc"><pre class="plaintext">Set the query string of the request to a string or a map of parameters.
11-
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L49">view source</a></div></div><div class="public anchor" id="var-request"><h3>request</h3><div class="usage"><code>(request method uri)</code><code>(request method uri params)</code></div><div class="doc"><pre class="plaintext">Create a minimal valid request map from a HTTP method keyword, a string
5+
a map of parameters to be url-encoded.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L68">view source</a></div></div><div class="public anchor" id="var-content-length"><h3>content-length</h3><div class="usage"><code>(content-length request length)</code></div><div class="doc"><pre class="plaintext">Set the content length of the request map.
6+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L37">view source</a></div></div><div class="public anchor" id="var-content-type"><h3>content-type</h3><div class="usage"><code>(content-type request mime-type)</code></div><div class="doc"><pre class="plaintext">Set the content type of the request map.
7+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L30">view source</a></div></div><div class="public anchor" id="var-cookie"><h3>cookie</h3><div class="usage"><code>(cookie request cookie-name value)</code></div><div class="doc"><pre class="plaintext">Add a cookie to the request headers map
8+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L19">view source</a></div></div><div class="public anchor" id="var-default-port"><h3>default-port</h3><div class="usage"></div><div class="doc"><pre class="plaintext">A map of the default ports for a scheme.
9+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L98">view source</a></div></div><div class="public anchor" id="var-header"><h3>header</h3><div class="usage"><code>(header request header value)</code></div><div class="doc"><pre class="plaintext">Add a HTTP header to the request map.
10+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L13">view source</a></div></div><div class="public anchor" id="var-json-body"><h3>json-body</h3><div class="usage"><code>(json-body request body-value)</code></div><div class="doc"><pre class="plaintext">Set the body of the request to a JSON structure. The supplied body value
11+
should be a map of parameters to be converted to JSON.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L90">view source</a></div></div><div class="public anchor" id="var-query-string"><h3>query-string</h3><div class="usage"><code>(query-string request params)</code></div><div class="doc"><pre class="plaintext">Set the query string of the request to a string or a map of parameters.
12+
</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L60">view source</a></div></div><div class="public anchor" id="var-request"><h3>request</h3><div class="usage"><code>(request method uri)</code><code>(request method uri params)</code></div><div class="doc"><pre class="plaintext">Create a minimal valid request map from a HTTP method keyword, a string
1213
containing a URI, and an optional map of parameters that will be added to
1314
the query string of the URI. The URI can be relative or absolute. Relative
14-
URIs are assumed to go to <a href="http://localhost">http://localhost</a>.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.3.2/src/ring/mock/request.clj#L92">view source</a></div></div></div></body></html>
15+
URIs are assumed to go to <a href="http://localhost">http://localhost</a>.</pre></div><div class="src-link"><a href="https://github.com/ring-clojure/ring-mock/blob/0.5.0/src/ring/mock/request.clj#L103">view source</a></div></div></div></body></html>

0 commit comments

Comments
 (0)