File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/YankCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::YankCommand - 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="../VersionOption.html">Gem::VersionOption</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_platform_from_requirements">#get_platform_from_requirements</a>
<li ><a href="#method-i-get_version_from_requirements">#get_version_from_requirements</a>
<li ><a href="#method-i-yank_api_request">#yank_api_request</a>
<li ><a href="#method-i-yank_gem">#yank_gem</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::YankCommand">
<h1 id="class-Gem::Commands::YankCommand" class="class">
class Gem::Commands::YankCommand
</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/yank_command.rb, line 31</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">'yank'</span>, <span class="ruby-string">'Remove a pushed gem from the index'</span>
<span class="ruby-identifier">add_version_option</span>(<span class="ruby-string">"remove"</span>)
<span class="ruby-identifier">add_platform_option</span>(<span class="ruby-string">"remove"</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">'Yank from 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-keyword">end</span>
<span class="ruby-identifier">add_key_option</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/yank_command.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:host</span>]
<span class="ruby-identifier">sign_in</span> <span class="ruby-ivar">@host</span>
<span class="ruby-identifier">version</span> = <span class="ruby-identifier">get_version_from_requirements</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>])
<span class="ruby-identifier">platform</span> = <span class="ruby-identifier">get_platform_from_requirements</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">version</span>
<span class="ruby-identifier">yank_gem</span>(<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"A version argument is required: #{usage}"</span>
<span class="ruby-identifier">terminate_interaction</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-yank_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">yank_gem</span><span
class="method-args">(version, platform)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="yank_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/yank_command.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">yank_gem</span>(<span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>)
<span class="ruby-identifier">say</span> <span class="ruby-node">"Yanking gem from #{self.host}..."</span>
<span class="ruby-identifier">args</span> = [<span class="ruby-value">:delete</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>, <span class="ruby-string">"api/v1/gems/yank"</span>]
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">yank_api_request</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">say</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</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_platform_from_requirements" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_platform_from_requirements</span><span
class="method-args">(requirements)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_platform_from_requirements-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/yank_command.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_platform_from_requirements</span>(<span class="ruby-identifier">requirements</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">platforms</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">requirements</span>.<span class="ruby-identifier">key?</span> <span class="ruby-value">:added_platform</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_version_from_requirements" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_version_from_requirements</span><span
class="method-args">(requirements)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_version_from_requirements-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/yank_command.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_version_from_requirements</span>(<span class="ruby-identifier">requirements</span>)
<span class="ruby-identifier">requirements</span>.<span class="ruby-identifier">requirements</span>.<span class="ruby-identifier">first</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">version</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-yank_api_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">yank_api_request</span><span
class="method-args">(method, version, platform, api)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="yank_api_request-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/yank_command.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">yank_api_request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">platform</span>, <span class="ruby-identifier">api</span>)
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">get_one_gem_name</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">rubygems_api_request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">api</span>, <span class="ruby-identifier">host</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">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-identifier">data</span> = {
<span class="ruby-string">'gem_name'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>,
<span class="ruby-string">'version'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">version</span>,
}
<span class="ruby-identifier">data</span>[<span class="ruby-string">'platform'</span>] = <span class="ruby-identifier">platform</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">platform</span>
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">set_form_data</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">response</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>