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: AuthenticationRequiredError, BadAuthenticationError, Base, CertificateFailureError, CompactIndex, Dependency, Downloader, FallbackError, Index, NetworkDownError, SSLError

Constant Summary

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, FallbackError]
  fail_errors << Gem::Requirement::BadRequirementError if defined?(Gem::Requirement::BadRequirementError)
  fail_errors.push(*NET_ERRORS.map {|e| SharedHelpers.const_get_safely(e, Net) }.compact)
end.freeze

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remote) ⇒ Fetcher

Returns a new instance of Fetcher



77
78
79
80
81
82
# File 'lib/bundler/fetcher.rb', line 77

def initialize(remote)
  @remote = remote

  Socket.do_not_reverse_lookup = true
  connection # create persistent connection
end

Class Attribute Details

.api_timeoutObject

Returns the value of attribute api_timeout



70
71
72
# File 'lib/bundler/fetcher.rb', line 70

def api_timeout
  @api_timeout
end

.disable_endpointObject

Returns the value of attribute disable_endpoint



70
71
72
# File 'lib/bundler/fetcher.rb', line 70

def disable_endpoint
  @disable_endpoint
end

.max_retriesObject

Returns the value of attribute max_retries



70
71
72
# File 'lib/bundler/fetcher.rb', line 70

def max_retries
  @max_retries
end

.redirect_limitObject

Returns the value of attribute redirect_limit



70
71
72
# File 'lib/bundler/fetcher.rb', line 70

def redirect_limit
  @redirect_limit
end

Instance Method Details

#fetch_spec(spec) ⇒ Object

fetch a gem specification



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/bundler/fetcher.rb', line 89

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

  uri = URI.parse("#{remote_uri}#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}.rz")
  if uri.scheme == "file"
    Bundler.load_marshal Gem.inflate(Gem.read_binary(uri.path))
  elsif cached_spec_path = gemspec_cached_path(spec_file_name)
    Bundler.load_gemspec(cached_spec_path)
  else
    Bundler.load_marshal Gem.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

#fetchersObject



198
199
200
# File 'lib/bundler/fetcher.rb', line 198

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

#http_proxyObject



202
203
204
205
# File 'lib/bundler/fetcher.rb', line 202

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

#inspectObject



207
208
209
# File 'lib/bundler/fetcher.rb', line 207

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/bundler/fetcher.rb', line 114

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

  if Bundler::Fetcher.disable_endpoint
    @use_api = false
    specs = fetchers.last.specs(gem_names)
  else
    specs = []
    fetchers.shift until fetchers.first.available? || fetchers.empty?
    fetchers.dup.each do |f|
      break unless f.api_fetcher? && !gem_names || !specs = f.specs(gem_names)
      fetchers.delete(f)
    end
    @use_api = false if fetchers.none?(&:api_fetcher?)
  end

  specs.each do |name, version, platform, dependencies|
    next if name == "bundler"
    spec = if dependencies
      EndpointSpecification.new(name, version, platform, 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
ensure
  Bundler.rubygems.sources = old
end

#specs_with_retry(gem_names, source) ⇒ Object

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



107
108
109
110
111
# File 'lib/bundler/fetcher.rb', line 107

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

#uriObject



84
85
86
# File 'lib/bundler/fetcher.rb', line 84

def uri
  @remote.anonymized_uri
end

#use_apiObject



151
152
153
154
155
156
157
158
159
160
161
# File 'lib/bundler/fetcher.rb', line 151

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_agentObject



163
164
165
166
167
168
169
170
171
172
173
174
175
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 163

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
                         "???"
                       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