Your IP : 52.14.49.59
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Auth::AbstractRequest - 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">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-authorization_key">#authorization_key</a>
<li ><a href="#method-i-params">#params</a>
<li ><a href="#method-i-parts">#parts</a>
<li ><a href="#method-i-provided-3F">#provided?</a>
<li ><a href="#method-i-request">#request</a>
<li ><a href="#method-i-scheme">#scheme</a>
<li ><a href="#method-i-valid-3F">#valid?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Auth::AbstractRequest">
<h1 id="class-Rack::Auth::AbstractRequest" class="class">
class Rack::Auth::AbstractRequest
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="AUTHORIZATION_KEYS">AUTHORIZATION_KEYS
<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">(env)</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/rack/auth/abstract/request.rb, line 7</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-ivar">@env</span> = <span class="ruby-identifier">env</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-params" class="method-detail ">
<div class="method-heading">
<span class="method-name">params</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="params-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">params</span>
<span class="ruby-ivar">@params</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">last</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parts" class="method-detail ">
<div class="method-heading">
<span class="method-name">parts</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="parts-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parts</span>
<span class="ruby-ivar">@parts</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@env</span>[<span class="ruby-identifier">authorization_key</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">' '</span>, <span class="ruby-value">2</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-provided-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">provided?</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="provided-3F-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 15</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">provided?</span>
<span class="ruby-operator">!</span><span class="ruby-identifier">authorization_key</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-request" class="method-detail ">
<div class="method-heading">
<span class="method-name">request</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="request-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">request</span>
<span class="ruby-ivar">@request</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@env</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scheme" class="method-detail ">
<div class="method-heading">
<span class="method-name">scheme</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="scheme-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scheme</span>
<span class="ruby-ivar">@scheme</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-valid-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid?</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="valid-3F-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid?</span>
<span class="ruby-operator">!</span><span class="ruby-ivar">@env</span>[<span class="ruby-identifier">authorization_key</span>].<span class="ruby-identifier">nil?</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-authorization_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">authorization_key</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="authorization_key-source">
<pre><span class="ruby-comment"># File lib/rack/auth/abstract/request.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">authorization_key</span>
<span class="ruby-ivar">@authorization_key</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">AUTHORIZATION_KEYS</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@env</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">key</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>