Class: Gemirro::Server

Inherits:
Sinatra::Base
  • Object
show all
Defined in:
lib/gemirro/server.rb

Overview

Launch Sinatra server to easily download gems.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#gems_fetcher ⇒ Gemirro::GemsFetcher

Returns:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
150
151
152
153
154
155
156
157
158
159
160
161
162
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
197
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/gemirro/server.rb', line 14

class Server < Sinatra::Base
  attr_accessor :versions_fetcher, :gems_fetcher

  access_logger = Logger.new(Gemirro.configuration.server.access_log)
                  .tap do |logger|
    ::Logger.class_eval { alias_method :write, :'<<' }
    logger.level = ::Logger::INFO
  end

  error_logger = File.new(Gemirro.configuration.server.error_log, 'a+')
  error_logger.sync = true

  before do
    Gemirro.configuration.logger = access_logger
    env['rack.errors'] = error_logger
  end

  ##
  # Configure server
  #
  configure do
    config = Gemirro.configuration
    config.server.host = 'localhost' if config.server.host.nil?
    config.server.port = '2000' if config.server.port.nil?

    set :views, Gemirro::Configuration.views_directory
    set :port, config.server.port
    set :bind, config.server.host
    set :public_folder, config.destination.gsub(%r{/$}, '')
    set :environment, config.environment
    set :dump_errors, true
    set :raise_errors, true

    enable :logging
    use Rack::CommonLogger, access_logger
  end

  ##
  # Set template for not found action
  #
  # @return [nil]
  #
  not_found do
    content_type 'text/html'
    erb(:not_found)
  end

  ##
  # Display information about one gem
  #
  # @return [nil]
  #
  get('/gem/:gemname') do
    gems = gems_collection
    @gem = gems.find_by_name(params[:gemname])
    return not_found if @gem.nil?

    erb(:gem)
  end

  ##
  # Display home page containing the list of gems already
  # downloaded on the server
  #
  # @return [nil]
  #
  get('/') do
    @gems = gems_collection
    erb(:index)
  end

  ##
  # Return gem dependencies as binary
  #
  # @return [nil]
  #
  get '/api/v1/dependencies' do
    content_type 'application/octet-stream'
    return 200 unless query_gems.any?
    return Marshal.dump(query_gems_list) if query_gems_list.any?
    404
  end

  ##
  # Return gem dependencies as json
  #
  # @return [nil]
  #
  get '/api/v1/dependencies.json' do
    content_type 'application/json'
    return {} unless query_gems.any?
    return JSON.dump(query_gems_list) if query_gems_list.any?
    404
  end

  ##
  # Try to get all request and download files
  # if files aren't found.
  #
  # @return [nil]
  #
  get('*') do |path|
    resource = "#{settings.public_folder}#{path}"

    # Try to download gem
    fetch_gem(resource)
    # If not found again, return a 404
    return not_found unless File.exist?(resource)

    send_file(resource)
  end

  ##
  # Try to fetch gem and download its if it's possible, and
  # build and install indicies.
  #
  # @param [String] resource
  # @return [Indexer]
  #
  def fetch_gem(resource)
    name = File.basename(resource)
    regexp = /^(.*)-(\d+(?:\.\d+){,4})\.gem(?:spec\.rz)?$/
    result = name.match(regexp)
    return unless result

    gem_name, gem_version = result.captures
    return unless gem_name && gem_version

    logger.info("Try to download #{gem_name} with version #{gem_version}")

    begin
      gems_fetcher.source.gems.clear
      gems_fetcher.source.gems.push(Gemirro::Gem.new(gem_name, gem_version))
      gems_fetcher.fetch
    rescue StandardError => e
      logger.error(e.message)
    end

    update_indexes
  end

  ##
  # Update indexes files
  #
  # @return [Indexer]
  #
  def update_indexes
    indexer    = Gemirro::Indexer.new(configuration.destination)
    indexer.only_origin = true
    indexer.ui = ::Gem::SilentUI.new

    configuration.logger.info('Generating indexes')
    indexer.generate_index
  rescue SystemExit => e
    configuration.logger.info(e.message)
  end

  ##
  # @see Gemirro.configuration
  #
  def configuration
    Gemirro.configuration
  end

  ##
  # @see Gemirro::VersionsFetcher.fetch
  #
  def versions_fetcher
    @versions_fetcher ||= Gemirro::VersionsFetcher
                          .new(configuration.source).fetch
  end

  ##
  # @return [Gemirro::GemsFetcher]
  #
  def gems_fetcher
    @gems_fetcher ||= Gemirro::GemsFetcher.new(
      configuration.source, versions_fetcher)
  end

  ##
  # Return all gems pass to query
  #
  # @return [Array]
  #
  def query_gems
    params[:gems].to_s.split(',')
  end

  ##
  # @see Gemirro::Configuration#logger
  # @return [Logger]
  #
  def logger
    configuration.logger
  end

  ##
  # Generate Gems collection from Marshal dump
  #
  # @return [Gemirro::GemVersionCollection]
  #
  def gems_collection
    gems = specs_files_paths.map do |specs_file_path|
      if File.exist?(specs_file_path)
        Marshal.load(Zlib::GzipReader.open(specs_file_path).read)
      else
        []
      end
    end.inject(:|)

    GemVersionCollection.new(gems)
  end

  ##
  # Return gems list from query params
  #
  # @return [Array]
  #
  def query_gems_list
    gems = query_gems.flat_map do |query_gem|
      gem_dependencies(query_gem)
    end
    gems = gems.select do |g|
      !g.empty?
    end
    gems
  end

  ##
  # List of versions and dependencies of each version
  # from a gem name.
  #
  # @return [Array]
  #
  def gem_dependencies(gem_name)
    gems = gems_collection
    gem_collection = gems.find_by_name(gem_name)
    return '' if gem_collection.nil?

    gem_collection = gem_collection.map do |gem|
      [gem, spec_for(gem.name, gem.number, gem.platform)]
    end

    gem_collection.reject! do |_, spec|
      spec.nil?
    end

    gem_collection.map do |gem, spec|
      dependencies = spec.dependencies.select do |d|
        d.type == :runtime
      end

      dependencies.map! do |d|
        [d.name.is_a?(Array) ? d.name.first : d.name, d.requirement.to_s]
      end

      {
        name: gem.name,
        number: gem.number,
        platform: gem.platform,
        dependencies: dependencies
      }
    end
  end

  ##
  # Return specs fils paths
  #
  # @return [Array]
  #
  def specs_files_paths
    marshal_version = Gemirro::Configuration.marshal_version
    specs_file_types.map do |specs_file_type|
      File.join(settings.public_folder,
                [specs_file_type, marshal_version, 'gz.orig'].join('.'))
    end
  end

  ##
  # Return specs fils types
  #
  # @return [Array]
  #
  def specs_file_types
    [:specs, :prerelease_specs]
  end

  helpers do
    ##
    # Return gem specification from gemname and version
    #
    # @param [String] gemname
    # @param [String] version
    # @return [::Gem::Specification]
    #
    def spec_for(gemname, version, platform = 'ruby')
      filename = [gemname, version]
      filename.push(platform) if platform != 'ruby'
      spec_file = File.join(settings.public_folder,
                            'quick',
                            Gemirro::Configuration.marshal_identifier,
                            "#{filename.join('-')}.gemspec.rz")

      File.open(spec_file, 'r') do |uz_file|
        uz_file.binmode
        Marshal.load(::Gem.inflate(uz_file.read))
      end if File.exist?(spec_file)
    end
  end
