123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::SigninCommand

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

Constant Summary

::Gem::Command - Inherited

HELP

::Gem::GemcutterUtilities - Included

API_SCOPES, ERROR_CODE

Class Attribute Summary

::Gem::Command - Inherited

.build_args

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

Class Method Summary

::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=, #scope=, #default_host?

::Gem::Command - Inherited

#command

The name of the command.
#defaults

The default options for the command.
#deprecated?,
#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

::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.
#mfa_unauthorized?,
#otp

The OTP code from the command options or from the user’s configuration.
#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.
#update_scope,
#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.
#api_key_forbidden?, #fetch_otp, #get_key_name, #get_mfa_params, #get_scope_params, #get_user_profile, #pretty_host, #request_with_otp, #wait_for_otp_thread, #webauthn_verification_url

::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
#extract_gem_name_and_version, #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

Returns a value representing the “cost” of transforming str1 into str2 Vendored version of DidYouMean::Levenshtein.distance from the ruby/did_you_mean gem @ 1.4.0 github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37.
#truncate_text, #min3

Constructor Details

.new ⇒ SigninCommand

[ GitHub ] 

  


# File 'lib/rubygems/commands/signin_command.rb', line 9



def initialize
  super "signin", "Sign in to any gemcutter-compatible host. "\
        "It defaults to https://rubygems.org"

  add_option("--host HOST", "Push to another gemcutter-compatible host") do |value, options|
    options[:host] = value
  end

  add_otp_option
end


  







Instance Method Details



  

    #description  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/signin_command.rb', line 20



def description # :nodoc:
  "The signin command executes host sign in for a push server (the default is"\
  " https://rubygems.org). The host can be provided with the host flag or can"\
  " be inferred from the provided gem. Host resolution matches the resolution"\
  " strategy for the push command."
end


  








  

    #execute  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/signin_command.rb', line 31



def execute
   options[:host]
end


  








  

    #usage  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/signin_command.rb', line 27



def usage # :nodoc:
  program_name
end