module EventMachine::HttpEncoding

Methods for building HTTP requests

Constants

FIELD_ENCODING
HTTP_REQUEST_HEADER

Public Instance Methods

bytesize(string) click to toggle source
# File lib/em-http/client.rb, line 102
def bytesize(string)
  string.bytesize
end
encode_auth(k,v) click to toggle source

Encode basic auth in an HTTP header In: Array ([user, pass]) - for basic auth

String - custom auth string (OAuth, etc)
# File lib/em-http/client.rb, line 191
def encode_auth(k,v)
  if v.is_a? Array
    FIELD_ENCODING % [k, ["Basic", Base64.encode64(v.join(":")).chomp].join(" ")]
  else
    encode_field(k,v)
  end
end
encode_field(k, v) click to toggle source

Encode a field in an HTTP header

# File lib/em-http/client.rb, line 184
def encode_field(k, v)
  FIELD_ENCODING % [k, v]
end
encode_headers(head) click to toggle source
# File lib/em-http/client.rb, line 199
def encode_headers(head)
  head.inject('') do |result, (key, value)|
    # Munge keys from foo-bar-baz to Foo-Bar-Baz
    key = key.split('-').map { |k| k.to_s.capitalize }.join('-')
    result << case key
      when 'Authorization', 'Proxy-authorization'
        encode_auth(key, value)
      else
        encode_field(key, value)
    end
  end
end
encode_host() click to toggle source

HTTP is kind of retarded that you have to specify a Host header, but if you include port 80 then further redirects will tack on the :80 which is annoying.

# File lib/em-http/client.rb, line 119
def encode_host
  if @uri.port == 80 || @uri.port == 443
    return @uri.host
  else
    @uri.host + ":#{@uri.port}"
  end
end
encode_param(k, v) click to toggle source

URL encodes query parameters: single k=v, or a URL encoded array, if v is an array of values

# File lib/em-http/client.rb, line 152
def encode_param(k, v)
  if v.is_a?(Array)
    v.map { |e| escape(k) + "[]=" + escape(e) }.join("&")
  else
    escape(k) + "=" + escape(v)
  end
end
encode_query(uri, query) click to toggle source
# File lib/em-http/client.rb, line 137
def encode_query(uri, query)
  encoded_query = if query.kind_of?(Hash)
    query.map { |k, v| encode_param(k, v) }.join('&')
  else
    query.to_s
  end

  if !uri.query.to_s.empty?
    encoded_query = [encoded_query, uri.query].reject {|part| part.empty?}.join("&")
  end
  encoded_query.to_s.empty? ? uri.path : "#{uri.path}?#{encoded_query}"
end
encode_request(method, uri, query, proxy) click to toggle source
# File lib/em-http/client.rb, line 127
def encode_request(method, uri, query, proxy)
  query = encode_query(uri, query)

  # Non CONNECT proxies require that you provide the full request
  # uri in request header, as opposed to a relative path.
  query = uri.join(query) if proxy && proxy[:type] != :socks && !proxy[:use_connect]

  HTTP_REQUEST_HEADER % [method.to_s.upcase, query]
end
escape(s) click to toggle source

Escapes a URI.

# File lib/em-http/client.rb, line 88
def escape(s)
  s.to_s.gsub(/([^a-zA-Z0-9_.-]+)/) {
    '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
  }
end
form_encode_body(obj) click to toggle source
# File lib/em-http/client.rb, line 160
def form_encode_body(obj)
  pairs = []
  recursive = Proc.new do |h, prefix|
    h.each do |k,v|
      key = prefix == '' ? escape(k) : "#{prefix}[#{escape(k)}]"

      if v.is_a? Array
        nh = Hash.new
        v.size.times { |t| nh[t] = v[t] }
        recursive.call(nh, key)

      elsif v.is_a? Hash
        recursive.call(v, key)
      else
        pairs << "#{key}=#{escape(v)}"
      end
    end
  end

  recursive.call(obj, '')
  return pairs.join('&')
end
munge_header_keys(head) click to toggle source

Map all header keys to a downcased string version

# File lib/em-http/client.rb, line 112
def munge_header_keys(head)
  head.inject({}) { |h, (k, v)| h[k.to_s.downcase] = v; h }
end
unescape(s) click to toggle source

Unescapes a URI escaped string.

# File lib/em-http/client.rb, line 95
def unescape(s)
  s.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/){
    [$1.delete('%')].pack('H*')
  }
end