Class: Gem::Commands::PushCommand
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::Gem::Command
|
|
Instance Chain:
|
|
Inherits: |
Gem::Command
|
Defined in: | lib/rubygems/commands/push_command.rb |
Constant Summary
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 |
.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= |
::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. |
#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
Instance Method Summary
- #execute
- #send_gem(name)
- #get_hosts_for(name) private
- #get_push_scope private
- #send_push_request(name, args) 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. |
#mfa_unauthorized?, | |
#otp | The OTP code from the command options or from the user’s configuration. |
#rubygems_api_request | |
#set_api_key | Returns true when the user has enabled multifactor authentication from |
#sign_in | Signs in with the RubyGems API at |
#update_scope, | |
#verify_api_key | Retrieves the pre-configured API key |
#with_response | If |
#api_key_forbidden?, #ask_otp, #get_key_name, #get_scope_params, #pretty_host, #request_with_otp |
::Gem::LocalRemoteOptions
- Included
#accept_uri_http | Allows |
#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 |
#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 |
#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 |
#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 |
#add_parser_description, #add_parser_options, #add_parser_summary |
::Gem::UserInteraction
- Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
::Gem::DefaultUserInteraction
- Included
::Gem::Text
- Included
#clean_text | Remove any non-printable characters and make the text suitable for printing. |
#format_text | Wraps |
#levenshtein_distance | This code is based directly on the |
#truncate_text, #min3 |
Constructor Details
.new ⇒ PushCommand
# File 'lib/rubygems/commands/push_command.rb', line 31
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, | [:host] = value @user_defined_host = true end @host = nil end
Instance Method Details
#arguments
# File 'lib/rubygems/commands/push_command.rb', line 23
def arguments # :nodoc: "GEM built gem to push up" end
#description
# File 'lib/rubygems/commands/push_command.rb', line 11
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 50
def execute gem_name = get_one_gem_name default_gem_server, push_host = get_hosts_for(gem_name) @host = if @user_defined_host [:host] elsif default_gem_server default_gem_server elsif push_host push_host else [:host] end sign_in @host, scope: get_push_scope send_gem(gem_name) end
#get_hosts_for(name) (private)
[ GitHub ]#get_push_scope (private)
[ GitHub ]# File 'lib/rubygems/commands/push_command.rb', line 106
def get_push_scope :push_rubygem end
#send_gem(name)
[ GitHub ]# File 'lib/rubygems/commands/push_command.rb', line 69
def send_gem(name) args = [:post, "api/v1/gems"] _, push_host = get_hosts_for(name) @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 88
def send_push_request(name, args) rubygems_api_request(*args, scope: get_push_scope) 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 end
#usage
# File 'lib/rubygems/commands/push_command.rb', line 27
def usage # :nodoc: "#{program_name} GEM" end