Class: ActionDispatch::Request

### Home Classes Methods

### In Files

- lib/action_dispatch/http/request.rb
- lib/action_dispatch/middleware/cookies.rb
- lib/action_dispatch/middleware/flash.rb

### Parent

Rack::Request

### Methods

- #GET
- #POST
- #authorization
- #body
- #content_length
- #cookie_jar
- #deep_munge
- #delete?
- #flash
- #form_data?
- #fullpath
- #get?
- #head?
- #headers
- #ip
- #key?
- #local?
- #media_type
- #method
- #method_symbol
- #original_fullpath
- #original_url
- #parse_query
- #post?
- #put?
- #query_parameters
- #raw_post
- #remote_ip
- #request_method
- #request_method_symbol
- #request_parameters
- #reset_session
- #server_software
- #session_options=
- #uuid
- #xhr?
- #xml_http_request?

### Included Modules

- ActionDispatch::Http::Cache::Request
- ActionDispatch::Http::MimeNegotiation
- ActionDispatch::Http::Parameters
- ActionDispatch::Http::FilterParameters
- ActionDispatch::Http::Upload
- ActionDispatch::Http::URL

### Class/Module Index

Quicksearch

- ActionDispatch
- ActionDispatch::Assertions
- ActionDispatch::Assertions::DomAssertions
- ActionDispatch::Assertions::ResponseAssertions
- ActionDispatch::Assertions::RoutingAssertions
- ActionDispatch::Assertions::SelectorAssertions
- ActionDispatch::Assertions::TagAssertions
- ActionDispatch::BestStandardsSupport
- ActionDispatch::BodyProxy
- ActionDispatch::Callbacks
- ActionDispatch::Cookies
- ActionDispatch::Cookies::CookieOverflow
- ActionDispatch::DebugExceptions
- ActionDispatch::ExceptionWrapper
- ActionDispatch::FileHandler
- ActionDispatch::Flash
- ActionDispatch::Flash::FlashHash
- ActionDispatch::Head
- ActionDispatch::Http
- ActionDispatch::Http::Cache
- ActionDispatch::Http::Cache::Request
- ActionDispatch::Http::Cache::Response
- ActionDispatch::Http::FilterParameters
- ActionDispatch::Http::Headers
- ActionDispatch::Http::MimeNegotiation
- ActionDispatch::Http::ParameterFilter
- ActionDispatch::Http::Parameters
- ActionDispatch::Http::URL
- ActionDispatch::Http::Upload
- ActionDispatch::Http::UploadedFile
- ActionDispatch::Integration
- ActionDispatch::Integration::RequestHelpers
- ActionDispatch::Integration::Runner
- ActionDispatch::Integration::Session
- ActionDispatch::IntegrationTest
- ActionDispatch::MiddlewareStack
- ActionDispatch::MiddlewareStack::Middleware
- ActionDispatch::ParamsParser
- ActionDispatch::PerformanceTest
- ActionDispatch::PublicExceptions
- ActionDispatch::RailsEntityStore
- ActionDispatch::RailsMetaStore
- ActionDispatch::Railtie
- ActionDispatch::Reloader
- ActionDispatch::RemoteIp
- ActionDispatch::RemoteIp::GetIp
- ActionDispatch::RemoteIp::IpSpoofAttackError
- ActionDispatch::Request
- ActionDispatch::RequestId
- ActionDispatch::Rescue
- ActionDispatch::Response
- ActionDispatch::Routing
- ActionDispatch::Routing::Mapper
- ActionDispatch::Routing::Mapper::Base
- ActionDispatch::Routing::Mapper::HttpHelpers
- ActionDispatch::Routing::Mapper::Resources
- ActionDispatch::Routing::Mapper::Scoping
- ActionDispatch::Routing::PolymorphicRoutes
- ActionDispatch::Routing::Redirection
- ActionDispatch::Routing::RouteSet
- ActionDispatch::Routing::RouteSet::MountedHelpers
- ActionDispatch::Routing::UrlFor
- ActionDispatch::Session
- ActionDispatch::Session::AbstractStore
- ActionDispatch::Session::CacheStore
- ActionDispatch::Session::Compatibility
- ActionDispatch::Session::CookieStore
- ActionDispatch::Session::DestroyableSession
- ActionDispatch::Session::MemCacheStore
- ActionDispatch::Session::StaleSessionCheck
- ActionDispatch::ShowExceptions
- ActionDispatch::Static
- ActionDispatch::TestProcess
- ActionDispatch::TestRequest
- ActionDispatch::TestResponse
- ActionController
- ActionController::Base
- ActionController::Caching
- ActionController::Caching::Actions
- ActionController::Caching::Actions::ActionCachePath
- ActionController::Caching::Actions::ClassMethods
- ActionController::Caching::ConfigMethods
- ActionController::Caching::Fragments
- ActionController::Caching::Pages
- ActionController::Caching::Pages::ClassMethods
- ActionController::Caching::Sweeping
- ActionController::Compatibility
- ActionController::ConditionalGet
- ActionController::Cookies
- ActionController::DataStreaming
- ActionController::Flash
- ActionController::ForceSSL
- ActionController::ForceSSL::ClassMethods
- ActionController::Head
- ActionController::Helpers
- ActionController::Helpers::ClassMethods
- ActionController::HideActions
- ActionController::HideActions::ClassMethods
- ActionController::HttpAuthentication
- ActionController::HttpAuthentication::Basic
- ActionController::HttpAuthentication::Basic::ControllerMethods
- ActionController::HttpAuthentication::Basic::ControllerMethods::ClassMethods
- ActionController::HttpAuthentication::Digest
- ActionController::HttpAuthentication::Digest::ControllerMethods
- ActionController::HttpAuthentication::Token
- ActionController::HttpAuthentication::Token::ControllerMethods
- ActionController::ImplicitRender
- ActionController::Instrumentation
- ActionController::Instrumentation::ClassMethods
- ActionController::LogSubscriber
- ActionController::Metal
- ActionController::Middleware
- ActionController::Middleware::ActionMiddleware
- ActionController::MimeResponds
- ActionController::MimeResponds::ClassMethods
- ActionController::ParamsWrapper
- ActionController::ParamsWrapper::ClassMethods
- ActionController::RackDelegation
- ActionController::Railtie
- ActionController::Railties
- ActionController::Railties::Paths
- ActionController::RecordIdentifier
- ActionController::Redirecting
- ActionController::Renderers
- ActionController::Renderers::All
- ActionController::Renderers::ClassMethods
- ActionController::Rendering
- ActionController::RequestForgeryProtection
- ActionController::RequestForgeryProtection::ClassMethods
- ActionController::Rescue
- ActionController::Responder
- ActionController::SessionManagement
- ActionController::SessionManagement::ClassMethods
- ActionController::Streaming
- ActionController::TemplateAssertions
- ActionController::TestCase
- ActionController::TestCase::Behavior
- ActionController::TestCase::Behavior::ClassMethods
- ActionController::TestCase::RaiseActionExceptions
- ActionController::TestResponse
- ActionController::Testing
- ActionController::Testing::ClassMethods
- ActionController::UrlFor
- ActionView
- ActionView::Base
- ActionView::Context
- ActionView::FileSystemResolver
- ActionView::FixtureResolver
- ActionView::Helpers
- ActionView::Helpers::ActiveModelHelper
- ActionView::Helpers::ActiveModelInstanceTag
- ActionView::Helpers::AssetPaths
- ActionView::Helpers::AssetTagHelper
- ActionView::Helpers::AssetTagHelper::AssetIncludeTag
- ActionView::Helpers::AssetTagHelper::JavascriptIncludeTag
- ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers
- ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers::ClassMethods
- ActionView::Helpers::AssetTagHelper::StylesheetIncludeTag
- ActionView::Helpers::AssetTagHelper::StylesheetTagHelpers
- ActionView::Helpers::AssetTagHelper::StylesheetTagHelpers::ClassMethods
- ActionView::Helpers::AtomFeedHelper
- ActionView::Helpers::AtomFeedHelper::AtomBuilder
- ActionView::Helpers::AtomFeedHelper::AtomFeedBuilder
- ActionView::Helpers::CacheHelper
- ActionView::Helpers::CaptureHelper
- ActionView::Helpers::CsrfHelper
- ActionView::Helpers::DateHelper
- ActionView::Helpers::DateHelperInstanceTag
- ActionView::Helpers::DebugHelper
- ActionView::Helpers::FormBuilder
- ActionView::Helpers::FormHelper
- ActionView::Helpers::FormOptionsHelper
- ActionView::Helpers::FormTagHelper
- ActionView::Helpers::InstanceTag
- ActionView::Helpers::JavaScriptHelper
- ActionView::Helpers::OutputSafetyHelper
- ActionView::Helpers::RecordTagHelper
- ActionView::Helpers::RenderingHelper
- ActionView::Helpers::SanitizeHelper
- ActionView::Helpers::TagHelper
- ActionView::Helpers::TextHelper
- ActionView::Helpers::TranslationHelper
- ActionView::Helpers::UrlHelper
- ActionView::LogSubscriber
- ActionView::LookupContext
- ActionView::LookupContext::DetailsCache
- ActionView::LookupContext::ViewPaths
- ActionView::NullResolver
- ActionView::PartialRenderer
- ActionView::Railtie
- ActionView::Renderer
- ActionView::Resolver
- ActionView::Resolver::Path
- ActionView::Template
- ActionView::Template::Handlers
- ActionView::Template::Handlers::Builder
- ActionView::Template::Handlers::ERB
- ActionView::Template::Handlers::Erubis
- ActionView::TestCase
- ActionView::TestCase::Behavior
- ActionView::TestCase::Behavior::ClassMethods
- ActionView::TestCase::Behavior::Locals
- ActionView::TestCase::TestController
- AbstractController
- AbstractController::ActionNotFound
- AbstractController::AssetPaths
- AbstractController::Base
- AbstractController::Callbacks
- AbstractController::Callbacks::ClassMethods
- AbstractController::Collector
- AbstractController::DoubleRenderError
- AbstractController::Error
- AbstractController::Helpers
- AbstractController::Helpers::ClassMethods
- AbstractController::Layouts
- AbstractController::Layouts::ClassMethods
- AbstractController::Layouts::ClassMethods::LayoutConditions
- AbstractController::Logger
- AbstractController::Railties
- AbstractController::Railties::RoutesHelpers
- AbstractController::Rendering
- AbstractController::Rendering::ClassMethods
- AbstractController::Translation
- AbstractController::UrlFor
- AbstractController::UrlFor::ClassMethods
- AbstractController::ViewPaths
- AbstractController::ViewPaths::ClassMethods
- Sprockets
- Sprockets::Bootstrap
- Sprockets::Compressors
- Sprockets::Helpers
- Sprockets::Helpers::IsolatedHelper
- Sprockets::Helpers::RailsHelper
- Sprockets::Helpers::RailsHelper::AssetPaths
- Sprockets::Helpers::RailsHelper::AssetPaths::AssetNotPrecompiledError
- Sprockets::Railtie
- Sprockets::StaticCompiler
- HTML
- HTML::FullSanitizer
- HTML::LinkSanitizer
- HTML::Sanitizer
- HTML::Selector
- HTML::Tag
- HTML::WhiteListSanitizer
- Mime
- Mime::Mimes
- Mime::Type
- ActionPack
- Object
- Rack

