123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::PushCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Gem::Command
Defined in: lib/rubygems/commands/push_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

::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

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.

#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

::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

.newPushCommand

[ GitHub ]

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

def initialize
  super 'push', 'Push a gem up to the gem server', :host => self.host

  @user_defined_host = false

  add_proxy_option
  add_key_option
  add_otp_option

  add_option('--host HOST',
             'Push to another gemcutter-compatible host',
             '  (e.g. https://rubygems.org)') do |value, options|
    options[:host] = value
    @user_defined_host = true
  end

  @host = nil
end

Instance Method Details

#arguments

This method is for internal use only.
[ GitHub ]

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

def arguments # :nodoc:
  "GEM       built gem to push up"
end

#description

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/push_command.rb', line 12

def description # :nodoc:
  <<-EOF
The push command uploads a gem to the push server (the default is
https://rubygems.org) and adds it to the index.

The gem can be removed from the index and deleted from the server using the yank
command.  For further discussion see the help for the yank command.

The push command will use ~/.gem/credentials to authenticate to a server, but you can use the RubyGems environment variable GEM_HOST_API_KEY to set the api key to authenticate.
  EOF
end

#execute

[ GitHub ]

  
# File 'lib/rubygems/commands/push_command.rb', line 51

def execute
  gem_name = get_one_gem_name
  default_gem_server, push_host = get_hosts_for(gem_name)

  default_host = nil
  user_defined_host = nil

  if @user_defined_host
    user_defined_host = options[:host]
  else
    default_host = options[:host]
  end

  @host = if user_defined_host
            user_defined_host
          elsif default_gem_server
            default_gem_server
          elsif push_host
            push_host
          else
            default_host
          end

   @host

  send_gem(gem_name)
end

#get_hosts_for(name) (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/push_command.rb', line 137

def get_hosts_for(name)
   = Gem::Package.new(name).spec.

  [
    ["default_gem_server"],
    ["allowed_push_host"]
  ]
end

#send_gem(name)

[ GitHub ]

  
# File 'lib/rubygems/commands/push_command.rb', line 79

def send_gem(name)
  args = [:post, "api/v1/gems"]

  latest_rubygems_version = Gem.latest_rubygems_version

  if latest_rubygems_version < Gem.rubygems_version and
       Gem.rubygems_version.prerelease? and
       Gem::Version.new('2.0.0.rc.2') != Gem.rubygems_version
    alert_error <<-ERROR
You are using a beta release of RubyGems (#{Gem::VERSION}) which is not
allowed to push gems.  Please downgrade or upgrade to a release version.

The latest released RubyGems version is #{latest_rubygems_version}

You can upgrade or downgrade to the latest release version with:

gem update --system=#{latest_rubygems_version}

    ERROR
    terminate_interaction 1
  end

  gem_data = Gem::Package.new(name)

  unless @host
    @host = gem_data.spec.['default_gem_server']
  end

  push_host = nil

  if gem_data.spec..has_key?('allowed_push_host')
    push_host = gem_data.spec.['allowed_push_host']
  end

  @host ||= push_host

  # Always include @host, even if it's nil
  args += [ @host, push_host ]

  say "Pushing gem to #{@host || Gem.host}..."

  response = send_push_request(name, args)

  with_response response
end

#send_push_request(name, args) (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/push_command.rb', line 127

def send_push_request(name, args)
  rubygems_api_request(*args) do |request|
    request.body = Gem.read_binary name
    request.add_field "Content-Length", request.body.size
    request.add_field "Content-Type",   "application/octet-stream"
    request.add_field "Authorization",  api_key
    request.add_field "OTP", options[:otp] if options[:otp]
  end
end

#usage

This method is for internal use only.
[ GitHub ]

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

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