end

#versions_fetcher ⇒ Object

See Also:

  • VersionsFetcher.fetch


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
150
151
152
153
154
155
156
157
158
159
160
161
162
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
197
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/gemirro/server.rb', line 14

class Server < Sinatra::Base
  attr_accessor :versions_fetcher, :gems_fetcher

  access_logger = Logger.new(Gemirro.configuration.server.access_log)
                  .tap do |logger|
    ::Logger.class_eval { alias_method :write, :'<<' }
    logger.level = ::Logger::INFO
  end

  error_logger = File.new(Gemirro.configuration.server.error_log, 'a+')
  error_logger.sync = true

  before do
    Gemirro.configuration.logger = access_logger
    env['rack.errors'] = error_logger
  end

  ##
  # Configure server
  #
  configure do
    config = Gemirro.configuration
    config.server.host = 'localhost' if config.server.host.nil?
    config.server.port = '2000' if config.server.port.nil?

    set :views, Gemirro::Configuration.views_directory
    set :port, config.server.port
    set :bind, config.server.host
    set :public_folder, config.destination.gsub(%r{/$}, '')
    set :environment, config.environment
    set :dump_errors, true
    set :raise_errors, true

    enable :logging
    use Rack::CommonLogger, access_logger
  end

  ##
  # Set template for not found action
  #
  # @return [nil]
  #
  not_found do
    content_type 'text/html'
    erb(:not_found)
  end

  ##
  # Display information about one gem
  #
  # @return [nil]
  #
  get('/gem/:gemname') do
    gems = gems_collection
    @gem = gems.find_by_name(params[:gemname])
    return not_found if @gem.nil?

    erb(:gem)
  end

  ##
  # Display home page containing the list of gems already
  # downloaded on the server
  #
  # @return [nil]
  #
  get('/') do
    @gems = gems_collection
    erb(:index)
  end

  ##
  # Return gem dependencies as binary
  #
  # @return [nil]
  #
  get '/api/v1/dependencies' do
    content_type 'application/octet-stream'
    return 200 unless query_gems.any?
    return Marshal.dump(query_gems_list) if query_gems_list.any?
    404
  end

  ##
  # Return gem dependencies as json
  #
  # @return [nil]
  #
  get '/api/v1/dependencies.json' do
    content_type 'application/json'
    return {} unless query_gems.any?
    return JSON.dump(query_gems_list) if query_gems_list.any?
    404
  end

  ##
  # Try to get all request and download files
  # if files aren't found.
  #
  # @return [nil]
  #
  get('*') do |path|
    resource = "#{settings.public_folder}#{path}"

    # Try to download gem
    fetch_gem(resource)
    # If not found again, return a 404
    return not_found unless File.exist?(resource)

    send_file(resource)
  end

  ##
  # Try to fetch gem and download its if it's possible, and
  # build and install indicies.
  #
  # @param [String] resource
  # @return [Indexer]
  #
  def fetch_gem(resource)
    name = File.basename(resource)
    regexp = /^(.*)-(\d+(?:\.\d+){,4})\.gem(?:spec\.rz)?$/
    result = name.match(regexp)
    return unless result

    gem_name, gem_version = result.captures
    return unless gem_name && gem_version

    logger.info("Try to download #{gem_name} with version #{gem_version}")

    begin
      gems_fetcher.source.gems.clear
      gems_fetcher.source.gems.push(Gemirro::Gem.new(gem_name, gem_version))
      gems_fetcher.fetch
    rescue StandardError => e
      logger.error(e.message)
    end

    update_indexes
  end

  ##
  # Update indexes files
  #
  # @return [Indexer]
  #
  def update_indexes
    indexer    = Gemirro::Indexer.new(configuration.destination)
    indexer.only_origin = true
    indexer.ui = ::Gem::SilentUI.new

    configuration.logger.info('Generating indexes')
    indexer.generate_index
  rescue SystemExit => e
    configuration.logger.info(e.message)
  end

  ##
  # @see Gemirro.configuration
  #
  def configuration
    Gemirro.configuration
  end

  ##
  # @see Gemirro::VersionsFetcher.fetch
  #
  def versions_fetcher
    @versions_fetcher ||= Gemirro::VersionsFetcher
                          .new(configuration.source).fetch
  end

  ##
  # @return [Gemirro::GemsFetcher]
  #
  def gems_fetcher
    @gems_fetcher ||= Gemirro::GemsFetcher.new(
      configuration.source, versions_fetcher)
  end

  ##
  # Return all gems pass to query
  #
  # @return [Array]
  #
  def query_gems
    params[:gems].to_s.split(',')
  end

  ##
  # @see Gemirro::Configuration#logger
  # @return [Logger]
  #
  def logger
    configuration.logger
  end

  ##
  # Generate Gems collection from Marshal dump
  #
  # @return [Gemirro::GemVersionCollection]
  #
  def gems_collection
    gems = specs_files_paths.map do |specs_file_path|
      if File.exist?(specs_file_path)
        Marshal.load(Zlib::GzipReader.open(specs_file_path).read)
      else
        []
      end
    end.inject(:|)

    GemVersionCollection.new(gems)
  end

  ##
  # Return gems list from query params
  #
  # @return [Array]
  #
  def query_gems_list
    gems = query_gems.flat_map do |query_gem|
      gem_dependencies(query_gem)
    end
    gems = gems.select do |g|
      !g.empty?
    end
    gems
  end

  ##
  # List of versions and dependencies of each version
  # from a gem name.
  #
  # @return [Array]
  #
  def gem_dependencies(gem_name)
    gems = gems_collection
    gem_collection = gems.find_by_name(gem_name)
    return '' if gem_collection.nil?

    gem_collection = gem_collection.map do |gem|
      [gem, spec_for(gem.name, gem.number, gem.platform)]
    end

    gem_collection.reject! do |_, spec|
      spec.nil?
    end

    gem_collection.map do |gem, spec|
      dependencies = spec.dependencies.select do |d|
        d.type == :runtime
      end

      dependencies.map! do |d|
        [d.name.is_a?(Array) ? d.name.first : d.name, d.requirement.to_s]
      end

      {
        name: gem.name,
        number: gem.number,
        platform: gem.platform,
        dependencies: dependencies
      }
    end
  end

  ##
  # Return specs fils paths
  #
  # @return [Array]
  #
  def specs_files_paths
    marshal_version = Gemirro::Configuration.marshal_version
    specs_file_types.map do |specs_file_type|
      File.join(settings.public_folder,
                [specs_file_type, marshal_version, 'gz.orig'].join('.'))
    end
  end

  ##
  # Return specs fils types
  #
  # @return [Array]
  #
  def specs_file_types
    [:specs, :prerelease_specs]
  end

  helpers do
    ##
    # Return gem specification from gemname and version
    #
    # @param [String] gemname
    # @param [String] version
    # @return [::Gem::Specification]
    #
    def spec_for(gemname, version, platform = 'ruby')
      filename = [gemname, version]
      filename.push(platform) if platform != 'ruby'
      spec_file = File.join(settings.public_folder,
                            'quick',
                            Gemirro::Configuration.marshal_identifier,
                            "#{filename.join('-')}.gemspec.rz")

      File.open(spec_file, 'r') do |uz_file|
        uz_file.binmode
        Marshal.load(::Gem.inflate(uz_file.read))
      end if File.exist?(spec_file)
    end
  end
