Class: Rack::ETag

Inherits:
Object
  • Object
show all
Defined in:
lib/sinatra/rack_etag.rb

Overview

Automatically sets the ETag header on all String bodies.

The ETag header is skipped if ETag or Last-Modified headers are sent or if a sendfile body (body.responds_to :to_path) is given (since such cases should be handled by apache/nginx).

On initialization, you can pass two parameters: a Cache-Control directive used when Etag is absent and a directive when it is present. The first defaults to nil, while the second defaults to “max-age=0, privaute, must-revalidate”

Instance Method Summary collapse

Constructor Details

#initialize(app, no_cache_control = nil, cache_control = nil) ⇒ ETag

Returns a new instance of ETag.



34
35
36
37
38
 
# File 'lib/sinatra/rack_etag.rb', line 34

def initialize(app, no_cache_control = nil, cache_control = nil)
  @app = app
  @cache_control = cache_control || "max-age=0, private, must-revalidate"
  @no_cache_control = no_cache_control
end

Instance Method Details

#call(env) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/sinatra/rack_etag.rb', line 40

def call(env)
  status, headers, body = @app.call(env)

  if etag_status?(status) && etag_body?(body) && !http_caching?(headers)
    digest, body = digest_body(body)
    headers['ETag'] = digest.to_s if digest
  end

  if not headers['Cache-Control'] and digest
    headers['Cache-Control'] = digest ? @cache_control : @no_cache_control
  end

  [status, headers, body]
end