module Bundler::URI
Bundler::URI is a module providing classes to handle Uniform Resource Identifiers (RFC2396).
Features¶ ↑
-
Uniform way of handling URIs.
-
Flexibility to introduce custom Bundler::URI schemes.
-
Flexibility to have an alternate Bundler::URI::Parser (or just different patterns and regexp's).
Basic example¶ ↑
require 'bundler/vendor/uri/lib/uri' uri = Bundler::URI("http://foo.com/posts?id=30&limit=5#time=1305298413") #=> #<Bundler::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"
Adding custom URIs¶ ↑
module Bundler::URI class RSYNC < Generic DEFAULT_PORT = 873 end @@schemes['RSYNC'] = RSYNC end #=> Bundler::URI::RSYNC Bundler::URI.scheme_list #=> {"FILE"=>Bundler::URI::File, "FTP"=>Bundler::URI::FTP, "HTTP"=>Bundler::URI::HTTP, # "HTTPS"=>Bundler::URI::HTTPS, "LDAP"=>Bundler::URI::LDAP, "LDAPS"=>Bundler::URI::LDAPS, # "MAILTO"=>Bundler::URI::MailTo, "RSYNC"=>Bundler::URI::RSYNC} uri = Bundler::URI("rsync://rsync.foo.com") #=> #<Bundler::URI::RSYNC rsync://rsync.foo.com>
RFC References¶ ↑
A good place to view an RFC spec is www.ietf.org/rfc.html.
Here is a list of all related RFC's:
Class tree¶ ↑
-
Bundler::URI::Generic (in uri/generic.rb)
-
Bundler::URI::File - (in uri/file.rb)
-
Bundler::URI::FTP - (in uri/ftp.rb)
-
Bundler::URI::HTTP - (in uri/http.rb)
-
Bundler::URI::HTTPS - (in uri/https.rb)
-
-
Bundler::URI::LDAP - (in uri/ldap.rb)
-
Bundler::URI::LDAPS - (in uri/ldaps.rb)
-
-
Bundler::URI::MailTo - (in uri/mailto.rb)
-
-
Bundler::URI::Parser - (in uri/common.rb)
-
Bundler::URI::REGEXP - (in uri/common.rb)
-
Bundler::URI::REGEXP::PATTERN - (in uri/common.rb)
-
-
Bundler::URI::Util - (in uri/common.rb)
-
Bundler::URI::Escape - (in uri/common.rb)
-
Bundler::URI::Error - (in uri/common.rb)
-
Bundler::URI::InvalidURIError - (in uri/common.rb)
-
Bundler::URI::InvalidComponentError - (in uri/common.rb)
-
Bundler::URI::BadURIError - (in uri/common.rb)
-
Copyright Info¶ ↑
- Author
-
Akira Yamada <akira@ruby-lang.org>
- Documentation
-
Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru> Vincent Batts <vbatts@hashbangbash.com>
- License
-
Copyright © 2001 akira yamada <akira@ruby-lang.org> You can redistribute it and/or modify it under the same term as Ruby.
- Revision
-
$Id$
Constants
- DEFAULT_PARSER
Bundler::URI::Parser.new
- Parser
- REGEXP
- RFC3986_PARSER
Public Class Methods
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 ::decode_www_form_component, ::encode_www_form.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 453 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
Decodes given str
of URL-encoded form data.
This decodes + to SP.
See ::encode_www_form_component, ::decode_www_form.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 385 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
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 ::encode_www_form_component.
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 ::encode_www_form_component, ::decode_www_form.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 417 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
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 ::decode_www_form_component, ::encode_www_form.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 367 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
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"]
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 297 def self.extract(str, schemes = nil, &block) warn "Bundler::URI.extract is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.extract(str, schemes, &block) end
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>
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 269 def self.join(*str) RFC3986_PARSER.join(*str) end
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.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 232 def self.parse(uri) RFC3986_PARSER.parse(uri) end
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
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 334 def self.regexp(schemes = nil) warn "Bundler::URI.regexp is obsolete", uplevel: 1 if $VERBOSE DEFAULT_PARSER.make_regexp(schemes) end
Returns a Hash of the defined schemes.
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 143 def self.scheme_list @@schemes end
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]
# File lib/bundler/vendor/uri/lib/uri/common.rb, line 195 def self.split(uri) RFC3986_PARSER.split(uri) end