In Files

  • rubygems/gemcutter_utilities.rb

Class/Module Index [+]

Quicksearch

Gem::GemcutterUtilities

Utility methods for using the RubyGems API.

Attributes

host[W]

Public Instance Methods

add_key_option() click to toggle source

Add the –key option

 
               # File rubygems/gemcutter_utilities.rb, line 18
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
            
api_key() click to toggle source

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

 
               # File rubygems/gemcutter_utilities.rb, line 29
def api_key
  if options[:key] then
    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
            
host() click to toggle source

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

 
               # File rubygems/gemcutter_utilities.rb, line 43
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
            
rubygems_api_request(method, path, host = nil, allowed_push_host = nil, &block) click to toggle source

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.

 
               # File rubygems/gemcutter_utilities.rb, line 62
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 and self.host != allowed_push_host
    alert_error "#{self.host.inspect} is not allowed by the gemspec, which only allows #{allowed_push_host.inspect}"
    terminate_interaction 1
  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
            
sign_in(sign_in_host = nil) click to toggle source

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

 
               # File rubygems/gemcutter_utilities.rb, line 87
def sign_in sign_in_host = nil
  sign_in_host ||= self.host
  return if Gem.configuration.rubygems_api_key

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

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

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

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

  with_response response do |resp|
    say "Signed in."
    Gem.configuration.rubygems_api_key = resp.body
  end
end
            
verify_api_key(key) click to toggle source

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

 
               # File rubygems/gemcutter_utilities.rb, line 120
def verify_api_key(key)
  if Gem.configuration.api_keys.key? key then
    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) click to toggle source

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.

 
               # File rubygems/gemcutter_utilities.rb, line 136
def with_response response, error_prefix = nil
  case response
  when Net::HTTPSuccess then
    if block_given? then
      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
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus