ActionDispatch::Http::URL

extract_domain(host, tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 22
        def extract_domain(host, tld_length)
          extract_domain_from(host, tld_length) if named_host?(host)
        end

🔎 See on GitHub

extract_subdomain(host, tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 46
        def extract_subdomain(host, tld_length)
          extract_subdomains(host, tld_length).join(".")
        end

🔎 See on GitHub

extract_subdomains(host, tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 32
        def extract_subdomains(host, tld_length)
          if named_host?(host)
            extract_subdomains_from(host, tld_length)
          else
            []
          end
        end

🔎 See on GitHub

full_url_for(options)

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 58
        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

🔎 See on GitHub

new()

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 186
      def initialize
        super
        @protocol = nil
        @port     = nil
      end

🔎 See on GitHub

path_for(options)

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 70
        def path_for(options)
          path = options[:script_name].to_s.chomp("/")
          path << options[:path] if options.key?(:path)

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

          path
        end

🔎 See on GitHub

url_for(options)

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 50
        def url_for(options)
          if options[:only_path]
            path_for options
          else
            full_url_for options
          end
        end

🔎 See on GitHub

domain(tld_length = @@tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 329
      def domain(tld_length = @@tld_length)
        ActionDispatch::Http::URL.extract_domain(host, tld_length)
      end

🔎 See on GitHub

host()

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

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

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 233
      def host
        raw_host_with_port.sub(/:\d+$/, "")
      end

🔎 See on GitHub

host_with_port()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 249
      def host_with_port
        "#{host}#{port_string}"
      end

🔎 See on GitHub

optional_port()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 300
      def optional_port
        standard_port? ? nil : port
      end

🔎 See on GitHub

port()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 260
      def port
        @port ||= begin
          if raw_host_with_port =~ /:(\d+)$/
            $1.to_i
          else
            standard_port
          end
        end
      end

🔎 See on GitHub

port_string()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 312
      def port_string
        standard_port? ? "" : ":#{port}"
      end

🔎 See on GitHub

protocol()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 207
      def protocol
        @protocol ||= ssl? ? "https://" : "http://"
      end

🔎 See on GitHub

raw_host_with_port()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 221
      def raw_host_with_port
        if forwarded = x_forwarded_host.presence
          forwarded.split(/,\s?/).last
        else
          get_header("HTTP_HOST") || "#{server_name || server_addr}:#{get_header('SERVER_PORT')}"
        end
      end

🔎 See on GitHub

server_port()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 323
      def server_port
        get_header("SERVER_PORT").to_i
      end

🔎 See on GitHub

standard_port()

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

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

📝 Source code

# File actionpack/lib/action_dispatch/http/url.rb, line 274
      def standard_port
        case protocol
        when "https://" then 443
        else 80
        end
      end

🔎 See on GitHub

standard_port?()

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 288
      def standard_port?
        port == standard_port
      end

🔎 See on GitHub

subdomain(tld_length = @@tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 345
      def subdomain(tld_length = @@tld_length)
        ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
      end

🔎 See on GitHub

subdomains(tld_length = @@tld_length)

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 code

# File actionpack/lib/action_dispatch/http/url.rb, line 337
      def subdomains(tld_length = @@tld_length)
        ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
      end

🔎 See on GitHub

url()

Returns the complete URL used for this request.

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

📝 Source code

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

🔎 See on GitHub

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

ActionDispatch::Http::URL

Methods

Constants

Class Public methods

extract_domain(host, tld_length)

extract_subdomain(host, tld_length)

extract_subdomains(host, tld_length)

full_url_for(options)

new()

path_for(options)

url_for(options)

Instance Public methods

domain(tld_length = @@tld_length)

host()

host_with_port()

optional_port()

port()

port_string()

protocol()

raw_host_with_port()

server_port()

standard_port()

standard_port?()

subdomain(tld_length = @@tld_length)

subdomains(tld_length = @@tld_length)

url()