Module: Bundler::URI

Included in:
Generic
Defined in:
lib/bundler/vendor/uri/lib/uri.rb,
lib/bundler/vendor/uri/lib/uri/ws.rb,
lib/bundler/vendor/uri/lib/uri/ftp.rb,
lib/bundler/vendor/uri/lib/uri/wss.rb,
lib/bundler/vendor/uri/lib/uri/file.rb,
lib/bundler/vendor/uri/lib/uri/http.rb,
lib/bundler/vendor/uri/lib/uri/ldap.rb,
lib/bundler/vendor/uri/lib/uri/https.rb,
lib/bundler/vendor/uri/lib/uri/ldaps.rb,
lib/bundler/vendor/uri/lib/uri/common.rb,
lib/bundler/vendor/uri/lib/uri/mailto.rb,
lib/bundler/vendor/uri/lib/uri/generic.rb,
lib/bundler/vendor/uri/lib/uri/version.rb,
lib/bundler/vendor/uri/lib/uri/rfc2396_parser.rb,
lib/bundler/vendor/uri/lib/uri/rfc3986_parser.rb

Overview

–

uri/common.rb

Author

Akira Yamada <akira@ruby-lang.org>

License

You can redistribute it and/or modify it under the same term as Ruby.

See Bundler::URI for general documentation

Defined Under Namespace

Modules: RFC2396_REGEXP, Util Classes: BadURIError, Error, FTP, File, Generic, HTTP, HTTPS, InvalidComponentError, InvalidURIError, LDAP, LDAPS, MailTo, RFC2396_Parser, RFC3986_Parser, WS, WSS

Constant Summary collapse

RFC2396_PARSER =

The default parser instance for RFC 2396.

RFC2396_Parser.new
RFC3986_PARSER =

The default parser instance for RFC 3986.

RFC3986_Parser.new
DEFAULT_PARSER =

The default parser instance.

RFC3986_PARSER
TBLENCWWWCOMP_ =

:nodoc:

{}
TBLENCURICOMP_ =

:nodoc:

TBLENCWWWCOMP_.dup.freeze
TBLDECWWWCOMP_ =

:nodoc:

{}
VERSION_CODE =

:stopdoc:

'010003'.freeze
VERSION = 
VERSION_CODE.scan(/../).collect{|n| n.to_i}.join('.').freeze

Class Method Summary collapse

Class Method Details

.const_missing(const) ⇒ Object

:nodoc:


47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 47

def self.const_missing(const) # :nodoc:
  if const == :REGEXP
    warn "Bundler::URI::REGEXP is obsolete. Use Bundler::URI::RFC2396_REGEXP explicitly.", uplevel: 1 if $VERBOSE
    Bundler::URI::RFC2396_REGEXP
  elsif value = RFC2396_PARSER.regexp[const]
    warn "Bundler::URI::#{const} is obsolete. Use RFC2396_PARSER.regexp[#{const.inspect}] explicitly.", uplevel: 1 if $VERBOSE
    value
  elsif value = RFC2396_Parser.const_get(const)
    warn "Bundler::URI::#{const} is obsolete. Use RFC2396_Parser::#{const} explicitly.", uplevel: 1 if $VERBOSE
    value
  else
    super
  end
end

.decode_uri_component(str, enc = Encoding::UTF_8) ⇒ Object

Like Bundler::URI.decode_www_form_component, except that '+' is preserved.


406
407
408
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 406

def self.decode_uri_component(str, enc=Encoding::UTF_8)
  _decode_uri_component(/%\h\h/, str, enc)
end

.decode_www_form(str, enc = Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false) ⇒ Object

Returns name/value pairs derived from the given string str, which must be an ASCII string.

The method may be used to decode the body of Net::HTTPResponse object res for which res['Content-Type'] is 'application/x-www-form-urlencoded'.

The returned data is an array of 2-element subarrays; each subarray is a name/value pair (both are strings). Each returned string has encoding enc, and has had invalid characters removed via String#scrub.

A simple example:

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

