Class: Bundler::Fetcher
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Exceptions:
| |
Inherits: | Object |
Defined in: | lib/bundler/fetcher.rb, lib/bundler/fetcher/base.rb, lib/bundler/fetcher/compact_index.rb, lib/bundler/fetcher/dependency.rb, lib/bundler/fetcher/downloader.rb, lib/bundler/fetcher/index.rb |
Overview
Handles all the fetching with the rubygems server
Constant Summary
-
FAIL_ERRORS =
# File 'lib/bundler/fetcher.rb', line 82begin fail_errors = [AuthenticationRequiredError, BadAuthenticationError, AuthenticationForbiddenError, FallbackError] fail_errors << Gem::Requirement::BadRequirementError fail_errors.concat(NET_ERRORS.map {|e| Net.const_get(e) }) end.freeze
-
FETCHERS =
# File 'lib/bundler/fetcher.rb', line 227[CompactIndex, Dependency, Index].freeze
-
HTTP_ERRORS =
# File 'lib/bundler/fetcher.rb', line 287[ Timeout::Error, EOFError, SocketError, Errno::ENETDOWN, Errno::ENETUNREACH, Errno::EINVAL, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::EAGAIN, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError, PersistentHTTP::Error, Zlib::BufError, Errno::EHOSTUNREACH ].freeze
-
NET_ERRORS =
Exceptions classes that should bypass retry attempts. If your password didn’t work the first time, it’s not going to the third time.
[:HTTPBadGateway, :HTTPBadRequest, :HTTPFailedDependency, :HTTPForbidden, :HTTPInsufficientStorage, :HTTPMethodNotAllowed, :HTTPMovedPermanently, :HTTPNoContent, :HTTPNotFound, :HTTPNotImplemented, :HTTPPreconditionFailed, :HTTPRequestEntityTooLarge, :HTTPRequestURITooLong, :HTTPUnauthorized, :HTTPUnprocessableEntity, :HTTPUnsupportedMediaType, :HTTPVersionNotSupported].freeze
Class Attribute Summary
- .api_timeout rw
- .disable_endpoint rw
- .max_retries rw
- .redirect_limit rw
Class Method Summary
- .new(remote) ⇒ Fetcher constructor
Instance Method Summary
-
#fetch_spec(spec)
fetch a gem specification.
- #fetchers
- #http_proxy
- #inspect
-
#specs(gem_names, source)
return the specs in the bundler format as an index.
-
#specs_with_retry(gem_names, source)
return the specs in the bundler format as an index with retries.
- #uri
- #use_api
- #user_agent
- #bundler_cert_store private
- #cis private
- #connection private
- #downloader private
-
#gemspec_cached_path(spec_file_name)
private
cached gem specification path, if one exists.
- #remote_uri private
Constructor Details
.new(remote) ⇒ Fetcher
# File 'lib/bundler/fetcher.rb', line 96
def initialize(remote) @remote = remote Socket.do_not_reverse_lookup = true connection # create persistent connection end
Class Attribute Details
.api_timeout (rw)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 89
attr_accessor :disable_endpoint, :api_timeout, :redirect_limit, :max_retries
.disable_endpoint (rw)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 89
attr_accessor :disable_endpoint, :api_timeout, :redirect_limit, :max_retries
.max_retries (rw)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 89
attr_accessor :disable_endpoint, :api_timeout, :redirect_limit, :max_retries
.redirect_limit (rw)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 89
attr_accessor :disable_endpoint, :api_timeout, :redirect_limit, :max_retries
Instance Method Details
#bundler_cert_store (private)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 294
def bundler_cert_store store = OpenSSL::X509::Store.new ssl_ca_cert = Bundler.settings[:ssl_ca_cert] || (Gem.configuration.ssl_ca_cert if Gem.configuration.respond_to?(:ssl_ca_cert)) if ssl_ca_cert if File.directory? ssl_ca_cert store.add_path ssl_ca_cert else store.add_file ssl_ca_cert end else store.set_default_paths Gem::Request.get_cert_files.each {|c| store.add_file c } end store end
#cis (private)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 229
def cis env_cis = { "TRAVIS" => "travis", "CIRCLECI" => "circle", "SEMAPHORE" => "semaphore", "JENKINS_URL" => "jenkins", "BUILDBOX" => "buildbox", "GO_SERVER_URL" => "go", "SNAP_CI" => "snap", "GITLAB_CI" => "gitlab", "GITHUB_ACTIONS" => "github", "CI_NAME" => ENV["CI_NAME"], "CI" => "ci", } env_cis.find_all {|env, _| ENV[env] }.map {|_, ci| ci } end
#connection (private)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 246
def connection @connection ||= begin needs_ssl = remote_uri.scheme == "https" || Bundler.settings[:ssl_verify_mode] || Bundler.settings[:ssl_client_cert] raise SSLError if needs_ssl && !defined?(OpenSSL::SSL) con = PersistentHTTP.new :name => "bundler", :proxy => :ENV if gem_proxy = Gem.configuration[:http_proxy] con.proxy = Bundler::URI.parse(gem_proxy) if gem_proxy != :no_proxy end if remote_uri.scheme == "https" con.verify_mode = (Bundler.settings[:ssl_verify_mode] || OpenSSL::SSL::VERIFY_PEER) con.cert_store = bundler_cert_store end ssl_client_cert = Bundler.settings[:ssl_client_cert] || (Gem.configuration.ssl_client_cert if Gem.configuration.respond_to?(:ssl_client_cert)) if ssl_client_cert pem = File.read(ssl_client_cert) con.cert = OpenSSL::X509::Certificate.new(pem) con.key = OpenSSL::PKey::RSA.new(pem) end con.read_timeout = Fetcher.api_timeout con.open_timeout = Fetcher.api_timeout con.override_headers["User-Agent"] = user_agent con.override_headers["X-Gemfile-Source"] = @remote.original_uri.to_s if @remote.original_uri con end end
#downloader (private)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 316
def downloader @downloader ||= Downloader.new(connection, self.class.redirect_limit) end
#fetch_spec(spec)
fetch a gem specification
# File 'lib/bundler/fetcher.rb', line 108
def fetch_spec(spec) spec -= [nil, "ruby", ""] spec_file_name = "#{spec.join "-"}.gemspec" uri = Bundler::URI.parse("#{remote_uri}#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}.rz") if uri.scheme == "file" path = Bundler.rubygems.correct_for_windows_path(uri.path) Bundler.safe_load_marshal Bundler.rubygems.inflate(Gem.read_binary(path)) elsif cached_spec_path = gemspec_cached_path(spec_file_name) Bundler.load_gemspec(cached_spec_path) else Bundler.safe_load_marshal Bundler.rubygems.inflate(downloader.fetch(uri).body) end rescue MarshalError raise HTTPError, "Gemspec #{spec} contained invalid data.\n" \ "Your network or your gem server is probably having issues right now." end
#fetchers
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 212
def fetchers @fetchers ||= FETCHERS.map {|f| f.new(downloader, @remote, uri) } end
#gemspec_cached_path(spec_file_name) (private)
cached gem specification path, if one exists
#http_proxy
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 216
def http_proxy return unless uri = connection.proxy_uri uri.to_s end
#inspect
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 221
def inspect "#<#{self.class}:0x#{object_id} uri=#{uri}>" end
#remote_uri (private)
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 312
def remote_uri @remote.uri end
#specs(gem_names, source)
return the specs in the bundler format as an index
# File 'lib/bundler/fetcher.rb', line 134
def specs(gem_names, source) index = Bundler::Index.new if Bundler::Fetcher.disable_endpoint @use_api = false specs = fetchers.last.specs(gem_names) else specs = [] @fetchers = fetchers.drop_while do |f| !f.available? || (f.api_fetcher? && !gem_names) || !specs = f.specs(gem_names) end @use_api = false if fetchers.none?(&:api_fetcher?) end specs.each do |name, version, platform, dependencies, | spec = if dependencies EndpointSpecification.new(name, version, platform, self, dependencies, ) else RemoteSpecification.new(name, version, platform, self) end spec.source = source spec.remote = @remote index << spec end index rescue CertificateFailureError Bundler.ui.info "" if gem_names && use_api # newline after dots raise end
#specs_with_retry(gem_names, source)
return the specs in the bundler format as an index with retries
# File 'lib/bundler/fetcher.rb', line 127
def specs_with_retry(gem_names, source) Bundler::Retry.new("fetcher", FAIL_ERRORS).attempts do specs(gem_names, source) end end
#uri
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 103
def uri @remote.anonymized_uri end
#use_api
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 165
def use_api return @use_api if defined?(@use_api) fetchers.shift until fetchers.first.available? @use_api = if remote_uri.scheme == "file" || Bundler::Fetcher.disable_endpoint false else fetchers.first.api_fetcher? end end
#user_agent
[ GitHub ]# File 'lib/bundler/fetcher.rb', line 177
def user_agent @user_agent ||= begin ruby = Bundler::RubyVersion.system agent = String.new("bundler/#{Bundler::VERSION}") agent << " rubygems/#{Gem::VERSION}" agent << " ruby/#{ruby.versions_string(ruby.versions)}" agent << " (#{ruby.host})" agent << " command/#{ARGV.first}" if ruby.engine != "ruby" # engine_version raises on unknown engines engine_version = begin ruby.engine_versions rescue RuntimeError "???" end agent << " #{ruby.engine}/#{ruby.versions_string(engine_version)}" end agent << " options/#{Bundler.settings.all.join(",")}" agent << " ci/#{cis.join(",")}" if cis.any? # add a random ID so we can consolidate runs server-side agent << " " << SecureRandom.hex(8) # add any user agent strings set in the config extra_ua = Bundler.settings[:user_agent] agent << " " << extra_ua if extra_ua agent end end