File: C:/Ruby27-x64/share/doc/ruby/html/Gem/GemcutterUtilities.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::GemcutterUtilities - 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="module">
<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="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Text.html">Gem::Text</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-add_key_option">#add_key_option</a>
<li ><a href="#method-i-add_otp_option">#add_otp_option</a>
<li ><a href="#method-i-api_key">#api_key</a>
<li ><a href="#method-i-get_otp">#get_otp</a>
<li ><a href="#method-i-host">#host</a>
<li ><a href="#method-i-mfa_unauthorized-3F">#mfa_unauthorized?</a>
<li ><a href="#method-i-rubygems_api_request">#rubygems_api_request</a>
<li ><a href="#method-i-set_api_key">#set_api_key</a>
<li ><a href="#method-i-sign_in">#sign_in</a>
<li ><a href="#method-i-verify_api_key">#verify_api_key</a>
<li ><a href="#method-i-with_response">#with_response</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::GemcutterUtilities">
<h1 id="module-Gem::GemcutterUtilities" class="module">
module Gem::GemcutterUtilities
</h1>
<section class="description">
<p>Utility methods for using the RubyGems API.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ERROR_CODE">ERROR_CODE
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-host" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">host</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</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_key_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_key_option</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the –key option</p>
<div class="method-source-code" id="add_key_option-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_key_option</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-k'</span>, <span class="ruby-string">'--key KEYNAME'</span>, <span class="ruby-constant">Symbol</span>,
<span class="ruby-string">'Use the given API key'</span>,
<span class="ruby-string">'from ~/.gem/credentials'</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">:key</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_otp_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_otp_option</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the –otp option</p>
<div class="method-source-code" id="add_otp_option-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_otp_option</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--otp CODE'</span>,
<span class="ruby-string">'Digit code for multifactor authentication'</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">:otp</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-api_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">api_key</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The API key from the command options or from the user's configuration.</p>
<div class="method-source-code" id="api_key-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">api_key</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"GEM_HOST_API_KEY"</span>]
<span class="ruby-constant">ENV</span>[<span class="ruby-string">"GEM_HOST_API_KEY"</span>]
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:key</span>]
<span class="ruby-identifier">verify_api_key</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:key</span>]
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">api_keys</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">host</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">api_keys</span>[<span class="ruby-identifier">host</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">rubygems_api_key</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_otp" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_otp</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="get_otp-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_otp</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">'You have enabled multi-factor authentication. Please enter OTP code.'</span>
<span class="ruby-identifier">ask</span> <span class="ruby-string">'Code: '</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-host" class="method-detail ">
<div class="method-heading">
<span class="method-name">host</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The host to connect to either from the RUBYGEMS_HOST environment variable or from the user's configuration</p>
<div class="method-source-code" id="host-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">host</span>
<span class="ruby-identifier">configured_host</span> = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">host</span> <span class="ruby-keyword">unless</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">disable_default_gem_server</span>
<span class="ruby-ivar">@host</span> <span class="ruby-operator">||=</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">env_rubygems_host</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'RUBYGEMS_HOST'</span>]
<span class="ruby-identifier">env_rubygems_host</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">env_rubygems_host</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">env_rubygems_host</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">env_rubygems_host</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">configured_host</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mfa_unauthorized-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">mfa_unauthorized?</span><span
class="method-args">(response)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="mfa_unauthorized-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mfa_unauthorized?</span>(<span class="ruby-identifier">response</span>)
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPUnauthorized</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'You have enabled multifactor authentication'</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rubygems_api_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">rubygems_api_request</span><span
class="method-args">(method, path, host = nil, allowed_push_host = nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates an RubyGems API to <code>host</code> and <code>path</code> with the given HTTP <code>method</code>.</p>
<p>If <code>allowed_push_host</code> metadata is present, then it will only allow that host.</p>
<div class="method-source-code" id="rubygems_api_request-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rubygems_api_request</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">host</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">allowed_push_host</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">require</span> <span class="ruby-string">'net/http'</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span> = <span class="ruby-identifier">host</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">host</span>
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-string">"You must specify a gem server"</span>
<span class="ruby-identifier">terminate_interaction</span>(<span class="ruby-constant">ERROR_CODE</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">allowed_push_host</span>
<span class="ruby-identifier">allowed_host_uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">allowed_push_host</span>)
<span class="ruby-identifier">host_uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span>)
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">host_uri</span>.<span class="ruby-identifier">scheme</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">allowed_host_uri</span>.<span class="ruby-identifier">scheme</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">host_uri</span>.<span class="ruby-identifier">host</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">allowed_host_uri</span>.<span class="ruby-identifier">host</span>)
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"#{self.host.inspect} is not allowed by the gemspec, which only allows #{allowed_push_host.inspect}"</span>
<span class="ruby-identifier">terminate_interaction</span>(<span class="ruby-constant">ERROR_CODE</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span> <span class="ruby-node">"#{self.host}/#{path}"</span>
<span class="ruby-identifier">request_method</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">const_get</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>
<span class="ruby-identifier">response</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">RemoteFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">request_method</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">response</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">mfa_unauthorized?</span>(<span class="ruby-identifier">response</span>)
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">RemoteFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">request_method</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">req</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">add_field</span> <span class="ruby-string">"OTP"</span>, <span class="ruby-identifier">get_otp</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">req</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_api_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_api_key</span><span
class="method-args">(host, key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true when the user has enabled multifactor authentication from <code>response</code> text and no otp provided by options.</p>
<div class="method-source-code" id="set_api_key-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 190</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_api_key</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">key</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">host</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_HOST</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">rubygems_api_key</span> = <span class="ruby-identifier">key</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">set_api_key</span> <span class="ruby-identifier">host</span>, <span class="ruby-identifier">key</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sign_in" class="method-detail ">
<div class="method-heading">
<span class="method-name">sign_in</span><span
class="method-args">(sign_in_host = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Signs in with the RubyGems API at <code>sign_in_host</code> and sets the rubygems API key.</p>
<div class="method-source-code" id="sign_in-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sign_in</span>(<span class="ruby-identifier">sign_in_host</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">sign_in_host</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">host</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">api_key</span>
<span class="ruby-identifier">pretty_host</span> = <span class="ruby-keyword">if</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_HOST</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">sign_in_host</span>
<span class="ruby-string">'RubyGems.org'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">sign_in_host</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Enter your #{pretty_host} credentials."</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"Don't have an account yet? "</span> <span class="ruby-operator">+</span>
<span class="ruby-node">"Create one at #{sign_in_host}/sign_up"</span>
<span class="ruby-identifier">email</span> = <span class="ruby-identifier">ask</span> <span class="ruby-string">" Email: "</span>
<span class="ruby-identifier">password</span> = <span class="ruby-identifier">ask_for_password</span> <span class="ruby-string">"Password: "</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"\n"</span>
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">rubygems_api_request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">"api/v1/api_key"</span>,
<span class="ruby-identifier">sign_in_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">basic_auth</span> <span class="ruby-identifier">email</span>, <span class="ruby-identifier">password</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-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">say</span> <span class="ruby-string">"Signed in."</span>
<span class="ruby-identifier">set_api_key</span> <span class="ruby-identifier">host</span>, <span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-verify_api_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">verify_api_key</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieves the pre-configured API key <code>key</code> or terminates interaction with an error.</p>
<div class="method-source-code" id="verify_api_key-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 153</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify_api_key</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">api_keys</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">key</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">api_keys</span>[<span class="ruby-identifier">key</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-string">"No such API key. Please add it to your configuration (done automatically on initial `gem push`)."</span>
<span class="ruby-identifier">terminate_interaction</span>(<span class="ruby-constant">ERROR_CODE</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-with_response" class="method-detail ">
<div class="method-heading">
<span class="method-name">with_response</span><span
class="method-args">(response, error_prefix = nil) { |response| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If <code>response</code> is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.</p>
<p>If the response was not successful, shows an error to the user including the <code>error_prefix</code> and the response body.</p>
<div class="method-source-code" id="with_response-source">
<pre><span class="ruby-comment"># File lib/rubygems/gemcutter_utilities.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_response</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">error_prefix</span> = <span class="ruby-keyword">nil</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-keyword">then</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">response</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">say</span> <span class="ruby-identifier">clean_text</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">message</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
<span class="ruby-identifier">message</span> = <span class="ruby-node">"#{error_prefix}: #{message}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">error_prefix</span>
<span class="ruby-identifier">say</span> <span class="ruby-identifier">clean_text</span>(<span class="ruby-identifier">message</span>)
<span class="ruby-identifier">terminate_interaction</span>(<span class="ruby-constant">ERROR_CODE</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>