module Gem::GemcutterUtilities

Utility methods for using the RubyGems API.

Constants

API_SCOPES
ERROR_CODE

Attributes

host[W]
scope[W]

Public Instance Methods

add_key_option() click to toggle source

Add the –key option

# 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,options|
    options[:key] = value
  end
end
add_otp_option() click to toggle source

Add the –otp option

# File lib/rubygems/gemcutter_utilities.rb, line 32
def add_otp_option
  add_option('--otp CODE',
             'Digit code for multifactor authentication',
             'You can also use the environment variable GEM_HOST_OTP_CODE') do |value, options|
    options[:otp] = value
  end
end
api_key() click to toggle source

The API key from the command options or from the user’s configuration.

# File lib/rubygems/gemcutter_utilities.rb, line 43
def api_key
  if ENV["GEM_HOST_API_KEY"]
    ENV["GEM_HOST_API_KEY"]
  elsif options[:key]
    verify_api_key options[:key]
  elsif Gem.configuration.api_keys.key?(host)
    Gem.configuration.api_keys[host]
  else
    Gem.configuration.rubygems_api_key
  end
end
host() click to toggle source

The host to connect to either from the RUBYGEMS_HOST environment variable or from the user’s configuration

# File lib/rubygems/gemcutter_utilities.rb, line 66
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
mfa_unauthorized?(response) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 120
def mfa_unauthorized?(response)
  response.kind_of?(Net::HTTPUnauthorized) && response.body.start_with?('You have enabled multifactor authentication')
end
otp() click to toggle source

The OTP code from the command options or from the user’s configuration.

# File lib/rubygems/gemcutter_utilities.rb, line 58
def otp
  options[:otp] || ENV["GEM_HOST_OTP_CODE"]
end
rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block) click to toggle source

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.

# File lib/rubygems/gemcutter_utilities.rb, line 85
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 mfa_unauthorized?(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) click to toggle source

Returns true when the user has enabled multifactor authentication from response text and no otp provided by options.

# File lib/rubygems/gemcutter_utilities.rb, line 223
def set_api_key(host, key)
  if 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) click to toggle source

Signs in with the RubyGems API at sign_in_host and sets the rubygems API key.

# File lib/rubygems/gemcutter_utilities.rb, line 150
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)
  mfa_params   = get_mfa_params(email, password)
  all_params   = scope_params.merge(mfa_params)

  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(all_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) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 124
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) click to toggle source

Retrieves the pre-configured API key key or terminates interaction with an error.

# File lib/rubygems/gemcutter_utilities.rb, line 186
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) { |response| ... } click to toggle source

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.

# File lib/rubygems/gemcutter_utilities.rb, line 202
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
    message = response.body
    message = "#{error_prefix}: #{message}" if error_prefix

    say clean_text(message)
    terminate_interaction(ERROR_CODE)
  end
end

Private Instance Methods

api_key_forbidden?(response) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 313
def api_key_forbidden?(response)
  response.kind_of?(Net::HTTPForbidden) && response.body.start_with?("The API key doesn't have access")
end
ask_otp() click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 242
def ask_otp
  say 'You have enabled multi-factor authentication. Please enter OTP code.'
  options[:otp] = ask 'Code: '
end
default_host?() click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 272
def default_host?
  self.host == Gem::DEFAULT_HOST
end
get_key_name(scope) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 299
def get_key_name(scope)
  hostname = Socket.gethostname || "unknown-host"
  user = ENV["USER"] || ENV["USERNAME"] || "unknown-user"
  ts = Time.now.strftime("%Y%m%d%H%M%S")
  default_key_name = "#{hostname}-#{user}-#{ts}"

  key_name = ask "API Key name [#{default_key_name}]: " unless scope
  if key_name.nil? || key_name.empty?
    default_key_name
  else
    key_name
  end
end
get_mfa_params(email, password) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 276
def get_mfa_params(email, password)
  return {} unless default_host?

  mfa_level = get_user_mfa_level(email, password)
  params = {}
  if mfa_level == "ui_only" || mfa_level == "ui_and_gem_signin"
    selected = ask_yes_no("Would you like to enable MFA for this key? (strongly recommended)")
    params["mfa"] = true if selected
  end
  params
end
get_scope_params(scope) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 255
def get_scope_params(scope)
  scope_params = {}

  if scope
    scope_params = { scope => true }
  else
    say "Please select scopes you want to enable for the API key (y/n)"
    API_SCOPES.each do |scope|
      selected = ask_yes_no("#{scope}", false)
      scope_params[scope] = true if selected
    end
    say "\n"
  end

  scope_params
end
get_user_mfa_level(email, password) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 288
def get_user_mfa_level(email, password)
  response = rubygems_api_request(:get, "api/v1/profile/me.yaml") do |request|
    request.basic_auth email, password
  end

  with_response response do |resp|
    body = Gem::SafeYAML.load clean_text(resp.body)
    body["mfa"]
  end
end
pretty_host(host) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 247
def pretty_host(host)
  if default_host?
    'RubyGems.org'
  else
    host
  end
end
request_with_otp(method, uri, &block) click to toggle source
# File lib/rubygems/gemcutter_utilities.rb, line 233
def request_with_otp(method, uri, &block)
  request_method = Net::HTTP.const_get method.to_s.capitalize

  Gem::RemoteFetcher.fetcher.request(uri, request_method) do |req|
    req["OTP"] = otp if otp
    block.call(req)
  end
end