BodyPattern

internal

Stubbing and setting expectations on 'HTTP' requests.
Includes tools for stubbing 'HTTP' requests, including expected
request conditions and response conditions. Match on
'HTTP' method, query parameters, request body, headers and
more. Can be used for unit tests or outside of a testing
context.

Scott Chamberlain

webmockr

Stubbing and Setting Expectations on 'HTTP' Requests

Aaron Wolen

rOpenSci 

BodyPattern function

<p><div class="r6-fields"></div></p><dl>
<dt><code>pattern</code></dt>
<dd><p>a list</p></dd><p></p><p>
<dt><code>partial</code></dt>
<dd><p>bool, default: <code>FALSE</code></p></dd></p><p>
<dt><code>partial_type</code></dt>
<dd><p>a string, default: NULL</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/BodyPattern%24new()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::BodyPattern$new()"><code>BodyPattern$new()</code></a></p></li>
<li><p><a href="/link/BodyPattern%24matches()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::BodyPattern$matches()"><code>BodyPattern$matches()</code></a></p></li>
<li><p><a href="/link/BodyPattern%24to_s()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::BodyPattern$to_s()"><code>BodyPattern$to_s()</code></a></p></li>
<li><p><a href="/link/BodyPattern%24clone()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::BodyPattern$clone()"><code>BodyPattern$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-BodyPattern-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new <code>BodyPattern</code> object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>BodyPattern$new(pattern)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>pattern</code></dt>
<dd><p>(list) a body object - from a request stub (i.e.,
the mock)</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new <code>BodyPattern</code> object</p>
</div><p></p><p></p><p><hr>
<a id="method-BodyPattern-matches"></a></p><div class="section" id="method-matches-">
<h3>Method <code>matches()</code></h3>
<p>Match a request body pattern against a pattern</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>BodyPattern$matches(body, content_type = "")</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>body</code></dt>
<dd><p>(list) the body, i.e., from the HTTP request</p></dd></dl></div></p><p>
<dt><code>content_type</code></dt>
<dd><p>(character) content type</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a boolean</p>
</div><p></p><p></p><p><hr>
<a id="method-BodyPattern-to_s"></a></p><div class="section" id="method-to-s-">
<h3>Method <code>to_s()</code></h3>
<p>Print pattern for easy human consumption</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>BodyPattern$to_s()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>a string</p>
</div></p><p></p><p><hr>
<a id="method-BodyPattern-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>BodyPattern$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

BodyPattern — BodyPattern

<p><div class="r6-fields"></p><dl>
<dt><code>pattern</code></dt>
<dd><p>a list</p></dd>


<dt><code>partial</code></dt>
<dd><p>bool, default: <code>FALSE</code></p></dd>


<dt><code>partial_type</code></dt>
<dd><p>a string, default: NULL</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-BodyPattern-new'><code>BodyPattern$new()</code></a></p></li>
<li><p><a href='#method-BodyPattern-matches'><code>BodyPattern$matches()</code></a></p></li>
<li><p><a href='#method-BodyPattern-to_s'><code>BodyPattern$to_s()</code></a></p></li>
<li><p><a href='#method-BodyPattern-clone'><code>BodyPattern$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-BodyPattern-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new <code>BodyPattern</code> object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>BodyPattern$new(pattern)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>pattern</code></dt>
<dd><p>(list) a body object - from a request stub (i.e.,
the mock)</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new <code>BodyPattern</code> object</p>
</div>

</div><p><hr>
<a id="method-BodyPattern-matches"></a></p><div class='section' id='method-matches-'>
<h3>Method <code>matches()</code></h3>
<p>Match a request body pattern against a pattern</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>BodyPattern$matches(body, content_type = "")</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>body</code></dt>
<dd><p>(list) the body, i.e., from the HTTP request</p></dd>


<dt><code>content_type</code></dt>
<dd><p>(character) content type</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a boolean</p>
</div>

</div><p><hr>
<a id="method-BodyPattern-to_s"></a></p><div class='section' id='method-to-s-'>
<h3>Method <code>to_s()</code></h3>
<p>Print pattern for easy human consumption</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>BodyPattern$to_s()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>a string</p>
</div>

</div><p><hr>
<a id="method-BodyPattern-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>BodyPattern$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


BodyPattern: BodyPattern

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `matches()`

Usage

Arguments

Returns

Method `to_s()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method matches()

Usage

Arguments

Returns

Method to_s()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `matches()`

Method `to_s()`

Method `clone()`