Module: Gem::GemcutterUtilities

Included in:
Commands::OwnerCommand, Commands::PushCommand, Commands::SigninCommand, Commands::YankCommand
Defined in:
lib/rubygems/gemcutter_utilities.rb

Overview

Utility methods for using the RubyGems API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#host ⇒ Object

The host to connect to either from the RUBYGEMS_HOST environment variable or from the user’s configuration



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 54

def host
  configured_host = Gem.host unless
    Gem.configuration.disable_default_gem_server

  @host ||=
    begin
      env_rubygems_host = ENV['RUBYGEMS_HOST']
      env_rubygems_host = nil if
        env_rubygems_host and env_rubygems_host.empty?

      env_rubygems_host|| configured_host
    end
end

Instance Method Details

#add_key_option ⇒ Object

Add the –key option



19
20
21
22
23
24
25
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 19

def add_key_option
  add_option('-k', '--key KEYNAME', Symbol,
             'Use the given API key',
             'from ~/.gem/credentials') do |value,options|
    options[:key] = value
  end
end

#add_otp_option ⇒ Object

Add the –otp option



30
31
32
33
34
35
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 30

def add_otp_option
  add_option('--otp CODE',
             'Digit code for multifactor authentication') do |value, options|
    options[:otp] = value
  end
end

#api_key ⇒ Object

The API key from the command options or from the user’s configuration.



40
41
42
43
44
45
46
47
48
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 40

def api_key
  if options[:key]
    verify_api_key options[:key]
  elsif Gem.configuration.api_keys.key?(host)
    Gem.configuration.api_keys[host]
  else
    Gem.configuration.rubygems_api_key
  end
end

#need_otp?(response) ⇒ Boolean

Returns true when the user has enabled multifactor authentication from response text.

Returns:

  • (Boolean) 


180
181
182
183
184
185
186
187
188
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 180

def need_otp?(response)
  return unless response.kind_of?(Net::HTTPUnauthorized) &&
      response.body.start_with?('You have enabled multifactor authentication')
  return true if options[:otp]

  say 'You have enabled multi-factor authentication. Please enter OTP code.'
  options[:otp] = ask 'Code: '
  true
end

#rubygems_api_request(method, path, host = nil, allowed_push_host = nil, &block) ⇒ Object

Creates an RubyGems API to host and path with the given HTTP method.

If allowed_push_host metadata is present, then it will only allow that host.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 73

def rubygems_api_request(method, path, host = nil, allowed_push_host = nil, &block)
  require 'net/http'

  self.host = host if host
  unless self.host
    alert_error "You must specify a gem server"
    terminate_interaction 1 # TODO: question this
  end

  if allowed_push_host
    allowed_host_uri = URI.parse(allowed_push_host)
    host_uri         = URI.parse(self.host)

    unless (host_uri.scheme == allowed_host_uri.scheme) && (host_uri.host == allowed_host_uri.host)
      alert_error "#{self.host.inspect} is not allowed by the gemspec, which only allows #{allowed_push_host.inspect}"
      terminate_interaction 1
    end
  end

  uri = URI.parse "#{self.host}/#{path}"

  request_method = Net::HTTP.const_get method.to_s.capitalize

  Gem::RemoteFetcher.fetcher.request(uri, request_method, &block)
end

#set_api_key(host, key) ⇒ Object 



190
191
192
193
194
195
196
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 190

def set_api_key(host, key)
  if host == Gem::DEFAULT_HOST
    Gem.configuration.rubygems_api_key = key
  else
    Gem.configuration.set_api_key host, key
  end
end

#sign_in(sign_in_host = nil) ⇒ Object

Signs in with the RubyGems API at sign_in_host and sets the rubygems API key.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 103

def ( = nil)
   ||= self.host
  return if api_key

  pretty_host = if Gem::DEFAULT_HOST == 
                  'RubyGems.org'
                else
                  
                end

  say "Enter your #{pretty_host} credentials."
  say "Don't have an account yet? " +
      "Create one at #{}/sign_up"

  email    =              ask "   Email: "
  password = ask_for_password "Password: "
  say "\n"

  response = rubygems_api_request(:get, "api/v1/api_key",
                                  ) do |request|
    request.basic_auth email, password
  end

  if need_otp? response
    response = rubygems_api_request(:get, "api/v1/api_key", ) do |request|
      request.basic_auth email, password
      request.add_field "OTP", options[:otp]
    end
  end

  with_response response do |resp|
    say "Signed in."
    set_api_key host, resp.body
  end
end

#verify_api_key(key) ⇒ Object

Retrieves the pre-configured API key key or terminates interaction with an error.



143
144
145
146
147
148
149
150
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 143

def verify_api_key(key)
  if Gem.configuration.api_keys.key? key
    Gem.configuration.api_keys[key]
  else
    alert_error "No such API key. Please add it to your configuration (done automatically on initial `gem push`)."
    terminate_interaction 1 # TODO: question this
  end
end

#with_response(response, error_prefix = nil) ⇒ Object

If response is an HTTP Success (2XX) response, yields the response if a block was given or shows the response body to the user.

If the response was not successful, shows an error to the user including the error_prefix and the response body.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/rubygems/gemcutter_utilities.rb', line 159

def with_response(response, error_prefix = nil)
  case response
  when Net::HTTPSuccess then
    if block_given?
      yield response
    else
      say response.body
    end
  else
    message = response.body
    message = "#{error_prefix}: #{message}" if error_prefix

    say message
    terminate_interaction 1 # TODO: question this
  end
end