Class: Spikard::Header

Inherits:
ParamBase show all
Defined in:
lib/spikard/params.rb

Overview

Extract a value from request headers.

Use this as a default parameter value to inject header values into route handlers.

Examples:

app.get("/items") do |user_agent: Header(default: "unknown")|
  { user_agent: user_agent }
end

app.get("/users/me") do |authorization: Header(default: nil)|
  if authorization
    { authenticated: true }
  else
    { authenticated: false }
  end
end

Instance Attribute Summary collapse

Attributes inherited from ParamBase

#default, #default_factory, #schema

Instance Method Summary collapse

Methods inherited from ParamBase

#get_default, #has_default?

Constructor Details

#initialize(default = nil, default_factory: nil, header_alias: nil, convert_underscores: true, schema: nil) ⇒ Header

Returns a new instance of Header.



110
111
112
113
114
 
# File 'lib/spikard/params.rb', line 110

def initialize(default = nil, default_factory: nil, header_alias: nil, convert_underscores: true, schema: nil)
  super(default, default_factory: default_factory, schema: schema)
  @header_alias = header_alias
  @convert_underscores = convert_underscores
end

Instance Attribute Details

#convert_underscores ⇒ Object (readonly)

Returns the value of attribute convert_underscores.



108
109
110
 
# File 'lib/spikard/params.rb', line 108

def convert_underscores
  @convert_underscores
end

#header_alias ⇒ Object (readonly)

Returns the value of attribute header_alias.



108
109
110
 
# File 'lib/spikard/params.rb', line 108

def header_alias
  @header_alias
end