The returned strings have certain conversions, similar to those performed in Bundler::URI.decode_www_form_component:

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

The given string may contain consecutive separators:

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

A different separator may be specified:

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

Raises:

  • (ArgumentError) 

581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 581

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

.decode_www_form_component(str, enc = Encoding::UTF_8) ⇒ Object

Returns a string decoded from the given URL-encoded string str.

The given string is first encoded as Encoding::ASCII-8BIT (using String#b), then decoded (as below), and finally force-encoded to the given encoding enc.

The returned string:

  • Preserves:

    • Characters '*', '.', '-', and '_'.

    • Character in ranges 'a'..'z', 'A'..'Z', and '0'..'9'.

    Example:

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

  • Converts:

    • Character '+' to character ' '.

    • Each “percent notation” to an ASCII character.

    Example:

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

Related: Bundler::URI.decode_uri_component (preserves '+').


395
396
397
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 395

def self.decode_www_form_component(str, enc=Encoding::UTF_8)
  _decode_uri_component(/\+|%\h\h/, str, enc)
end

.encode_uri_component(str, enc = nil) ⇒ Object

Like Bundler::URI.encode_www_form_component, except that ' ' (space) is encoded as '%20' (instead of '+').


401
402
403
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 401

def self.encode_uri_component(str, enc=nil)
  _encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCURICOMP_, str, enc)
end

.encode_www_form(enum, enc = nil) ⇒ Object

Returns a URL-encoded string derived from the given Enumerable enum.

The result is suitable for use as form data for an HTTP request whose Content-Type is 'application/x-www-form-urlencoded'.

The returned string consists of the elements of enum, each converted to one or more URL-encoded strings, and all joined with character '&'.

Simple examples:

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

The returned string is formed using method Bundler::URI.encode_www_form_component, which converts certain characters:

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

When enum is Array-like, each element ele is converted to a field:

  • If ele is an array of two or more elements, the field is formed from its first two elements (and any additional elements are ignored):

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

    Examples:

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

  • If ele is an array of one element, the field is formed from ele[0]:

    Bundler::URI.encode_www_form_component(ele[0])

    Example:

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

  • Otherwise the field is formed from ele:

    Bundler::URI.encode_www_form_component(ele)

    Example:

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

The elements of an Array-like enum may be mixture:

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

When enum is Hash-like, each key/value pair is converted to one or more fields:

  • If value is Array-convertible, each element ele in value is paired with key to form a field:

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

    Example:

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

  • Otherwise, key and value are paired to form a field:

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

    Example:

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

The elements of a Hash-like enum may be mixture:

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


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 528

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

.encode_www_form_component(str, enc = nil) ⇒ Object

Returns a URL-encoded string derived from the given string str.

The returned string:

  • Preserves:

    • Characters '*', '.', '-', and '_'.

    • Character in ranges 'a'..'z', 'A'..'Z', and '0'..'9'.

    Example:

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

  • Converts:

    • Character ' ' to character '+'.

    • Any other character to “percent notation”; the percent notation for character c is '%%%X' % c.ord.

    Example:

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

Encoding:

  • If str has encoding Encoding::ASCII_8BIT, argument enc is ignored.

  • Otherwise str is converted first to Encoding::UTF_8 (with suitable character replacements), and then to encoding enc.

In either case, the returned string has forced encoding Encoding::US_ASCII.

Related: Bundler::URI.encode_uri_component (encodes ' ' as '%20').


362
363
364
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 362

def self.encode_www_form_component(str, enc=nil)
  _encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_, str, enc)
end

.extract(str, schemes = nil, &block) ⇒ Object

Synopsis

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

Args

str

String to extract URIs from.

schemes

Limit Bundler::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 "bundler/vendor/uri/lib/uri"

Bundler::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"]


266
267
268
269
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 266

def self.extract(str, schemes = nil, &block) # :nodoc:
  warn "Bundler::URI.extract is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.extract(str, schemes, &block)
end

.for(scheme, *arguments, default: Generic) ⇒ Object