No matching classes.

# ActionDispatch::Request

### Constants

ENV_METHODS
HTTP_METHODS
HTTP_METHOD_LOOKUP
LOCALHOST
RFC2518
RFC2616

  List of HTTP request methods from the following RFCs: Hypertext Transfer Protocol -- HTTP/1.1 (www.ietf.org/rfc/rfc2616.txt) HTTP Extensions for Distributed Authoring -- WEBDAV (www.ietf.org/rfc/rfc2518.txt) Versioning Extensions to WebDAV (www.ietf.org/rfc/rfc3253.txt) Ordered Collections Protocol (WebDAV) (www.ietf.org/rfc/rfc3648.txt) Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol (www.ietf.org/rfc/rfc3744.txt) Web Distributed Authoring and Versioning (WebDAV) SEARCH (www.ietf.org/rfc/rfc5323.txt) PATCH Method for HTTP (www.ietf.org/rfc/rfc5789.txt)

RFC3253
RFC3648
RFC3744
RFC5323
RFC5789

### Public Instance Methods

GET() click to toggle source

Override Rack's GET method to support indifferent access

    # File lib/action_dispatch/http/request.rb, line 230
    def GET
      @env["action_dispatch.request.query_parameters"] ||= deep_munge(normalize_parameters(super) || {})
    end

