File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/PushCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::PushCommand - 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="../Command.html">Gem::Command</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../LocalRemoteOptions.html">Gem::LocalRemoteOptions</a>
<li><a class="include" href="../GemcutterUtilities.html">Gem::GemcutterUtilities</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-get_hosts_for">#get_hosts_for</a>
<li ><a href="#method-i-send_gem">#send_gem</a>
<li ><a href="#method-i-send_push_request">#send_push_request</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::PushCommand">
<h1 id="class-Gem::Commands::PushCommand" class="class">
class Gem::Commands::PushCommand
</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Command.html#method-c-new"><code>Gem::Command::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/push_command.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-keyword">super</span> <span class="ruby-string">'push'</span>, <span class="ruby-string">'Push a gem up to the gem server'</span>, <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span>
<span class="ruby-ivar">@user_defined_host</span> = <span class="ruby-keyword">false</span>
<span class="ruby-identifier">add_proxy_option</span>
<span class="ruby-identifier">add_key_option</span>
<span class="ruby-identifier">add_otp_option</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--host HOST'</span>,
<span class="ruby-string">'Push to another gemcutter-compatible host'</span>,
<span class="ruby-string">' (e.g. https://rubygems.org)'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:host</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-ivar">@user_defined_host</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@host</span> = <span class="ruby-keyword">nil</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-execute" class="method-detail ">
<div class="method-heading">
<span class="method-name">execute</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="execute-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/push_command.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-identifier">gem_name</span> = <span class="ruby-identifier">get_one_gem_name</span>
<span class="ruby-identifier">default_gem_server</span>, <span class="ruby-identifier">push_host</span> = <span class="ruby-identifier">get_hosts_for</span>(<span class="ruby-identifier">gem_name</span>)
<span class="ruby-identifier">default_host</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">user_defined_host</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@user_defined_host</span>
<span class="ruby-identifier">user_defined_host</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:host</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">default_host</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:host</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@host</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">user_defined_host</span>
<span class="ruby-identifier">user_defined_host</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">default_gem_server</span>
<span class="ruby-identifier">default_gem_server</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">push_host</span>
<span class="ruby-identifier">push_host</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">default_host</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sign_in</span> <span class="ruby-ivar">@host</span>
<span class="ruby-identifier">send_gem</span>(<span class="ruby-identifier">gem_name</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_gem</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/push_command.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_gem</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">args</span> = [<span class="ruby-value">:post</span>, <span class="ruby-string">"api/v1/gems"</span>]
<span class="ruby-identifier">latest_rubygems_version</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">latest_rubygems_version</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">latest_rubygems_version</span> <span class="ruby-operator"><</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">rubygems_version</span> <span class="ruby-keyword">and</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">rubygems_version</span>.<span class="ruby-identifier">prerelease?</span> <span class="ruby-keyword">and</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'2.0.0.rc.2'</span>) <span class="ruby-operator">!=</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">rubygems_version</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-identifier"><<-ERROR</span>
<span class="ruby-value">You are using a beta release of RubyGems (#{Gem::VERSION}) which is not
allowed to push gems. Please downgrade or upgrade to a release version.
The latest released RubyGems version is #{latest_rubygems_version}
You can upgrade or downgrade to the latest release version with:
gem update --system=#{latest_rubygems_version}
</span><span class="ruby-identifier"> ERROR</span>
<span class="ruby-identifier">terminate_interaction</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gem_data</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@host</span>
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">gem_data</span>.<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">metadata</span>[<span class="ruby-string">'default_gem_server'</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">push_host</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gem_data</span>.<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">metadata</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">'allowed_push_host'</span>)
<span class="ruby-identifier">push_host</span> = <span class="ruby-identifier">gem_data</span>.<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">metadata</span>[<span class="ruby-string">'allowed_push_host'</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@host</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">push_host</span>
<span class="ruby-comment"># Always include @host, even if it's nil</span>
<span class="ruby-identifier">args</span> <span class="ruby-operator">+=</span> [ <span class="ruby-ivar">@host</span>, <span class="ruby-identifier">push_host</span> ]
<span class="ruby-identifier">say</span> <span class="ruby-node">"Pushing gem to #{@host || Gem.host}..."</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">send_push_request</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">args</span>)
<span class="ruby-identifier">with_response</span> <span class="ruby-identifier">response</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-get_hosts_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_hosts_for</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_hosts_for-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/push_command.rb, line 137</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_hosts_for</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">gem_metadata</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">metadata</span>
[
<span class="ruby-identifier">gem_metadata</span>[<span class="ruby-string">"default_gem_server"</span>],
<span class="ruby-identifier">gem_metadata</span>[<span class="ruby-string">"allowed_push_host"</span>]
]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_push_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_push_request</span><span
class="method-args">(name, args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_push_request-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/push_command.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_push_request</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">args</span>)
<span class="ruby-identifier">rubygems_api_request</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">request</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">body</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">read_binary</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_field</span> <span class="ruby-string">"Content-Length"</span>, <span class="ruby-identifier">request</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_field</span> <span class="ruby-string">"Content-Type"</span>, <span class="ruby-string">"application/octet-stream"</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_field</span> <span class="ruby-string">"Authorization"</span>, <span class="ruby-identifier">api_key</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">add_field</span> <span class="ruby-string">"OTP"</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:otp</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:otp</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>