1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
|
# frozen_string_literal: true
# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
module Protocol
module HTTP
module URL
# Escapes a string using percent encoding.
def self.escape(string, encoding = string.encoding)
string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
'%' + m.unpack('H2' * m.bytesize).join('%').upcase
end.force_encoding(encoding)
end
# Unescapes a percent encoded string.
def self.unescape(string, encoding = string.encoding)
string.b.gsub(/%(\h\h)/) do |hex|
Integer($1, 16).chr
end.force_encoding(encoding)
end
# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
# Escapes non-path characters using percent encoding.
def self.escape_path(path)
encoding = path.encoding
path.b.gsub(NON_PCHAR) do |m|
'%' + m.unpack('H2' * m.bytesize).join('%').upcase
end.force_encoding(encoding)
end
# Encodes a hash or array into a query string.
def self.encode(value, prefix = nil)
case value
when Array
return value.map {|v|
self.encode(v, "#{prefix}[]")
}.join("&")
when Hash
return value.map {|k, v|
self.encode(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
}.reject(&:empty?).join('&')
when nil
return prefix
else
raise ArgumentError, "value must be a Hash" if prefix.nil?
return "#{prefix}=#{escape(value.to_s)}"
end
end
# Scan a string for URL-encoded key/value pairs.
# @yields {|key, value| ...}
# @parameter key [String] The unescaped key.
# @parameter value [String] The unescaped key.
def self.scan(string)
string.split('&') do |assignment|
key, value = assignment.split('=', 2)
yield unescape(key), unescape(value)
end
end
def self.split(name)
name.scan(/([^\[]+)|(?:\[(.*?)\])/).flatten!.compact!
end
def self.assign(keys, value, parent)
top, *middle = keys
middle.each_with_index do |key, index|
if key.nil? or key.empty?
parent = (parent[top] ||= Array.new)
top = parent.size
if nested = middle[index+1] and last = parent.last
top -= 1 unless last.include?(nested)
end
else
parent = (parent[top] ||= Hash.new)
top = key
end
end
parent[top] = value
end
# TODO use native C extension from `Trenni::Reference`.
def self.decode(string, maximum = 8, symbolize_keys: false)
parameters = {}
self.scan(string) do |name, value|
keys = self.split(name)
if keys.size > maximum
raise ArgumentError, "Key length exceeded limit!"
end
if symbolize_keys
keys.collect!{|key| key.empty? ? nil : key.to_sym}
end
self.assign(keys, value, parameters)
end
return parameters
end
end
end
end
|