Class/Module Index [+]

Quicksearch

ActionDispatch::Http::URL

Public Instance Methods

domain(tld_length = 1) click to toggle source

Returns the domain part of a host, such as "rubyonrails.org" in "www.rubyonrails.org". You can specify a different tld_length, such as 2 to catch rubyonrails.co.uk in "www.rubyonrails.co.uk".

# File lib/action_dispatch/http/url.rb, line 78
def domain(tld_length = 1)
  return nil unless named_host?(host)

  host.split('.').last(1 + tld_length).join('.')
end
host() click to toggle source

Returns the host for this request, such as example.com.

# File lib/action_dispatch/http/url.rb, line 34
def host
  raw_host_with_port.sub(/:\d+$/, '')
end
host_with_port() click to toggle source

Returns a host:port string for this request, such as "example.com" or "example.com:8080".

# File lib/action_dispatch/http/url.rb, line 40
def host_with_port
  "#{host}#{port_string}"
end
port() click to toggle source

Returns the port number of this request as an integer.

# File lib/action_dispatch/http/url.rb, line 45
def port
  if raw_host_with_port =~ /:(\d+)$/
    $1.to_i
  else
    standard_port
  end
end
port_string() click to toggle source

Returns a port suffix like ":8080" if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

# File lib/action_dispatch/http/url.rb, line 68
def port_string
  port == standard_port ? '' : ":#{port}"
end
protocol() click to toggle source

Returns 'https://' if this is an SSL request and 'http://' otherwise.

# File lib/action_dispatch/http/url.rb, line 15
def protocol
  ssl? ? 'https://' : 'http://'
end
raw_host_with_port() click to toggle source

Returns the host for this request, such as "example.com".

# File lib/action_dispatch/http/url.rb, line 25
def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"]
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end
request_uri() click to toggle source

Returns the request URI, accounting for server idiosyncrasies. WEBrick includes the full URL. IIS leaves REQUEST_URI blank.

# File lib/action_dispatch/http/url.rb, line 100
def request_uri
  ActiveSupport::Deprecation.warn "Using #request_uri is deprecated. Use fullpath instead.", caller
  fullpath
end
scheme() click to toggle source

Returns 'https' if this is an SSL request and 'http' otherwise.

# File lib/action_dispatch/http/url.rb, line 10
def scheme
  ssl? ? 'https' : 'http'
end
server_port() click to toggle source
# File lib/action_dispatch/http/url.rb, line 72
def server_port
  @env['SERVER_PORT'].to_i
end
ssl?() click to toggle source

Is this an SSL request?

# File lib/action_dispatch/http/url.rb, line 20
def ssl?
  @env['HTTPS'] == 'on' || @env['HTTP_X_FORWARDED_PROTO'] == 'https'
end
standard_port() click to toggle source

Returns the standard port number for this request's protocol.

# File lib/action_dispatch/http/url.rb, line 54
def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end
standard_port?() click to toggle source

Returns whether this request is using the standard port

# File lib/action_dispatch/http/url.rb, line 62
def standard_port?
  port == standard_port
end
subdomain(tld_length = 1) click to toggle source
# File lib/action_dispatch/http/url.rb, line 94
def subdomain(tld_length = 1)
  subdomains(tld_length).join('.')
end
subdomains(tld_length = 1) click to toggle source

Returns all the subdomains as an array, so ["dev", "www"] would be returned for "dev.www.rubyonrails.org". You can specify a different tld_length, such as 2 to catch ["www"] instead of ["www", "rubyonrails"] in "www.rubyonrails.co.uk".

# File lib/action_dispatch/http/url.rb, line 88
def subdomains(tld_length = 1)
  return [] unless named_host?(host)
  parts = host.split('.')
  parts[0..-(tld_length+2)]
end
url() click to toggle source

Returns the complete URL used for this request.

# File lib/action_dispatch/http/url.rb, line 5
def url
  protocol + host_with_port + fullpath
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.