File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/OwnerCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::OwnerCommand - 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="../Text.html">Gem::Text</a>
<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-add_owners">#add_owners</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-manage_owners">#manage_owners</a>
<li ><a href="#method-i-remove_owners">#remove_owners</a>
<li ><a href="#method-i-send_owner_request">#send_owner_request</a>
<li ><a href="#method-i-show_owners">#show_owners</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::OwnerCommand">
<h1 id="class-Gem::Commands::OwnerCommand" class="class">
class Gem::Commands::OwnerCommand
</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/owner_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">'owner'</span>, <span class="ruby-string">'Manage gem owners of a gem on the push server'</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">defaults</span>.<span class="ruby-identifier">merge!</span> <span class="ruby-value">:add</span> <span class="ruby-operator">=></span> [], <span class="ruby-value">:remove</span> <span class="ruby-operator">=></span> []
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'-a'</span>, <span class="ruby-string">'--add EMAIL'</span>, <span class="ruby-string">'Add an owner'</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">:add</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'-r'</span>, <span class="ruby-string">'--remove EMAIL'</span>, <span class="ruby-string">'Remove an owner'</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">:remove</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'-h'</span>, <span class="ruby-string">'--host HOST'</span>,
<span class="ruby-string">'Use 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-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-add_owners" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_owners</span><span
class="method-args">(name, owners)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="add_owners-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/owner_command.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_owners</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owners</span>)
<span class="ruby-identifier">manage_owners</span> <span class="ruby-value">:post</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">owners</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<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/owner_command.rb, line 54</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-identifier">name</span> = <span class="ruby-identifier">get_one_gem_name</span>
<span class="ruby-identifier">add_owners</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:add</span>]
<span class="ruby-identifier">remove_owners</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:remove</span>]
<span class="ruby-identifier">show_owners</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-manage_owners" class="method-detail ">
<div class="method-heading">
<span class="method-name">manage_owners</span><span
class="method-args">(method, name, owners)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="manage_owners-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/owner_command.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">manage_owners</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">owners</span>)
<span class="ruby-identifier">owners</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">owner</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">send_owner_request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
<span class="ruby-identifier">action</span> = <span class="ruby-identifier">method</span> <span class="ruby-operator">==</span> <span class="ruby-value">:delete</span> <span class="ruby-operator">?</span> <span class="ruby-string">"Removing"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"Adding"</span>
<span class="ruby-identifier">with_response</span> <span class="ruby-identifier">response</span>, <span class="ruby-node">"#{action} #{owner}"</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-comment"># ignore</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove_owners" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_owners</span><span
class="method-args">(name, owners)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="remove_owners-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/owner_command.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_owners</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owners</span>)
<span class="ruby-identifier">manage_owners</span> <span class="ruby-value">:delete</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">owners</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-show_owners" class="method-detail ">
<div class="method-heading">
<span class="method-name">show_owners</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="show_owners-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/owner_command.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">show_owners</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">load_yaml</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">rubygems_api_request</span> <span class="ruby-value">:get</span>, <span class="ruby-node">"api/v1/gems/#{name}/owners.yaml"</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-keyword">end</span>
<span class="ruby-identifier">with_response</span> <span class="ruby-identifier">response</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">resp</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">owners</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SafeYAML</span>.<span class="ruby-identifier">load</span> <span class="ruby-identifier">clean_text</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>)
<span class="ruby-identifier">say</span> <span class="ruby-node">"Owners for gem: #{name}"</span>
<span class="ruby-identifier">owners</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">owner</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"- #{owner['email'] || owner['handle'] || owner['id']}"</span>
<span class="ruby-keyword">end</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-send_owner_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_owner_request</span><span
class="method-args">(method, name, owner)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="send_owner_request-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/owner_command.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_owner_request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
<span class="ruby-identifier">rubygems_api_request</span> <span class="ruby-identifier">method</span>, <span class="ruby-node">"api/v1/gems/#{name}/owners"</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">set_form_data</span> <span class="ruby-string">'email'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">owner</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>