модуль URI
URI — это модуль, предоставляющий классы для работы с универсальными идентификаторами ресурсов (RFC2396).
Функциональные возможности
-
Единый способ обработки URI.
-
Гибкость в добавлении пользовательских схем
URI. -
Гибкость в использовании альтернативного
URI::Parser(или просто различных шаблонов и регулярных выражений).
Базовый пример
require 'uri'
uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
#=> #<URI::HTTP http://foo.com/posts?id=30&limit=5#time=1305298413>
uri.scheme #=> "http"
uri.host #=> "foo.com"
uri.path #=> "/posts"
uri.query #=> "id=30&limit=5"
uri.fragment #=> "time=1305298413"
uri.to_s #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"
Добавление пользовательских URI
module URI
class RSYNC < Generic
DEFAULT_PORT = 873
end
register_scheme 'RSYNC', RSYNC
end
#=> URI::RSYNC
URI.scheme_list
#=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP,
# "HTTPS"=>URI::HTTPS, "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS,
# "MAILTO"=>URI::MailTo, "RSYNC"=>URI::RSYNC}
uri = URI("rsync://rsync.foo.com")
#=> #<URI::RSYNC rsync://rsync.foo.com>
Ссылки на RFC
Хорошее место для просмотра спецификации RFC — www.ietf.org/rfc.html.
Вот список всех связанных RFC:
Class дерево
-
URI::Generic(в uri/generic.rb)-
URI::File- (в uri/file.rb) -
URI::FTP- (в uri/ftp.rb) -
URI::HTTP- (в uri/http.rb)-
URI::HTTPS- (в uri/https.rb)
-
-
URI::LDAP- (в uri/ldap.rb)-
URI::LDAPS- (в uri/ldaps.rb)
-
-
URI::MailTo- (в uri/mailto.rb)
-
-
URI::Parser- (в uri/common.rb) -
URI::REGEXP- (в uri/common.rb)-
URI::REGEXP::PATTERN - (в uri/common.rb)
-
-
URI::Util - (в uri/common.rb)
-
URI::Error- (в uri/common.rb)-
URI::InvalidURIError- (в uri/common.rb) -
URI::InvalidComponentError- (в uri/common.rb) -
URI::BadURIError- (в uri/common.rb)
-
Информация об авторских правах
- Автор
-
Akira Yamada <akira@ruby-lang.org>
- Документация
-
Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru> Vincent Batts <vbatts@hashbangbash.com>
- Лицензия
-
Авторские права © 2001 akira yamada <akira@ruby-lang.org> Вы можете распространять и/или изменять его на тех же условиях, что и Ruby.
Константы
- DEFAULT_PARSER
- INITIAL_SCHEMES
- Parser
- REGEXP
- RFC3986_PARSER
- TBLENCURICOMP_
Методы публичного класса
# File lib/uri/common.rb, line 351 def self.decode_uri_component(str, enc=Encoding::UTF_8) _decode_uri_component(/%\h\h/, str, enc) end
Декодирует заданные str данные, закодированные в формате URL.
Это не декодирует + в пробел.
# File lib/uri/common.rb, line 438
def 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
ary
end Декодирует данные формы, закодированные в формате URL, из заданных str.
Декодирует данные application/x-www-form-urlencoded и возвращает массив массивов ключ-значение.
Это ссылается на url.spec.whatwg.org/#concept-urlencoded-parser, поэтому поддерживает только разделитель & и не поддерживает разделитель ;-.
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"}
# File lib/uri/common.rb, line 337 def self.decode_www_form_component(str, enc=Encoding::UTF_8) _decode_uri_component(/\+|%\h\h/, str, enc) end
Декодирует заданные str данные формы, закодированные в формате URL.
Это декодирует + в пробел.
# File lib/uri/common.rb, line 344 def self.encode_uri_component(str, enc=nil) _encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCURICOMP_, str, enc) end
Кодирует str с помощью кодирования URL.
Это кодирует пробел в %20 вместо +.
# File lib/uri/common.rb, line 402
def 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 Генерирует данные формы, закодированные в формате URL, из заданных enum.
Это генерирует данные application/x-www-form-urlencoded, определённые в HTML5, из объекта Enumerable.
Внутренне использует URI.encode_www_form_component(str).
Этот метод не преобразует кодировку заданных элементов, поэтому преобразуйте их перед вызовом этого метода, если вы хотите отправлять данные в кодировке, отличной от исходной, или смешанной кодировке. (Строки, которые закодированы в кодировке, несовместимой с HTML5 ASCII, преобразуются в UTF-8.)
Этот метод не обрабатывает файлы. Если вы отправляете файл, используйте multipart/form-data.
Это ссылается на 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"
# File lib/uri/common.rb, line 328 def self.encode_www_form_component(str, enc=nil) _encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_, str, enc) end
Кодирует заданные str в данные формы, закодированные в формате URL.
Этот метод не преобразует *, -, ., 0-9, A-Z, _, a-z, но преобразует пробел (ASCII) в + и преобразует другие символы в %XX.
Если enc задан, преобразуйте str в кодировку перед кодированием в проценты.
Это реализация www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.
# File lib/uri/common.rb, line 257 def self.extract(str, schemes = nil, &block) warn "URI.extract is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.extract(str, schemes, &block) end
Краткое описание
URI::extract(str[, schemes][,&blk])
Аргументы
Описание
Извлекает URI из строки. Если блок задан, итерируется по всем совпавшим URI. Возвращает nil, если блок задан, или массив с совпадениями.
Использование
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 lib/uri/common.rb, line 95
def 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 Создаёт экземпляр URI, используя схему для определения соответствующего класса из URI.scheme_list.
# File lib/uri/common.rb, line 229 def self.join(*str) RFC3986_PARSER.join(*str) end
Краткое описание
URI::join(str[, str, ...])
Аргументы
-
str -
Строка(и) для обработки, будут преобразованы в URI RFC3986 перед слиянием.
Описание
Объединяет URI.
Использование
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 lib/open-uri.rb, line 23
def self.open(name, *rest, &block)
if name.respond_to?(:open)
name.open(*rest, &block)
elsif name.respond_to?(:to_str) &&
%r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ name &&
(uri = URI.parse(name)).respond_to?(:open)
uri.open(*rest, &block)
else
super
end
end Позволяет открыть различные ресурсы, включая URI.
Если первый аргумент отвечает методу «open», «open» вызывается на нём с остальными аргументами.
Если первый аргумент — строка, начинающаяся с (protocol)://, она анализируется с помощью URI.parse. Если полученный объект отвечает методу «open», «open» вызывается на нём с остальными аргументами.
В противном случае, вызывается Kernel#open.
OpenURI::OpenRead#open предоставляет URI::HTTP#open, URI::HTTPS#open и URI::FTP#open, Kernel#open.
Мы можем принимать URI и строки, начинающиеся с http://, https:// и ftp://. В этих случаях открытый объект файла дополняется OpenURI::Meta.
# File lib/uri/common.rb, line 192 def self.parse(uri) RFC3986_PARSER.parse(uri) end
Краткое описание
URI::parse(uri_str)
Аргументы
Описание
Создаёт экземпляр одного из подклассов URI из строки.
Исключения
-
URI::InvalidURIError -
Выбрасывается, если переданный
URIне является корректным.
Использование
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"
Рекомендуется сначала ::escape переданного uri_str если есть какие-либо некорректные символы URI.
# File lib/uri/common.rb, line 294 def self.regexp(schemes = nil) warn "URI.regexp is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.make_regexp(schemes) end
Краткое описание
URI::regexp([match_schemes])
Аргументы
-
match_schemes -
Arrayсхем. Если задано, результирующее совпадение regexp с URI, схема которого является одной из схем совпадения.
Описание
Возвращает объект Regexp, который соответствует строкам, похожим на URI. Объект Regexp, возвращаемый этим методом, включает произвольное количество групп захвата (скобки). Не полагайтесь на их количество.
Использование
require 'uri' # extract first URI from html_string html_string.slice(URI.regexp) # remove ftp URIs html_string.sub(URI.regexp(['ftp']), '') # You should not rely on the number of parentheses html_string.scan(URI.regexp) do |*matches| p $& end
# File lib/uri/common.rb, line 76 def self.register_scheme(scheme, klass) Schemes.const_set(scheme.to_s.upcase, klass) end
Регистрирует заданную klass для экземпляризации при разборе URL с заданной scheme. Обратите внимание, что в настоящее время регистрируются только схемы, которые после .upcase являются допустимыми именами констант (не допускаются -/+/. ).
# File lib/uri/common.rb, line 81
def self.scheme_list
Schemes.constants.map { |name|
[name.to_s.upcase, Schemes.const_get(name)]
}.to_h
end Возвращает Hash определённых схем.
# File lib/uri/common.rb, line 155 def self.split(uri) RFC3986_PARSER.split(uri) end
Краткое описание
URI::split(uri)
Аргументы
Описание
Разделяет строку на следующие части и возвращает массив с результатом:
-
Схема
-
Пользовательские данные
-
Хост
-
Порт
-
Регистр
-
Путь
-
Непрозрачная часть
-
Запрос
-
Фрагмент
Использование
require 'uri'
URI.split("http://www.ruby-lang.org/")
# => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]
Приватные методы класса
# File lib/uri/common.rb, line 369
def self._decode_uri_component(regexp, str, enc)
raise ArgumentError, "invalid %-encoding (#{str})" if /%(?!\h\h)/.match?(str)
str.b.gsub(regexp, TBLDECWWWCOMP_).force_encoding(enc)
end # File lib/uri/common.rb, line 355
def self._encode_uri_component(regexp, table, str, enc)
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!(regexp, table)
str.force_encoding(Encoding::US_ASCII)
end
Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.