Module: Protocol::HTTP::URL

Defined in:
lib/protocol/http/url.rb

Constant Summary collapse

NON_PCHAR =

According to tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.

/([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze

Class Method Summary collapse

Class Method Details

.assign(keys, value, parent) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/protocol/http/url.rb', line 87

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

.decode(string, maximum = 8, symbolize_keys: false) ⇒ Object

TODO use native C extension from ‘Trenni::Reference`.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/protocol/http/url.rb', line 108

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

.encode(value, prefix = nil) ⇒ Object

Encodes a hash or array into a query string.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/protocol/http/url.rb', line 52

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

.escape(string, encoding = string.encoding) ⇒ Object

Escapes a string using percent encoding.



27
28
29
30
31
 
# File 'lib/protocol/http/url.rb', line 27

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

.escape_path(path) ⇒ Object

Escapes non-path characters using percent encoding.



44
45
46
47
48
49
 
# File 'lib/protocol/http/url.rb', line 44

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

.scan(string) ⇒ Object

Scan a string for URL-encoded key/value pairs.



75
76
77
78
79
80
81
 
# File 'lib/protocol/http/url.rb', line 75

def self.scan(string)
  string.split('&') do |assignment|
    key, value = assignment.split('=', 2)
    
    yield unescape(key), unescape(value)
  end
end

.split(name) ⇒ Object 



83
84
85
 
# File 'lib/protocol/http/url.rb', line 83

def self.split(name)
  name.scan(/([^\[]+)|(?:\[(.*?)\])/).flatten!.compact!
end

.unescape(string, encoding = string.encoding) ⇒ Object

Unescapes a percent encoded string.



34
35
36
37
38
 
# File 'lib/protocol/http/url.rb', line 34

def self.unescape(string, encoding = string.encoding)
  string.b.gsub(/%(\h\h)/) do |hex|
    Integer(hex, 16).chr
  end.force_encoding(encoding)
end