Strelka-CORS

Attributes

access_control_max_age[RW]: The number of seconds a preflight request can be cached
allowed_headers[RW]: The Array of raw header names that should be allowed on a preflighted request
allowed_methods[RW]: The Array of raw HTTP verb names that should be allowed on a preflighted request
allowed_origin[R]: The origin that should be allowed by the response.
exposed_headers[RW]: The Array of raw header names that should be exposed on the request.

Public Instance Methods

anchor

add_cors_headers()

Add any CORS headers which have been set up to the receiving response.

# File lib/strelka/httpresponse/cors.rb, line 100
def add_cors_headers
        origin = self.allowed_origin || self.request.origin.to_s
        if self.set_header_if_present( :allow_origin, origin ) && origin != '*'
                if (( current_vary = self.header.vary ))
                        self.header.vary = [current_vary, 'origin'].join( ', ' )
                else
                        self.header.vary = 'origin'
                end
        end

        self.set_header_if_present( :allow_credentials, self.credentials_allowed? )

        if self.request.is_preflight?
                self.log.debug "Preflight response; adding -Allow- headers"
                self.set_header_if_present( :allow_headers, self.allow_headers_header )
                self.set_header_if_present( :allow_methods, self.allow_methods_header )
                self.set_header_if_present( :max_age, self.access_control_max_age_header )
        else
                self.log.debug "Regular response; adding -Expose- headers"
                self.header.access_control_expose_headers = self.expose_headers_header
        end
end

anchor

allow_any_origin()

Set the headers of the response to indicate that any Origin is allowed.

# File lib/strelka/httpresponse/cors.rb, line 60
def allow_any_origin
        self.allow_origin( '*' )
end

anchor

allow_cookies()

Alias for: allow_credentials

anchor

allow_credentials()

Allow credentials in a preflighted request.

# File lib/strelka/httpresponse/cors.rb, line 93
def allow_credentials
        self.credentials_allowed = true
end

Also aliased as: allow_cookies

anchor

allow_header( *header_names )

Alias for: allow_headers

anchor

allow_headers( *header_names )

Add header_names to the list of headers that should be allowed in a preflighted request.

# File lib/strelka/httpresponse/cors.rb, line 76
def allow_headers( *header_names )
        self.allowed_headers ||= []
        self.allowed_headers += header_names
end

Also aliased as: allow_header

anchor

allow_method( *verbs )

Alias for: allow_methods

anchor

allow_methods( *verbs )

Add verbs to the list of HTTP methods that should be allowed in a preflighted request.

# File lib/strelka/httpresponse/cors.rb, line 85
def allow_methods( *verbs )
        self.allowed_methods ||= []
        self.allowed_methods += verbs
end

Also aliased as: allow_method

anchor

allow_origin( new_origin )

Set the allowed origin for the response.

# File lib/strelka/httpresponse/cors.rb, line 54
def allow_origin( new_origin )
        @allowed_origin = new_origin
end

anchor

credentials_allowed()

Whether or not credentials are allowed in the preflighted request

# File lib/strelka/httpresponse/cors.rb, line 50
attr_predicate_accessor :credentials_allowed

anchor

expose_header( *header_names )

Alias for: expose_headers

anchor

expose_headers( *header_names )

Add header_names to the list of headers that should be exposed in the response.

# File lib/strelka/httpresponse/cors.rb, line 67
def expose_headers( *header_names )
        self.exposed_headers ||= []
        self.exposed_headers += header_names
end

Also aliased as: expose_header

Protected Instance Methods

anchor

access_control_max_age_header()

Return the value that should be set on the Access-Control-Max-Age header according to the responses access_control_max_age

# File lib/strelka/httpresponse/cors.rb, line 169
def access_control_max_age_header
        max_age = self.access_control_max_age or return nil
        return max_age.to_i.to_s
end

anchor

allow_headers_header()

Return the value that should be set on the Access-Control-Allow-Headers header according to the response's allowed_headers.

# File lib/strelka/httpresponse/cors.rb, line 151
def allow_headers_header
        return nil unless self.allowed_headers && !self.allowed_headers.empty?
        return self.allowed_headers.map do |header_name|
                header_name.to_s.split( /[\-_]+/ ).map( &:capitalize ).join( '-' )
        end.sort.uniq.join( ' ' )
end

anchor

allow_methods_header()

Return the value that should be set on the Access-Control-Allow-Methods header according to the response's allowed_methods.

# File lib/strelka/httpresponse/cors.rb, line 161
def allow_methods_header
        return nil unless self.allowed_methods && !self.allowed_methods.empty?
        return self.allowed_methods.map( &:to_s ).sort.uniq.join( ' ' )
end

anchor

expose_headers_header()

Return the value that should be set on the Access-Control-Expose-Headers header according to the response's exposed_headers.

# File lib/strelka/httpresponse/cors.rb, line 141
def expose_headers_header
        return nil unless self.exposed_headers && !self.exposed_headers.empty?
        return self.exposed_headers.map do |header_name|
                header_name.to_s.split( /[\-_]+/ ).map( &:capitalize ).join( '-' )
        end.sort.uniq.join( ' ' )
end

anchor

initialize( * )

Add some instance variables to the request object.

# File lib/strelka/httpresponse/cors.rb, line 12
def initialize( * ) # :notnew:
        @exposed_headers = []
        @allowed_headers = []
        @allowed_methods = []
        @allowed_origin = nil
        @credentials_allowed = false
        @access_control_max_age = nil
        super
end

anchor

set_header_if_present( name, value )

If value is not nil or empty, set the access control header with the specified name to it.

# File lib/strelka/httpresponse/cors.rb, line 130
def set_header_if_present( name, value )
        return unless value && !value.to_s.empty?
        header_name = "access_control_%s" % [ name ]
        self.header[ header_name ] = value.to_s

        return value
end