Module: Excon::Utils

Extended by:
Utils
Included in:
Connection, Socket, Utils
Defined in:
lib/excon/utils.rb

Constant Summary collapse

UNESCAPED = 
/([#{ Regexp.escape(control + ' ' + delims + unwise + nonascii) }])/
ESCAPED = 
/%([0-9a-fA-F]{2})/

Instance Method Summary collapse

Instance Method Details

#connection_uri(datum = @data) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/excon/utils.rb', line 20

def connection_uri(datum = @data)
  unless datum
    raise ArgumentError, '`datum` must be given unless called on a Connection'
  end
  if datum[:scheme] == UNIX
    '' << datum[:scheme] << '://' << datum[:socket]
  else
    '' << datum[:scheme] << '://' << datum[:host] << port_string(datum)
  end
end

#escape_uri(str) ⇒ Object

Escapes HTTP reserved and unwise characters in str



74
75
76
77
78
79
 
# File 'lib/excon/utils.rb', line 74

def escape_uri(str)
  str = str.dup
  str.force_encoding('BINARY') if FORCE_ENC
  str.gsub!(UNESCAPED) { "%%%02X" % $1[0].ord }
  str
end

#port_string(datum) ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/excon/utils.rb', line 35

def port_string(datum)
  if datum[:port].nil? || (datum[:omit_default_port] && ((datum[:scheme].casecmp('http') == 0 && datum[:port] == 80) || (datum[:scheme].casecmp('https') == 0 && datum[:port] == 443)))
    ''
  else
    ':' << datum[:port].to_s
  end
end

#query_string(datum) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/excon/utils.rb', line 43

def query_string(datum)
  str = ''
  case datum[:query]
  when String
    str << '?' << datum[:query]
  when Hash
    str << '?'
    datum[:query].sort_by {|k,_| k.to_s }.each do |key, values|
      if values.nil?
        str << key.to_s << '&'
      else
        [values].flatten.each do |value|
          str << key.to_s << '=' << CGI.escape(value.to_s) << '&'
        end
      end
    end
    str.chop! # remove trailing '&'
  end
  str
end

#request_uri(datum) ⇒ Object 



31
32
33
 
# File 'lib/excon/utils.rb', line 31

def request_uri(datum)
  connection_uri(datum) << datum[:path] << query_string(datum)
end

#split_header_value(str) ⇒ Object

Splits a header value str according to HTTP specification.



65
66
67
68
69
70
71
 
# File 'lib/excon/utils.rb', line 65

def split_header_value(str)
  return [] if str.nil?
  str = str.strip
  str.force_encoding('BINARY') if FORCE_ENC
  str.scan(%r'\G((?:"(?:\\.|[^"])+?"|[^",]+)+)
                (?:,\s*|\Z)'xn).flatten
end

#unescape_form(str) ⇒ Object

Unescape form encoded values in str



90
91
92
93
94
95
96
 
# File 'lib/excon/utils.rb', line 90

def unescape_form(str)
  str = str.dup
  str.force_encoding('BINARY') if FORCE_ENC
  str.gsub!(/\+/, ' ')
  str.gsub!(ESCAPED) { $1.hex.chr }
  str
end

#unescape_uri(str) ⇒ Object

Unescapes HTTP reserved and unwise characters in str



82
83
84
85
86
87
 
# File 'lib/excon/utils.rb', line 82

def unescape_uri(str)
  str = str.dup
  str.force_encoding('BINARY') if FORCE_ENC
  str.gsub!(ESCAPED) { $1.hex.chr }
  str
end

#valid_connection_keys(params = {}) ⇒ Object 



12
13
14
 
# File 'lib/excon/utils.rb', line 12

def valid_connection_keys(params = {})
  Excon::VALID_CONNECTION_KEYS
end

#valid_request_keys(params = {}) ⇒ Object 



16
17
18
 
# File 'lib/excon/utils.rb', line 16

def valid_request_keys(params = {})
  Excon::VALID_REQUEST_KEYS
end