Class: Addressable::URI

Inherits:
Object
  • Object
show all
Defined in:
lib/addressable/uri.rb

Overview

This is an implementation of a URI parser based on <a href=“RFC”>www.ietf.org/rfc/rfc3986.txt“>RFC 3986</a>, <a href=”RFC“>www.ietf.org/rfc/rfc3987.txt”>RFC 3987</a>.

Defined Under Namespace

Modules: CharacterClasses Classes: InvalidURIError

Constant Summary

SLASH =
'/'
EMPTY_STR =
''
URIREGEX =
/^(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?$/
PORT_MAPPING =
{
  "http" => 80,
  "https" => 443,
  "ftp" => 21,
  "tftp" => 69,
  "sftp" => 22,
  "ssh" => 22,
  "svn+ssh" => 22,
  "telnet" => 23,
  "nntp" => 119,
  "gopher" => 70,
  "wais" => 210,
  "ldap" => 389,
  "prospero" => 1525
}
NORMPATH =
/^(?!\/)[^\/:]*:.*$/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Addressable::URI

Creates a new uri object from component parts.

Parameters:

  • [String, (Hash)

    a customizable set of options



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
# File 'lib/addressable/uri.rb', line 776

def initialize(options={})
  if options.has_key?(:authority)
    if (options.keys & [:userinfo, :user, :password, :host, :port]).any?
      raise ArgumentError,
        "Cannot specify both an authority and any of the components " +
        "within the authority."
    end
  end
  if options.has_key?(:userinfo)
    if (options.keys & [:user, :password]).any?
      raise ArgumentError,
        "Cannot specify both a userinfo and either the user or password."
    end
  end

  self.defer_validation do
    # Bunch of crazy logic required because of the composite components
    # like userinfo and authority.
    self.scheme = options[:scheme] if options[:scheme]
    self.user = options[:user] if options[:user]
    self.password = options[:password] if options[:password]
    self.userinfo = options[:userinfo] if options[:userinfo]
    self.host = options[:host] if options[:host]
    self.port = options[:port] if options[:port]
    self.authority = options[:authority] if options[:authority]
    self.path = options[:path] if options[:path]
    self.query = options[:query] if options[:query]
    self.query_values = options[:query_values] if options[:query_values]
    self.fragment = options[:fragment] if options[:fragment]
  end
end

Class Method Details

.convert_path(path) ⇒ Addressable::URI

Converts a path to a file scheme URI. If the path supplied is relative, it will be returned as a relative URI. If the path supplied is actually a non-file URI, it will parse the URI as if it had been parsed with Addressable::URI.parse. Handles all of the various Microsoft-specific formats for specifying paths.

Examples:

base = Addressable::URI.convert_path("/absolute/path/")
uri = Addressable::URI.convert_path("relative/path")
(base + uri).to_s
#=> "file:///absolute/path/relative/path"

Addressable::URI.convert_path(
  "c:\\windows\\My Documents 100%20\\foo.txt"
).to_s
#=> "file:///c:/windows/My%20Documents%20100%20/foo.txt"

Addressable::URI.convert_path("http://example.com/").to_s
#=> "http://example.com/"

Parameters:

  • path (String, Addressable::URI, #to_str)

    Typically a String path to a file or directory, but will return a sensible return value if an absolute URI is supplied instead.

Returns:

  • (Addressable::URI)

    The parsed file scheme URI or the original URI if some other URI scheme was provided.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/addressable/uri.rb', line 244

def self.convert_path(path)
  # If we were given nil, return nil.
  return nil unless path
  # If a URI object is passed, just return itself.
  return path if path.kind_of?(self)
  if !path.respond_to?(:to_str)
    raise TypeError, "Can't convert #{path.class} into String."
  end
  # Otherwise, convert to a String
  path = path.to_str.strip

  path.gsub!(/^file:\/?\/?/, EMPTY_STR) if path =~ /^file:\/?\/?/
  path = SLASH + path if path =~ /^([a-zA-Z])[\|:]/
  uri = self.parse(path)

  if uri.scheme == nil
    # Adjust windows-style uris
    uri.path.gsub!(/^\/?([a-zA-Z])[\|:][\\\/]/) do
      "/#{$1.downcase}:/"
    end
    uri.path.gsub!(/\\/, SLASH)
    if File.exists?(uri.path) &&
        File.stat(uri.path).directory?
      uri.path.gsub!(/\/$/, EMPTY_STR)
      uri.path = uri.path + '/'
    end

    # If the path is absolute, set the scheme and host.
    if uri.path =~ /^\//
      uri.scheme = "file"
      uri.host = EMPTY_STR
    end
    uri.normalize!
  end

  return uri
end

.encode(uri, return_type = String) ⇒ String, Addressable::URI Also known as: escape

Percent encodes any special characters in the URI.

Parameters:

  • uri (String, Addressable::URI, #to_str)

    The URI to encode.

  • return_type (Class) (defaults to: String)

    The type of object to return. This value may only be set to String or Addressable::URI. All other values are invalid. Defaults to String.

Returns:

  • (String, Addressable::URI)

    The encoded URI. The return type is determined by the return_type parameter.



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
# File 'lib/addressable/uri.rb', line 561

def self.encode(uri, return_type=String)
  return nil if uri.nil?

  begin
    uri = uri.to_str
  rescue NoMethodError, TypeError
    raise TypeError, "Can't convert #{uri.class} into String."
  end if !uri.is_a? String

  if ![String, ::Addressable::URI].include?(return_type)
    raise TypeError,
      "Expected Class (String or Addressable::URI), " +
      "got #{return_type.inspect}"
  end
  uri_object = uri.kind_of?(self) ? uri : self.parse(uri)
  encoded_uri = Addressable::URI.new(
    :scheme => self.encode_component(uri_object.scheme,
      Addressable::URI::CharacterClasses::SCHEME),
    :authority => self.encode_component(uri_object.authority,
      Addressable::URI::CharacterClasses::AUTHORITY),
    :path => self.encode_component(uri_object.path,
      Addressable::URI::CharacterClasses::PATH),
    :query => self.encode_component(uri_object.query,
      Addressable::URI::CharacterClasses::QUERY),
    :fragment => self.encode_component(uri_object.fragment,
      Addressable::URI::CharacterClasses::FRAGMENT)
  )
  if return_type == String
    return encoded_uri.to_s
  elsif return_type == ::Addressable::URI
    return encoded_uri
  end
end

.form_encode(form_values, sort = false) ⇒ String

Encodes a set of key/value pairs according to the rules for the application/x-www-form-urlencoded MIME type.

Parameters:

  • form_values (#to_hash, #to_ary)

    The form values to encode.

  • sort (TrueClass, FalseClass) (defaults to: false)

    Sort the key/value pairs prior to encoding. Defaults to false.

Returns:

  • (String)

    The encoded value.



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
# File 'lib/addressable/uri.rb', line 686

def self.form_encode(form_values, sort=false)
  if form_values.respond_to?(:to_hash)
    form_values = form_values.to_hash.to_a
  elsif form_values.respond_to?(:to_ary)
    form_values = form_values.to_ary
  else
    raise TypeError, "Can't convert #{form_values.class} into Array."
  end

  form_values = form_values.inject([]) do |accu, (key, value)|
    if value.kind_of?(Array)
      value.each do |v|
        accu << [key.to_s, v.to_s]
      end
    else
      accu << [key.to_s, value.to_s]
    end
    accu
  end

  if sort
    # Useful for OAuth and optimizing caching systems
    form_values = form_values.sort
  end
  escaped_form_values = form_values.map do |(key, value)|
    # Line breaks are CRLF pairs
    [
      self.encode_component(
        key.gsub(/(\r\n|\n|\r)/, "\r\n"),
        CharacterClasses::UNRESERVED
      ).gsub("%20", "+"),
      self.encode_component(
        value.gsub(/(\r\n|\n|\r)/, "\r\n"),
        CharacterClasses::UNRESERVED
      ).gsub("%20", "+")
    ]
  end
  return (escaped_form_values.map do |(key, value)|
    "#{key}=#{value}"
  end).join("&")
end

.form_unencode(encoded_value) ⇒ Array

Decodes a String according to the rules for the application/x-www-form-urlencoded MIME type.

Parameters:

  • encoded_value (String, #to_str)

    The form values to decode.

Returns:

  • (Array)

    The decoded values. This is not a Hash because of the possibility for duplicate keys.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
# File 'lib/addressable/uri.rb', line 739

def self.form_unencode(encoded_value)
  if !encoded_value.respond_to?(:to_str)
    raise TypeError, "Can't convert #{encoded_value.class} into String."
  end
  encoded_value = encoded_value.to_str
  split_values = encoded_value.split("&").map do |pair|
    pair.split("=", 2)
  end
  return split_values.map do |(key, value)|
    [
      key ? self.unencode_component(
        key.gsub("+", "%20")).gsub(/(\r\n|\n|\r)/, "\n") : nil,
      value ? (self.unencode_component(
        value.gsub("+", "%20")).gsub(/(\r\n|\n|\r)/, "\n")) : nil
    ]
  end
end

.heuristic_parse(uri, hints = {}) ⇒ Addressable::URI

Converts an input to a URI. The input does not have to be a valid URI — the method will use heuristics to guess what URI was intended. This is not standards-compliant, merely user-friendly.

Parameters:

  • uri (String, Addressable::URI, #to_str)

    The URI string to parse. No parsing is performed if the object is already an Addressable::URI.

  • hints (Hash) (defaults to: {})

    A Hash of hints to the heuristic parser. Defaults to {:scheme => "http"}.

Returns:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/addressable/uri.rb', line 160

def self.heuristic_parse(uri, hints={})
  # If we were given nil, return nil.
  return nil unless uri
  # If a URI object is passed, just return itself.
  return uri.dup if uri.kind_of?(self)

  # If a URI object of the Ruby standard library variety is passed,
  # convert it to a string, then parse the string.
  # We do the check this way because we don't want to accidentally
  # cause a missing constant exception to be thrown.
  if uri.class.name =~ /^URI\b/
    uri = uri.to_s
  end

  if !uri.respond_to?(:to_str)
    raise TypeError, "Can't convert #{uri.class} into String."
  end
  # Otherwise, convert to a String
  uri = uri.to_str.dup
  hints = {
    :scheme => "http"
  }.merge(hints)
  case uri
  when /^http:\/+/
    uri.gsub!(/^http:\/+/, "http://")
  when /^https:\/+/
    uri.gsub!(/^https:\/+/, "https://")
  when /^feed:\/+http:\/+/
    uri.gsub!(/^feed:\/+http:\/+/, "feed:http://")
  when /^feed:\/+/
    uri.gsub!(/^feed:\/+/, "feed://")
  when /^file:\/+/
    uri.gsub!(/^file:\/+/, "file:///")
  when /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
    uri.gsub!(/^/, hints[:scheme] + "://")
  end
  parsed = self.parse(uri)
  if parsed.scheme =~ /^[^\/?#\.]+\.[^\/?#]+$/
    parsed = self.parse(hints[:scheme] + "://" + uri)
  end
  if parsed.path.include?(".")
    new_host = parsed.path[/^([^\/]+\.[^\/]*)/, 1]
    if new_host
      parsed.defer_validation do
        new_path = parsed.path.gsub(
          Regexp.new("^" + Regexp.escape(new_host)), EMPTY_STR)
        parsed.host = new_host
        parsed.path = new_path
        parsed.scheme = hints[:scheme] unless parsed.scheme
      end
    end
  end
  return parsed
end

.ip_based_schemesObject

Returns an array of known ip-based schemes. These schemes typically use a similar URI form: //<user>:<password>@<host>:<port>/<url-path>



1236
1237
1238
# File 'lib/addressable/uri.rb', line 1236

def self.ip_based_schemes
  return self.port_mapping.keys
end

.join(*uris) ⇒ Addressable::URI

Joins several URIs together.

Examples:

base = "http://example.com/"
uri = Addressable::URI.parse("relative/path")
Addressable::URI.join(base, uri)
#=> #<Addressable::URI:0xcab390 URI:http://example.com/relative/path>

Parameters:

Returns:



295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/addressable/uri.rb', line 295

def self.join(*uris)
  uri_objects = uris.collect do |uri|
    if !uri.respond_to?(:to_str)
      raise TypeError, "Can't convert #{uri.class} into String."
    end
    uri.kind_of?(self) ? uri : self.parse(uri.to_str)
  end
  result = uri_objects.shift.dup
  for uri in uri_objects
    result.join!(uri)
  end
  return result
end

.normalize_component(component, character_class = CharacterClasses::RESERVED + CharacterClasses::UNRESERVED, leave_encoded = '') ⇒ String

Normalizes the encoding of a URI component.

Examples:

Addressable::URI.normalize_component("simpl%65/%65xampl%65", "b-zB-Z")
=> "simple%2Fex%61mple"
Addressable::URI.normalize_component(
  "simpl%65/%65xampl%65", /[^b-zB-Z]/
)
=> "simple%2Fex%61mple"
Addressable::URI.normalize_component(
  "simpl%65/%65xampl%65",
  Addressable::URI::CharacterClasses::UNRESERVED
)
=> "simple%2Fexample"
Addressable::URI.normalize_component(
  "one%20two%2fthree%26four",
  "0-9a-zA-Z &/",
  "/"
)
=> "one two%2Fthree&four"

Parameters:

  • component (String, #to_str)

    The URI component to encode.

  • character_class (String, Regexp) (defaults to: CharacterClasses::RESERVED + CharacterClasses::UNRESERVED)

    The characters which are not percent encoded. If a String is passed, the String must be formatted as a regular expression character class. (Do not include the surrounding square brackets.) For example, "b-zB-Z0-9" would cause everything but the letters 'b' through 'z' and the numbers '0' through '9' to be percent encoded. If a Regexp is passed, the value /[^b-zB-Z0-9]/ would have the same effect. A set of useful String values may be found in the Addressable::URI::CharacterClasses module. The default value is the reserved plus unreserved character classes specified in <a href=“RFC”>www.ietf.org/rfc/rfc3986.txt“>RFC 3986</a>.

  • leave_encoded (String) (defaults to: '')

    When character_class is a String then leave_encoded is a string of characters that should remain percent encoded while normalizing the component; if they appear percent encoded in the original component, then they will be upcased (“%2f” normalized to “%2F”) but otherwise left alone.

Returns:

  • (String)

    The normalized component.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/addressable/uri.rb', line 496

def self.normalize_component(component, character_class=
    CharacterClasses::RESERVED + CharacterClasses::UNRESERVED,
    leave_encoded='')
  return nil if component.nil?

  begin
    component = component.to_str
  rescue NoMethodError, TypeError
    raise TypeError, "Can't convert #{component.class} into String."
  end if !component.is_a? String

  if ![String, Regexp].include?(character_class.class)
    raise TypeError,
      "Expected String or Regexp, got #{character_class.inspect}"
  end
  if character_class.kind_of?(String)
    leave_re = if leave_encoded.length > 0
      character_class = "#{character_class}%" unless character_class.include?('%')

      "|%(?!#{leave_encoded.chars.map do |char|
        seq = char.unpack('C*').map { |c| '%02x' % c }.join
        [seq.upcase, seq.downcase]
      end.flatten.join('|')})"
    end

    character_class = /[^#{character_class}]#{leave_re}/
  end
  if component.respond_to?(:force_encoding)
    # We can't perform regexps on invalid UTF sequences, but
    # here we need to, so switch to ASCII.
    component = component.dup
    component.force_encoding(Encoding::ASCII_8BIT)
  end
  unencoded = self.unencode_component(component, String, leave_encoded)
  begin
    encoded = self.encode_component(
      Addressable::IDNA.unicode_normalize_kc(unencoded),
      character_class,
      leave_encoded
    )
  rescue ArgumentError
    encoded = self.encode_component(unencoded)
  end
  if encoded.respond_to?(:force_encoding)
    encoded.force_encoding(Encoding::UTF_8)
  end
  return encoded
end

.normalized_encode(uri, return_type = String) ⇒ String, Addressable::URI

Normalizes the encoding of a URI. Characters within a hostname are not percent encoded to allow for internationalized domain names.

Parameters:

  • uri (String, Addressable::URI, #to_str)

    The URI to encode.

  • return_type (Class) (defaults to: String)

    The type of object to return. This value may only be set to String or Addressable::URI. All other values are invalid. Defaults to String.

Returns:

  • (String, Addressable::URI)

    The encoded URI. The return type is determined by the return_type parameter.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
# File 'lib/addressable/uri.rb', line 616

def self.normalized_encode(uri, return_type=String)
  begin
    uri = uri.to_str
  rescue NoMethodError, TypeError
    raise TypeError, "Can't convert #{uri.class} into String."
  end if !uri.is_a? String

  if ![String, ::Addressable::URI].include?(return_type)
    raise TypeError,
      "Expected Class (String or Addressable::URI), " +
      "got #{return_type.inspect}"
  end
  uri_object = uri.kind_of?(self) ? uri : self.parse(uri)
  components = {
    :scheme => self.unencode_component(uri_object.scheme),
    :user => self.unencode_component(uri_object.user),
    :password => self.unencode_component(uri_object.password),
    :host => self.unencode_component(uri_object.host),
    :port => (uri_object.port.nil? ? nil : uri_object.port.to_s),
    :path => self.unencode_component(uri_object.path),
    :query => self.unencode_component(uri_object.query),
    :fragment => self.unencode_component(uri_object.fragment)
  }
  components.each do |key, value|
    if value != nil
      begin
        components[key] =
          Addressable::IDNA.unicode_normalize_kc(value.to_str)
      rescue ArgumentError
        # Likely a malformed UTF-8 character, skip unicode normalization
        components[key] = value.to_str
      end
    end
  end
  encoded_uri = Addressable::URI.new(
    :scheme => self.encode_component(components[:scheme],
      Addressable::URI::CharacterClasses::SCHEME),
    :user => self.encode_component(components[:user],
      Addressable::URI::CharacterClasses::UNRESERVED),
    :password => self.encode_component(components[:password],
      Addressable::URI::CharacterClasses::UNRESERVED),
    :host => components[:host],
    :port => components[:port],
    :path => self.encode_component(components[:path],
      Addressable::URI::CharacterClasses::PATH),
    :query => self.encode_component(components[:query],
      Addressable::URI::CharacterClasses::QUERY),
    :fragment => self.encode_component(components[:fragment],
      Addressable::URI::CharacterClasses::FRAGMENT)
  )
  if return_type == String
    return encoded_uri.to_s
  elsif return_type == ::Addressable::URI
    return encoded_uri
  end
end

.parse(uri) ⇒ Addressable::URI

Returns a URI object based on the parsed string.

Parameters:

  • uri (String, Addressable::URI, #to_str)

    The URI string to parse. No parsing is performed if the object is already an Addressable::URI.

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/addressable/uri.rb', line 83

def self.parse(uri)
  # If we were given nil, return nil.
  return nil unless uri
  # If a URI object is passed, just return itself.
  return uri.dup if uri.kind_of?(self)

  # If a URI object of the Ruby standard library variety is passed,
  # convert it to a string, then parse the string.
  # We do the check this way because we don't want to accidentally
  # cause a missing constant exception to be thrown.
  if uri.class.name =~ /^URI\b/
    uri = uri.to_s
  end

  # Otherwise, convert to a String
  begin
    uri = uri.to_str
  rescue TypeError, NoMethodError
    raise TypeError, "Can't convert #{uri.class} into String."
  end if not uri.is_a? String

  # This Regexp supplied as an example in RFC 3986, and it works great.
  scan = uri.scan(URIREGEX)
  fragments = scan[0]
  scheme = fragments[1]
  authority = fragments[3]
  path = fragments[4]
  query = fragments[6]
  fragment = fragments[8]
  user = nil
  password = nil
  host = nil
  port = nil
  if authority != nil
    # The Regexp above doesn't split apart the authority.
    userinfo = authority[/^([^\[\]]*)@/, 1]
    if userinfo != nil
      user = userinfo.strip[/^([^:]*):?/, 1]
      password = userinfo.strip[/:(.*)$/, 1]
    end
    host = authority.gsub(
      /^([^\[\]]*)@/, EMPTY_STR
    ).gsub(
      /:([^:@\[\]]*?)$/, EMPTY_STR
    )
    port = authority[/:([^:@\[\]]*?)$/, 1]
  end
  if port == EMPTY_STR
    port = nil
  end

  return new(
    :scheme => scheme,
    :user => user,
    :password => password,
    :host => host,
    :port => port,
    :path => path,
    :query => query,
    :fragment => fragment
  )
end

.port_mappingObject

Returns a hash of common IP-based schemes and their default port numbers. Adding new schemes to this hash, as necessary, will allow for better URI normalization.



1243
1244
1245
# File 'lib/addressable/uri.rb', line 1243

def self.port_mapping
  PORT_MAPPING
end

.unencode(uri, return_type = String, leave_encoded = '') ⇒ String, Addressable::URI Also known as: unescape, unencode_component, unescape_component

Unencodes any percent encoded characters within a URI component. This method may be used for unencoding either components or full URIs, however, it is recommended to use the unencode_component alias when unencoding components.

Parameters:

  • uri (String, Addressable::URI, #to_str)

    The URI or component to unencode.

  • return_type (Class) (defaults to: String)

    The type of object to return. This value may only be set to String or Addressable::URI. All other values are invalid. Defaults to String.

  • leave_encoded (String) (defaults to: '')

    A string of characters to leave encoded. If a percent encoded character in this list is encountered then it will remain percent encoded.

Returns:

  • (String, Addressable::URI)

    The unencoded component or URI. The return type is determined by the return_type parameter.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/addressable/uri.rb', line 414

def self.unencode(uri, return_type=String, leave_encoded='')
  return nil if uri.nil?

  begin
    uri = uri.to_str
  rescue NoMethodError, TypeError
    raise TypeError, "Can't convert #{uri.class} into String."
  end if !uri.is_a? String
  if ![String, ::Addressable::URI].include?(return_type)
    raise TypeError,
      "Expected Class (String or Addressable::URI), " +
      "got #{return_type.inspect}"
  end
  uri = uri.dup
  # Seriously, only use UTF-8. I'm really not kidding!
  uri.force_encoding("utf-8") if uri.respond_to?(:force_encoding)
  leave_encoded.force_encoding("utf-8") if leave_encoded.respond_to?(:force_encoding)
  result = uri.gsub(/%[0-9a-f]{2}/iu) do |sequence|
    c = sequence[1..3].to_i(16).chr
    c.force_encoding("utf-8") if c.respond_to?(:force_encoding)
    leave_encoded.include?(c) ? sequence : c
  end
  result.force_encoding("utf-8") if result.respond_to?(:force_encoding)
  if return_type == String
    return result
  elsif return_type == ::Addressable::URI
    return ::Addressable::URI.parse(result)
  end
end

Instance Method Details

#==(uri) ⇒ TrueClass, FalseClass

Returns true if the URI objects are equal. This method normalizes both URIs before doing the comparison.

Parameters:

  • uri (Object)

    The URI to compare.

Returns:

  • (TrueClass, FalseClass)

    true if the URIs are equivalent, false otherwise.



2076
2077
2078
2079
# File 'lib/addressable/uri.rb', line 2076

def ==(uri)
  return false unless uri.kind_of?(URI)
  return self.normalize.to_s == uri.normalize.to_s
end

#===(uri) ⇒ TrueClass, FalseClass

Returns true if the URI objects are equal. This method normalizes both URIs before doing the comparison, and allows comparison against Strings.

Parameters:

  • uri (Object)

    The URI to compare.

Returns:

  • (TrueClass, FalseClass)

    true if the URIs are equivalent, false otherwise.



2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
# File 'lib/addressable/uri.rb', line 2054

def ===(uri)
  if uri.respond_to?(:normalize)
    uri_string = uri.normalize.to_s
  else
    begin
      uri_string = ::Addressable::URI.parse(uri).normalize.to_s
    rescue InvalidURIError, TypeError
      return false
    end
  end
  return self.normalize.to_s == uri_string
end

#absolute?TrueClass, FalseClass

Determines if the URI is absolute.

Returns:

  • (TrueClass, FalseClass)

    true if the URI is absolute. false otherwise.



1716
1717
1718
# File 'lib/addressable/uri.rb', line 1716

def absolute?
  return !relative?
end

#authorityString

The authority component for this URI. Combines the user, password, host, and port components.

Returns:

  • (String)

    The authority component.



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
# File 'lib/addressable/uri.rb', line 1141

def authority
  self.host && @authority ||= (begin
    authority = ""
    if self.userinfo != nil
      authority << "#{self.userinfo}@"
    end
    authority << self.host
    if self.port != nil
      authority << ":#{self.port}"
    end
    authority
  end)
end

#authority=(new_authority) ⇒ Object

Sets the authority component for this URI.

Parameters:

  • new_authority (String, #to_str)

    The new authority component.



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
# File 'lib/addressable/uri.rb', line 1177

def authority=(new_authority)
  if new_authority
    if !new_authority.respond_to?(:to_str)
      raise TypeError, "Can't convert #{new_authority.class} into String."
    end
    new_authority = new_authority.to_str
    new_userinfo = new_authority[/^([^\[\]]*)@/, 1]
    if new_userinfo
      new_user = new_userinfo.strip[/^([^:]*):?/, 1]
      new_password = new_userinfo.strip[/:(.*)$/, 1]
    end
    new_host = new_authority.gsub(
      /^([^\[\]]*)@/, EMPTY_STR
    ).gsub(
      /:([^:@\[\]]*?)$/, EMPTY_STR
    )
    new_port =
      new_authority[/:([^:@\[\]]*?)$/, 1]
  end

  # Password assigned first to ensure validity in case of nil
  self.password = defined?(new_password) ? new_password : nil
  self.user = defined?(new_user) ? new_user : nil
  self.host = defined?(new_host) ? new_host : nil
  self.port = defined?(new_port) ? new_port : nil

  # Reset dependant values
  @userinfo = nil
  @normalized_userinfo = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#basenameString

The basename, if any, of the file in the path component.

Returns:

  • (String)

    The path's basename.



1442
1443
1444
1445
# File 'lib/addressable/uri.rb', line 1442

def basename
  # Path cannot be nil
  return File.basename(self.path).gsub(/;[^\/]*$/, EMPTY_STR)
end

#default_portInteger

The default port for this URI's scheme. This method will always returns the default port for the URI's scheme regardless of the presence of an explicit port in the URI.

Returns:

  • (Integer)

    The default port.



1315
1316
1317
# File 'lib/addressable/uri.rb', line 1315

def default_port
  URI.port_mapping[self.scheme.strip.downcase] if self.scheme
end

#defer_validation(&block) ⇒ Object

This method allows you to make several changes to a URI simultaneously, which separately would cause validation errors, but in conjunction, are valid. The URI will be revalidated as soon as the entire block has been executed.

Parameters:

  • block (Proc)

    A set of operations to perform on a given URI.

Raises:

  • (LocalJumpError)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'lib/addressable/uri.rb', line 2235

def defer_validation(&block)
  raise LocalJumpError, "No block given." unless block
  @validation_deferred = true
  block.call()
  @validation_deferred = false
  validate
  return nil
end

#display_uriAddressable::URI

Creates a URI suitable for display to users. If semantic attacks are likely, the application should try to detect these and warn the user. See <a href=“RFC”>www.ietf.org/rfc/rfc3986.txt“>RFC 3986</a>, section 7.6 for more information.

Returns:



2038
2039
2040
2041
2042
# File 'lib/addressable/uri.rb', line 2038

def display_uri
  display_uri = self.normalize
  display_uri.host = ::Addressable::IDNA.to_unicode(display_uri.host)
  return display_uri
end

#dupAddressable::URI

Clones the URI object.

Returns:



2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
# File 'lib/addressable/uri.rb', line 2108

def dup
  duplicated_uri = self.class.new(
    :scheme => self.scheme ? self.scheme.dup : nil,
    :user => self.user ? self.user.dup : nil,
    :password => self.password ? self.password.dup : nil,
    :host => self.host ? self.host.dup : nil,
    :port => self.port,
    :path => self.path ? self.path.dup : nil,
    :query => self.query ? self.query.dup : nil,
    :fragment => self.fragment ? self.fragment.dup : nil
  )
  return duplicated_uri
end

#empty?TrueClass, FalseClass

Determines if the URI is an empty string.

Returns:

  • (TrueClass, FalseClass)

    Returns true if empty, false otherwise.



2170
2171
2172
# File 'lib/addressable/uri.rb', line 2170

def empty?
  return self.to_s.empty?
end

#eql?(uri) ⇒ TrueClass, FalseClass

Returns true if the URI objects are equal. This method does NOT normalize either URI before doing the comparison.

Parameters:

  • uri (Object)

    The URI to compare.

Returns:

  • (TrueClass, FalseClass)

    true if the URIs are equivalent, false otherwise.



2090
2091
2092
2093
# File 'lib/addressable/uri.rb', line 2090

def eql?(uri)
  return false unless uri.kind_of?(URI)
  return self.to_s == uri.to_s
end

#extnameString

The extname, if any, of the file in the path component. Empty string if there is no extension.

Returns:

  • (String)

    The path's extname.



1452
1453
1454
1455
# File 'lib/addressable/uri.rb', line 1452

def extname
  return nil unless self.path
  return File.extname(self.basename)
end

#fragmentString

The fragment component for this URI.

Returns:

  • (String)

    The fragment component.



1649
1650
1651
# File 'lib/addressable/uri.rb', line 1649

def fragment
  return instance_variable_defined?(:@fragment) ? @fragment : nil
end

#fragment=(new_fragment) ⇒ Object

Sets the fragment component for this URI.

Parameters:

  • new_fragment (String, #to_str)

    The new fragment component.



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
# File 'lib/addressable/uri.rb', line 1671

def fragment=(new_fragment)
  if new_fragment && !new_fragment.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_fragment.class} into String."
  end
  @fragment = new_fragment ? new_fragment.to_str : nil

  # Reset dependant values
  @normalized_fragment = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#freezeAddressable::URI

Freeze URI, initializing instance variables.

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
# File 'lib/addressable/uri.rb', line 812

def freeze
  self.normalized_scheme
  self.normalized_user
  self.normalized_password
  self.normalized_userinfo
  self.normalized_host
  self.normalized_port
  self.normalized_authority
  self.normalized_site
  self.normalized_path
  self.normalized_query
  self.normalized_fragment
  self.hash
  super
end

#hashInteger

A hash value that will make a URI equivalent to its normalized form.

Returns:

  • (Integer)

    A hash of the URI.



2100
2101
2102
# File 'lib/addressable/uri.rb', line 2100

def hash
  return @hash ||= (self.to_s.hash * -1)
end

#hostString

The host component for this URI.

Returns:

  • (String)

    The host component.



1055
1056
1057
# File 'lib/addressable/uri.rb', line 1055

def host
  return instance_variable_defined?(:@host) ? @host : nil
end

#host=(new_host) ⇒ Object

Sets the host component for this URI.

Parameters:

  • new_host (String, #to_str)

    The new host component.



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
# File 'lib/addressable/uri.rb', line 1084

def host=(new_host)
  if new_host && !new_host.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_host.class} into String."
  end
  @host = new_host ? new_host.to_str : nil

  unreserved = CharacterClasses::UNRESERVED
  sub_delims = CharacterClasses::SUB_DELIMS
  if @host != nil && (@host =~ /[<>{}\/\?\#\@]/ ||
      (@host[/^\[(.*)\]$/, 1] != nil && @host[/^\[(.*)\]$/, 1] !~
      Regexp.new("^[#{unreserved}#{sub_delims}:]*$")))
    raise InvalidURIError, "Invalid character in host: '#{@host.to_s}'"
  end

  # Reset dependant values
  @authority = nil
  @normalized_host = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#hostnameString

This method is same as URI::Generic#host except brackets for IPv6 (and 'IPvFuture') addresses are removed.

Returns:

  • (String)

    The hostname for this URI.

See Also:



1115
1116
1117
1118
# File 'lib/addressable/uri.rb', line 1115

def hostname
  v = self.host
  /\A\[(.*)\]\z/ =~ v ? $1 : v
end

#hostname=(new_hostname) ⇒ Object

This method is same as URI::Generic#host= except the argument can be a bare IPv6 address (or 'IPvFuture').

Parameters:

  • new_hostname (String, #to_str)

    The new hostname for this URI.

See Also:



1127
1128
1129
1130
1131
1132
1133
1134
# File 'lib/addressable/uri.rb', line 1127

def hostname=(new_hostname)
  if new_hostname && !new_hostname.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_hostname.class} into String."
  end
  v = new_hostname ? new_hostname.to_str : nil
  v = "[#{v}]" if /\A\[.*\]\z/ !~ v && /:/ =~ v
  self.host = v
end

#inferred_portInteger

The inferred port component for this URI. This method will normalize to the default port for the URI's scheme if the port isn't explicitly specified in the URI.

Returns:

  • (Integer)

    The inferred port component.



1301
1302
1303
1304
1305
1306
1307
# File 'lib/addressable/uri.rb', line 1301

def inferred_port
  if self.port.to_i == 0
    self.default_port
  else
    self.port.to_i
  end
end

#inspectString

Returns a String representation of the URI object's state.

Returns:

  • (String)

    The URI object's state, as a String.



2223
2224
2225
# File 'lib/addressable/uri.rb', line 2223

def inspect
  sprintf("#<%s:%#0x URI:%s>", URI.to_s, self.object_id, self.to_s)
end

#ip_based?TrueClass, FalseClass

Determines if the scheme indicates an IP-based protocol.

Returns:

  • (TrueClass, FalseClass)

    true if the scheme indicates an IP-based protocol. false otherwise.



1692
1693
1694
1695
1696
1697
1698
# File 'lib/addressable/uri.rb', line 1692

def ip_based?
  if self.scheme
    return URI.ip_based_schemes.include?(
      self.scheme.strip.downcase)
  end
  return false
end

#join(uri) ⇒ Addressable::URI Also known as: +

Joins two URIs together.

Parameters:

Returns:



1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
# File 'lib/addressable/uri.rb', line 1726

def join(uri)
  if !uri.respond_to?(:to_str)
    raise TypeError, "Can't convert #{uri.class} into String."
  end
  if !uri.kind_of?(URI)
    # Otherwise, convert to a String, then parse.
    uri = URI.parse(uri.to_str)
  end
  if uri.to_s.empty?
    return self.dup
  end

  joined_scheme = nil
  joined_user = nil
  joined_password = nil
  joined_host = nil
  joined_port = nil
  joined_path = nil
  joined_query = nil
  joined_fragment = nil

  # Section 5.2.2 of RFC 3986
  if uri.scheme != nil
    joined_scheme = uri.scheme
    joined_user = uri.user
    joined_password = uri.password
    joined_host = uri.host
    joined_port = uri.port
    joined_path = URI.normalize_path(uri.path)
    joined_query = uri.query
  else
    if uri.authority != nil
      joined_user = uri.user
      joined_password = uri.password
      joined_host = uri.host
      joined_port = uri.port
      joined_path = URI.normalize_path(uri.path)
      joined_query = uri.query
    else
      if uri.path == nil || uri.path.empty?
        joined_path = self.path
        if uri.query != nil
          joined_query = uri.query
        else
          joined_query = self.query
        end
      else
        if uri.path[0..0] == SLASH
          joined_path = URI.normalize_path(uri.path)
        else
          base_path = self.path.dup
          base_path = EMPTY_STR if base_path == nil
          base_path = URI.normalize_path(base_path)

          # Section 5.2.3 of RFC 3986
          #
          # Removes the right-most path segment from the base path.
          if base_path =~ /\//
            base_path.gsub!(/\/[^\/]+$/, SLASH)
          else
            base_path = EMPTY_STR
          end

          # If the base path is empty and an authority segment has been
          # defined, use a base path of SLASH
          if base_path.empty? && self.authority != nil
            base_path = SLASH
          end

          joined_path = URI.normalize_path(base_path + uri.path)
        end
        joined_query = uri.query
      end
      joined_user = self.user
      joined_password = self.password
      joined_host = self.host
      joined_port = self.port
    end
    joined_scheme = self.scheme
  end
  joined_fragment = uri.fragment

  return self.class.new(
    :scheme => joined_scheme,
    :user => joined_user,
    :password => joined_password,
    :host => joined_host,
    :port => joined_port,
    :path => joined_path,
    :query => joined_query,
    :fragment => joined_fragment
  )
end

#join!(uri) ⇒ Addressable::URI

Destructive form of join.

Parameters:

Returns:

See Also:



1829
1830
1831
# File 'lib/addressable/uri.rb', line 1829

def join!(uri)
  replace_self(self.join(uri))
end

#merge(hash) ⇒ Addressable::URI

Merges a URI with a Hash of components. This method has different behavior from join. Any components present in the hash parameter will override the original components. The path component is not treated specially.

Parameters:

Returns:

See Also:

  • Hash#merge


1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
# File 'lib/addressable/uri.rb', line 1844

def merge(hash)
  if !hash.respond_to?(:to_hash)
    raise TypeError, "Can't convert #{hash.class} into Hash."
  end
  hash = hash.to_hash

  if hash.has_key?(:authority)
    if (hash.keys & [:userinfo, :user, :password, :host, :port]).any?
      raise ArgumentError,
        "Cannot specify both an authority and any of the components " +
        "within the authority."
    end
  end
  if hash.has_key?(:userinfo)
    if (hash.keys & [:user, :password]).any?
      raise ArgumentError,
        "Cannot specify both a userinfo and either the user or password."
    end
  end

  uri = self.class.new
  uri.defer_validation do
    # Bunch of crazy logic required because of the composite components
    # like userinfo and authority.
    uri.scheme =
      hash.has_key?(:scheme) ? hash[:scheme] : self.scheme
    if hash.has_key?(:authority)
      uri.authority =
        hash.has_key?(:authority) ? hash[:authority] : self.authority
    end
    if hash.has_key?(:userinfo)
      uri.userinfo =
        hash.has_key?(:userinfo) ? hash[:userinfo] : self.userinfo
    end
    if !hash.has_key?(:userinfo) && !hash.has_key?(:authority)
      uri.user =
        hash.has_key?(:user) ? hash[:user] : self.user
      uri.password =
        hash.has_key?(:password) ? hash[:password] : self.password
    end
    if !hash.has_key?(:authority)
      uri.host =
        hash.has_key?(:host) ? hash[:host] : self.host
      uri.port =
        hash.has_key?(:port) ? hash[:port] : self.port
    end
    uri.path =
      hash.has_key?(:path) ? hash[:path] : self.path
    uri.query =
      hash.has_key?(:query) ? hash[:query] : self.query
    uri.fragment =
      hash.has_key?(:fragment) ? hash[:fragment] : self.fragment
  end

  return uri
end

#merge!(uri) ⇒ Addressable::URI

Destructive form of merge.

Parameters:

Returns:

See Also:



1909
1910
1911
# File 'lib/addressable/uri.rb', line 1909

def merge!(uri)
  replace_self(self.merge(uri))
end

#normalizeAddressable::URI

Returns a normalized URI object.

NOTE: This method does not attempt to fully conform to specifications. It exists largely to correct other people's failures to read the specifications, and also to deal with caching issues since several different URIs may represent the same resource and should not be cached multiple times.

Returns:



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
# File 'lib/addressable/uri.rb', line 2001

def normalize
  # This is a special exception for the frequently misused feed
  # URI scheme.
  if normalized_scheme == "feed"
    if self.to_s =~ /^feed:\/*http:\/*/
      return URI.parse(
        self.to_s[/^feed:\/*(http:\/*.*)/, 1]
      ).normalize
    end
  end

  return self.class.new(
    :scheme => normalized_scheme,
    :authority => normalized_authority,
    :path => normalized_path,
    :query => normalized_query,
    :fragment => normalized_fragment
  )
end

#normalize!Addressable::URI

Destructively normalizes this URI object.

Returns:

See Also:



2027
2028
2029
# File 'lib/addressable/uri.rb', line 2027

def normalize!
  replace_self(self.normalize)
end

#normalized_authorityString

The authority component for this URI, normalized.

Returns:

  • (String)

    The authority component, normalized.



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'lib/addressable/uri.rb', line 1159

def normalized_authority
  self.authority && @normalized_authority ||= (begin
    authority = ""
    if self.normalized_userinfo != nil
      authority << "#{self.normalized_userinfo}@"
    end
    authority << self.normalized_host
    if self.normalized_port != nil
      authority << ":#{self.normalized_port}"
    end
    authority
  end)
end

#normalized_fragmentString

The fragment component for this URI, normalized.

Returns:

  • (String)

    The fragment component, normalized.



1657
1658
1659
1660
1661
1662
1663
1664
1665
# File 'lib/addressable/uri.rb', line 1657

def normalized_fragment
  self.fragment && @normalized_fragment ||= (begin
    component = Addressable::URI.normalize_component(
      self.fragment,
      Addressable::URI::CharacterClasses::FRAGMENT
    )
    component == "" ? nil : component
  end)
end

#normalized_hostString

The host component for this URI, normalized.

Returns:

  • (String)

    The host component, normalized.



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'lib/addressable/uri.rb', line 1063

def normalized_host
  self.host && @normalized_host ||= (begin
    if !self.host.strip.empty?
      result = ::Addressable::IDNA.to_ascii(
        URI.unencode_component(self.host.strip.downcase)
      )
      if result =~ /[^\.]\.$/
        # Single trailing dots are unnecessary.
        result = result[0...-1]
      end
      result
    else
      EMPTY_STR
    end
  end)
end

#normalized_passwordString

The password component for this URI, normalized.

Returns:

  • (String)

    The password component, normalized.



943
944
945
946
947
948
949
950
951
952
953
954
955
# File 'lib/addressable/uri.rb', line 943

def normalized_password
  self.password && @normalized_password ||= (begin
    if self.normalized_scheme =~ /https?/ && self.password.strip.empty? &&
        (!self.user || self.user.strip.empty?)
      nil
    else
      Addressable::URI.normalize_component(
        self.password.strip,
        Addressable::URI::CharacterClasses::UNRESERVED
      )
    end
  end)
end

#normalized_pathString

The path component for this URI, normalized.

Returns:

  • (String)

    The path component, normalized.



1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
# File 'lib/addressable/uri.rb', line 1394

def normalized_path
  @normalized_path ||= (begin
    path = self.path.to_s
    if self.scheme == nil && path =~ NORMPATH
      # Relative paths with colons in the first segment are ambiguous.
      path = path.sub(":", "%2F")
    end
    # String#split(delimeter, -1) uses the more strict splitting behavior
    # found by default in Python.
    result = (path.strip.split(SLASH, -1).map do |segment|
      Addressable::URI.normalize_component(
        segment,
        Addressable::URI::CharacterClasses::PCHAR
      )
    end).join(SLASH)

    result = URI.normalize_path(result)
    if result.empty? &&
        ["http", "https", "ftp", "tftp"].include?(self.normalized_scheme)
      result = SLASH
    end
    result
  end)
end

#normalized_portInteger

The port component for this URI, normalized.

Returns:

  • (Integer)

    The port component, normalized.



1261
1262
1263
1264
1265
1266
1267
# File 'lib/addressable/uri.rb', line 1261

def normalized_port
  if URI.port_mapping[self.normalized_scheme] == self.port
    nil
  else
    self.port
  end
end

#normalized_query(*flags) ⇒ String

The query component for this URI, normalized.

Returns:

  • (String)

    The query component, normalized.



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
# File 'lib/addressable/uri.rb', line 1469

def normalized_query(*flags)
  modified_query_class = Addressable::URI::CharacterClasses::QUERY.dup
  # Make sure possible key-value pair delimiters are escaped.
  modified_query_class.sub!("\\&", "").sub!("\\;", "")
  pairs = (self.query || "").split("&", -1)
  pairs.sort! if flags.include?(:sorted)
  component = (pairs.map do |pair|
    Addressable::URI.normalize_component(pair, modified_query_class, "+")
  end).join("&")
  component == "" ? nil : component
end

#normalized_schemeString

The scheme component for this URI, normalized.

Returns:

  • (String)

    The scheme component, normalized.



840
841
842
843
844
845
846
847
848
849
850
851
# File 'lib/addressable/uri.rb', line 840

def normalized_scheme
  self.scheme && @normalized_scheme ||= (begin
    if self.scheme =~ /^\s*ssh\+svn\s*$/i
      "svn+ssh"
    else
      Addressable::URI.normalize_component(
        self.scheme.strip.downcase,
        Addressable::URI::CharacterClasses::SCHEME
      )
    end
  end)
end

#normalized_siteString

The normalized combination of components that represent a site. Combines the scheme, user, password, host, and port components. Primarily useful for HTTP and HTTPS.

For example, "http://example.com/path?query" would have a site value of "http://example.com".

Returns:

  • (String)

    The normalized components that identify a site.



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
# File 'lib/addressable/uri.rb', line 1346

def normalized_site
  self.site && @normalized_site ||= (begin
    site_string = ""
    if self.normalized_scheme != nil
      site_string << "#{self.normalized_scheme}:"
    end
    if self.normalized_authority != nil
      site_string << "//#{self.normalized_authority}"
    end
    site_string
  end)
end

#normalized_userString

The user component for this URI, normalized.

Returns:

  • (String)

    The user component, normalized.



890
891
892
893
894
895
896
897
898
899
900
901
902
# File 'lib/addressable/uri.rb', line 890

def normalized_user
  self.user && @normalized_user ||= (begin
    if normalized_scheme =~ /https?/ && self.user.strip.empty? &&
        (!self.password || self.password.strip.empty?)
      nil
    else
      Addressable::URI.normalize_component(
        self.user.strip,
        Addressable::URI::CharacterClasses::UNRESERVED
      )
    end
  end)
end

#normalized_userinfoString

The userinfo component for this URI, normalized.

Returns:

  • (String)

    The userinfo component, normalized.



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
# File 'lib/addressable/uri.rb', line 1007

def normalized_userinfo
  self.userinfo && @normalized_userinfo ||= (begin
    current_user = self.normalized_user
    current_password = self.normalized_password
    if !current_user && !current_password
      nil
    elsif current_user && current_password
      "#{current_user}:#{current_password}"
    elsif current_user && !current_password
      "#{current_user}"
    end
  end)
end

#omit(*components) ⇒ Addressable::URI

Omits components from a URI.

Examples:

uri = Addressable::URI.parse("http://example.com/path?query")
#=> #<Addressable::URI:0xcc5e7a URI:http://example.com/path?query>
uri.omit(:scheme, :authority)
#=> #<Addressable::URI:0xcc4d86 URI:/path?query>

Parameters:

  • *components (Symbol)

    The components to be omitted.

Returns:



2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
# File 'lib/addressable/uri.rb', line 2134

def omit(*components)
  invalid_components = components - [
    :scheme, :user, :password, :userinfo, :host, :port, :authority,
    :path, :query, :fragment
  ]
  unless invalid_components.empty?
    raise ArgumentError,
      "Invalid component names: #{invalid_components.inspect}."
  end
  duplicated_uri = self.dup
  duplicated_uri.defer_validation do
    components.each do |component|
      duplicated_uri.send((component.to_s + "=").to_sym, nil)
    end
    duplicated_uri.user = duplicated_uri.normalized_user
  end
  duplicated_uri
end

#omit!(*components) ⇒ Addressable::URI

Destructive form of omit.

Parameters:

  • *components (Symbol)

    The components to be omitted.

Returns:

See Also:



2161
2162
2163
# File 'lib/addressable/uri.rb', line 2161

def omit!(*components)
  replace_self(self.omit(*components))
end

#originString

The origin for this URI, serialized to ASCII, as per RFC 6454, section 6.2.

Returns:

  • (String)

    The serialized origin.



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
# File 'lib/addressable/uri.rb', line 1218

def origin
  return (if self.scheme && self.authority
    if self.normalized_port
      (
        "#{self.normalized_scheme}://#{self.normalized_host}" +
        ":#{self.normalized_port}"
      )
    else
      "#{self.normalized_scheme}://#{self.normalized_host}"
    end
  else
    "null"
  end)
end

#passwordString

The password component for this URI.

Returns:

  • (String)

    The password component.



935
936
937
# File 'lib/addressable/uri.rb', line 935

def password
  return instance_variable_defined?(:@password) ? @password : nil
end

#password=(new_password) ⇒ Object

Sets the password component for this URI.

Parameters:

  • new_password (String, #to_str)

    The new password component.



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
# File 'lib/addressable/uri.rb', line 961

def password=(new_password)
  if new_password && !new_password.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_password.class} into String."
  end
  @password = new_password ? new_password.to_str : nil

  # You can't have a nil user with a non-nil password
  @password ||= nil
  @user ||= nil
  if @password != nil
    @user = EMPTY_STR if @user.nil?
  end

  # Reset dependant values
  @userinfo = nil
  @normalized_userinfo = nil
  @authority = nil
  @normalized_password = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#pathString

The path component for this URI.

Returns:

  • (String)

    The path component.



1385
1386
1387
# File 'lib/addressable/uri.rb', line 1385

def path
  return instance_variable_defined?(:@path) ? @path : EMPTY_STR
end

#path=(new_path) ⇒ Object

Sets the path component for this URI.

Parameters:

  • new_path (String, #to_str)

    The new path component.



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
# File 'lib/addressable/uri.rb', line 1423

def path=(new_path)
  if new_path && !new_path.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_path.class} into String."
  end
  @path = (new_path || EMPTY_STR).to_str
  if !@path.empty? && @path[0..0] != SLASH && host != nil
    @path = "/#{@path}"
  end

  # Reset dependant values
  @normalized_path = nil
  @uri_string = nil
  @hash = nil
end

#portInteger

The port component for this URI. This is the port number actually given in the URI. This does not infer port numbers from default values.

Returns:

  • (Integer)

    The port component.



1253
1254
1255
# File 'lib/addressable/uri.rb', line 1253

def port
  return instance_variable_defined?(:@port) ? @port : nil
end

#port=(new_port) ⇒ Object

Sets the port component for this URI.

Parameters:

  • new_port (String, Integer, #to_s)

    The new port component.



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
# File 'lib/addressable/uri.rb', line 1273

def port=(new_port)
  if new_port != nil && new_port.respond_to?(:to_str)
    new_port = Addressable::URI.unencode_component(new_port.to_str)
  end
  if new_port != nil && !(new_port.to_s =~ /^\d+$/)
    raise InvalidURIError,
      "Invalid port number: #{new_port.inspect}"
  end

  @port = new_port.to_s.to_i
  @port = nil if @port == 0

  # Reset dependant values
  @authority = nil
  @normalized_port = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#queryString

The query component for this URI.

Returns:

  • (String)

    The query component.



1461
1462
1463
# File 'lib/addressable/uri.rb', line 1461

def query
  return instance_variable_defined?(:@query) ? @query : nil
end

#query=(new_query) ⇒ Object

Sets the query component for this URI.

Parameters:

  • new_query (String, #to_str)

    The new query component.



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'lib/addressable/uri.rb', line 1485

def query=(new_query)
  if new_query && !new_query.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_query.class} into String."
  end
  @query = new_query ? new_query.to_str : nil

  # Reset dependant values
  @normalized_query = nil
  @uri_string = nil
  @hash = nil
end

#query_values(return_type = Hash) ⇒ Hash, Array

Converts the query component to a Hash value.

Examples:

Addressable::URI.parse("?one=1&two=2&three=3").query_values
#=> {"one" => "1", "two" => "2", "three" => "3"}
Addressable::URI.parse("?one=two&one=three").query_values(Array)
#=> [["one", "two"], ["one", "three"]]
Addressable::URI.parse("?one=two&one=three").query_values(Hash)
#=> {"one" => "three"}

Parameters:

  • return_type (Class) (defaults to: Hash)

    The return type desired. Value must be either `Hash` or `Array`.

Returns:

  • (Hash, Array)

    The query string parsed as a Hash or Array object.



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
# File 'lib/addressable/uri.rb', line 1512

def query_values(return_type=Hash)
  empty_accumulator = Array == return_type ? [] : {}
  if return_type != Hash && return_type != Array
    raise ArgumentError, "Invalid return type. Must be Hash or Array."
  end
  return nil if self.query == nil
  split_query = (self.query.split("&").map do |pair|
    pair.split("=", 2) if pair && !pair.empty?
  end).compact
  return split_query.inject(empty_accumulator.dup) do |accu, pair|
    # I'd rather use key/value identifiers instead of array lookups,
    # but in this case I really want to maintain the exact pair structure,
    # so it's best to make all changes in-place.
    pair[0] = URI.unencode_component(pair[0])
    if pair[1].respond_to?(:to_str)
      # I loathe the fact that I have to do this. Stupid HTML 4.01.
      # Treating '+' as a space was just an unbelievably bad idea.
      # There was nothing wrong with '%20'!
      # If it ain't broke, don't fix it!
      pair[1] = URI.unencode_component(pair[1].to_str.gsub(/\+/, " "))
    end
    if return_type == Hash
      accu[pair[0]] = pair[1]
    else
      accu << pair
    end
    accu
  end
end

#query_values=(new_query_values) ⇒ Object

Sets the query component for this URI from a Hash object. An empty Hash or Array will result in an empty query string.

Examples:

uri.query_values = {:a => "a", :b => ["c", "d", "e"]}
uri.query
# => "a=a&b=c&b=d&b=e"
uri.query_values = [['a', 'a'], ['b', 'c'], ['b', 'd'], ['b', 'e']]
uri.query
# => "a=a&b=c&b=d&b=e"
uri.query_values = [['a', 'a'], ['b', ['c', 'd', 'e']]]
uri.query
# => "a=a&b=c&b=d&b=e"
uri.query_values = [['flag'], ['key', 'value']]
uri.query
# => "flag&key=value"

Parameters:

  • new_query_values (Hash, #to_hash, Array)

    The new query values.



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/addressable/uri.rb', line 1561

def query_values=(new_query_values)
  if new_query_values == nil
    self.query = nil
    return nil
  end

  if !new_query_values.is_a?(Array)
    if !new_query_values.respond_to?(:to_hash)
      raise TypeError,
        "Can't convert #{new_query_values.class} into Hash."
    end
    new_query_values = new_query_values.to_hash
    new_query_values = new_query_values.map do |key, value|
      key = key.to_s if key.kind_of?(Symbol)
      [key, value]
    end
    # Useful default for OAuth and caching.
    # Only to be used for non-Array inputs. Arrays should preserve order.
    new_query_values.sort!
  end

  # new_query_values have form [['key1', 'value1'], ['key2', 'value2']]
  buffer = ""
  new_query_values.each do |key, value|
    encoded_key = URI.encode_component(
      key, CharacterClasses::UNRESERVED
    )
    if value == nil
      buffer << "#{encoded_key}&"
    elsif value.kind_of?(Array)
      value.each do |sub_value|
        encoded_value = URI.encode_component(
          sub_value, CharacterClasses::UNRESERVED
        )
        buffer << "#{encoded_key}=#{encoded_value}&"
      end
    else
      encoded_value = URI.encode_component(
        value, CharacterClasses::UNRESERVED
      )
      buffer << "#{encoded_key}=#{encoded_value}&"
    end
  end
  self.query = buffer.chop
end

#relative?TrueClass, FalseClass

Determines if the URI is relative.

Returns:

  • (TrueClass, FalseClass)

    true if the URI is relative. false otherwise.



1706
1707
1708
# File 'lib/addressable/uri.rb', line 1706

def relative?
  return self.scheme.nil?
end

#request_uriString

The HTTP request URI for this URI. This is the path and the query string.

Returns:

  • (String)

    The request URI required for an HTTP request.



1612
1613
1614
1615
1616
1617
1618
# File 'lib/addressable/uri.rb', line 1612

def request_uri
  return nil if self.absolute? && self.scheme !~ /^https?$/
  return (
    (!self.path.empty? ? self.path : SLASH) +
    (self.query ? "?#{self.query}" : EMPTY_STR)
  )
end

#request_uri=(new_request_uri) ⇒ Object

Sets the HTTP request URI for this URI.

Parameters:

  • new_request_uri (String, #to_str)

    The new HTTP request URI.



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
# File 'lib/addressable/uri.rb', line 1624

def request_uri=(new_request_uri)
  if !new_request_uri.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_request_uri.class} into String."
  end
  if self.absolute? && self.scheme !~ /^https?$/
    raise InvalidURIError,
      "Cannot set an HTTP request URI for a non-HTTP URI."
  end
  new_request_uri = new_request_uri.to_str
  path_component = new_request_uri[/^([^\?]*)\?(?:.*)$/, 1]
  query_component = new_request_uri[/^(?:[^\?]*)\?(.*)$/, 1]
  path_component = path_component.to_s
  path_component = (!path_component.empty? ? path_component : SLASH)
  self.path = path_component
  self.query = query_component

  # Reset dependant values
  @uri_string = nil
  @hash = nil
end

#route_from(uri) ⇒ Addressable::URI

Returns the shortest normalized relative form of this URI that uses the supplied URI as a base for resolution. Returns an absolute URI if necessary. This is effectively the opposite of route_to.

Parameters:

Returns:

  • (Addressable::URI)

    The normalized relative URI that is equivalent to the original URI.



1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# File 'lib/addressable/uri.rb', line 1922

def route_from(uri)
  uri = URI.parse(uri).normalize
  normalized_self = self.normalize
  if normalized_self.relative?
    raise ArgumentError, "Expected absolute URI, got: #{self.to_s}"
  end
  if uri.relative?
    raise ArgumentError, "Expected absolute URI, got: #{uri.to_s}"
  end
  if normalized_self == uri
    return Addressable::URI.parse("##{normalized_self.fragment}")
  end
  components = normalized_self.to_hash
  if normalized_self.scheme == uri.scheme
    components[:scheme] = nil
    if normalized_self.authority == uri.authority
      components[:user] = nil
      components[:password] = nil
      components[:host] = nil
      components[:port] = nil
      if normalized_self.path == uri.path
        components[:path] = nil
        if normalized_self.query == uri.query
          components[:query] = nil
        end
      else
        if uri.path != SLASH and components[:path]
          self_splitted_path = split_path(components[:path])
          uri_splitted_path = split_path(uri.path)
          self_dir = self_splitted_path.shift
          uri_dir = uri_splitted_path.shift
          while !self_splitted_path.empty? && !uri_splitted_path.empty? and self_dir == uri_dir
            self_dir = self_splitted_path.shift
            uri_dir = uri_splitted_path.shift
          end
          components[:path] = (uri_splitted_path.fill('..') + [self_dir] + self_splitted_path).join(SLASH)
        end
      end
    end
  end
  # Avoid network-path references.
  if components[:host] != nil
    components[:scheme] = normalized_self.scheme
  end
  return Addressable::URI.new(
    :scheme => components[:scheme],
    :user => components[:user],
    :password => components[:password],
    :host => components[:host],
    :port => components[:port],
    :path => components[:path],
    :query => components[:query],
    :fragment => components[:fragment]
  )
end

#route_to(uri) ⇒ Addressable::URI

Returns the shortest normalized relative form of the supplied URI that uses this URI as a base for resolution. Returns an absolute URI if necessary. This is effectively the opposite of route_from.

Parameters:

Returns:

  • (Addressable::URI)

    The normalized relative URI that is equivalent to the supplied URI.



1987
1988
1989
# File 'lib/addressable/uri.rb', line 1987

def route_to(uri)
  return URI.parse(uri).route_from(self)
end

#schemeString

The scheme component for this URI.

Returns:

  • (String)

    The scheme component.



832
833
834
# File 'lib/addressable/uri.rb', line 832

def scheme
  return instance_variable_defined?(:@scheme) ? @scheme : nil
end

#scheme=(new_scheme) ⇒ Object

Sets the scheme component for this URI.

Parameters:

  • new_scheme (String, #to_str)

    The new scheme component.



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
# File 'lib/addressable/uri.rb', line 857

def scheme=(new_scheme)
  if new_scheme && !new_scheme.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_scheme.class} into String."
  elsif new_scheme
    new_scheme = new_scheme.to_str
  end
  if new_scheme && new_scheme !~ /[a-z][a-z0-9\.\+\-]*/i
    raise InvalidURIError, "Invalid scheme format."
  end
  @scheme = new_scheme
  @scheme = nil if @scheme.to_s.strip.empty?

  # Reset dependant values
  @normalized_scheme = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#siteString

The combination of components that represent a site. Combines the scheme, user, password, host, and port components. Primarily useful for HTTP and HTTPS.

For example, "http://example.com/path?query" would have a site value of "http://example.com".

Returns:

  • (String)

    The components that identify a site.



1328
1329
1330
1331
1332
1333
1334
1335
# File 'lib/addressable/uri.rb', line 1328

def site
  (self.scheme || self.authority) && @site ||= (begin
    site_string = ""
    site_string << "#{self.scheme}:" if self.scheme != nil
    site_string << "//#{self.authority}" if self.authority != nil
    site_string
  end)
end

#site=(new_site) ⇒ Object

Sets the site value for this URI.

Parameters:

  • new_site (String, #to_str)

    The new site value.



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
# File 'lib/addressable/uri.rb', line 1363

def site=(new_site)
  if new_site
    if !new_site.respond_to?(:to_str)
      raise TypeError, "Can't convert #{new_site.class} into String."
    end
    new_site = new_site.to_str
    # These two regular expressions derived from the primary parsing
    # expression
    self.scheme = new_site[/^(?:([^:\/?#]+):)?(?:\/\/(?:[^\/?#]*))?$/, 1]
    self.authority = new_site[
      /^(?:(?:[^:\/?#]+):)?(?:\/\/([^\/?#]*))?$/, 1
    ]
  else
    self.scheme = nil
    self.authority = nil
  end
end

#to_hashHash

Returns a Hash of the URI components.

Returns:

  • (Hash)

    The URI as a Hash of components.



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
# File 'lib/addressable/uri.rb', line 2206

def to_hash
  return {
    :scheme => self.scheme,
    :user => self.user,
    :password => self.password,
    :host => self.host,
    :port => self.port,
    :path => self.path,
    :query => self.query,
    :fragment => self.fragment
  }
end

#to_sString Also known as: to_str

Converts the URI to a String.

Returns:

  • (String)

    The URI's String representation.



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
# File 'lib/addressable/uri.rb', line 2178

def to_s
  if self.scheme == nil && self.path != nil && !self.path.empty? &&
      self.path =~ NORMPATH
    raise InvalidURIError,
      "Cannot assemble URI string with ambiguous path: '#{self.path}'"
  end
  @uri_string ||= (begin
    uri_string = ""
    uri_string << "#{self.scheme}:" if self.scheme != nil
    uri_string << "//#{self.authority}" if self.authority != nil
    uri_string << self.path.to_s
    uri_string << "?#{self.query}" if self.query != nil
    uri_string << "##{self.fragment}" if self.fragment != nil
    if uri_string.respond_to?(:force_encoding)
      uri_string.force_encoding(Encoding::UTF_8)
    end
    uri_string
  end)
end

#userString

The user component for this URI.

Returns:

  • (String)

    The user component.



882
883
884
# File 'lib/addressable/uri.rb', line 882

def user
  return instance_variable_defined?(:@user) ? @user : nil
end

#user=(new_user) ⇒ Object

Sets the user component for this URI.

Parameters:

  • new_user (String, #to_str)

    The new user component.



908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
# File 'lib/addressable/uri.rb', line 908

def user=(new_user)
  if new_user && !new_user.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_user.class} into String."
  end
  @user = new_user ? new_user.to_str : nil

  # You can't have a nil user with a non-nil password
  if password != nil
    @user = EMPTY_STR if @user.nil?
  end

  # Reset dependant values
  @userinfo = nil
  @normalized_userinfo = nil
  @authority = nil
  @normalized_user = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end

#userinfoString

The userinfo component for this URI. Combines the user and password components.

Returns:

  • (String)

    The userinfo component.



991
992
993
994
995
996
997
998
999
1000
1001
# File 'lib/addressable/uri.rb', line 991

def userinfo
  current_user = self.user
  current_password = self.password
  (current_user || current_password) && @userinfo ||= (begin
    if current_user && current_password
      "#{current_user}:#{current_password}"
    elsif current_user && !current_password
      "#{current_user}"
    end
  end)
end

#userinfo=(new_userinfo) ⇒ Object

Sets the userinfo component for this URI.

Parameters:

  • new_userinfo (String, #to_str)

    The new userinfo component.



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
# File 'lib/addressable/uri.rb', line 1025

def userinfo=(new_userinfo)
  if new_userinfo && !new_userinfo.respond_to?(:to_str)
    raise TypeError, "Can't convert #{new_userinfo.class} into String."
  end
  new_user, new_password = if new_userinfo
    [
      new_userinfo.to_str.strip[/^(.*):/, 1],
      new_userinfo.to_str.strip[/:(.*)$/, 1]
    ]
  else
    [nil, nil]
  end

  # Password assigned first to ensure validity in case of nil
  self.password = new_password
  self.user = new_user

  # Reset dependant values
  @authority = nil
  @uri_string = nil
  @hash = nil

  # Ensure we haven't created an invalid URI
  validate()
end