Returns a new object constructed from the given scheme, arguments, and default:

  • The new object is an instance of Bundler::URI.scheme_list[scheme.upcase].

  • The object is initialized by calling the class initializer using scheme and arguments. See Bundler::URI::Generic.new.

Examples:

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


150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 150

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

.join(*str) ⇒ Object

Merges the given Bundler::URI strings str per RFC 2396.

Each string in str is converted to an RFC3986 Bundler::URI before being merged.

Examples:

Bundler::URI.join("http://example.com/","main.rbx")
# => #<Bundler::URI::HTTP http://example.com/main.rbx>

Bundler::URI.join('http://example.com', 'foo')
# => #<Bundler::URI::HTTP http://example.com/foo>

Bundler::URI.join('http://example.com', '/foo', '/bar')
# => #<Bundler::URI::HTTP http://example.com/bar>

Bundler::URI.join('http://example.com', '/foo', 'bar')
# => #<Bundler::URI::HTTP http://example.com/bar>

Bundler::URI.join('http://example.com', '/foo/', 'bar')
# => #<Bundler::URI::HTTP http://example.com/foo/bar>


238
239
240
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 238

def self.join(*str)
  DEFAULT_PARSER.join(*str)
end

.parse(uri) ⇒ Object

Returns a new Bundler::URI object constructed from the given string uri:

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

It’s recommended to first ::escape string uri if it may contain invalid Bundler::URI characters.


211
212
213
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 211

def self.parse(uri)
  DEFAULT_PARSER.parse(uri)
end

.parser=(parser = RFC3986_PARSER) ⇒ Object

Set the default parser instance.


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 29

def self.parser=(parser = RFC3986_PARSER)
  remove_const(:Parser) if defined?(::Bundler::URI::Parser)
  const_set("Parser", parser.class)

  remove_const(:REGEXP) if defined?(::Bundler::URI::REGEXP)
  remove_const(:PATTERN) if defined?(::Bundler::URI::PATTERN)
  if Parser == RFC2396_Parser
    const_set("REGEXP", Bundler::URI::RFC2396_REGEXP)
    const_set("PATTERN", Bundler::URI::RFC2396_REGEXP::PATTERN)
  end

  Parser.new.regexp.each_pair do |sym, str|
    remove_const(sym) if const_defined?(sym, false)
    const_set(sym, str)
  end
end

.regexp(schemes = nil) ⇒ Object

Synopsis

Bundler::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 Bundler::URI-like strings. The Regexp object returned by this method includes arbitrary number of capture group (parentheses). Never rely on its number.

Usage

require 'bundler/vendor/uri/lib/uri'

# extract first Bundler::URI from html_string
html_string.slice(Bundler::URI.regexp)

# remove ftp URIs
html_string.sub(Bundler::URI.regexp(['ftp']), '')

# You should not rely on the number of parentheses
html_string.scan(Bundler::URI.regexp) do |*matches|
  p $&
end


303
304
305
306
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 303

def self.regexp(schemes = nil)# :nodoc:
  warn "Bundler::URI.regexp is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.make_regexp(schemes)
end

.register_scheme(scheme, klass) ⇒ Object

Registers the given klass as the class to be instantiated when parsing a Bundler::URI with the given scheme:

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

Note that after calling String#upcase on scheme, it must be a valid constant name.


106
107
108
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 106

def self.register_scheme(scheme, klass)
  Schemes.const_set(scheme.to_s.upcase, klass)
end

.scheme_list ⇒ Object

Returns a hash of the defined schemes:

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

Related: Bundler::URI.register_scheme.


124
125
126
127
128
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 124

def self.scheme_list
  Schemes.constants.map { |name|
    [name.to_s.upcase, Schemes.const_get(name)]
  }.to_h
end

.split(uri) ⇒ Object

Returns a 9-element array representing the parts of the Bundler::URI formed from the string uri; each array element is a string or nil:

names = %w[scheme userinfo host port registry path opaque query fragment]
values = Bundler::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"]]


197
198
199
 
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 197

def self.split(uri)
  DEFAULT_PARSER.split(uri)
end