Class: Gem::Commands::YankCommand

Inherits:
Gem::Command show all
Includes:
GemcutterUtilities, LocalRemoteOptions, VersionOption
Defined in:
lib/rubygems/commands/yank_command.rb

Instance Attribute Summary

Attributes included from GemcutterUtilities

#host

Attributes inherited from Gem::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods included from GemcutterUtilities

#add_key_option, #api_key, #rubygems_api_request, #sign_in, #verify_api_key, #with_response

Methods included from VersionOption

#add_platform_option, #add_prerelease_option, #add_version_option

Methods included from LocalRemoteOptions

#accept_uri_http, #add_bulk_threshold_option, #add_clear_sources_option, #add_local_remote_options, #add_proxy_option, #add_source_option, #add_update_sources_option, #both?, #local?, #remote?

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, #defaults_str, extra_args, extra_args=, #get_all_gem_names, #get_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize ⇒ YankCommand

Returns a new instance of YankCommand.



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubygems/commands/yank_command.rb', line 38

def initialize
  super 'yank', 'Remove a pushed gem from the index'

  add_version_option("remove")
  add_platform_option("remove")

  add_option('--undo') do |value, options|
    options[:undo] = true
  end

  add_key_option
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



30
31
32
 
# File 'lib/rubygems/commands/yank_command.rb', line 30

def arguments # :nodoc:
  "GEM       name of gem"
end

#description ⇒ Object

:nodoc:



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/rubygems/commands/yank_command.rb', line 12

def description # :nodoc:
  "The yank command removes a gem you pushed to a server from the server's\nindex.\n\nNote that if you push a gem to rubygems.org the yank command does not\nprevent other people from downloading the gem via the download link.\n\nOnce you have pushed a gem several downloads will happen automatically\nvia the webhooks.  If you accidentally pushed passwords or other sensitive\ndata you will need to change them immediately and yank your gem.\n\nIf you are yanking a gem due to intellectual property reasons contact\nhttp://help.rubygems.org for permanent removal.  Be sure to mention this\nas the reason for the removal request.\n  EOF\nend\n"

#execute ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubygems/commands/yank_command.rb', line 51

def execute
  

  version   = get_version_from_requirements(options[:version])
  platform  = get_platform_from_requirements(options)

  if version then
    if options[:undo] then
      unyank_gem(version, platform)
    else
      yank_gem(version, platform)
    end
  else
    say "A version argument is required: #{usage}"
    terminate_interaction
  end
end

#unyank_gem(version, platform) ⇒ Object 



74
75
76
77
 
# File 'lib/rubygems/commands/yank_command.rb', line 74

def unyank_gem(version, platform)
  say "Unyanking gem from #{host}..."
  yank_api_request(:put, version, platform, "api/v1/gems/unyank")
end

#usage ⇒ Object

:nodoc:



34
35
36
 
# File 'lib/rubygems/commands/yank_command.rb', line 34

def usage # :nodoc:
  "#{program_name} GEM -v VERSION [-p PLATFORM] [--undo] [--key KEY_NAME]"
end

#yank_gem(version, platform) ⇒ Object 



69
70
71
72
 
# File 'lib/rubygems/commands/yank_command.rb', line 69

def yank_gem(version, platform)
  say "Yanking gem from #{self.host}..."
  yank_api_request(:delete, version, platform, "api/v1/gems/yank")
end