class Gem::Request - Documentation for Ruby 3.4
Description: Documentation for the Gem::Request class
Keywords: ruby,class,Gem::Request

# class Gem::Request

### Public Class Methods

configure_connection_for_https (connection, cert_files)
Source

    # File lib/rubygems/request.rb, line 52
    def self.configure_connection_for_https(connection, cert_files)
      raise Gem::Exception.new("OpenSSL is not available. Install OpenSSL and rebuild Ruby (preferred) or use non-HTTPS sources") unless Gem::HAVE_OPENSSL

      connection.use_ssl = true
      connection.verify_mode =
        Gem.configuration.ssl_verify_mode || OpenSSL::SSL::VERIFY_PEER
      store = OpenSSL::X509::Store.new

      if Gem.configuration.ssl_client_cert
        pem = File.read Gem.configuration.ssl_client_cert
        connection.cert = OpenSSL::X509::Certificate.new pem
        connection.key = OpenSSL::PKey::RSA.new pem
      end

      store.set_default_paths
      cert_files.each do |ssl_cert_file|
        store.add_file ssl_cert_file
      end
      if Gem.configuration.ssl_ca_cert
        if File.directory? Gem.configuration.ssl_ca_cert
          store.add_path Gem.configuration.ssl_ca_cert
        else
          store.add_file Gem.configuration.ssl_ca_cert
        end
      end
      connection.cert_store = store

      connection.verify_callback = proc do |preverify_ok, store_context|
        verify_certificate store_context unless preverify_ok

        preverify_ok
      end

      connection
    end

get_cert_files ()
Source

    # File lib/rubygems/request.rb, line 47
    def self.get_cert_files
      pattern = File.expand_path("./ssl_certs/*/*.pem", __dir__)
      Dir.glob(pattern)
    end

get_proxy_from_env (scheme = "http")
Source

    # File lib/rubygems/request.rb, line 167
    def self.get_proxy_from_env(scheme = "http")
      downcase_scheme = scheme.downcase
      upcase_scheme = scheme.upcase
      env_proxy = ENV["#{downcase_scheme}_proxy"] || ENV["#{upcase_scheme}_PROXY"]

      no_env_proxy = env_proxy.nil? || env_proxy.empty?

      if no_env_proxy
        return ["https", "http"].include?(downcase_scheme) ? :no_proxy : get_proxy_from_env("http")
      end

      require "uri"
      uri = Gem::URI(Gem::UriFormatter.new(env_proxy).normalize)

      if uri && uri.user.nil? && uri.password.nil?
        user     = ENV["#{downcase_scheme}_proxy_user"] || ENV["#{upcase_scheme}_PROXY_USER"]
        password = ENV["#{downcase_scheme}_proxy_pass"] || ENV["#{upcase_scheme}_PROXY_PASS"]

        uri.user     = Gem::UriFormatter.new(user).escape
        uri.password = Gem::UriFormatter.new(password).escape
      end

      uri
    end

Returns a proxy `URI` for the given `scheme` if one is set in the environment variables.

new (uri, request_class, last_modified, pool)
Source

    # File lib/rubygems/request.rb, line 29
    def initialize(uri, request_class, last_modified, pool)
      @uri = uri
      @request_class = request_class
      @last_modified = last_modified
      @requests = Hash.new(0).compare_by_identity
      @user_agent = user_agent

      @connection_pool = pool
    end

verify_certificate (store_context)
Source

    # File lib/rubygems/request.rb, line 88
    def self.verify_certificate(store_context)
      depth  = store_context.error_depth
      error  = store_context.error_string
      number = store_context.error
      cert   = store_context.current_cert

      ui.alert_error "SSL verification error at depth #{depth}: #{error} (#{number})"

      extra_message = verify_certificate_message number, cert

      ui.alert_error extra_message if extra_message
    end

