OwlCyberSecurity - MANAGER

Edit File: MockRequest.html

<!DOCTYPE html>

<title>class Rack::MockRequest - rack-2.2.10 Documentation</title>

<div id="table-of-contents-navigation">
 <a href="../table_of_contents.html#pages">Pages</a>
 <a href="../table_of_contents.html#classes">Classes</a>
 <a href="../table_of_contents.html#methods">Methods</a>
 </div>
</div>

</div>

<div id="class-metadata">
 
 <div id="parent-class-section" class="nav-section">
 <h3>Parent</h3>

Object
 
</div>

<div id="method-list-section" class="nav-section">
 <h3>Methods</h3>

<ul class="link-list" role="directory">
 
 <li ><a href="#method-c-env_for">::env_for</a>
 
 <li ><a href="#method-c-new">::new</a>
 
 <li ><a href="#method-c-parse_uri_rfc2396">::parse_uri_rfc2396</a>
 
 <li ><a href="#method-i-delete">#delete</a>
 
 <li ><a href="#method-i-get">#get</a>
 
 <li ><a href="#method-i-head">#head</a>
 
 <li ><a href="#method-i-options">#options</a>
 
 <li ><a href="#method-i-patch">#patch</a>
 
 <li ><a href="#method-i-post">#post</a>
 
 <li ><a href="#method-i-put">#put</a>
 
 <li ><a href="#method-i-request">#request</a>
 
 </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Rack::MockRequest">
 <h1 id="class-Rack::MockRequest" class="class">
 class Rack::MockRequest
 </h1>

<section class="description">
 
<a href="MockRequest.html"><code>Rack::MockRequest</code></a> helps testing your <a href="../Rack.html"><code>Rack</code></a> application without actually using HTTP.

After performing a request on a URL with get/post/put/patch/delete, it returns a <a href="MockResponse.html"><code>MockResponse</code></a> with useful helper methods for effective testing.

You can pass a hash with additional configuration to the get/post/put/patch/delete.
<dl class="rdoc-list note-list"><dt><code>:input</code>
<dd>
A String or IO-like to be used as rack.input.
</dd><dt><code>:fatal</code>
<dd>
Raise a <a href="MockRequest/FatalWarning.html"><code>FatalWarning</code></a> if the app writes to rack.errors.
</dd><dt><code>:lint</code>
<dd>
If true, wrap the application in a <a href="Lint.html"><code>Rack::Lint</code></a>.
</dd></dl>

</section>

<section class="constants-list">
 <header>
 <h3>Constants</h3>
 </header>
 <dl>
 
 <dt id="DEFAULT_ENV">DEFAULT_ENV
 
 <dd>
 
 
 </dl>
 </section>

<section id="public-class-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Class Methods</h3>
 </header>