Also aliased as: query_parameters
POST() click to toggle source

Override Rack's POST method to support indifferent access

    # File lib/action_dispatch/http/request.rb, line 236
    def POST
      @env["action_dispatch.request.request_parameters"] ||= deep_munge(normalize_parameters(super) || {})
    end

Also aliased as: request_parameters
authorization() click to toggle source

Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.

    # File lib/action_dispatch/http/request.rb, line 244
    def authorization
      @env['HTTP_AUTHORIZATION']   ||
      @env['X-HTTP_AUTHORIZATION'] ||
      @env['X_HTTP_AUTHORIZATION'] ||
      @env['REDIRECT_X_HTTP_AUTHORIZATION']
    end

body() click to toggle source

The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.

    # File lib/action_dispatch/http/request.rb, line 196
    def body
      if raw_post = @env['RAW_POST_DATA']
        raw_post.force_encoding(Encoding::BINARY) if raw_post.respond_to?(:force_encoding)
        StringIO.new(raw_post)
      else
        @env['rack.input']
      end
    end

content_length() click to toggle source

Returns the content length of the request as an integer.

    # File lib/action_dispatch/http/request.rb, line 147
    def content_length
      super.to_i
    end

cookie_jar() click to toggle source

    # File lib/action_dispatch/middleware/cookies.rb, line 7
    def cookie_jar
      env['action_dispatch.cookies'] ||= Cookies::CookieJar.build(self)
    end

