Module: Gem::GemcutterUtilities

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `Commands::OwnerCommand`, `Commands::PushCommand`, `Commands::SigninCommand`, `Commands::YankCommand`
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `Text`
Defined in:	lib/rubygems/gemcutter_utilities.rb

Overview

Utility methods for using the RubyGems API.

Constant Summary

API_SCOPES =
# File 'lib/rubygems/gemcutter_utilities.rb', line 11

%i[index_rubygems push_rubygem yank_rubygem add_owner remove_owner access_webhooks show_dashboard].freeze

ERROR_CODE =
# File 'lib/rubygems/gemcutter_utilities.rb', line 10
```
1
```

Instance Attribute Summary

#host rw

The host to connect to either from the RUBYGEMS_HOST environment variable or from the user’s configuration.
#host=(value) rw
#scope=(value) writeonly

Instance Method Summary

#add_key_option

Add the –key option.
#add_otp_option

Add the –otp option.
#api_key

The API key from the command options or from the user’s configuration.
#mfa_unauthorized?(response) ⇒ Boolean
#otp

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)

Creates an RubyGems API to #host and path with the given HTTP method.
#set_api_key(host, key)

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)

Signs in with the RubyGems API at sign_in_host and sets the rubygems API key.
#update_scope(scope)
#verify_api_key(key)

Retrieves the pre-configured API key key or terminates interaction with an error.
#with_response(response, error_prefix = nil)

If response is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.
#api_key_forbidden?(response) ⇒ Boolean private
#ask_otp private
#get_key_name(scope) private
#get_scope_params(scope) private
#pretty_host(host) private
#request_with_otp(method, uri, &block) private

`Text` - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	This code is based directly on the `Text` gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Instance Attribute Details

#host (rw)

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

[ GitHub ]

# 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

#host=(value) (rw)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 15


attr_writer :host

#scope=(value) (writeonly)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 16


attr_writer :scope

Instance Method Details

#add_key_option

Add the –key option

[ GitHub ]

# 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

Add the –otp option

[ GitHub ]

# 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

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

[ GitHub ]

# 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

#api_key_forbidden?(response) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 284


def api_key_forbidden?(response)
  response.kind_of?(Net::HTTPForbidden) && response.body.start_with?("The API key doesn't have access")
end

#ask_otp (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 240


def ask_otp
  say 'You have enabled multi-factor authentication. Please enter OTP code.'
  options[:otp] = ask 'Code: '
end

#get_key_name(scope) (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 270


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_scope_params(scope) (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 253


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 "#{scope} [y/N]: "
      scope_params[scope] = true if selected =~ /^[yY](es)?$/
    end
    say "\n"
  end

  scope_params
end

#mfa_unauthorized?(response) ⇒ `Boolean`

[ GitHub ]

# 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

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

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 58


def otp
  options[:otp] || ENV["GEM_HOST_OTP_CODE"]
end

#pretty_host(host) (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 245


def pretty_host(host)
  if Gem::DEFAULT_HOST == host
    'RubyGems.org'
  else
    host
  end
end

#request_with_otp(method, uri, &block) (private)

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 231


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

#rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block)

Creates an RubyGems API to #host and Gem.path with the given HTTP method.

If allowed_push_host metadata is present, then it will only allow that host.

[ GitHub ]

# 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)

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

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 221


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)

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

[ GitHub ]

# 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)

  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)

[ GitHub ]

# 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)

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

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 184


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)

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.

[ GitHub ]

# File 'lib/rubygems/gemcutter_utilities.rb', line 200


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

Module: Gem::GemcutterUtilities

Overview

Constant Summary

Instance Attribute Summary

Instance Method Summary

Text - Included

Instance Attribute Details

#host (rw)

#host=(value) (rw)

#scope=(value) (writeonly)

Instance Method Details

#add_key_option

#add_otp_option

#api_key

#api_key_forbidden?(response) ⇒ Boolean (private)

#ask_otp (private)

#get_key_name(scope) (private)

#get_scope_params(scope) (private)

#mfa_unauthorized?(response) ⇒ Boolean

#otp

#pretty_host(host) (private)

#request_with_otp(method, uri, &block) (private)

#rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block)

#set_api_key(host, key)

#sign_in(sign_in_host = nil, scope: nil)

#update_scope(scope)

#verify_api_key(key)

#with_response(response, error_prefix = nil)

`Text` - Included

#api_key_forbidden?(response) ⇒ `Boolean` (private)

#mfa_unauthorized?(response) ⇒ `Boolean`