end

Instance Method Details

#* ⇒ nil

Try to get all request and download files if files aren’t found.

Returns:

  • (nil) 


115
116
117
118
119
120
121
122
123
124
 
# File 'lib/gemirro/server.rb', line 115

get('*') do |path|
  resource = "#{settings.public_folder}#{path}"

  # Try to download gem
  fetch_gem(resource)
  # If not found again, return a 404
  return not_found unless File.exist?(resource)

  send_file(resource)
end

#/ ⇒ nil

Display home page containing the list of gems already downloaded on the server

Returns:

  • (nil) 


80
81
82
83
 
# File 'lib/gemirro/server.rb', line 80

get('/') do
  @gems = gems_collection
  erb(:index)
end

#configuration ⇒ Object

See Also:



174
175
176
 
# File 'lib/gemirro/server.rb', line 174

def configuration
  Gemirro.configuration
end

#fetch_gem(resource) ⇒ Indexer

Try to fetch gem and download its if it’s possible, and build and install indicies.

Parameters:

  • resource (String)

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/gemirro/server.rb', line 133

def fetch_gem(resource)
  name = File.basename(resource)
  regexp = /^(.*)-(\d+(?:\.\d+){,4})\.gem(?:spec\.rz)?$/
  result = name.match(regexp)
  return unless result

  gem_name, gem_version = result.captures
  return unless gem_name && gem_version

  logger.info("Try to download #{gem_name} with version #{gem_version}")

  begin
    gems_fetcher.source.gems.clear
    gems_fetcher.source.gems.push(Gemirro::Gem.new(gem_name, gem_version))
    gems_fetcher.fetch
  rescue StandardError => e
    logger.error(e.message)
  end

  update_indexes