deep_munge(hash) click to toggle source

Remove nils from the params hash

    # File lib/action_dispatch/http/request.rb, line 257
    def deep_munge(hash)
      hash.each do |k, v|
        case v
        when Array
          v.grep(Hash) { |x| deep_munge(x) }
          v.compact!
          hash[k] = nil if v.empty?
        when Hash
          deep_munge(v)
        end
      end

      hash
    end

delete?() click to toggle source

Is this a DELETE request? Equivalent to `request.request_method_symbol == :delete`.

    # File lib/action_dispatch/http/request.rb, line 113
    def delete?
      HTTP_METHOD_LOOKUP[request_method] == :delete
    end

flash() click to toggle source

Access the contents of the flash. Use `flash["notice"]` to read a notice you put there or `flash["notice"] = "hello"` to put a new one.

    # File lib/action_dispatch/middleware/flash.rb, line 6
    def flash
      @env[Flash::KEY] ||= (session["flash"] || Flash::FlashHash.new)
    end

form_data?() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 205
    def form_data?
      FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s)
    end

fullpath() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 134
    def fullpath
      @fullpath ||= super
    end

get?() click to toggle source

Is this a GET (or HEAD) request? Equivalent to `request.request_method_symbol == :get`.

    # File lib/action_dispatch/http/request.rb, line 95
    def get?
      HTTP_METHOD_LOOKUP[request_method] == :get
    end

head?() click to toggle source

Is this a HEAD request? Equivalent to `request.method_symbol == :head`.

    # File lib/action_dispatch/http/request.rb, line 119
    def head?
      HTTP_METHOD_LOOKUP[method] == :head
    end

headers() click to toggle source

Provides access to the request's HTTP headers, for example:

    request.headers["Content-Type"] # => "text/plain"

    # File lib/action_dispatch/http/request.rb, line 126
    def headers
      Http::Headers.new(@env)
    end

ip() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 159
    def ip
      @ip ||= super
    end

key?(key) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 38
    def key?(key)
      @env.key?(key)
    end

local?() click to toggle source

True if the request came from localhost, 127.0.0.1.

    # File lib/action_dispatch/http/request.rb, line 252
    def local?
      LOCALHOST.any? { |local_ip| local_ip === remote_addr && local_ip === remote_ip }
    end

media_type() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 142
    def media_type
      content_mime_type.to_s
    end

method() click to toggle source

