File: C:/Ruby27-x64/share/doc/ruby/html/Gem/RemoteFetcher.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::RemoteFetcher - 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>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="UserInteraction.html">Gem::UserInteraction</a>
<li><a class="include" href="UriParsing.html">Gem::UriParsing</a>
</ul>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Deprecate.html">Gem::Deprecate</a>
</ul>
</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-fetcher">::fetcher</a>
<li ><a href="#method-c-fetcher-3D">::fetcher=</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-cache_update_path">#cache_update_path</a>
<li ><a href="#method-i-close_all">#close_all</a>
<li ><a href="#method-i-download">#download</a>
<li ><a href="#method-i-download_to_cache">#download_to_cache</a>
<li ><a href="#method-i-fetch_file">#fetch_file</a>
<li ><a href="#method-i-fetch_http">#fetch_http</a>
<li ><a href="#method-i-fetch_https">#fetch_https</a>
<li ><a href="#method-i-fetch_path">#fetch_path</a>
<li ><a href="#method-i-fetch_s3">#fetch_s3</a>
<li ><a href="#method-i-fetch_size">#fetch_size</a>
<li ><a href="#method-i-https-3F">#https?</a>
<li ><a href="#method-i-pools_for">#pools_for</a>
<li ><a href="#method-i-proxy_for">#proxy_for</a>
<li ><a href="#method-i-request">#request</a>
<li ><a href="#method-i-s3_uri_signer">#s3_uri_signer</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::RemoteFetcher">
<h1 id="class-Gem::RemoteFetcher" class="class">
class Gem::RemoteFetcher
</h1>
<section class="description">
<p><a href="RemoteFetcher.html"><code>RemoteFetcher</code></a> handles the details of fetching gems and gem information from a remote source.</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-headers" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">headers</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</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-fetcher" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetcher</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Cached <a href="RemoteFetcher.html"><code>RemoteFetcher</code></a> instance.</p>
<div class="method-source-code" id="fetcher-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">fetcher</span>
<span class="ruby-ivar">@fetcher</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>[<span class="ruby-value">:http_proxy</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-fetcher-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetcher=</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="fetcher-3D-source">
<pre><span class="ruby-comment"># File lib/rubygems/test_utilities.rb, line 171</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">fetcher=</span>(<span class="ruby-identifier">fetcher</span>)
<span class="ruby-ivar">@fetcher</span> = <span class="ruby-identifier">fetcher</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(proxy=nil, dns=nil, headers={})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initialize a remote fetcher using the source <a href="../URI.html"><code>URI</code></a> and possible proxy information.</p>
<p><code>proxy</code></p>
<ul><li>
<p>[String]: explicit specification of proxy; overrides any environment</p>
<pre class="ruby"><span class="ruby-identifier">variable</span> <span class="ruby-identifier">setting</span>
</pre>
</li><li>
<p>nil: respect environment variables (HTTP_PROXY, HTTP_PROXY_USER,</p>
<pre>HTTP_PROXY_PASS)</pre>
</li><li>
<p><code>:no_proxy</code>: ignore environment variables and _don't_ use a proxy</p>
</li></ul>
<p><code>headers</code>: A set of additional HTTP headers to be sent to the server when</p>
<pre>fetching the gem.</pre>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">proxy</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">dns</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">headers</span>={})
<span class="ruby-identifier">require</span> <span class="ruby-string">'net/http'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'stringio'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'time'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'uri'</span>
<span class="ruby-constant">Socket</span>.<span class="ruby-identifier">do_not_reverse_lookup</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@proxy</span> = <span class="ruby-identifier">proxy</span>
<span class="ruby-ivar">@pools</span> = {}
<span class="ruby-ivar">@pool_lock</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@cert_files</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">get_cert_files</span>
<span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">headers</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-cache_update_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">cache_update_path</span><span
class="method-args">(uri, path = nil, update = true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Downloads <code>uri</code> to <code>path</code> if necessary. If no path is given, it just passes the data.</p>
<div class="method-source-code" id="cache_update_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 296</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cache_update_path</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">update</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">mtime</span> = <span class="ruby-identifier">path</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">stat</span>(<span class="ruby-identifier">path</span>).<span class="ruby-identifier">mtime</span> <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">fetch_path</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">mtime</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-comment"># indicates the server returned 304 Not Modified</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">read_binary</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">update</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">path</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">write_binary</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">data</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">close_all</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="close_all-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 343</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close_all</span>
<span class="ruby-ivar">@pools</span>.<span class="ruby-identifier">each_value</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">pool</span><span class="ruby-operator">|</span> <span class="ruby-identifier">pool</span>.<span class="ruby-identifier">close_all</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-download" class="method-detail ">
<div class="method-heading">
<span class="method-name">download</span><span
class="method-args">(spec, source_uri, install_dir = Gem.dir)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Moves the gem <code>spec</code> from <code>source_uri</code> to the cache dir unless it is already there. If the source_uri is local the gem cache dir copy is always replaced.</p>
<div class="method-source-code" id="download-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download</span>(<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source_uri</span>, <span class="ruby-identifier">install_dir</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">dir</span>)
<span class="ruby-identifier">cache_dir</span> =
<span class="ruby-keyword">if</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">install_dir</span> <span class="ruby-comment"># see fetch_command</span>
<span class="ruby-identifier">install_dir</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">writable?</span> <span class="ruby-identifier">install_dir</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">install_dir</span>, <span class="ruby-string">"cache"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">user_dir</span>, <span class="ruby-string">"cache"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem_file_name</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-identifier">local_gem_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">cache_dir</span>, <span class="ruby-identifier">gem_file_name</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-identifier">cache_dir</span> <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">cache_dir</span>
<span class="ruby-identifier">source_uri</span> = <span class="ruby-identifier">parse_uri</span>(<span class="ruby-identifier">source_uri</span>)
<span class="ruby-identifier">scheme</span> = <span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">scheme</span>
<span class="ruby-comment"># URI.parse gets confused by MS Windows paths with forward slashes.</span>
<span class="ruby-identifier">scheme</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">scheme</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^[a-z]$/i</span>
<span class="ruby-comment"># REFACTOR: split this up and dispatch on scheme (eg download_http)</span>
<span class="ruby-comment"># REFACTOR: be sure to clean up fake fetcher when you do this... cleaner</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">scheme</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'http'</span>, <span class="ruby-string">'https'</span>, <span class="ruby-string">'s3'</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">local_gem_path</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-node">"Downloading gem #{gem_file_name}"</span>
<span class="ruby-identifier">remote_gem_path</span> = <span class="ruby-identifier">source_uri</span> <span class="ruby-operator">+</span> <span class="ruby-node">"gems/#{gem_file_name}"</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">cache_update_path</span> <span class="ruby-identifier">remote_gem_path</span>, <span class="ruby-identifier">local_gem_path</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">FetchError</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">original_platform</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">platform</span>
<span class="ruby-identifier">alternate_name</span> = <span class="ruby-node">"#{spec.original_name}.gem"</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-node">"Failed, downloading gem #{alternate_name}"</span>
<span class="ruby-identifier">remote_gem_path</span> = <span class="ruby-identifier">source_uri</span> <span class="ruby-operator">+</span> <span class="ruby-node">"gems/#{alternate_name}"</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">cache_update_path</span> <span class="ruby-identifier">remote_gem_path</span>, <span class="ruby-identifier">local_gem_path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'file'</span> <span class="ruby-keyword">then</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">path</span>
<span class="ruby-identifier">path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">path</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">extname</span>(<span class="ruby-identifier">path</span>) <span class="ruby-operator">==</span> <span class="ruby-string">'.gem'</span>
<span class="ruby-identifier">remote_gem_path</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">correct_for_windows_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-string">'gems'</span>, <span class="ruby-identifier">gem_file_name</span>))
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span>(<span class="ruby-identifier">remote_gem_path</span>, <span class="ruby-identifier">local_gem_path</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">local_gem_path</span> = <span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-node">"Using local gem #{local_gem_path}"</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-comment"># TODO test for local overriding cache</span>
<span class="ruby-identifier">source_path</span> = <span class="ruby-keyword">if</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">win_platform?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">scheme</span> <span class="ruby-operator">&&</span>
<span class="ruby-operator">!</span><span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">':'</span>)
<span class="ruby-node">"#{source_uri.scheme}:#{source_uri.path}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">path</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">source_path</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">UriFormatter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">source_path</span>).<span class="ruby-identifier">unescape</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span> <span class="ruby-identifier">source_path</span>, <span class="ruby-identifier">local_gem_path</span> <span class="ruby-keyword">unless</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">identical?</span>(<span class="ruby-identifier">source_path</span>, <span class="ruby-identifier">local_gem_path</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">local_gem_path</span> = <span class="ruby-identifier">source_uri</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-node">"Using local gem #{local_gem_path}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"unsupported URI scheme #{source_uri.scheme}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">local_gem_path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-download_to_cache" class="method-detail ">
<div class="method-heading">
<span class="method-name">download_to_cache</span><span
class="method-args">(dependency)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Given a name and requirement, downloads this gem into cache and returns the filename. Returns nil if the gem cannot be located.</p>
<div class="method-source-code" id="download_to_cache-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download_to_cache</span>(<span class="ruby-identifier">dependency</span>)
<span class="ruby-identifier">found</span>, <span class="ruby-identifier">_</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SpecFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">spec_for_dependency</span> <span class="ruby-identifier">dependency</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">found</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span> = <span class="ruby-identifier">found</span>.<span class="ruby-identifier">max_by</span> { <span class="ruby-operator">|</span>(<span class="ruby-identifier">s</span>,<span class="ruby-identifier">_</span>)<span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span> }
<span class="ruby-identifier">download</span> <span class="ruby-identifier">spec</span>, <span class="ruby-identifier">source</span>.<span class="ruby-identifier">uri</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_file</span><span
class="method-args">(uri, *_)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../File.html"><code>File</code></a> Fetcher. Dispatched by <code>fetch_path</code>. Use it instead.</p>
<div class="method-source-code" id="fetch_file-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 208</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_file</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">_</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">read_binary</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">correct_for_windows_path</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_http" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_http</span><span
class="method-args">(uri, last_modified = nil, head = false, depth = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>HTTP Fetcher. Dispatched by <code>fetch_path</code>. Use it instead.</p>
<div class="method-source-code" id="fetch_http-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 215</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_http</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">last_modified</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">head</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">depth</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">fetch_type</span> = <span class="ruby-identifier">head</span> <span class="ruby-operator">?</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Head</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">request</span> <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">fetch_type</span>, <span class="ruby-identifier">last_modified</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">req</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">headers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">add_field</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>) }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">response</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPOK</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPNotModified</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">uri</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:uri</span>
<span class="ruby-identifier">head</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">response</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPMovedPermanently</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPFound</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPSeeOther</span>,
<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPTemporaryRedirect</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'too many redirects'</span>, <span class="ruby-identifier">uri</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">depth</span> <span class="ruby-operator">></span> <span class="ruby-value">10</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'Location'</span>]
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"redirecting but no redirect location was given"</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">parse_uri</span> <span class="ruby-identifier">location</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">https?</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">https?</span>(<span class="ruby-identifier">location</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"redirecting to non-https resource: #{location}"</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">fetch_http</span>(<span class="ruby-identifier">location</span>, <span class="ruby-identifier">last_modified</span>, <span class="ruby-identifier">head</span>, <span class="ruby-identifier">depth</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"bad response #{response.message} #{response.code}"</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="RemoteFetcher.html#method-i-fetch_https">fetch_https</a>
</div>
</div>
<div id="method-i-fetch_https" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">fetch_https</span><span
class="method-args">(uri, last_modified = nil, head = false, depth = 0)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="RemoteFetcher.html#method-i-fetch_http">fetch_http</a>
</div>
</div>
<div id="method-i-fetch_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_path</span><span
class="method-args">(uri, mtime = nil, head = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Downloads <code>uri</code> and returns it as a <a href="../String.html"><code>String</code></a>.</p>
<div class="method-source-code" id="fetch_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_path</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">mtime</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">head</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">parse_uri</span> <span class="ruby-identifier">uri</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"uri scheme is invalid: #{uri.scheme.inspect}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">send</span> <span class="ruby-node">"fetch_#{uri.scheme}"</span>, <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">mtime</span>, <span class="ruby-identifier">head</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span> <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span><span class="ruby-identifier">head</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\.gz$/</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">data</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">gunzip</span> <span class="ruby-identifier">data</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">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"server did not return a valid file"</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownHostError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'timed out'</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IOError</span>, <span class="ruby-constant">SocketError</span>, <span class="ruby-constant">SystemCallError</span>,
<span class="ruby-operator">*</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLError</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">OpenSSL</span>)) <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/getaddrinfo/</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownHostError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'no such name'</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{e.class}: #{e}"</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_s3" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_s3</span><span
class="method-args">(uri, mtime = nil, head = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fetch_s3-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 278</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_s3</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">mtime</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">head</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">public_uri</span> = <span class="ruby-identifier">s3_uri_signer</span>(<span class="ruby-identifier">uri</span>).<span class="ruby-identifier">sign</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">S3URISigner</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigurationError</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">S3URISigner</span><span class="ruby-operator">::</span><span class="ruby-constant">InstanceProfileError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FetchError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>, <span class="ruby-node">"s3://#{uri.host}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">fetch_https</span> <span class="ruby-identifier">public_uri</span>, <span class="ruby-identifier">mtime</span>, <span class="ruby-identifier">head</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch_size" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch_size</span><span
class="method-args">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the size of <code>uri</code> in bytes.</p>
<div class="method-source-code" id="fetch_size-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 315</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch_size</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">fetch_path</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">response</span>[<span class="ruby-string">'content-length'</span>].<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-https-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">https?</span><span
class="method-args">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="https-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 339</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">https?</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">'https'</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">(uri, request_class, last_modified = nil) { |req| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Performs a <a href="../Net/HTTP.html"><code>Net::HTTP</code></a> request of type <code>request_class</code> on <code>uri</code> returning a <a href="../Net/HTTP.html"><code>Net::HTTP</code></a> response object. request maintains a table of persistent connections to reduce connect overhead.</p>
<div class="method-source-code" id="request-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 328</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">request_class</span>, <span class="ruby-identifier">last_modified</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">proxy</span> = <span class="ruby-identifier">proxy_for</span> <span class="ruby-ivar">@proxy</span>, <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">pool</span> = <span class="ruby-identifier">pools_for</span>(<span class="ruby-identifier">proxy</span>).<span class="ruby-identifier">pool_for</span> <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">request_class</span>, <span class="ruby-identifier">last_modified</span>, <span class="ruby-identifier">pool</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">req</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">req</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-s3_uri_signer" class="method-detail ">
<div class="method-heading">
<span class="method-name">s3_uri_signer</span><span
class="method-args">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>we have our own signing code here to avoid a dependency on the aws-sdk gem</p>
<div class="method-source-code" id="s3_uri_signer-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 288</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">s3_uri_signer</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">S3URISigner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</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-pools_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">pools_for</span><span
class="method-args">(proxy)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="pools_for-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 353</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pools_for</span>(<span class="ruby-identifier">proxy</span>)
<span class="ruby-ivar">@pool_lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@pools</span>[<span class="ruby-identifier">proxy</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span><span class="ruby-operator">::</span><span class="ruby-constant">ConnectionPools</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">proxy</span>, <span class="ruby-ivar">@cert_files</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-proxy_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">proxy_for</span><span
class="method-args">(proxy, uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="proxy_for-source">
<pre><span class="ruby-comment"># File lib/rubygems/remote_fetcher.rb, line 349</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">proxy_for</span>(<span class="ruby-identifier">proxy</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">proxy_uri</span>(<span class="ruby-identifier">proxy</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">get_proxy_from_env</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</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>