Class: Gem::Commands::OwnerCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Gem::Command`
Instance Chain: self, `::Gem::GemcutterUtilities`, `::Gem::LocalRemoteOptions`, `::Gem::Command`, `::Gem::UserInteraction`, `::Gem::DefaultUserInteraction`, `::Gem::Text`
Inherits:	Gem::Command Object Gem::Command Gem::Commands::OwnerCommand
Defined in:	lib/rubygems/commands/owner_command.rb

Constant Summary

`::Gem::Command` - Inherited

HELP

`::Gem::GemcutterUtilities` - Included

ERROR_CODE

Class Attribute Summary

`::Gem::Command` - Inherited

.build_args	Arguments used when building gems.
.build_args=, .extra_args, .extra_args=

Class Method Summary

.new ⇒ OwnerCommand constructor

`::Gem::Command` - Inherited

.add_common_option,
.add_specific_extra_args	Add a list of extra arguments for the given command.
.common_options,
.new	Initializes a generic gem command named `command`.
.specific_extra_args	Return an array of extra arguments for the command.
.specific_extra_args_hash	Accessor for the specific extra args hash (self initializing).

Instance Attribute Summary

`::Gem::GemcutterUtilities` - Included

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

`::Gem::LocalRemoteOptions` - Included

#both?	Is fetching of local and remote information enabled?
#local?	Is local fetching enabled?
#remote?	Is remote fetching enabled?

`::Gem::Command` - Inherited

#command	The name of the command.
#defaults	The default options for the command.
#options	The options for the command.
#program_name	The name of the command for command-line invocation.
#summary	A short description of the command.

`::Gem::DefaultUserInteraction` - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

#add_owners(name, owners)
#execute
#manage_owners(method, name, owners)
#remove_owners(name, owners)
#show_owners(name)
#send_owner_request(method, name, owner) private
#arguments Internal use only
#description Internal use only
#usage Internal use only

`::Gem::GemcutterUtilities` - Included

#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.
#get_otp, #mfa_unauthorized?,
#rubygems_api_request	Creates an RubyGems API to Gem.host and Gem.path with the given HTTP `method`.
#set_api_key	Returns true when the user has enabled multifactor authentication from `response` text and no otp provided by options.
#sign_in	Signs in with the RubyGems API at `sign_in_host` and sets the rubygems API key.
#verify_api_key	Retrieves the pre-configured API key `key` or terminates interaction with an error.
#with_response	If `response` is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.

`::Gem::LocalRemoteOptions` - Included

#accept_uri_http	Allows OptionParser to handle HTTP URIs.
#add_bulk_threshold_option	Add the –bulk-threshold option.
#add_clear_sources_option	Add the –clear-sources option.
#add_local_remote_options	Add local/remote options to the command line parser.
#add_proxy_option	Add the –http-proxy option.
#add_source_option	Add the –source option.
#add_update_sources_option	Add the –update-sources option.

`::Gem::Command` - Inherited

#add_extra_args	Adds extra args from ~/.gemrc.
#add_option	Add a command-line option and handler to the command.
#arguments	Override to provide details of the arguments a command takes.
#begins?	True if `long` begins with the characters from `short`.
#check_deprecated_options,
#defaults_str	Override to display the default values of the command options.
#deprecate_option	Mark a command-line option as deprecated, and optionally specify a deprecation horizon.
#description	Override to display a longer description of what this command does.
#execute	Override to provide command handling.
#get_all_gem_names	Get all gem names from the command line.
#get_all_gem_names_and_versions	Get all [gem, version] from the command line.
#get_one_gem_name	Get a single gem name from the command line.
#get_one_optional_argument	Get a single optional argument from the command line.
#handle_options	Handle the given list of arguments by parsing them and recording the results.
#handles?	True if the command handles the given argument list.
#invoke	Invoke the command with the given list of arguments.
#invoke_with_build_args	Invoke the command with the given list of normal arguments and additional build arguments.
#merge_options	Merge a set of command options with the set of default options (without modifying the default option hash).
#remove_option	Remove previously defined command-line argument `name`.
#show_help	Display the help message for the command.
#show_lookup_failure	Display to the user that a gem couldn’t be found and reasons why –.
#usage	Override to display the usage for an individual gem command.
#when_invoked	Call the given block when invoked.
#add_parser_run_info	Adds a section with `title` and `content` to the parser help view.
#configure_options,
#create_option_parser	Creates an option parser and fills it in with the help info for the command.
#option_is_deprecated?,
#parser	Create on demand parser.
#wrap	Wraps `text` to `width`
#add_parser_description, #add_parser_options, #add_parser_summary

`::Gem::UserInteraction` - Included

#alert	Displays an alert `statement`.
#alert_error	Displays an error `statement` to the error output location.
#alert_warning	Displays a warning `statement` to the warning output location.
#ask	Asks a `question` and returns the answer.
#ask_for_password	Asks for a password with a `prompt`
#ask_yes_no	Asks a yes or no `question`.
#choose_from_list	Asks the user to answer `question` with an answer from the given `list`.
#say	Displays the given `statement` on the standard output (or equivalent).
#terminate_interaction	Terminates the RubyGems process with the given `exit_code`
#verbose	Calls `say` with `msg` or the results of the block if really_verbose is true.

`::Gem::DefaultUserInteraction` - Included

#use_ui

See DefaultUserInteraction.use_ui

`::Gem::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 `::Gem::Text` gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

