› Protocol::HTTP › Source › Protocol › HTTP › ContentEncoding

class ContentEncoding

Encode a response according the the request's acceptable encodings.

Definitions

DEFAULT_WRAPPERS = {...}

The default wrappers to use for encoding content.

Implementation

 
DEFAULT_WRAPPERS = {
	"gzip" => Body::Deflate.method(:for)
}

DEFAULT_CONTENT_TYPES = %r{^(text/.*?)|(.*?/json)|(.*?/javascript)$}

The default content types to apply encoding to.

def initialize(delegate, content_types = DEFAULT_CONTENT_TYPES, wrappers = DEFAULT_WRAPPERS)

Initialize the content encoding middleware.

Signature
parameter　delegate　Middleware

The next middleware in the chain.

parameter　content_types　Regexp

The content types to apply encoding to.

parameter　wrappers　Hash

The encoding wrappers to use.

Implementation

 
def initialize(delegate, content_types = DEFAULT_CONTENT_TYPES, wrappers = DEFAULT_WRAPPERS)
	super(delegate)
	
	@content_types = content_types
	@wrappers = wrappers
end

def call(request)

Encode the response body according to the request's acceptable encodings.

Signature
parameter　request　Request

The request.

returns　Response

The response.

Implementation

 
def call(request)
	response = super
	
	# Early exit if the response has already specified a content-encoding.
	return response if response.headers["content-encoding"]
	
	# This is a very tricky issue, so we avoid it entirely.
	# https://lists.w3.org/Archives/Public/ietf-http-wg/2014JanMar/1179.html
	return response if response.partial?
	
	# Ensure that caches are aware we are varying the response based on the accept-encoding request header:
	response.headers.add("vary", "accept-encoding")
	
	# TODO use http-accept and sort by priority
	if !response.body.empty? and accept_encoding = request.headers["accept-encoding"]
		if content_type = response.headers["content-type"] and @content_types =~ content_type
			body = response.body
			
			accept_encoding.each do |name|
				if wrapper = @wrappers[name]
					response.headers["content-encoding"] = name
					
					body = wrapper.call(body)
					
					break
				end
			end
			
			response.body = body
		end
	end
	
	return response
end