Class: Gem::Commands::PushCommand

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::PushCommand
Defined in:	lib/rubygems/commands/push_command.rb

Class Attribute Summary

::Gem::Command - Inherited

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

Class Method Summary

.new ⇒ PushCommand 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

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

::Gem::DefaultUserInteraction - Included

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

::Gem::GemcutterUtilities - Included

#add_key_option	Add the –key option.
#api_key	The API key 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,
#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`.
#defaults_str	Override to display the default values of the command options.
#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.
#parser	Create on demand parser.
#wrap	Wraps `text` to `width`

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

Constructor Details

.new ⇒ `PushCommand`

[ GitHub ]

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


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

  add_proxy_option
  add_key_option

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

  @host = nil
end

Instance Method Details

#execute

[ GitHub ]

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


def execute
  @host = options[:host]

  sign_in @host

  send_gem get_one_gem_name
end

#send_gem(name)

[ GitHub ]

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


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 then
    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 then
    @host = gem_data.spec.metadata['default_gem_server']
  end

  push_host = nil

  if gem_data.spec.metadata.has_key?('allowed_push_host')
    push_host = gem_data.spec.metadata['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 = 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
  end

  with_response response
end

Class: Gem::Commands::PushCommand

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 ⇒ PushCommand

Instance Method Details

#execute

#send_gem(name)

.new ⇒ `PushCommand`