модуль URI

Как URI.decode_www_form_component, за исключением того, что '+' сохраняется.

Возвращает пары имя/значение, полученные из заданной строки str, которая должна быть строкой ASCII.

Метод можно использовать для декодирования тела объекта Net::HTTPResponse res, для которого res['Content-Type'] имеет значение 'application/x-www-form-urlencoded'.

Возвращаемые данные представляют собой массив подмассивов из двух элементов; каждый подмассив — это пара имя/значение (оба элемента являются строками). Кодировка каждой возвращаемой строки — enc; недопустимые символы удаляются с помощью String#scrub.

Простой пример:

URI.decode_www_form('foo=0&bar=1&baz')
# => [["foo", "0"], ["bar", "1"], ["baz", ""]]

Возвращаемые строки подвергаются некоторым преобразованиям, аналогичным тем, которые выполняются в URI.decode_www_form_component:

URI.decode_www_form('f%23o=%2F&b-r=%24&b+z=%40')
# => [["f#o", "/"], ["b-r", "$"], ["b z", "@"]]

Заданная строка может содержать несколько разделителей подряд:

URI.decode_www_form('foo=0&&bar=1&&baz=2')
# => [["foo", "0"], ["", ""], ["bar", "1"], ["", ""], ["baz", "2"]]

Можно указать другой разделитель:

URI.decode_www_form('foo=0--bar=1--baz', separator: '--')
# => [["foo", "0"], ["bar", "1"], ["baz", ""]]

Возвращает строку, декодированную из заданной строки с URL-кодированием str.