<div id="method-c-env_for" class="method-detail ">
 
 <div class="method-heading">
 env_for(uri = &quot;&quot;, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Return the <a href="../Rack.html"><code>Rack</code></a> environment used for a request to <code>uri</code>. All options that are strings are added to the returned environment. Options:
<dl class="rdoc-list note-list"><dt>:fatal 
<dd>
Whether to raise an exception if request outputs to rack.errors
</dd><dt>:input 
<dd>
The rack.input to set
</dd><dt>:method 
<dd>
The HTTP request method to use
</dd><dt>:params 
<dd>
The params to use
</dd><dt>:script_name 
<dd>
The SCRIPT_NAME to set
</dd></dl>

<div class="method-source-code" id="env_for-source">
 <pre># File lib/rack/mock.rb, line 105
def self.env_for(uri = &quot;&quot;, opts = {})
 uri = parse_uri_rfc2396(uri)
 uri.path = &quot;/#{uri.path}&quot; unless uri.path[0] == ?/

env = DEFAULT_ENV.dup

env[REQUEST_METHOD] = (opts[:method] ? opts[:method].to_s.upcase : GET).b
 env[SERVER_NAME] = (uri.host || &quot;example.org&quot;).b
 env[SERVER_PORT] = (uri.port ? uri.port.to_s : &quot;80&quot;).b
 env[QUERY_STRING] = (uri.query.to_s).b
 env[PATH_INFO] = ((!uri.path || uri.path.empty?) ? &quot;/&quot; : uri.path).b
 env[RACK_URL_SCHEME] = (uri.scheme || &quot;http&quot;).b
 env[HTTPS] = (env[RACK_URL_SCHEME] == &quot;https&quot; ? &quot;on&quot; : &quot;off&quot;).b

env[SCRIPT_NAME] = opts[:script_name] || &quot;&quot;

if opts[:fatal]
 env[RACK_ERRORS] = FatalWarner.new
 else
 env[RACK_ERRORS] = StringIO.new
 end

if params = opts[:params]
 if env[REQUEST_METHOD] == GET
 params = Utils.parse_nested_query(params) if params.is_a?(String)
 params.update(Utils.parse_nested_query(env[QUERY_STRING]))
 env[QUERY_STRING] = Utils.build_nested_query(params)
 elsif !opts.has_key?(:input)
 opts[&quot;CONTENT_TYPE&quot;] = &quot;application/x-www-form-urlencoded&quot;
 if params.is_a?(Hash)
 if data = Rack::Multipart.build_multipart(params)
 opts[:input] = data
 opts[&quot;CONTENT_LENGTH&quot;] ||= data.length.to_s
 opts[&quot;CONTENT_TYPE&quot;] = &quot;multipart/form-data; boundary=#{Rack::Multipart::MULTIPART_BOUNDARY}&quot;
 else
 opts[:input] = Utils.build_nested_query(params)
 end
 else
 opts[:input] = params
 end
 end
 end

empty_str = String.new
 opts[:input] ||= empty_str
 if String === opts[:input]
 rack_input = StringIO.new(opts[:input])
 else
 rack_input = opts[:input]
 end

rack_input.set_encoding(Encoding::BINARY)
 env[RACK_INPUT] = rack_input

env[&quot;CONTENT_LENGTH&quot;] ||= env[RACK_INPUT].size.to_s if env[RACK_INPUT].respond_to?(:size)

opts.each { |field, value|
 env[field] = value if String === field
 }

env
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-new" class="method-detail ">
 
 <div class="method-heading">
 new(app)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new-source">
 <pre># File lib/rack/mock.rb, line 52
def initialize(app)
 @app = app
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-parse_uri_rfc2396" class="method-detail ">
 
 <div class="method-heading">
 parse_uri_rfc2396(uri)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 For historical reasons, we&#39;re pinning to RFC 2396. URI::Parser = URI::RFC2396_Parser

<div class="method-source-code" id="parse_uri_rfc2396-source">
 <pre># File lib/rack/mock.rb, line 92
def self.parse_uri_rfc2396(uri)
 @parser ||= URI::Parser.new
 @parser.parse(uri)
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Instance Methods</h3>
 </header>

<div id="method-i-delete" class="method-detail ">
 
 <div class="method-heading">
 delete(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a DELETE request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="delete-source">
 <pre># File lib/rack/mock.rb, line 65
def delete(uri, opts = {}) request(DELETE, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-get" class="method-detail ">
 
 <div class="method-heading">
 get(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a GET request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="get-source">
 <pre># File lib/rack/mock.rb, line 57
def get(uri, opts = {}) request(GET, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-head" class="method-detail ">
 
 <div class="method-heading">
 head(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a HEAD request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="head-source">
 <pre># File lib/rack/mock.rb, line 67
def head(uri, opts = {}) request(HEAD, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-options" class="method-detail ">
 
 <div class="method-heading">
 options(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make an OPTIONS request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="options-source">
 <pre># File lib/rack/mock.rb, line 69
def options(uri, opts = {}) request(OPTIONS, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-patch" class="method-detail ">
 
 <div class="method-heading">
 patch(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a PATCH request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="patch-source">
 <pre># File lib/rack/mock.rb, line 63
def patch(uri, opts = {}) request(PATCH, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-post" class="method-detail ">
 
 <div class="method-heading">
 post(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a POST request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="post-source">
 <pre># File lib/rack/mock.rb, line 59
def post(uri, opts = {}) request(POST, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-put" class="method-detail ">
 
 <div class="method-heading">
 put(uri, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a PUT request and return a <a href="MockResponse.html"><code>MockResponse</code></a>. See <a href="MockRequest.html#method-i-request"><code>request</code></a>.

<div class="method-source-code" id="put-source">
 <pre># File lib/rack/mock.rb, line 61
def put(uri, opts = {}) request(PUT, uri, opts) end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-request" class="method-detail ">
 
 <div class="method-heading">
 request(method = GET, uri = &quot;&quot;, opts = {})
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Make a request using the given request method for the given uri to the rack application and return a <a href="MockResponse.html"><code>MockResponse</code></a>. Options given are passed to <a href="MockRequest.html#method-c-env_for"><code>MockRequest.env_for</code></a>.

<div class="method-source-code" id="request-source">
 <pre># File lib/rack/mock.rb, line 74
def request(method = GET, uri = &quot;&quot;, opts = {})
 env = self.class.env_for(uri, opts.merge(method: method))

if opts[:lint]
 app = Rack::Lint.new(@app)
 else
 app = @app
 end

errors = env[RACK_ERRORS]
 status, headers, body = app.call(env)
 MockResponse.new(status, headers, body, errors)
ensure
 body.close if body.respond_to?(:close)
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 </section>

</main>

<footer id="validator-badges" role="contentinfo">
 <a href="https://validator.w3.org/check/referer">Validate</a>
 Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
 Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>