File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/CompactIndexClient/Updater.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::CompactIndexClient::Updater - 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"><a href="../../Object.html">Object</a>
</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-checksum_for_file">#checksum_for_file</a>
<li ><a href="#method-i-etag_for">#etag_for</a>
<li ><a href="#method-i-slice_body">#slice_body</a>
<li ><a href="#method-i-update">#update</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::CompactIndexClient::Updater">
<h1 id="class-Bundler::CompactIndexClient::Updater" class="class">
class Bundler::CompactIndexClient::Updater
</h1>
<section class="description">
</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">(fetcher)</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/bundler/compact_index_client/updater.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">fetcher</span>)
<span class="ruby-ivar">@fetcher</span> = <span class="ruby-identifier">fetcher</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"tmpdir"</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-checksum_for_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">checksum_for_file</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="checksum_for_file-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/updater.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checksum_for_file</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">file?</span>
<span class="ruby-comment"># This must use IO.read instead of Digest.file().hexdigest</span>
<span class="ruby-comment"># because we need to preserve \n line endings on windows when calculating</span>
<span class="ruby-comment"># the checksum</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value">:read</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">digest</span>(<span class="ruby-value">:MD5</span>).<span class="ruby-identifier">hexdigest</span>(<span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-etag_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">etag_for</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="etag_for-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/updater.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">etag_for</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">sum</span> = <span class="ruby-identifier">checksum_for_file</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">sum</span> <span class="ruby-operator">?</span> <span class="ruby-node">%("#{sum}")</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-slice_body" class="method-detail ">
<div class="method-heading">
<span class="method-name">slice_body</span><span
class="method-args">(body, range)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="slice_body-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/updater.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">slice_body</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">range</span>)
<span class="ruby-identifier">body</span>.<span class="ruby-identifier">byteslice</span>(<span class="ruby-identifier">range</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update" class="method-detail ">
<div class="method-heading">
<span class="method-name">update</span><span
class="method-args">(local_path, remote_path, retrying = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="update-source">
<pre><span class="ruby-comment"># File lib/bundler/compact_index_client/updater.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">retrying</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">headers</span> = {}
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mktmpdir</span>(<span class="ruby-string">"bundler-compact-index-"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">local_temp_dir</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">local_temp_path</span> = <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">local_temp_dir</span>).<span class="ruby-identifier">join</span>(<span class="ruby-identifier">local_path</span>.<span class="ruby-identifier">basename</span>)
<span class="ruby-comment"># first try to fetch any new bytes on the existing file</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">retrying</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">local_path</span>.<span class="ruby-identifier">file?</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">local_temp_path</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span> <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">local_temp_path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">headers</span>[<span class="ruby-string">"If-None-Match"</span>] = <span class="ruby-identifier">etag_for</span>(<span class="ruby-identifier">local_temp_path</span>)
<span class="ruby-identifier">headers</span>[<span class="ruby-string">"Range"</span>] =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">local_temp_path</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">nonzero?</span>
<span class="ruby-comment"># Subtract a byte to ensure the range won't be empty.</span>
<span class="ruby-comment"># Avoids 416 (Range Not Satisfiable) responses.</span>
<span class="ruby-node">"bytes=#{local_temp_path.size - 1}-"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-node">"bytes=#{local_temp_path.size}-"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment"># Fastly ignores Range when Accept-Encoding: gzip is set</span>
<span class="ruby-identifier">headers</span>[<span class="ruby-string">"Accept-Encoding"</span>] = <span class="ruby-string">"gzip"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@fetcher</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPNotModified</span>)
<span class="ruby-identifier">content</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>[<span class="ruby-string">"Content-Encoding"</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"gzip"</span>
<span class="ruby-identifier">content</span> = <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipReader</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">content</span>)).<span class="ruby-identifier">read</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">local_temp_path</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPPartialContent</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">local_temp_path</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">nonzero?</span>
<span class="ruby-identifier">local_temp_path</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">"a"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">slice_body</span>(<span class="ruby-identifier">content</span>, <span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">local_temp_path</span>.<span class="ruby-identifier">open</span>(<span class="ruby-string">"w"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">content</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">response_etag</span> = (<span class="ruby-identifier">response</span>[<span class="ruby-string">"ETag"</span>] <span class="ruby-operator">||</span> <span class="ruby-string">""</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r{\AW/}</span>, <span class="ruby-string">""</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">etag_for</span>(<span class="ruby-identifier">local_temp_path</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">response_etag</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">local_path</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mv</span>(<span class="ruby-identifier">local_temp_path</span>, <span class="ruby-identifier">local_path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">retrying</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">MisMatchedChecksumError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">response_etag</span>, <span class="ruby-identifier">etag_for</span>(<span class="ruby-identifier">local_temp_path</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">update</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-value">:retrying</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EACCES</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">PermissionError</span>,
<span class="ruby-string">"Bundler does not have write access to create a temp directory "</span> \
<span class="ruby-node">"within #{Dir.tmpdir}. Bundler must have write access to your "</span> \
<span class="ruby-string">"systems temp directory to function properly. "</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipFile</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPError</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>