class Protocol::HTTP::Reference
A relative reference, excluding any authority. The path part of an HTTP request.
def self.[] reference
@parameter reference [Reference | String] The reference to type-cast.
Type-cast a reference.
def self.[] reference if reference.is_a? self return reference else return self.parse(reference) end end
def self.parse(path = "/", parameters = nil)
def self.parse(path = "/", parameters = nil) base, fragment = path.split("#", 2) path, query = base.split("?", 2) self.new(path, query, fragment, parameters) end
def + other
def + other other = self.class[other] self.class.new( expand_path(self.path, other.path, true), other.query, other.fragment, other.parameters, ) end
def <=> other
@parameter other [Reference] The other reference to compare.
Compare two references.
def <=> other to_ary <=> other.to_ary end
def append(buffer = String.new)
def append(buffer = String.new) if query? buffer << URL.escape_path(@path) << "?" << @query buffer << "&" << URL.encode(@parameters) if parameters? else buffer << URL.escape_path(@path) buffer << "?" << URL.encode(@parameters) if parameters? end if fragment? buffer << "#" << URL.escape(@fragment) end return buffer end
def base
def base self.class.new(@path, nil, nil, nil) end
def expand_absolute_path(path, parts)
def expand_absolute_path(path, parts) parts.each do |part| if part == ".." path.pop elsif part == "." # Do nothing. else path << part end end if path.first != "" path.unshift("") end end
def expand_path(base, relative, pop = true)
-
pop
(Boolean
) -- whether to remove the last path component of the base path, to conform to URI merging behaviour, as defined by RFC2396.
def expand_path(base, relative, pop = true) if relative.start_with? "/" return relative end path = split(base) # RFC2396 Section 5.2: # 6) a) All but the last segment of the base URI's path component is # copied to the buffer. In other words, any characters after the # last (right-most) slash character, if any, are excluded. path.pop if pop or path.last == "" parts = split(relative) # Absolute path: if path.first == "" expand_absolute_path(path, parts) else expand_relative_path(path, parts) end return path.join("/") end
def expand_relative_path(path, parts)
def expand_relative_path(path, parts) parts.each do |part| if part == ".." and path.any? path.pop elsif part == "." # Do nothing. else path << part end end end
def fragment?
def fragment? @fragment and !@fragment.empty? end
def freeze
Freeze the reference.
def freeze return self if frozen? @path.freeze @query.freeze @fragment.freeze @parameters.freeze super end
def initialize(path = "/", query = nil, fragment = nil, parameters = nil)
@parameter fragment [String | Nil] The fragment, the part after the '#'.
@parameter query [String | Nil] The un-parsed query string, e.g. 'x=10&y=20'.
@parameter path [String] The path component, e.g. `/foo/bar/index.html`.
Initialize the reference.
def initialize(path = "/", query = nil, fragment = nil, parameters = nil) @path = path @query = query @fragment = fragment @parameters = parameters end
def parameters?
def parameters? @parameters and !@parameters.empty? end
def query?
def query? @query and !@query.empty? end
def split(path)
def split(path) if path.empty? [path] else path.split("/", -1) end end
def to_ary
Implicit conversion to an array.
def to_ary [@path, @query, @fragment, @parameters] end
def to_s
Convert the reference to a string, e.g. `/foo/bar/index.html?x=10&y=20#section`
def to_s append end
def with(path: nil, parameters: nil, fragment: @fragment, pop: false, merge: true)
@argument pop [Boolean] If the path contains a trailing filename, pop the last component of the path before appending the new path.
@argument fragment [String] Set the fragment to this value.
@argument parameters [Hash] Append the parameters to this reference.
@argument path [String] Append the string to this reference similar to `File.join`.
Update the reference with the given path, parameters and fragment.
def with(path: nil, parameters: nil, fragment: @fragment, pop: false, merge: true) if @parameters if parameters and merge parameters = @parameters.merge(parameters) else parameters = @parameters end end if @query and !merge query = nil else query = @query end if path path = expand_path(@path, path, pop) else path = @path end self.class.new(path, query, fragment, parameters) end