File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Fetcher/Downloader.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Fetcher::Downloader - 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-fetch">#fetch</a>
<li ><a href="#method-i-request">#request</a>
<li ><a href="#method-i-validate_uri_scheme-21">#validate_uri_scheme!</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Fetcher::Downloader">
<h1 id="class-Bundler::Fetcher::Downloader" class="class">
class Bundler::Fetcher::Downloader
</h1>
<section class="description">
</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-connection" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">connection</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-redirect_limit" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">redirect_limit</span><span
class="attribute-access-type">[R]</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(connection, redirect_limit)</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/fetcher/downloader.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">connection</span>, <span class="ruby-identifier">redirect_limit</span>)
<span class="ruby-ivar">@connection</span> = <span class="ruby-identifier">connection</span>
<span class="ruby-ivar">@redirect_limit</span> = <span class="ruby-identifier">redirect_limit</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-fetch" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch</span><span
class="method-args">(uri, headers = {}, counter = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fetch-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/downloader.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">headers</span> = {}, <span class="ruby-identifier">counter</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPError</span>, <span class="ruby-string">"Too many redirects"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">counter</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">redirect_limit</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">headers</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"HTTP #{response.code} #{response.message} #{uri}"</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">HTTPSuccess</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPNotModified</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">HTTPRedirection</span>
<span class="ruby-identifier">new_uri</span> = <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">response</span>[<span class="ruby-string">"location"</span>])
<span class="ruby-keyword">if</span> <span class="ruby-identifier">new_uri</span>.<span class="ruby-identifier">host</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>
<span class="ruby-identifier">new_uri</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span>
<span class="ruby-identifier">new_uri</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">new_uri</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">counter</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPRequestedRangeNotSatisfiable</span>
<span class="ruby-identifier">new_headers</span> = <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">new_headers</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"Range"</span>)
<span class="ruby-identifier">new_headers</span>[<span class="ruby-string">"Accept-Encoding"</span>] = <span class="ruby-string">"gzip"</span>
<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">new_headers</span>)
<span class="ruby-keyword">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPRequestEntityTooLarge</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FallbackError</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">HTTPTooManyRequests</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TooManyRequestsError</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">HTTPUnauthorized</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">BadAuthenticationError</span>, <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AuthenticationRequiredError</span>, <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPNotFound</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FallbackError</span>, <span class="ruby-node">"Net::HTTPNotFound: #{URICredentialsFilter.credential_filtered_uri(uri)}"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPError</span>, <span class="ruby-node">"#{response.class}#{": #{response.body}" unless response.body.empty?}"</span>
<span class="ruby-keyword">end</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, headers)</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/bundler/fetcher/downloader.rb, line 49</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">headers</span>)
<span class="ruby-identifier">validate_uri_scheme!</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"HTTP GET #{uri}"</span>
<span class="ruby-identifier">req</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">new</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">request_uri</span>, <span class="ruby-identifier">headers</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span>
<span class="ruby-identifier">user</span> = <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span>)
<span class="ruby-identifier">password</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span> <span class="ruby-operator">?</span> <span class="ruby-constant">CGI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">req</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">raise</span> <span class="ruby-keyword">unless</span> [<span class="ruby-string">"undefined method"</span>, <span class="ruby-string">"use_ssl="</span>].<span class="ruby-identifier">all?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">snippet</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">snippet</span> }
<span class="ruby-identifier">raise</span> <span class="ruby-constant">LoadError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"cannot load such file -- openssl"</span>)
<span class="ruby-keyword">rescue</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-identifier">raise</span> <span class="ruby-constant">CertificateFailureError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">*</span><span class="ruby-constant">HTTP_ERRORS</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">trace</span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/host down:/</span>, <span class="ruby-regexp">/getaddrinfo: nodename nor servname provided/</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NetworkDownError</span>, <span class="ruby-node">"Could not reach host #{uri.host}. Check your network "</span> \
<span class="ruby-string">"connection and try again."</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPError</span>, <span class="ruby-node">"Network error while fetching #{URICredentialsFilter.credential_filtered_uri(uri)}"</span> \
<span class="ruby-node">" (#{e})"</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-validate_uri_scheme-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">validate_uri_scheme!</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="validate_uri_scheme-21-source">
<pre><span class="ruby-comment"># File lib/bundler/fetcher/downloader.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate_uri_scheme!</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\Ahttps?\z/</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidOption</span>,
<span class="ruby-node">"The request uri `#{uri}` has an invalid scheme (`#{uri.scheme}`). "</span> \
<span class="ruby-string">"Did you mean `http` or `https`?"</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>