Sha256: 1c36eceda31c24e6145b9af9ce3decdd0223c4715e01469516100e0547dd63b2

Contents?: true

Size: 1.87 KB

Versions: 45

Compression:

Stored size: 1.87 KB

Contents

# frozen_string_literal: true

require 'digest/sha2'

require_relative 'constants'
require_relative 'utils'

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
    ETAG_STRING = Rack::ETAG
    DEFAULT_CACHE_CONTROL = "max-age=0, private, must-revalidate"

    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 = response = @app.call(env)

      if etag_status?(status) && body.respond_to?(:to_ary) && !skip_caching?(headers)
        body = body.to_ary
        digest = digest_body(body)
        headers[ETAG_STRING] = %(W/"#{digest}") if digest
      end

      unless headers[CACHE_CONTROL]
        if digest
          headers[CACHE_CONTROL] = @cache_control if @cache_control
        else
          headers[CACHE_CONTROL] = @no_cache_control if @no_cache_control
        end
      end

      response
    end

    private

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

      def skip_caching?(headers)
        headers.key?(ETAG_STRING) || headers.key?('last-modified')
      end

      def digest_body(body)
        digest = nil

        body.each do |part|
          (digest ||= Digest::SHA256.new) << part unless part.empty?
        end

        digest && digest.hexdigest.byteslice(0,32)
      end
  end
end

Version data entries

45 entries across 44 versions & 9 rubygems

Version Path
rack-3.1.12 lib/rack/etag.rb
rack-3.0.14 lib/rack/etag.rb
rack-3.0.13 lib/rack/etag.rb
rack-3.1.11 lib/rack/etag.rb
rack-3.0.12 lib/rack/etag.rb
rack-3.1.10 lib/rack/etag.rb
tailscale_middleware-0.0.3 vendor/cache/ruby/3.4.0/gems/rack-3.1.9/lib/rack/etag.rb
rack-3.1.9 lib/rack/etag.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rack-3.1.7/lib/rack/etag.rb
rack-3.1.8 lib/rack/etag.rb
rack-3.1.7 lib/rack/etag.rb
rack-3.1.6 lib/rack/etag.rb
rack-3.1.5 lib/rack/etag.rb
rack-3.1.4 lib/rack/etag.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rack-3.1.3/lib/rack/etag.rb
rack-3.1.3 lib/rack/etag.rb
rack-3.1.2 lib/rack/etag.rb
rack-3.1.1 lib/rack/etag.rb
rack-3.1.0 lib/rack/etag.rb
tinymce-rails-7.1.2 vendor/bundle/ruby/3.3.0/gems/rack-3.0.11/lib/rack/etag.rb