Module: Bundler::URI

Extended by:
Escape
Includes:
RFC2396_REGEXP
Included in:
Generic
Defined in:
lib/bundler/vendor/uri/lib/uri.rb,
lib/bundler/vendor/uri/lib/uri/ftp.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

frozen_string_literal: false

Defined Under Namespace

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

Constant Summary collapse

REGEXP =
RFC2396_REGEXP
Parser =
RFC2396_Parser
RFC3986_PARSER =
RFC3986_Parser.new
DEFAULT_PARSER =

Bundler::URI::Parser.new

Parser.new
TBLENCWWWCOMP_ =

:nodoc:

{}
TBLDECWWWCOMP_ =

:nodoc:

{}
VERSION_CODE =

:stopdoc:

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

Class Method Summary collapse

Methods included from Escape

escape, unescape

Class Method Details

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

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 = Bundler::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 Bundler::URI.decode_www_form_component, Bundler::URI.encode_www_form.

Raises:

  • (ArgumentError)

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 454

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

Decodes given str of URL-encoded form data.

This decodes + to SP.

See Bundler::URI.encode_www_form_component, Bundler::URI.decode_www_form.

Raises:

  • (ArgumentError)

386
387
388
389
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 386

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

.encode_www_form(enum, enc = nil) ⇒ Object

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

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

See Bundler::URI.encode_www_form_component, Bundler::URI.decode_www_form.


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 418

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

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 Bundler::URI.decode_www_form_component, Bundler::URI.encode_www_form.


368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 368

def 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

.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:[email protected] and here also.")
# => ["http://foo.example.com/bla", "mailto:[email protected]"]

298
299
300
301
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 298

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

.join(*str) ⇒ Object

Synopsis

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

Args

str

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

Description

Joins URIs.

Usage

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

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>

270
271
272
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 270

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

.parse(uri) ⇒ Object

Synopsis

Bundler::URI::parse(uri_str)

Args

uri_str

String with Bundler::URI.

Description

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

Raises

Bundler::URI::InvalidURIError

Raised if Bundler::URI given is not a correct one.

Usage

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

uri = Bundler::URI.parse("http://www.ruby-lang.org/")
# => #<Bundler::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 Bundler::URI characters.


233
234
235
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 233

def self.parse(uri)
  RFC3986_PARSER.parse(uri)
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 it's 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

335
336
337
338
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 335

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

.scheme_listObject

Returns a Hash of the defined schemes.


144
145
146
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 144

def self.scheme_list
  @@schemes
end

.split(uri) ⇒ Object

Synopsis

Bundler::URI::split(uri)

Args

uri

String with Bundler::URI.

Description

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

  • Scheme

  • Userinfo

  • Host

  • Port

  • Registry

  • Path

  • Opaque

  • Query

  • Fragment

Usage

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

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

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

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