.new ⇒ `OwnerCommand`

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 32


def initialize
  super 'owner', 'Manage gem owners of a gem on the push server'
  add_proxy_option
  add_key_option
  add_otp_option
  defaults.merge! :add => [], :remove => []

  add_option '-a', '--add EMAIL', 'Add an owner' do |value, options|
    options[:add] << value
  end

  add_option '-r', '--remove EMAIL', 'Remove an owner' do |value, options|
    options[:remove] << value
  end

  add_option '-h', '--host HOST',
             'Use another gemcutter-compatible host',
             '  (e.g. https://rubygems.org)' do |value, options|
    options[:host] = value
  end
end

Instance Method Details

#add_owners(name, owners)

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 82


def add_owners(name, owners)
  manage_owners :post, name, owners
end

#arguments

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 24


def arguments # :nodoc:
  "GEM       gem to manage owners for"
end

#description

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 13


def description # :nodoc:
  <<-EOF
The owner command lets you add and remove owners of a gem on a push
server (the default is https://rubygems.org).

The owner of a gem has the permission to push new versions, yank existing
versions or edit the HTML page of the gem.  Be careful of who you give push
permission to.
  EOF
end

#execute

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 54


def execute
  @host = options[:host]

  sign_in
  name = get_one_gem_name

  add_owners    name, options[:add]
  remove_owners name, options[:remove]
  show_owners   name
end

#manage_owners(method, name, owners)

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 90


def manage_owners(method, name, owners)
  owners.each do |owner|
    begin
      response = send_owner_request(method, name, owner)
      action = method == :delete ? "Removing" : "Adding"

      with_response response, "#{action} #{owner}"
    rescue
      # ignore
    end
  end
end

#remove_owners(name, owners)

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 86


def remove_owners(name, owners)
  manage_owners :delete, name, owners
end

#send_owner_request(method, name, owner) (private)

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 105


def send_owner_request(method, name, owner)
  rubygems_api_request method, "api/v1/gems/#{name}/owners" do |request|
    request.set_form_data 'email' => owner
    request.add_field "Authorization", api_key
    request.add_field "OTP", options[:otp] if options[:otp]
  end
end

#show_owners(name)

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 65


def show_owners(name)
  Gem.load_yaml

  response = rubygems_api_request :get, "api/v1/gems/#{name}/owners.yaml" do |request|
    request.add_field "Authorization", api_key
  end

  with_response response do |resp|
    owners = Gem::SafeYAML.load clean_text(resp.body)

    say "Owners for gem: #{name}"
    owners.each do |owner|
      say "- #{owner['email'] || owner['handle'] || owner['id']}"
    end
  end
end

#usage

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/owner_command.rb', line 28


def usage # :nodoc:
  "#{program_name} GEM"
end

Class: Gem::Commands::OwnerCommand

Constant Summary

::Gem::Command - Inherited

::Gem::GemcutterUtilities - Included

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::GemcutterUtilities - Included

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::GemcutterUtilities - Included

::Gem::LocalRemoteOptions - Included

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

Constructor Details

.new ⇒ OwnerCommand

Instance Method Details

#add_owners(name, owners)

#arguments

#description

#execute

#manage_owners(method, name, owners)

#remove_owners(name, owners)

#send_owner_request(method, name, owner) (private)

#show_owners(name)

#usage

`::Gem::Command` - Inherited

`::Gem::GemcutterUtilities` - Included

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::GemcutterUtilities` - Included

`::Gem::LocalRemoteOptions` - Included

`::Gem::Command` - Inherited

`::Gem::DefaultUserInteraction` - Included

`::Gem::GemcutterUtilities` - Included

`::Gem::LocalRemoteOptions` - Included

`::Gem::Command` - Inherited

`::Gem::UserInteraction` - Included

`::Gem::DefaultUserInteraction` - Included

`::Gem::Text` - Included

.new ⇒ `OwnerCommand`