Module: URI (Ruby 3.1.0) (2024)

Decodes URL-encoded form data from given str.

This decodes application/x-www-form-urlencoded data and returns an array of key-value arrays.

This refers url.spec.whatwg.org/#concept-urlencoded-parser, so this supports only &-separator, and doesn't support ;-separator.

ary = URI.decode_www_form("a=1&a=2&b=3")ary #=> [['a', '1'], ['a', '2'], ['b', '3']]ary.assoc('a').last #=> '1'ary.assoc('b').last #=> '3'ary.rassoc('a').last #=> '2'Hash[ary] #=> {"a"=>"2", "b"=>"3"}

See URI.decode_www_form_component, URI.encode_www_form.

 # File uri/common.rb, line 408def self.decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false) raise ArgumentError, "the input of #{self.name}.#{__method__} must be ASCII only string" unless str.ascii_only? ary = [] return ary if str.empty? enc = Encoding.find(enc) str.b.each_line(separator) do |string| string.chomp!(separator) key, sep, val = string.partition('=') if isindex if sep.empty? val = key key = +'' end isindex = false end if use__charset_ and key == '_charset_' and e = get_encoding(val) enc = e use__charset_ = false end key.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_) if val val.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_) else val = +'' end ary << [key, val] end ary.each do |k, v| k.force_encoding(enc) k.scrub! v.force_encoding(enc) v.scrub! end aryend 

Decodes given str of URL-encoded form data.

This decodes + to SP.

See URI.encode_www_form_component, URI.decode_www_form.

 # File uri/common.rb, line 340def self.decode_www_form_component(str, enc=Encoding::UTF_8) raise ArgumentError, "invalid %-encoding (#{str})" if /%(?!\h\h)/.match?(str) str.b.gsub(/\+|%\h\h/, TBLDECWWWCOMP_).force_encoding(enc)end 

Generates URL-encoded form data from given enum.

This generates application/x-www-form-urlencoded data defined in HTML5 from given an Enumerable object.

This internally uses URI.encode_www_form_component(str).

This method doesn't convert the encoding of given items, so convert them before calling this method if you want to send data as other than original encoding or mixed encoding data. (Strings which are encoded in an HTML5 ASCII incompatible encoding are converted to UTF-8.)

This method doesn't handle files. When you send a file, use multipart/form-data.

This refers url.spec.whatwg.org/#concept-urlencoded-serializer

URI.encode_www_form([["q", "ruby"], ["lang", "en"]])#=> "q=ruby&lang=en"URI.encode_www_form("q" => "ruby", "lang" => "en")#=> "q=ruby&lang=en"URI.encode_www_form("q" => ["ruby", "perl"], "lang" => "en")#=> "q=ruby&q=perl&lang=en"URI.encode_www_form([["q", "ruby"], ["q", "perl"], ["lang", "en"]])#=> "q=ruby&q=perl&lang=en"

See URI.encode_www_form_component, URI.decode_www_form.

 # File uri/common.rb, line 372def self.encode_www_form(enum, enc=nil) enum.map do |k,v| if v.nil? encode_www_form_component(k, enc) elsif v.respond_to?(:to_ary) v.to_ary.map do |w| str = encode_www_form_component(k, enc) unless w.nil? str << '=' str << encode_www_form_component(w, enc) end end.join('&') else str = encode_www_form_component(k, enc) str << '=' str << encode_www_form_component(v, enc) end end.join('&')end 

Encodes given str to URL-encoded form data.

This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP (ASCII space) to + and converts others to %XX.

If enc is given, convert str to the encoding before percent encoding.

This is an implementation of www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.

See URI.decode_www_form_component, URI.encode_www_form.

 # File uri/common.rb, line 322def self.encode_www_form_component(str, enc=nil) str = str.to_s.dup if str.encoding != Encoding::ASCII_8BIT if enc && enc != Encoding::ASCII_8BIT str.encode!(Encoding::UTF_8, invalid: :replace, undef: :replace) str.encode!(enc, fallback: ->(x){"&##{x.ord};"}) end str.force_encoding(Encoding::ASCII_8BIT) end str.gsub!(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_) str.force_encoding(Encoding::US_ASCII)end 