end

#gem_dependencies(gem_name) ⇒ Array

List of versions and dependencies of each version from a gem name.

Returns:

  • (Array) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/gemirro/server.rb', line 249

def gem_dependencies(gem_name)
  gems = gems_collection
  gem_collection = gems.find_by_name(gem_name)
  return '' if gem_collection.nil?

  gem_collection = gem_collection.map do |gem|
    [gem, spec_for(gem.name, gem.number, gem.platform)]
  end

  gem_collection.reject! do |_, spec|
    spec.nil?
  end

  gem_collection.map do |gem, spec|
    dependencies = spec.dependencies.select do |d|
      d.type == :runtime
    end

    dependencies.map! do |d|
      [d.name.is_a?(Array) ? d.name.first : d.name, d.requirement.to_s]
    end

    {
      name: gem.name,
      number: gem.number,
      platform: gem.platform,
      dependencies: dependencies
    }
  end
end

#gems_collection ⇒ Gemirro::GemVersionCollection

Generate Gems collection from Marshal dump

Returns:



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/gemirro/server.rb', line 216

def gems_collection
  gems = specs_files_paths.map do |specs_file_path|
    if File.exist?(specs_file_path)
      Marshal.load(Zlib::GzipReader.open(specs_file_path).read)
    else
      []
    end
  end.inject(:|)

  GemVersionCollection.new(gems)
