docs/UmtsCustomMatchers/RedirectBack.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class UmtsCustomMatchers::RedirectBack - RDoc 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">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-matches-3F">#matches?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-UmtsCustomMatchers::RedirectBack">
<h1 id="class-UmtsCustomMatchers::RedirectBack" class="class">
class UmtsCustomMatchers::RedirectBack
</h1>
<section class="description">
<p>Matcher for redirecting to “back”. Asserts that the HTTP response code is a redirect, and also that the <code>Location</code> matches the HTTP_REFERER of the request.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ALLOWED_REQUEST_TYPES">ALLOWED_REQUEST_TYPES
<dd>
<dt id="ALLOWED_RESPONSE_TYPES">ALLOWED_RESPONSE_TYPES
<dd>
<dt id="MATCHER_MODULE">MATCHER_MODULE
<dd>
<dt id="REDIRECT_PATH_MATCHER">REDIRECT_PATH_MATCHER
<dd>
<dt id="STATUS_CODE_MATCHER">STATUS_CODE_MATCHER
<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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(scope)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/umts_custom_matchers/redirect_back.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">scope</span>)
<span class="ruby-ivar">@scope</span> = <span class="ruby-identifier">scope</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-matches-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">matches?</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if response is a <code>302</code>, and the location matches the <code>HTTP_REFERER</code> of the request. <code>false</code> otherwise.</p>
<div class="method-source-code" id="matches-3F-source">
<pre><span class="ruby-comment"># File lib/umts_custom_matchers/redirect_back.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">matches?</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">path</span> = <span class="ruby-string">'http://test.host/redirect'</span>
<span class="ruby-identifier">status_matcher</span> = <span class="ruby-constant">STATUS_CODE_MATCHER</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:redirect</span>
<span class="ruby-identifier">path_matcher</span> = <span class="ruby-constant">REDIRECT_PATH_MATCHER</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@scope</span>, <span class="ruby-identifier">path</span>
<span class="ruby-identifier">verify_spec_type</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">verify_request_type</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">verify_response_type</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">verify_input_type</span>(<span class="ruby-identifier">code</span>) <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@scope</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">env</span>[<span class="ruby-string">'HTTP_REFERER'</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">path</span>
<span class="ruby-identifier">code</span>.<span class="ruby-identifier">call</span>
<span class="ruby-ivar">@response</span> = <span class="ruby-ivar">@scope</span>.<span class="ruby-identifier">response</span>
<span class="ruby-identifier">verify_status_code</span>(<span class="ruby-identifier">status_matcher</span>) <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">verify_redirect_path</span>(<span class="ruby-identifier">path_matcher</span>) <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">true</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.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>