Class: Bundler::Fetcher

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/fetcher.rb,
lib/bundler/fetcher/base.rb,
lib/bundler/fetcher/index.rb,
lib/bundler/fetcher/dependency.rb,
lib/bundler/fetcher/downloader.rb,
lib/bundler/fetcher/compact_index.rb,
lib/bundler/fetcher/gem_remote_fetcher.rb

Overview

Handles all the fetching with the rubygems server

Defined Under Namespace

Classes: AuthenticationForbiddenError, AuthenticationRequiredError, BadAuthenticationError, Base, CertificateFailureError, CompactIndex, Dependency, Downloader, FallbackError, GemRemoteFetcher, Index, NetworkDownError, SSLError, TooManyRequestsError

Constant Summary collapse

HTTP_ERRORS = 
(Downloader::HTTP_RETRYABLE_ERRORS + Downloader::HTTP_NON_RETRYABLE_ERRORS).freeze
NET_ERRORS = 
[
  :HTTPBadGateway,
  :HTTPBadRequest,
  :HTTPFailedDependency,
  :HTTPForbidden,
  :HTTPInsufficientStorage,
  :HTTPMethodNotAllowed,
  :HTTPMovedPermanently,
  :HTTPNoContent,
  :HTTPNotFound,
  :HTTPNotImplemented,
  :HTTPPreconditionFailed,
  :HTTPRequestEntityTooLarge,
  :HTTPRequestURITooLong,
  :HTTPUnauthorized,
  :HTTPUnprocessableEntity,
  :HTTPUnsupportedMediaType,
  :HTTPVersionNotSupported,
].freeze
FAIL_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.

[
  AuthenticationRequiredError,
  BadAuthenticationError,
  AuthenticationForbiddenError,
  FallbackError,
  SecurityError,
  Gem::Requirement::BadRequirementError,
  Gem::Net::HTTPBadGateway,
  Gem::Net::HTTPBadRequest,
  Gem::Net::HTTPFailedDependency,
  Gem::Net::HTTPForbidden,
  Gem::Net::HTTPInsufficientStorage,
  Gem::Net::HTTPMethodNotAllowed,
  Gem::Net::HTTPMovedPermanently,
  Gem::Net::HTTPNoContent,
  Gem::Net::HTTPNotFound,
  Gem::Net::HTTPNotImplemented,
  Gem::Net::HTTPPreconditionFailed,
  Gem::Net::HTTPRequestEntityTooLarge,
  Gem::Net::HTTPRequestURITooLong,
  Gem::Net::HTTPUnauthorized,
  Gem::Net::HTTPUnprocessableEntity,
  Gem::Net::HTTPUnsupportedMediaType,
  Gem::Net::HTTPVersionNotSupported,
].freeze

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote) ⇒ Fetcher

Returns a new instance of Fetcher.



135
136
137
138
139
140
141
 
# File 'lib/bundler/fetcher.rb', line 135

def initialize(remote)
  @cis = nil
  @remote = remote

  Socket.do_not_reverse_lookup = true
  connection # create persistent connection
end

Class Attribute Details

.api_timeout ⇒ Object

Returns the value of attribute api_timeout.



128
129
130
 
# File 'lib/bundler/fetcher.rb', line 128

def api_timeout
  @api_timeout
end

.disable_endpoint ⇒ Object

Returns the value of attribute disable_endpoint.



128
129
130
 
# File 'lib/bundler/fetcher.rb', line 128

def disable_endpoint
  @disable_endpoint
end

.max_retries ⇒ Object

Returns the value of attribute max_retries.



128
129
130
 
# File 'lib/bundler/fetcher.rb', line 128

def max_retries
  @max_retries
end

.redirect_limit ⇒ Object

Returns the value of attribute redirect_limit.



128
129
130
 
# File 'lib/bundler/fetcher.rb', line 128

def redirect_limit
  @redirect_limit
end

Instance Method Details

#api_fetcher? ⇒ Boolean

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/bundler/fetcher.rb', line 242

def api_fetcher?
  fetchers.first.api_fetcher?
end

#fetch_spec(spec) ⇒ Object

fetch a gem specification



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/bundler/fetcher.rb', line 148

def fetch_spec(spec)
  spec -= [nil, "ruby", ""]
  spec_file_name = "#{spec.join "-"}.gemspec"

  uri = Gem::URI.parse("#{remote_uri}#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}.rz")
  spec = if uri.scheme == "file"
    path = Gem::Util.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
  raise MarshalError, "is #{spec.inspect}" unless spec.is_a?(Gem::Specification)
  spec
rescue MarshalError
  raise HTTPError, "Gemspec #{spec} contained invalid data.\n" \
    "Your network or your gem server is probably having issues right now."
end

#gem_remote_fetcher ⇒ Object 



246
247
248
249
250
251
252
253
254
 
# File 'lib/bundler/fetcher.rb', line 246

def gem_remote_fetcher
  @gem_remote_fetcher ||= begin
    require_relative "fetcher/gem_remote_fetcher"
    fetcher = GemRemoteFetcher.new Gem.configuration[:http_proxy]
    fetcher.headers["User-Agent"] = user_agent
    fetcher.headers["X-Gemfile-Source"] = @remote.original_uri.to_s if @remote.original_uri
    fetcher
  end
end

#http_proxy ⇒ Object 



233
234
235
236
 
# File 'lib/bundler/fetcher.rb', line 233

def http_proxy
  return unless uri = connection.proxy_uri
  uri.to_s
end

#inspect ⇒ Object 



238
239
240
 
# File 'lib/bundler/fetcher.rb', line 238

def inspect
  "#<#{self.class}:0x#{object_id} uri=#{uri}>"
end

#specs(gem_names, source) ⇒ Object

return the specs in the bundler format as an index



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/bundler/fetcher.rb', line 176

def specs(gem_names, source)
  index = Bundler::Index.new

  fetch_specs(gem_names).each do |name, version, platform, dependencies, metadata|
    spec = if dependencies
      EndpointSpecification.new(name, version, platform, self, dependencies, metadata).tap do |es|
        source.checksum_store.replace(es, es.checksum)
      end
    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 && api_fetcher? # newline after dots
  raise
end

#specs_with_retry(gem_names, source) ⇒ Object

return the specs in the bundler format as an index with retries



169
170
171
172
173
 
# File 'lib/bundler/fetcher.rb', line 169

def specs_with_retry(gem_names, source)
  Bundler::Retry.new("fetcher", FAIL_ERRORS).attempts do
    specs(gem_names, source)
  end
end

#uri ⇒ Object 



143
144
145
 
# File 'lib/bundler/fetcher.rb', line 143

def uri
  @remote.anonymized_uri
end

#user_agent ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/bundler/fetcher.rb', line 198

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 << " " << Gem::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