Synopsis¶ ↑

URI::extract(str[, schemes][,&blk])

Args¶ ↑

str

String to extract URIs from.

schemes

Limit URI matching to specific schemes.

Description¶ ↑

Extracts URIs from a string. If block given, iterates through all matched URIs. Returns nil if block given or array with matches.

Usage¶ ↑

require "uri"URI.extract("text here http://foo.example.org/bla and here mailto:test@example.com and here also.")# => ["http://foo.example.com/bla", "mailto:test@example.com"]

 # File uri/common.rb, line 252def self.extract(str, schemes = nil, &block) warn "URI.extract is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.extract(str, schemes, &block)end 

Construct a URI instance, using the scheme to detect the appropriate class from URI.scheme_list.

 # File uri/common.rb, line 90def self.for(scheme, *arguments, default: Generic) const_name = scheme.to_s.upcase uri_class = INITIAL_SCHEMES[const_name] uri_class ||= if /\A[A-Z]\w*\z/.match?(const_name) && Schemes.const_defined?(const_name, false) Schemes.const_get(const_name, false) end uri_class ||= default return uri_class.new(scheme, *arguments)end 

Synopsis¶ ↑

URI::join(str[, str, ...])

Args¶ ↑

str

String(s) to work with, will be converted to RFC3986 URIs before merging.

Description¶ ↑

Joins URIs.

Usage¶ ↑

require 'uri'URI.join("http://example.com/","main.rbx")# => #<URI::HTTP http://example.com/main.rbx>URI.join('http://example.com', 'foo')# => #<URI::HTTP http://example.com/foo>URI.join('http://example.com', '/foo', '/bar')# => #<URI::HTTP http://example.com/bar>URI.join('http://example.com', '/foo', 'bar')# => #<URI::HTTP http://example.com/bar>URI.join('http://example.com', '/foo/', 'bar')# => #<URI::HTTP http://example.com/foo/bar>

 # File uri/common.rb, line 224def self.join(*str) RFC3986_PARSER.join(*str)end 

Synopsis¶ ↑

URI::parse(uri_str)

Args¶ ↑

uri_str

String with URI.

Description¶ ↑

Creates one of the URI's subclasses instance from the string.

Raises¶ ↑

URI::InvalidURIError

Raised if URI given is not a correct one.

Usage¶ ↑

require 'uri'uri = URI.parse("http://www.ruby-lang.org/")# => #<URI::HTTP http://www.ruby-lang.org/>uri.scheme# => "http"uri.host# => "www.ruby-lang.org"

It's recommended to first ::escape the provided uri_str if there are any invalid URI characters.

 # File uri/common.rb, line 187def self.parse(uri) RFC3986_PARSER.parse(uri)end 

Synopsis¶ ↑

URI::regexp([match_schemes])

Args¶ ↑

match_schemes

Array of schemes. If given, resulting regexp matches to URIs whose scheme is one of the match_schemes.

Description¶ ↑

Returns a Regexp object which matches to URI-like strings. The Regexp object returned by this method includes arbitrary number of capture group (parentheses). Never rely on its number.

Usage¶ ↑

require 'uri'# extract first URI from html_stringhtml_string.slice(URI.regexp)# remove ftp URIshtml_string.sub(URI.regexp(['ftp']), '')# You should not rely on the number of parentheseshtml_string.scan(URI.regexp) do |*matches| p $&end

 # File uri/common.rb, line 289def self.regexp(schemes = nil) warn "URI.regexp is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.make_regexp(schemes)end 

Returns a Hash of the defined schemes.

 # File uri/common.rb, line 76def self.scheme_list Schemes.constants.map { |name| [name.to_s.upcase, Schemes.const_get(name)] }.to_hend 

Synopsis¶ ↑

URI::split(uri)

Args¶ ↑

uri

String with URI.

Description¶ ↑

Splits the string on following parts and returns array with result:

• Scheme

• Userinfo

• Host

• Port

• Registry

• Path

• Opaque

• Query

• Fragment

Usage¶ ↑

require 'uri'URI.split("http://www.ruby-lang.org/")# => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]

 # File uri/common.rb, line 150def self.split(uri) RFC3986_PARSER.split(uri)end