使用HTTParty解析HTTP头中的'set-cookie'字段

Question

我正在使用HTTParty进行HTTP请求和使用REST API。现在，我想重复使用通过POST调用的登录页面设置的cookie。

class SomeImporter
  include HTTParty

  def self.login
    response = self.post('https://www.example.com/login', :query => {:user => 'myusername', :password => 'secret'})
    self.default_cookies.add_cookies(response.header['set-cookie'])
    self.get('https://www.example.com/protected')
  end
end

这段代码没有正确设置cookies。 如何正确解析HTTParty返回的'set-cookie'头信息并设置cookies以供下次请求？

- Sven R.

Answer 1

通常HTTP头中每个Set-Cookie只有一个条目。HTTParty将它们合并为一个逗号分隔的字符串。但是，当将它们添加回默认cookie时，HTTParty不会自动拆分它们。您需要自己解析它们。

可以使用以下方法解析“set-cookie”。将其添加到您的类中：

# Parse the 'set-cookie' string
# @param [String] all_cookies_string
# @return [Hash]
def self.parse_set_cookie(all_cookies_string)
  cookies = Hash.new

  if all_cookies_string.present?
    # single cookies are devided with comma
    all_cookies_string.split(',').each {
      # @type [String] cookie_string
        |single_cookie_string|
      # parts of single cookie are seperated by semicolon; first part is key and value of this cookie
      # @type [String]
      cookie_part_string  = single_cookie_string.strip.split(';')[0]
      # remove whitespaces at beginning and end in place and split at '='
      # @type [Array]
      cookie_part         = cookie_part_string.strip.split('=')
      # @type [String]
      key                 = cookie_part[0]
      # @type [String]
      value               = cookie_part[1]

      # add cookie to Hash
      cookies[key] = value
    }
  end

  cookies
end

可以通过调整此行将Cookie添加到HTTParty以便跟随请求：

self.default_cookies.add_cookies(self.parse_set_cookie(response.header['set-cookie']))

在self.parse_set_cookie函数中，只提取了cookie的名称和值。您可以扩展它以获取更多详细信息，例如Path、Domain等。有关更多详细信息，请参见RFC 2109（4.2.2 Set-Cookie Syntax）。

- Sven R.

---

在 cookie 中有一个日期，如 Wed,，你不能通过 `,' 进行分割。 - tkhuynh

这个实现存在一个缺陷。它在=上分割了cookie字符串，然而=是cookie值中的一个有效字符。事实上，在base64编码的字符串中，=是常见的。这导致=被从值的末尾剥离掉。 - undefined

Answer 2

感谢@dineshspabu，我能够遵循他的模式并添加一些修改以处理到期日期。希望这有所帮助：

def cookies_to_hash(set_cookie)
  set_cookie = set_cookie.gsub(/Expires=[a-zA-Z]+,/) do |m|
    # replace , with #####
    m[0..-2] + "#####"
  end
  set_cookie = set_cookie.split(',')
  # Cookies as array of hashes
  all_cookies = []
  set_cookie.each do |each_cookie|
    ecookie = []
    each_cookie.strip.split(';').each do |cookie_attr|
      # replace ##### with , back
      ecookie << cookie_attr.split("=").map{|e| e.gsub(/#####/, ',') if e}
    end
    all_cookies << Hash[ecookie]
  end
  all_cookies
end

- tkhuynh

Answer 3

def cookies_to_hash(acookies)
    vs = acookies.split(',')
    ak = Array.new
    # Avoiding break in expiry date comma
    vs.each_cons(2) do |v, vn|
        unless(vn.include?("="))
            ak << "#{v}#{vn}"
        else
            ak << v if(v.include?("="))
        end
    end
    # Cookies as array of hashes
    all_cookies = []
    ak.each do |each_cookie|
        ecookie = []
        each_cookie.split(';').each do |cookie_attr|
            ecookie << cookie_attr.split("=")
        end
        all_cookies << Hash[ecookie]
    end
    all_cookies
end

上述方法将帮助您将响应头中的set-cookies转换为有效的哈希数组。解决了到期时间上的额外逗号问题。

- dineshsprabu

---

很遗憾，它无法处理过期日期。 - tkhuynh