Class: Sinatra::Request

Inherits:
Rack::Request
  • Object
show all
Defined in:
lib/sinatra/base.rb

Overview

The request object. See Rack::Request for more info: https://rubydoc.info/github/rack/rack/main/Rack/Request

Defined Under Namespace

Classes: AcceptEntry, MimeTypeEntry

Constant Summary collapse

HEADER_PARAM = 
/\s*[\w.]+=(?:[\w.]+|"(?:[^"\\]|\\.)*")?\s*/.freeze
HEADER_VALUE_WITH_PARAMS = 
%r{(?:(?:\w+|\*)/(?:\w+(?:\.|-|\+)?|\*)*)\s*(?:;#{HEADER_PARAM})*}.freeze

Instance Method Summary collapse

Instance Method Details

#accept ⇒ Object

Returns an array of acceptable media types for the response



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/sinatra/base.rb', line 29

def accept
  @env['sinatra.accept'] ||= if @env.include?('HTTP_ACCEPT') && (@env['HTTP_ACCEPT'].to_s != '')
                               @env['HTTP_ACCEPT']
                                 .to_s
                                 .scan(HEADER_VALUE_WITH_PARAMS)
                                 .map! { |e| AcceptEntry.new(e) }
                                 .sort
                             else
                               [AcceptEntry.new('*/*')]
                             end
end

#accept?(type) ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/sinatra/base.rb', line 41

def accept?(type)
  preferred_type(type).to_s.include?(type)
end

#forwarded? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/sinatra/base.rb', line 59

def forwarded?
  @env.include? 'HTTP_X_FORWARDED_HOST'
end

#idempotent? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/sinatra/base.rb', line 67

def idempotent?
  safe? || put? || delete? || link? || unlink?
end

#link? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/sinatra/base.rb', line 71

def link?
  request_method == 'LINK'
end

#params ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/sinatra/base.rb', line 79

def params
  super
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e
  raise BadRequest, "Invalid query parameters: #{Rack::Utils.escape_html(e.message)}"
rescue EOFError => e
  raise BadRequest, "Invalid multipart/form-data: #{Rack::Utils.escape_html(e.message)}"
end

#preferred_type(*types) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sinatra/base.rb', line 45

def preferred_type(*types)
  return accept.first if types.empty?

  types.flatten!
  return types.first if accept.empty?

  accept.detect do |accept_header|
    type = types.detect { |t| MimeTypeEntry.new(t).accepts?(accept_header) }
    return type if type
  end
end

#safe? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/sinatra/base.rb', line 63

def safe?
  get? || head? || options? || trace?
end

#unlink? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/sinatra/base.rb', line 75

def unlink?
  request_method == 'UNLINK'
end