Module: Gem::GemcutterUtilities
- Includes:
- Text
- Included in:
- Commands::OwnerCommand, Commands::PushCommand, Commands::SigninCommand, Commands::YankCommand
- Defined in:
- lib/rubygems/gemcutter_utilities.rb
Overview
Utility methods for using the RubyGems API.
Constant Summary collapse
- ERROR_CODE =
1
- API_SCOPES =
%i[index_rubygems push_rubygem yank_rubygem add_owner remove_owner access_webhooks show_dashboard].freeze
Instance Attribute Summary collapse
-
#host ⇒ Object
The host to connect to either from the RUBYGEMS_HOST environment variable or from the user’s configuration.
-
#scope ⇒ Object
writeonly
Sets the attribute scope.
Instance Method Summary collapse
-
#add_key_option ⇒ Object
Add the –key option.
-
#add_otp_option ⇒ Object
Add the –otp option.
-
#api_key ⇒ Object
The API key from the command options or from the user’s configuration.
- #mfa_unauthorized?(response) ⇒ Boolean
-
#otp ⇒ Object
The OTP code from the command options or from the user’s configuration.
-
#rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block) ⇒ Object
Creates an RubyGems API to
host
andpath
with the given HTTPmethod
. -
#set_api_key(host, key) ⇒ Object
Returns true when the user has enabled multifactor authentication from
response
text and no otp provided by options. -
#sign_in(sign_in_host = nil, scope: nil) ⇒ Object
Signs in with the RubyGems API at
sign_in_host
and sets the rubygems API key. - #update_scope(scope) ⇒ Object
-
#verify_api_key(key) ⇒ Object
Retrieves the pre-configured API key
key
or terminates interaction with an error. -
#with_response(response, error_prefix = nil) ⇒ Object
If
response
is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.
Methods included from Text
#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text
Instance Attribute Details
#host ⇒ Object
The host to connect to either from the RUBYGEMS_HOST environment variable or from the user’s configuration
65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 65 def host configured_host = Gem.host unless Gem.configuration.disable_default_gem_server @host ||= begin env_rubygems_host = ENV['RUBYGEMS_HOST'] env_rubygems_host = nil if env_rubygems_host and env_rubygems_host.empty? env_rubygems_host || configured_host end end |
#scope=(value) ⇒ Object (writeonly)
Sets the attribute scope
16 17 18 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 16 def scope=(value) @scope = value end |
Instance Method Details
#add_key_option ⇒ Object
Add the –key option
21 22 23 24 25 26 27 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 21 def add_key_option add_option('-k', '--key KEYNAME', Symbol, 'Use the given API key', "from #{Gem.configuration.credentials_path}") do |value,| [:key] = value end end |
#add_otp_option ⇒ Object
Add the –otp option
32 33 34 35 36 37 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 32 def add_otp_option add_option('--otp CODE', 'Digit code for multifactor authentication') do |value, | [:otp] = value end end |
#api_key ⇒ Object
The API key from the command options or from the user’s configuration.
42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 42 def api_key if ENV["GEM_HOST_API_KEY"] ENV["GEM_HOST_API_KEY"] elsif [:key] verify_api_key [:key] elsif Gem.configuration.api_keys.key?(host) Gem.configuration.api_keys[host] else Gem.configuration.rubygems_api_key end end |
#mfa_unauthorized?(response) ⇒ Boolean
119 120 121 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 119 def (response) response.kind_of?(Net::HTTPUnauthorized) && response.body.start_with?('You have enabled multifactor authentication') end |
#otp ⇒ Object
The OTP code from the command options or from the user’s configuration.
57 58 59 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 57 def otp [:otp] || ENV["GEM_HOST_OTP_CODE"] end |
#rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block) ⇒ Object
Creates an RubyGems API to host
and path
with the given HTTP method
.
If allowed_push_host
metadata is present, then it will only allow that host.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 84 def rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block) require 'net/http' self.host = host if host unless self.host alert_error "You must specify a gem server" terminate_interaction(ERROR_CODE) end if allowed_push_host allowed_host_uri = URI.parse(allowed_push_host) host_uri = URI.parse(self.host) unless (host_uri.scheme == allowed_host_uri.scheme) && (host_uri.host == allowed_host_uri.host) alert_error "#{self.host.inspect} is not allowed by the gemspec, which only allows #{allowed_push_host.inspect}" terminate_interaction(ERROR_CODE) end end uri = URI.parse "#{self.host}/#{path}" response = request_with_otp(method, uri, &block) if (response) ask_otp response = request_with_otp(method, uri, &block) end if api_key_forbidden?(response) update_scope(scope) request_with_otp(method, uri, &block) else response end end |
#set_api_key(host, key) ⇒ Object
Returns true when the user has enabled multifactor authentication from response
text and no otp provided by options.
220 221 222 223 224 225 226 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 220 def set_api_key(host, key) if host == Gem::DEFAULT_HOST Gem.configuration.rubygems_api_key = key else Gem.configuration.set_api_key host, key end end |
#sign_in(sign_in_host = nil, scope: nil) ⇒ Object
Signs in with the RubyGems API at sign_in_host
and sets the rubygems API key.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 149 def sign_in(sign_in_host = nil, scope: nil) sign_in_host ||= self.host return if api_key pretty_host = pretty_host(sign_in_host) say "Enter your #{pretty_host} credentials." say "Don't have an account yet? " + "Create one at #{sign_in_host}/sign_up" email = ask " Email: " password = ask_for_password "Password: " say "\n" key_name = get_key_name(scope) scope_params = get_scope_params(scope) response = rubygems_api_request(:post, "api/v1/api_key", sign_in_host, scope: scope) do |request| request.basic_auth email, password request["OTP"] = otp if otp request.body = URI.encode_www_form({ name: key_name }.merge(scope_params)) end with_response response do |resp| say "Signed in with API key: #{key_name}." set_api_key host, resp.body end end |
#update_scope(scope) ⇒ Object
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 123 def update_scope(scope) sign_in_host = self.host pretty_host = pretty_host(sign_in_host) update_scope_params = { scope => true } say "The existing key doesn't have access of #{scope} on #{pretty_host}. Please sign in to update access." email = ask " Email: " password = ask_for_password "Password: " response = rubygems_api_request(:put, "api/v1/api_key", sign_in_host, scope: scope) do |request| request.basic_auth email, password request["OTP"] = otp if otp request.body = URI.encode_www_form({:api_key => api_key }.merge(update_scope_params)) end with_response response do |resp| say "Added #{scope} scope to the existing API key" end end |
#verify_api_key(key) ⇒ Object
Retrieves the pre-configured API key key
or terminates interaction with an error.
183 184 185 186 187 188 189 190 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 183 def verify_api_key(key) if Gem.configuration.api_keys.key? key Gem.configuration.api_keys[key] else alert_error "No such API key. Please add it to your configuration (done automatically on initial `gem push`)." terminate_interaction(ERROR_CODE) end end |
#with_response(response, error_prefix = nil) ⇒ Object
If response
is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.
If the response was not successful, shows an error to the user including the error_prefix
and the response body.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/rubygems/gemcutter_utilities.rb', line 199 def with_response(response, error_prefix = nil) case response when Net::HTTPSuccess then if block_given? yield response else say clean_text(response.body) end else = response.body = "#{error_prefix}: #{}" if error_prefix say clean_text() terminate_interaction(ERROR_CODE) end end |