ActionDispatch::Http::URL (original) (raw)

Methods

D

E

F

H

N

O

P

R

S

U

Constants

HOST_REGEXP = /(^[^:]+:\/\/)?(\[[^\]]+\]|[^:]+)(?::(\d+$))?/
IP_HOST_REGEXP = /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
PROTOCOL_REGEXP = /^([^:]+)(:)?(\/\/)?$/

Class Public methods

Returns the domain part of a host given the domain level.

# Top-level domain example
extract_domain('www.example.com', 1) # => "example.com"
# Second-level domain example
extract_domain('dev.www.example.co.uk', 2) # => "example.co.uk"

Source: show | on GitHub

def extract_domain(host, tld_length) extract_domain_from(host, tld_length) if named_host?(host) end

Returns the subdomains of a host as a String given the domain level.

# Top-level domain example
extract_subdomain('www.example.com', 1) # => "www"
# Second-level domain example
extract_subdomain('dev.www.example.co.uk', 2) # => "dev.www"

Source: show | on GitHub

def extract_subdomain(host, tld_length) extract_subdomains(host, tld_length).join(".") end

Returns the subdomains of a host as an Array given the domain level.

# Top-level domain example
extract_subdomains('www.example.com', 1) # => ["www"]
# Second-level domain example
extract_subdomains('dev.www.example.co.uk', 2) # => ["dev", "www"]

Source: show | on GitHub

def extract_subdomains(host, tld_length) if named_host?(host) extract_subdomains_from(host, tld_length) else [] end end

Source: show | on GitHub

def full_url_for(options) host = options[:host] protocol = options[:protocol] port = options[:port]

unless host raise ArgumentError, "Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true" end

build_host_url(host, port, protocol, options, path_for(options)) end

Source: show | on GitHub

def initialize super @protocol = nil @port = nil end

Source: show | on GitHub

def path_for(options) path = options[:script_name].to_s.chomp("/") path << options[:path] if options.key?(:path)

path = "/" if options[:trailing_slash] && path.blank?

add_params(path, options[:params]) if options.key?(:params) add_anchor(path, options[:anchor]) if options.key?(:anchor)

path end

Source: show | on GitHub

def url_for(options) if options[:only_path] path_for options else full_url_for options end end

Instance Public methods

domain(tld_length = @@tld_length)Link

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>”.

Source: show | on GitHub

def domain(tld_length = @@tld_length) ActionDispatch::Http::URL.extract_domain(host, tld_length) end

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.host # => "example.com"

Source: show | on GitHub

def host raw_host_with_port.sub(/:\d+$/, "") end

Returns a host:port string for this request, such as “example.com” or “example.com:8080”. Port is only included if it is not a default port (80 or 443)

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.host_with_port # => "example.com:8080"

Source: show | on GitHub

def host_with_port "#{host}#{port_string}" end

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.optional_port # => nil

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.optional_port # => 8080

Source: show | on GitHub

def optional_port standard_port? ? nil : port end

Returns the port number of this request as an integer.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.port # => 80

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.port # => 8080

Source: show | on GitHub

def port @port ||= if raw_host_with_port =~ /:(\d+)$/ $1.to_i else standard_port end end

Returns a string port suffix, including colon, like “:8080” if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.port_string # => ""

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.port_string # => ":8080"

Source: show | on GitHub

def port_string standard_port? ? "" : ":#{port}" end

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.protocol # => "http://"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com', 'HTTPS' => 'on'
req.protocol # => "https://"

Source: show | on GitHub

def protocol @protocol ||= ssl? ? "https://" : "http://" end

Returns the host and port for this request, such as “example.com:8080”.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.raw_host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.raw_host_with_port # => "example.com:80"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.raw_host_with_port # => "example.com:8080"

Source: show | on GitHub

def raw_host_with_port if forwarded = x_forwarded_host.presence forwarded.split(/,\s?/).last else get_header("HTTP_HOST") || "#{server_name}:#{get_header('SERVER_PORT')}" end end

Returns the requested port, such as 8080, based on SERVER_PORT

req = ActionDispatch::Request.new 'SERVER_PORT' => '80'
req.server_port # => 80

req = ActionDispatch::Request.new 'SERVER_PORT' => '8080'
req.server_port # => 8080

Source: show | on GitHub

def server_port get_header("SERVER_PORT").to_i end

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.standard_port # => 80

Source: show | on GitHub

def standard_port if "https://" == protocol 443 else 80 end end

Returns whether this request is using the standard port

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.standard_port? # => true

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.standard_port? # => false

Source: show | on GitHub

def standard_port? port == standard_port end

subdomain(tld_length = @@tld_length)Link

Returns all the subdomains as a string, 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>”.

Source: show | on GitHub

def subdomain(tld_length = @@tld_length) ActionDispatch::Http::URL.extract_subdomain(host, tld_length) end

subdomains(tld_length = @@tld_length)Link

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>”.

Source: show | on GitHub

def subdomains(tld_length = @@tld_length) ActionDispatch::Http::URL.extract_subdomains(host, tld_length) end

Returns the complete URL used for this request.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.url # => "http://example.com"

Source: show | on GitHub

def url protocol + host_with_port + fullpath end