Sha256: d61a10755259f6a66bf3e912c2d48b206490d9f5b5fe02fa735b3ea174737f2a

Contents?: true

Size: 1.78 KB

Versions: 135

Compression:

Stored size: 1.78 KB

Contents

require 'digest/md5'

module Rack
  # 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, private, must-revalidate"
  class ETag
    DEFAULT_CACHE_CONTROL = "max-age=0, private, must-revalidate".freeze

    def initialize(app, no_cache_control = nil, cache_control = DEFAULT_CACHE_CONTROL)
      @app = app
      @cache_control = cache_control
      @no_cache_control = no_cache_control
    end

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

      if etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
        digest, body = digest_body(body)
        headers['ETag'] = %("#{digest}") if digest
      end

      unless headers['Cache-Control']
        headers['Cache-Control'] =
          (digest ? @cache_control : @no_cache_control) || []
      end

      [status, headers, body]
    end

    private

      def etag_status?(status)
        status == 200 || status == 201
      end

      def etag_body?(body)
        !body.respond_to?(:to_path)
      end

      def skip_caching?(headers)
        headers['Cache-Control'] == 'no-cache' ||
          headers.key?('ETag') || headers.key?('Last-Modified')
      end

      def digest_body(body)
        parts = []
        body.each { |part| parts << part }
        string_body = parts.join
        digest = Digest::MD5.hexdigest(string_body) unless string_body.empty?
        [digest, parts]
      end
  end
end

Version data entries

135 entries across 114 versions & 14 rubygems

Version Path
classiccms-0.7.5 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
classiccms-0.7.4 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
classiccms-0.7.3 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
candlepin-api-0.4.0 bundle/ruby/1.9.1/gems/rack-1.3.5/lib/rack/etag.rb
candlepin-api-0.4.0 bundle/ruby/gems/rack-1.3.5/lib/rack/etag.rb
candlepin-api-0.4.0 bundle/ruby/1.8/gems/rack-1.3.5/lib/rack/etag.rb
classiccms-0.7.2 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
classiccms-0.7.1 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
classiccms-0.7.0 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
rack-1.3.10 lib/rack/etag.rb
rack-1.3.9 lib/rack/etag.rb
sunrise-cms-0.5.0.rc1 vendor/bundle/ruby/1.9.1/gems/rack-1.4.1/lib/rack/etag.rb
rack-1.3.8 lib/rack/etag.rb
rack-1.3.7 lib/rack/etag.rb
challah-0.9.0 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
classiccms-0.6.9 vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
jquery_regex-0.0.3 vendor/bundle/gems/jquery_regex-0.0.3/vendor/bundle/gems/jquery_regex-0.0.1/vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
jquery_regex-0.0.3 vendor/bundle/gems/jquery_regex-0.0.2/vendor/bundle/gems/jquery_regex-0.0.1/vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
jquery_regex-0.0.3 vendor/bundle/gems/jquery_regex-0.0.3/vendor/bundle/gems/jquery_regex-0.0.2/vendor/bundle/gems/jquery_regex-0.0.1/vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb
jquery_regex-0.0.3 vendor/bundle/gems/jquery_regex-0.0.1/vendor/bundle/gems/rack-1.4.1/lib/rack/etag.rb