Сначала заданная строка кодируется как Encoding::ASCII-8BIT (с помощью String#b), затем декодируется (как описано ниже), а в конце принудительно преобразуется в заданную кодировку enc.

Возвращаемая строка:

• Сохраняет:

  • Символы '*', '.', '-' и '_'.

  • Символы из диапазонов 'a'..'z', 'A'..'Z' и '0'..'9'.

  Пример:

  URI.decode_www_form_component('*.-_azAZ09')
  # => "*.-_azAZ09"
  

• Преобразует:

  • Символ '+' в символ ' '.

  • Каждую «процентную запись» в символ ASCII.

  Пример:

  URI.decode_www_form_component('Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A')
  # => "Here are some punctuation characters: ,;?:"
  

Связанный метод: URI.decode_uri_component (сохраняет '+').

Как URI.encode_www_form_component, за исключением того, что ' ' (пробел) кодируется как '%20' (вместо '+').

Возвращает строку с URL-кодированием, полученную из заданного объекта Enumerable enum.

Результат подходит для использования в качестве данных формы в HTTP-запросе, у которого Content-Type равно 'application/x-www-form-urlencoded'.

Возвращаемая строка состоит из элементов enum, каждый из которых преобразуется в одну или несколько строк с URL-кодированием; все строки объединяются символом '&'.

Простые примеры:

URI.encode_www_form([['foo', 0], ['bar', 1], ['baz', 2]])
# => "foo=0&bar=1&baz=2"
URI.encode_www_form({foo: 0, bar: 1, baz: 2})
# => "foo=0&bar=1&baz=2"

Возвращаемая строка формируется с помощью метода URI.encode_www_form_component, который преобразует некоторые символы:

URI.encode_www_form('f#o': '/', 'b-r': '$', 'b z': '@')
# => "f%23o=%2F&b-r=%24&b+z=%40"

Если enum подобен массиву, каждый элемент ele преобразуется в поле:

• Если ele — это массив из двух или более элементов, поле формируется из первых двух элементов (все остальные элементы игнорируются):

  name = URI.encode_www_form_component(ele[0], enc)
  value = URI.encode_www_form_component(ele[1], enc)
  "#{name}=#{value}"
  

  Примеры:

  URI.encode_www_form([%w[foo bar], %w[baz bat bah]])
  # => "foo=bar&baz=bat"
  URI.encode_www_form([['foo', 0], ['bar', :baz, 'bat']])
  # => "foo=0&bar=baz"
  

• Если ele — это массив из одного элемента, поле формируется из ele[0]:

  URI.encode_www_form_component(ele[0])
  

  Пример:

  URI.encode_www_form([['foo'], [:bar], [0]])
  # => "foo&bar&0"
  

• В противном случае поле формируется из ele:

  URI.encode_www_form_component(ele)
  

  Пример:

  URI.encode_www_form(['foo', :bar, 0])
  # => "foo&bar&0"
  

Элементы объекта enum, подобного массиву, могут быть смешанными:

URI.encode_www_form([['foo', 0], ['bar', 1, 2], ['baz'], :bat])
# => "foo=0&bar=1&baz&bat"

Если enum подобен хешу, каждая пара key/value преобразуется в одно или несколько полей:

• Если value можно преобразовать в массив, каждый элемент ele в value объединяется с key для формирования поля:

  name = URI.encode_www_form_component(key, enc)
  value = URI.encode_www_form_component(ele, enc)
  "#{name}=#{value}"
  

  Пример:

  URI.encode_www_form({foo: [:bar, 1], baz: [:bat, :bam, 2]})
  # => "foo=bar&foo=1&baz=bat&baz=bam&baz=2"
  

• В противном случае key и value объединяются для формирования поля:

  name = URI.encode_www_form_component(key, enc)
  value = URI.encode_www_form_component(value, enc)
  "#{name}=#{value}"
  

  Пример:

  URI.encode_www_form({foo: 0, bar: 1, baz: 2})
  # => "foo=0&bar=1&baz=2"
  

Элементы объекта enum, подобного хешу, могут быть смешанными:

URI.encode_www_form({foo: [0, 1], bar: 2})
# => "foo=0&foo=1&bar=2"

Возвращает строку с URL-кодированием, полученную из заданной строки str.

Возвращаемая строка:

• Сохраняет:

  • Символы '*', '.', '-' и '_'.

  • Символы из диапазонов 'a'..'z', 'A'..'Z' и '0'..'9'.

  Пример:

  URI.encode_www_form_component('*.-_azAZ09')
  # => "*.-_azAZ09"
  

• Преобразует:

  • Символ ' ' в символ '+'.

  • Любой другой символ в «процентную запись»; процентная запись для символа c — это '%%%X' % c.ord.

  Пример:

  URI.encode_www_form_component('Here are some punctuation characters: ,;?:')
  # => "Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A"
  

Кодировка:

• Если str имеет кодировку Encoding::ASCII_8BIT, аргумент enc игнорируется.

• В противном случае сначала str преобразуется в Encoding::UTF_8 (с подходящей заменой символов), а затем — в кодировку enc.

В обоих случаях кодировка возвращаемой строки принудительно устанавливается в Encoding::US_ASCII.

Связанный метод: URI.encode_uri_component (кодирует ' ' как '%20').

Возвращает новый объект, созданный на основе заданных scheme, arguments и default:

• Новый объект является экземпляром URI.scheme_list[scheme.upcase].

• Объект инициализируется вызовом инициализатора класса с использованием scheme и arguments. См. URI::Generic.new.

Примеры:

values = ['john.doe', 'www.example.com', '123', nil, '/forum/questions/', nil, 'tag=networking&order=newest', 'top']
URI.for('https', *values)
# => #<URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
URI.for('foo', *values, default: URI::HTTP)
# => #<URI::HTTP foo://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>

Объединяет заданные строки URI str в соответствии с RFC 2396.

Перед объединением каждая строка в str преобразуется в URI по RFC3986.

Примеры:

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>

Позволяет открывать различные ресурсы, в том числе URI.

Если первый аргумент отвечает на метод ‘open’, этот метод вызывается для него с остальными аргументами.

Если первый аргумент — строка, начинающаяся с (protocol)://, она разбирается методом URI.parse. Если полученный объект отвечает на метод ‘open’, этот метод вызывается для него с остальными аргументами.

В противном случае вызывается Kernel#open.

OpenURI::OpenRead#open предоставляет URI::HTTP#open, URI::HTTPS#open и URI::FTP#open, Kernel#open.

Метод принимает URI и строки, начинающиеся с http://, https:// и ftp://. В этих случаях объект открытого файла расширяется модулем OpenURI::Meta.

Возвращает новый объект URI, созданный из заданной строки uri:

URI.parse('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# => #<URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
URI.parse('http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# => #<URI::HTTP http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>

Рекомендуется сначала вызвать URI::RFC2396_PARSER.escape для строки uri, если она может содержать недопустимые символы URI>.

Устанавливает экземпляр парсера по умолчанию.

Регистрирует заданный klass как класс, экземпляр которого создаётся при разборе URI с заданной scheme:

URI.register_scheme('MS_SEARCH', URI::Generic) # => URI::Generic
URI.scheme_list['MS_SEARCH']                   # => URI::Generic

Обратите внимание: после вызова String#upcase для scheme результат должен быть допустимым именем константы.

Возвращает хеш определённых схем:

URI.scheme_list
# =>
{"MAILTO"=>URI::MailTo,
 "LDAPS"=>URI::LDAPS,
 "WS"=>URI::WS,
 "HTTP"=>URI::HTTP,
 "HTTPS"=>URI::HTTPS,
 "LDAP"=>URI::LDAP,
 "FILE"=>URI::File,
 "FTP"=>URI::FTP}

Связанный метод: URI.register_scheme.

Возвращает массив из 9 элементов, представляющий части URI, полученного из строки uri; каждый элемент массива — это строка или nil:

names = %w[scheme userinfo host port registry path opaque query fragment]
values = URI.split('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
names.zip(values)
# =>
[["scheme", "https"],
 ["userinfo", "john.doe"],
 ["host", "www.example.com"],
 ["port", "123"],
 ["registry", nil],
 ["path", "/forum/questions/"],
 ["opaque", nil],
 ["query", "tag=networking&order=newest"],
 ["fragment", "top"]]

Возвращает строку, декодируя символы, соответствующие regexp, из заданной строки с URL-кодированием str.

Возвращает строку, полученную из заданной строки str, в которой символы, соответствующие regexp, закодированы в URI согласно table.