Returns the original value of the environment's REQUEST_METHOD, even if it was overridden by middleware. See request_method for more information.

    # File lib/action_dispatch/http/request.rb, line 84
    def method
      @method ||= check_method(env["rack.methodoverride.original_method"] || env['REQUEST_METHOD'])
    end

method_symbol() click to toggle source

Returns a symbol form of the method

    # File lib/action_dispatch/http/request.rb, line 89
    def method_symbol
      HTTP_METHOD_LOOKUP[method]
    end

original_fullpath() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 130
    def original_fullpath
      @original_fullpath ||= (env["ORIGINAL_FULLPATH"] || fullpath)
    end

original_url() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 138
    def original_url
      base_url + original_fullpath
    end

post?() click to toggle source

Is this a POST request? Equivalent to `request.request_method_symbol == :post`.

    # File lib/action_dispatch/http/request.rb, line 101
    def post?
      HTTP_METHOD_LOOKUP[request_method] == :post
    end

put?() click to toggle source

Is this a PUT request? Equivalent to `request.request_method_symbol == :put`.

    # File lib/action_dispatch/http/request.rb, line 107
    def put?
      HTTP_METHOD_LOOKUP[request_method] == :put
    end

query_parameters() click to toggle source
Alias for: GET
raw_post() click to toggle source

Read the request body. This is useful for web services that need to work with raw requests directly.

    # File lib/action_dispatch/http/request.rb, line 185
    def raw_post
      unless @env.include? 'RAW_POST_DATA'
        raw_post_body = body
        @env['RAW_POST_DATA'] = raw_post_body.read(@env['CONTENT_LENGTH'].to_i)
        raw_post_body.rewind if raw_post_body.respond_to?(:rewind)
      end
      @env['RAW_POST_DATA']
    end

remote_ip() click to toggle source

Originating IP address, usually set by the RemoteIp middleware.

    # File lib/action_dispatch/http/request.rb, line 164
    def remote_ip
      @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
    end

request_method() click to toggle source

Returns the HTTP method that the application should see. In the case where the method was overridden by a middleware (for instance, if a HEAD request was converted to a GET, or if a _method parameter was used to determine the method the application should use), this method returns the overridden value, not the original.

    # File lib/action_dispatch/http/request.rb, line 72
    def request_method
      @request_method ||= check_method(env["REQUEST_METHOD"])
    end

request_method_symbol() click to toggle source

Returns a symbol form of the request_method

    # File lib/action_dispatch/http/request.rb, line 77
    def request_method_symbol
      HTTP_METHOD_LOOKUP[request_method]
    end

request_parameters() click to toggle source
Alias for: POST
reset_session() click to toggle source

TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.

    # File lib/action_dispatch/http/request.rb, line 215
    def reset_session
      session.destroy if session && session.respond_to?(:destroy)
      self.session = {}
      @env['action_dispatch.request.flash_hash'] = nil
    end

server_software() click to toggle source

Returns the lowercase name of the HTTP server software.

    # File lib/action_dispatch/http/request.rb, line 179
    def server_software
      (@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil
    end

session_options=(options) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 225
    def session_options=(options)
      @env['rack.session.options'] = options
    end

uuid() click to toggle source

Returns the unique request id, which is based off either the X-Request-Id header that can be generated by a firewall, load balancer, or web server or by the RequestId middleware (which sets the action_dispatch.request_id environment variable).

This unique ID is useful for tracing a request from end-to-end as part of logging or debugging. This relies on the rack variable set by the ActionDispatch::RequestId middleware.

    # File lib/action_dispatch/http/request.rb, line 174
    def uuid
      @uuid ||= env["action_dispatch.request_id"]
    end

xhr?() click to toggle source
Alias for: xml_http_request?
xml_http_request?() click to toggle source

Returns true if the "X-Requested-With" header contains "XMLHttpRequest" (case-insensitive). All major JavaScript libraries send this header with every Ajax request.

    # File lib/action_dispatch/http/request.rb, line 154
    def xml_http_request?
      @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/
    end

Also aliased as: xhr?

### Protected Instance Methods

parse_query(qs) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 274
    def parse_query(qs)
      deep_munge(super)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.