verify_certificate_message (error_number, cert)
Source

    # File lib/rubygems/request.rb, line 101
    def self.verify_certificate_message(error_number, cert)
      return unless cert
      case error_number
      when OpenSSL::X509::V_ERR_CERT_HAS_EXPIRED then
        require "time"
        "Certificate #{cert.subject} expired at #{cert.not_after.iso8601}"
      when OpenSSL::X509::V_ERR_CERT_NOT_YET_VALID then
        require "time"
        "Certificate #{cert.subject} not valid until #{cert.not_before.iso8601}"
      when OpenSSL::X509::V_ERR_CERT_REJECTED then
        "Certificate #{cert.subject} is rejected"
      when OpenSSL::X509::V_ERR_CERT_UNTRUSTED then
        "Certificate #{cert.subject} is not trusted"
      when OpenSSL::X509::V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT then
        "Certificate #{cert.issuer} is not trusted"
      when OpenSSL::X509::V_ERR_INVALID_CA then
        "Certificate #{cert.subject} is an invalid CA certificate"
      when OpenSSL::X509::V_ERR_INVALID_PURPOSE then
        "Certificate #{cert.subject} has an invalid purpose"
      when OpenSSL::X509::V_ERR_SELF_SIGNED_CERT_IN_CHAIN then
        "Root certificate is not trusted (#{cert.subject})"
      when OpenSSL::X509::V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY then
        "You must add #{cert.issuer} to your local trusted store"
      when
        OpenSSL::X509::V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE then
        "Cannot verify certificate issued by #{cert.issuer}"
      end
    end

### Public Instance Methods

cert_files ()
Source

    # File lib/rubygems/request.rb, line 43
    def cert_files
      @connection_pool.cert_files
    end

connection_for (uri)
Source

    # File lib/rubygems/request.rb, line 134
    def connection_for(uri)
      @connection_pool.checkout
    rescue Gem::HAVE_OPENSSL ? OpenSSL::SSL::SSLError : Errno::EHOSTDOWN,
           Errno::EHOSTDOWN => e
      raise Gem::RemoteFetcher::FetchError.new(e.message, uri)
    end

Creates or an HTTP connection based on `uri`, or retrieves an existing connection, using a proxy if needed.

fetch () { |request| ... }
Source

    # File lib/rubygems/request.rb, line 141
    def fetch
      request = @request_class.new @uri.request_uri

      unless @uri.nil? || @uri.user.nil? || @uri.user.empty?
        request.basic_auth Gem::UriFormatter.new(@uri.user).unescape,
                           Gem::UriFormatter.new(@uri.password).unescape
      end

      request.add_field "User-Agent", @user_agent
      request.add_field "Connection", "keep-alive"
      request.add_field "Keep-Alive", "30"

      if @last_modified
        require "time"
        request.add_field "If-Modified-Since", @last_modified.httpdate
      end

      yield request if block_given?

      perform_request request
    end

proxy_uri ()
Source

    # File lib/rubygems/request.rb, line 39
    def proxy_uri
      @connection_pool.proxy_uri
    end

reset (connection)
Source

    # File lib/rubygems/request.rb, line 269
    def reset(connection)
      @requests.delete connection

      connection.finish
      connection.start
    end

Resets HTTP connection `connection`.

user_agent ()
Source

    # File lib/rubygems/request.rb, line 276
    def user_agent
      ua = "RubyGems/#{Gem::VERSION} #{Gem::Platform.local}".dup

      ruby_version = RUBY_VERSION
      ruby_version += "dev" if RUBY_PATCHLEVEL == -1

      ua << " Ruby/#{ruby_version} (#{RUBY_RELEASE_DATE}"
      if RUBY_PATCHLEVEL >= 0
        ua << " patchlevel #{RUBY_PATCHLEVEL}"
      else
        ua << " revision #{RUBY_REVISION}"
      end
      ua << ")"

      ua << " #{RUBY_ENGINE}" if RUBY_ENGINE != "ruby"

      ua
    end