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

Overview

Handles all the fetching with the rubygems server

Defined Under Namespace

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

Constant Summary collapse

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
FAIL_ERRORS = 
begin
  fail_errors = [AuthenticationRequiredError, BadAuthenticationError, AuthenticationForbiddenError, FallbackError]
  fail_errors << Gem::Requirement::BadRequirementError
  fail_errors.concat(NET_ERRORS.map {|e| Net.const_get(e) })
end.freeze

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote) ⇒ Fetcher

Returns a new instance of Fetcher.



96
97
98
99
100
101
 
# 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 ⇒ Object

Returns the value of attribute api_timeout.



89
90
91
 
# File 'lib/bundler/fetcher.rb', line 89

def api_timeout
  @api_timeout
end

.disable_endpoint ⇒ Object

Returns the value of attribute disable_endpoint.



89
90
91
 
# File 'lib/bundler/fetcher.rb', line 89

def disable_endpoint
  @disable_endpoint
end

.max_retries ⇒ Object

Returns the value of attribute max_retries.



89
90
91
 
# File 'lib/bundler/fetcher.rb', line 89

def max_retries
  @max_retries
end

.redirect_limit ⇒ Object

Returns the value of attribute redirect_limit.



89
90
91
 
# File 'lib/bundler/fetcher.rb', line 89

def redirect_limit
  @redirect_limit
end

Instance Method Details

#fetch_spec(spec) ⇒ Object

fetch a gem specification



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# 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 ⇒ Object 



212
213
214
 
# File 'lib/bundler/fetcher.rb', line 212

def fetchers
  @fetchers ||= FETCHERS.map {|f| f.new(downloader, @remote, uri) }
end

#http_proxy ⇒ Object 



216
217
218
219
 
# File 'lib/bundler/fetcher.rb', line 216

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

#inspect ⇒ Object 



221
222
223
 
# File 'lib/bundler/fetcher.rb', line 221

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# 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, metadata|
    spec = if dependencies
      EndpointSpecification.new(name, version, platform, self, dependencies, metadata)
    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) ⇒ Object

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



127
128
129
130
131
 
# 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 ⇒ Object 



103
104
105
 
# File 'lib/bundler/fetcher.rb', line 103

def uri
  @remote.anonymized_uri
end

#use_api ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# 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 ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# 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