%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::ConditionalGet - 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-call">#call</a>
<li ><a href="#method-i-etag_matches-3F">#etag_matches?</a>
<li ><a href="#method-i-fresh-3F">#fresh?</a>
<li ><a href="#method-i-modified_since-3F">#modified_since?</a>
<li ><a href="#method-i-to_rfc2822">#to_rfc2822</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::ConditionalGet">
<h1 id="class-Rack::ConditionalGet" class="class">
class Rack::ConditionalGet
</h1>
<section class="description">
<p>Middleware that enables conditional GET using If-None-Match and If-Modified-Since. The application should set either or both of the Last-Modified or Etag response headers according to RFC 2616. When either of the conditions is met, the response body is set to be zero length and the response status is set to 304 Not Modified.</p>
<p>Applications that defer response body generation until the body's each message is received will avoid response body generation completely when a conditional GET matches.</p>
<p>Adapted from Michael Klishin's Merb implementation: <a href="https://github.com/wycats/merb/blob/master/merb-core/lib/merb-core/rack/middleware/conditional_get.rb">github.com/wycats/merb/blob/master/merb-core/lib/merb-core/rack/middleware/conditional_get.rb</a></p>
</section>
<section id="5Buntitled-5D" class="documentation-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">(app)</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/conditional_get.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>)
<span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</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-call" class="method-detail ">
<div class="method-heading">
<span class="method-name">call</span><span
class="method-args">(env)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return empty 304 response if the response has not been modified since the last request.</p>
<div class="method-source-code" id="call-source">
<pre><span class="ruby-comment"># File lib/rack/conditional_get.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">env</span>[<span class="ruby-constant">REQUEST_METHOD</span>]
<span class="ruby-keyword">when</span> <span class="ruby-string">"GET"</span>, <span class="ruby-string">"HEAD"</span>
<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-identifier">headers</span> = <span class="ruby-constant">Utils</span><span class="ruby-operator">::</span><span class="ruby-constant">HeaderHash</span>[<span class="ruby-identifier">headers</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">fresh?</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-identifier">status</span> = <span class="ruby-value">304</span>
<span class="ruby-identifier">headers</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">CONTENT_TYPE</span>)
<span class="ruby-identifier">headers</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">CONTENT_LENGTH</span>)
<span class="ruby-identifier">original_body</span> = <span class="ruby-identifier">body</span>
<span class="ruby-identifier">body</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">BodyProxy</span>.<span class="ruby-identifier">new</span>([]) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">original_body</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">original_body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:close</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">end</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-etag_matches-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">etag_matches?</span><span
class="method-args">(none_match, headers)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether the <a href="ETag.html"><code>ETag</code></a> response header matches the If-None-Match request header. If so, the request has not been modified.</p>
<div class="method-source-code" id="etag_matches-3F-source">
<pre><span class="ruby-comment"># File lib/rack/conditional_get.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">etag_matches?</span>(<span class="ruby-identifier">none_match</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-identifier">headers</span>[<span class="ruby-string">'ETag'</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">none_match</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fresh-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">fresh?</span><span
class="method-args">(env, headers)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return whether the response has not been modified since the last request.</p>
<div class="method-source-code" id="fresh-3F-source">
<pre><span class="ruby-comment"># File lib/rack/conditional_get.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fresh?</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-comment"># If-None-Match has priority over If-Modified-Since per RFC 7232</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">none_match</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">'HTTP_IF_NONE_MATCH'</span>]
<span class="ruby-identifier">etag_matches?</span>(<span class="ruby-identifier">none_match</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-keyword">elsif</span> (<span class="ruby-identifier">modified_since</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">'HTTP_IF_MODIFIED_SINCE'</span>]) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">modified_since</span> = <span class="ruby-identifier">to_rfc2822</span>(<span class="ruby-identifier">modified_since</span>))
<span class="ruby-identifier">modified_since?</span>(<span class="ruby-identifier">modified_since</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-modified_since-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">modified_since?</span><span
class="method-args">(modified_since, headers)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether the Last-Modified response header matches the If-Modified-Since request header. If so, the request has not been modified.</p>
<div class="method-source-code" id="modified_since-3F-source">
<pre><span class="ruby-comment"># File lib/rack/conditional_get.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">modified_since?</span>(<span class="ruby-identifier">modified_since</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-identifier">last_modified</span> = <span class="ruby-identifier">to_rfc2822</span>(<span class="ruby-identifier">headers</span>[<span class="ruby-string">'Last-Modified'</span>]) <span class="ruby-keyword">and</span>
<span class="ruby-identifier">modified_since</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">last_modified</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_rfc2822" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_rfc2822</span><span
class="method-args">(since)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a Time object for the given string (which should be in RFC2822 format), or nil if the string cannot be parsed.</p>
<div class="method-source-code" id="to_rfc2822-source">
<pre><span class="ruby-comment"># File lib/rack/conditional_get.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_rfc2822</span>(<span class="ruby-identifier">since</span>)
<span class="ruby-comment"># shortest possible valid date is the obsolete: 1 Nov 97 09:55 A</span>
<span class="ruby-comment"># anything shorter is invalid, this avoids exceptions for common cases</span>
<span class="ruby-comment"># most common being the empty string</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">since</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">since</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">>=</span> <span class="ruby-value">16</span>
<span class="ruby-comment"># NOTE: there is no trivial way to write this in a non exception way</span>
<span class="ruby-comment"># _rfc2822 returns a hash but is not that usable</span>
<span class="ruby-constant">Time</span>.<span class="ruby-identifier">rfc2822</span>(<span class="ruby-identifier">since</span>) <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</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>
Zerion Mini Shell 1.0