end

#logger ⇒ Logger

Returns:

  • (Logger)

See Also:



207
208
209
 
# File 'lib/gemirro/server.rb', line 207

def logger
  configuration.logger
end

#query_gems ⇒ Array

Return all gems pass to query

Returns:

  • (Array) 


199
200
201
 
# File 'lib/gemirro/server.rb', line 199

def query_gems
  params[:gems].to_s.split(',')
end

#query_gems_list ⇒ Array

Return gems list from query params

Returns:

  • (Array) 


233
234
235
236
237
238
239
240
241
 
# File 'lib/gemirro/server.rb', line 233

def query_gems_list
  gems = query_gems.flat_map do |query_gem|
    gem_dependencies(query_gem)
  end
  gems = gems.select do |g|
    !g.empty?
  end
  gems
end

#specs_file_types ⇒ Array

Return specs fils types

Returns:

  • (Array) 


298
299
300
 
# File 'lib/gemirro/server.rb', line 298

def specs_file_types
  [:specs, :prerelease_specs]
end

#specs_files_paths ⇒ Array

Return specs fils paths

Returns:

  • (Array) 


285
286
287
288
289
290
291
 
# File 'lib/gemirro/server.rb', line 285

def specs_files_paths
  marshal_version = Gemirro::Configuration.marshal_version
  specs_file_types.map do |specs_file_type|
    File.join(settings.public_folder,
              [specs_file_type, marshal_version, 'gz.orig'].join('.'))
  end
end

#update_indexes ⇒ Indexer

Update indexes files

Returns:



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/gemirro/server.rb', line 160

def update_indexes
  indexer    = Gemirro::Indexer.new(configuration.destination)
  indexer.only_origin = true
  indexer.ui = ::Gem::SilentUI.new

  configuration.logger.info('Generating indexes')
  indexer.generate_index
rescue SystemExit => e
  configuration.logger.info(e.message)
end