File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Source/Rubygems/Remote.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Source::Rubygems::Remote - 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-apply_auth">#apply_auth</a>
<li ><a href="#method-i-cache_slug">#cache_slug</a>
<li ><a href="#method-i-remove_auth">#remove_auth</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Source::Rubygems::Remote">
<h1 id="class-Bundler::Source::Rubygems::Remote" class="class">
class Bundler::Source::Rubygems::Remote
</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-anonymized_uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">anonymized_uri</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-original_uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">original_uri</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">uri</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">(uri)</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/source/rubygems/remote.rb, line 9</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">orig_uri</span> = <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">mirror_for</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-ivar">@original_uri</span> = <span class="ruby-identifier">orig_uri</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">orig_uri</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">fallback_auth</span> = <span class="ruby-constant">Bundler</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">credentials_for</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">apply_auth</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">fallback_auth</span>).<span class="ruby-identifier">freeze</span>
<span class="ruby-ivar">@anonymized_uri</span> = <span class="ruby-identifier">remove_auth</span>(<span class="ruby-ivar">@uri</span>).<span class="ruby-identifier">freeze</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_slug" class="method-detail ">
<div class="method-heading">
<span class="method-name">cache_slug</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return [String] A slug suitable for use as a cache key for this</p>
<pre>remote.</pre>
<div class="method-source-code" id="cache_slug-source">
<pre><span class="ruby-comment"># File lib/bundler/source/rubygems/remote.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cache_slug</span>
<span class="ruby-ivar">@cache_slug</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">md5_available?</span>
<span class="ruby-identifier">cache_uri</span> = <span class="ruby-identifier">original_uri</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">host</span> = <span class="ruby-identifier">cache_uri</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">"file://"</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">cache_uri</span>.<span class="ruby-identifier">host</span>
<span class="ruby-identifier">uri_parts</span> = [<span class="ruby-identifier">host</span>, <span class="ruby-identifier">cache_uri</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">cache_uri</span>.<span class="ruby-identifier">port</span>, <span class="ruby-identifier">cache_uri</span>.<span class="ruby-identifier">path</span>]
<span class="ruby-identifier">uri_digest</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-identifier">uri_parts</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>))
<span class="ruby-identifier">uri_parts</span>[<span class="ruby-value">-1</span>] = <span class="ruby-identifier">uri_digest</span>
<span class="ruby-identifier">uri_parts</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</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="to_s-source">
<pre><span class="ruby-comment"># File lib/bundler/source/rubygems/remote.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-node">"rubygems remote at #{anonymized_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-apply_auth" class="method-detail ">
<div class="method-heading">
<span class="method-name">apply_auth</span><span
class="method-args">(uri, auth)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="apply_auth-source">
<pre><span class="ruby-comment"># File lib/bundler/source/rubygems/remote.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">apply_auth</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">auth</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span> = <span class="ruby-identifier">auth</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">uri</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidComponentError</span>
<span class="ruby-identifier">error_message</span> = <span class="ruby-string">"Please CGI escape your usernames and passwords before "</span> \
<span class="ruby-string">"setting them for authentication."</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">error_message</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove_auth" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_auth</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="remove_auth-source">
<pre><span class="ruby-comment"># File lib/bundler/source/rubygems/remote.rb, line 57</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_auth</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">uri</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>