OwlCyberSecurity - MANAGER
Edit File: MockResponse.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::MockResponse - rack-2.2.10 Documentation</title> <script type="text/javascript"> var rdoc_rel_prefix = "../"; var index_rel_prefix = "../"; </script> <script src="../js/navigation.js" defer></script> <script src="../js/search.js" defer></script> <script src="../js/search_index.js" defer></script> <script src="../js/searcher.js" defer></script> <script src="../js/darkfish.js" defer></script> <link href="../css/fonts.css" rel="stylesheet"> <link href="../css/rdoc.css" rel="stylesheet"> <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> <a href="../index.html" rel="home">Home</a> </h2> <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 id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <div id="search-field-wrapper"> <input id="search-field" role="combobox" aria-label="Search" aria-autocomplete="list" aria-controls="search-results" type="text" name="search" placeholder="Search" spellcheck="false" title="Type to search, Up and Down to navigate, Enter to load"> </div> <ul id="search-results" aria-label="Search Results" aria-busy="false" aria-expanded="false" aria-atomic="false" class="initially-hidden"></ul> </form> </div> </div> <div id="class-metadata"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link"><a href="Response.html">Rack::Response</a> </div> <!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> <li class="calls-super" ><a href="#method-c-new">::new</a> <li ><a href="#method-i-3D~">#=~</a> <li class="calls-super" ><a href="#method-i-body">#body</a> <li ><a href="#method-i-cookie">#cookie</a> <li ><a href="#method-i-empty-3F">#empty?</a> <li ><a href="#method-i-identify_cookie_attributes">#identify_cookie_attributes</a> <li ><a href="#method-i-match">#match</a> <li ><a href="#method-i-parse_cookies_from_header">#parse_cookies_from_header</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::MockResponse"> <h1 id="class-Rack::MockResponse" class="class"> class Rack::MockResponse </h1> <section class="description"> <p><a href="MockResponse.html"><code>Rack::MockResponse</code></a> provides useful helpers for testing your apps. Usually, you don't create the <a href="MockResponse.html"><code>MockResponse</code></a> on your own, but use <a href="MockRequest.html"><code>MockRequest</code></a>.</p> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-cookies" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">cookies</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> <p>Headers</p> </div> </div> <div id="attribute-i-errors" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">errors</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Errors</p> </div> </div> <div id="attribute-i-original_headers" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">original_headers</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> <p>Headers</p> </div> </div> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(status, headers, body, errors = StringIO.new(""))</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method <a href="Response.html#method-c-new"><code>Rack::Response::new</code></a> </div> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 184</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">errors</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">""</span>)) <span class="ruby-ivar">@original_headers</span> = <span class="ruby-identifier">headers</span> <span class="ruby-ivar">@errors</span> = <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">string</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:string</span>) <span class="ruby-ivar">@cookies</span> = <span class="ruby-identifier">parse_cookies_from_header</span> <span class="ruby-keyword">super</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>) <span class="ruby-identifier">buffered_body!</span> <span class="ruby-keyword">end</span></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-3D~" class="method-detail "> <div class="method-heading"> <span class="method-name">=~</span><span class="method-args">(other)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="3D~-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 194</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">=~</span>(<span class="ruby-identifier">other</span>) <span class="ruby-identifier">body</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">other</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-body" class="method-detail "> <div class="method-heading"> <span class="method-name">body</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method </div> <div class="method-source-code" id="body-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 202</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">body</span> <span class="ruby-comment"># FIXME: apparently users of MockResponse expect the return value of</span> <span class="ruby-comment"># MockResponse#body to be a string. However, the real response object</span> <span class="ruby-comment"># returns the body as a list.</span> <span class="ruby-comment">#</span> <span class="ruby-comment"># See spec_showstatus.rb:</span> <span class="ruby-comment">#</span> <span class="ruby-comment"># should "not replace existing messages" do</span> <span class="ruby-comment"># ...</span> <span class="ruby-comment"># res.body.should == "foo!"</span> <span class="ruby-comment"># end</span> <span class="ruby-identifier">buffer</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">super</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chunk</span><span class="ruby-operator">|</span> <span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">chunk</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">buffer</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-cookie" class="method-detail "> <div class="method-heading"> <span class="method-name">cookie</span><span class="method-args">(name)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="cookie-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 226</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cookie</span>(<span class="ruby-identifier">name</span>) <span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">name</span>, <span class="ruby-keyword">nil</span>) <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-empty-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">empty?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="empty-3F-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 222</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span> [<span class="ruby-value">201</span>, <span class="ruby-value">204</span>, <span class="ruby-value">304</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">status</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-match" class="method-detail "> <div class="method-heading"> <span class="method-name">match</span><span class="method-args">(other)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="match-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 198</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>(<span class="ruby-identifier">other</span>) <span class="ruby-identifier">body</span>.<span class="ruby-identifier">match</span> <span class="ruby-identifier">other</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-identify_cookie_attributes" class="method-detail "> <div class="method-heading"> <span class="method-name">identify_cookie_attributes</span><span class="method-args">(cookie_filling)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="identify_cookie_attributes-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 253</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">identify_cookie_attributes</span>(<span class="ruby-identifier">cookie_filling</span>) <span class="ruby-identifier">cookie_bits</span> = <span class="ruby-identifier">cookie_filling</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">';'</span>) <span class="ruby-identifier">cookie_attributes</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">store</span>(<span class="ruby-string">'value'</span>, <span class="ruby-identifier">cookie_bits</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">strip</span>) <span class="ruby-identifier">cookie_bits</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">bit</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">bit</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">'='</span> <span class="ruby-identifier">cookie_attribute</span>, <span class="ruby-identifier">attribute_value</span> = <span class="ruby-identifier">bit</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'='</span>) <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">store</span>(<span class="ruby-identifier">cookie_attribute</span>.<span class="ruby-identifier">strip</span>, <span class="ruby-identifier">attribute_value</span>.<span class="ruby-identifier">strip</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">cookie_attribute</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">'max-age'</span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">store</span>(<span class="ruby-string">'expires'</span>, <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">attribute_value</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">bit</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">'secure'</span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">store</span>(<span class="ruby-string">'secure'</span>, <span class="ruby-keyword">true</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">cookie_attributes</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-parse_cookies_from_header" class="method-detail "> <div class="method-heading"> <span class="method-name">parse_cookies_from_header</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="parse_cookies_from_header-source"> <pre><span class="ruby-comment"># File lib/rack/mock.rb, line 232</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_cookies_from_header</span> <span class="ruby-identifier">cookies</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">original_headers</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-string">'Set-Cookie'</span> <span class="ruby-identifier">set_cookie_header</span> = <span class="ruby-identifier">original_headers</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'Set-Cookie'</span>) <span class="ruby-identifier">set_cookie_header</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cookie</span><span class="ruby-operator">|</span> <span class="ruby-identifier">cookie_name</span>, <span class="ruby-identifier">cookie_filling</span> = <span class="ruby-identifier">cookie</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'='</span>, <span class="ruby-value">2</span>) <span class="ruby-identifier">cookie_attributes</span> = <span class="ruby-identifier">identify_cookie_attributes</span> <span class="ruby-identifier">cookie_filling</span> <span class="ruby-identifier">parsed_cookie</span> = <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Cookie</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">'name'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_name</span>.<span class="ruby-identifier">strip</span>, <span class="ruby-string">'value'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'value'</span>), <span class="ruby-string">'path'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'path'</span>, <span class="ruby-keyword">nil</span>), <span class="ruby-string">'domain'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'domain'</span>, <span class="ruby-keyword">nil</span>), <span class="ruby-string">'expires'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'expires'</span>, <span class="ruby-keyword">nil</span>), <span class="ruby-string">'secure'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">cookie_attributes</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-string">'secure'</span>, <span class="ruby-keyword">false</span>) ) <span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">store</span>(<span class="ruby-identifier">cookie_name</span>, <span class="ruby-identifier">parsed_cookie</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">cookies</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> </section> </main> <footer id="validator-badges" role="contentinfo"> <p><a href="https://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>