Ruby：如何通过 HTTP 将文件作为 multipart/form-data 发布？

Question

我想做一个看起来像从浏览器发布的 HMTL 表单的 HTTP POST。具体来说，发布一些文本字段和一个文件字段。

发布文本字段很简单，net/http rdocs 中有一个示例，但我不知道如何发布文件。

Net::HTTP 看起来不是最好的主意。 curb 看起来不错。

Answer 1

我喜欢RestClient。它用多部分表单数据等很酷的特性封装了 net/http：

require 'rest_client'
RestClient.post('http://localhost:3000/foo', 
  :name_of_file_param => File.new('/path/to/file'))

它还支持流式传输。

gem install rest-client 将帮助您入门。

Answer 2

关于 Nick Sieger 的多部分帖子库，我不能说太多好话。

它增加了对直接向 Net::HTTP 的多部分发布的支持，无需手动担心边界或大型库的目标可能与您自己的目标不同。

这里有一个来自README的关于如何使用它的小例子：

require 'net/http/post/multipart'

url = URI.parse('http://www.example.com/upload')
File.open("./image.jpg") do |jpg|
  req = Net::HTTP::Post::Multipart.new url.path,
    "file" => UploadIO.new(jpg, "image/jpeg", "image.jpg")
  res = Net::HTTP.start(url.host, url.port) do |http|
    http.request(req)
  end
end

您可以在此处查看库： http://github.com/nicksieger/multipart-post

或安装它：

$ sudo gem install multipart-post

如果您通过 SSL 连接，您需要像这样开始连接：

n = Net::HTTP.new(url.host, url.port) 
n.use_ssl = true
# for debugging dev server
#n.verify_mode = OpenSSL::SSL::VERIFY_NONE
res = n.start do |http|

Answer 3

另一个只使用标准库：

uri = URI('https://some.end.point/some/path')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'If you need some headers'
form_data = [['photos', photo.tempfile]] # or File.open() in case of local file

request.set_form form_data, 'multipart/form-data'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| # pay attention to use_ssl if you need it
  http.request(request)
end

尝试了很多方法，但只有这对我有用。

Answer 4

curb 看起来是一个很好的解决方案，但如果它不能满足您的需求，您可以使用Net::HTTP 来解决。多部分表单帖子只是一个经过仔细格式化的字符串，带有一些额外的标题。似乎每个需要编写多部分文章的 Ruby 程序员最终都会为它编写自己的小库，这让我想知道为什么这个功能不是内置的。也许是......无论如何，为了您的阅读乐趣，我会继续在这里给出我的解决方案。此代码基于我在几个博客上找到的示例，但我很遗憾再也找不到链接。所以我想我只需要为自己承担所有的功劳......

我为此编写的模块包含一个公共类，用于从String 和File 对象的散列生成表单数据和标题。例如，如果您想发布一个带有名为“title”的字符串参数和一个名为“document”的文件参数的表单，您可以执行以下操作：

#prepare the query
data, headers = Multipart::Post.prepare_query("title" => my_string, "document" => my_file)

然后你只需用Net::HTTP 做一个普通的POST：

http = Net::HTTP.new(upload_uri.host, upload_uri.port)
res = http.start {|con| con.post(upload_uri.path, data, headers) }

或者，您还想做POST。关键是Multipart 返回您需要发送的数据和标头。就是这样！很简单，对吧？这是 Multipart 模块的代码（您需要 mime-types gem）：

# Takes a hash of string and file parameters and returns a string of text
# formatted to be sent as a multipart form post.
#
# Author:: Cody Brimhall <mailto:brimhall@somuchwit.com>
# Created:: 22 Feb 2008
# License:: Distributed under the terms of the WTFPL (http://www.wtfpl.net/txt/copying/)

require 'rubygems'
require 'mime/types'
require 'cgi'


module Multipart
  VERSION = "1.0.0"

  # Formats a given hash as a multipart form post
  # If a hash value responds to :string or :read messages, then it is
  # interpreted as a file and processed accordingly; otherwise, it is assumed
  # to be a string
  class Post
    # We have to pretend we're a web browser...
    USERAGENT = "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6"
    BOUNDARY = "0123456789ABLEWASIEREISAWELBA9876543210"
    CONTENT_TYPE = "multipart/form-data; boundary=#{ BOUNDARY }"
    HEADER = { "Content-Type" => CONTENT_TYPE, "User-Agent" => USERAGENT }

    def self.prepare_query(params)
      fp = []

      params.each do |k, v|
        # Are we trying to make a file parameter?
        if v.respond_to?(:path) and v.respond_to?(:read) then
          fp.push(FileParam.new(k, v.path, v.read))
        # We must be trying to make a regular parameter
        else
          fp.push(StringParam.new(k, v))
        end
      end

      # Assemble the request body using the special multipart format
      query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
      return query, HEADER
    end
  end

  private

  # Formats a basic string key/value pair for inclusion with a multipart post
  class StringParam
    attr_accessor :k, :v

    def initialize(k, v)
      @k = k
      @v = v
    end

    def to_multipart
      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
    end
  end

  # Formats the contents of a file or string for inclusion with a multipart
  # form post
  class FileParam
    attr_accessor :k, :filename, :content

    def initialize(k, filename, content)
      @k = k
      @filename = filename
      @content = content
    end

    def to_multipart
      # If we can tell the possible mime-type from the filename, use the
      # first in the list; otherwise, use "application/octet-stream"
      mime_type = MIME::Types.type_for(filename)[0] || MIME::Types["application/octet-stream"][0]
      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{ filename }\"\r\n" +
             "Content-Type: #{ mime_type.simplified }\r\n\r\n#{ content }\r\n"
    end
  end
end

Answer 5

这是我在尝试了这篇文章中可用的其他解决方案后的解决方案，我正在使用它在 TwitPic 上上传照片：

  def upload(photo)
    `curl -F media=@#{photo.path} -F username=#{@username} -F password=#{@password} -F message='#{photo.title}' http://twitpic.com/api/uploadAndPost`
  end

Answer 6

快进到 2017 年，ruby stdlib net/http 从 1.9.3 开始内置此功能

Net::HTTPRequest#set_form)：添加以支持 application/x-www-form-urlencoded 和 multipart/form-data。

https://ruby-doc.org/stdlib-2.3.1/libdoc/net/http/rdoc/Net/HTTPHeader.html#method-i-set_form

我们甚至可以使用不支持:size的IO来流式传输表单数据。

希望这个答案真的可以帮助某人:)

附：我只在 ruby​​ 2.3.1 中测试过这个

Answer 7

好的，下面是一个使用遏制的简单示例。

require 'yaml'
require 'curb'

# prepare post data
post_data = fields_hash.map { |k, v| Curl::PostField.content(k, v.to_s) }
post_data << Curl::PostField.file('file', '/path/to/file'), 

# post
c = Curl::Easy.new('http://localhost:3000/foo')
c.multipart_form_post = true
c.http_post(post_data)

# print response
y [c.response_code, c.body_str]

Answer 8

在我覆盖 RestClient::Payload::Multipart 中的 create_file_field 之前，restclient 对我不起作用。

它在应该是 'Content-Disposition: form-data' 的每个部分中创建了一个 'Content-Disposition: multipart/form-data'。

http://www.ietf.org/rfc/rfc2388.txt

如果你需要，我的 fork 在这里：git@github.com:kcrawford/rest-client.git

Answer 9

NetHttp 的解决方案有个缺点，就是在发布大文件时，它会先将整个文件加载到内存中。

玩了一会儿后，我想出了以下解决方案：

class Multipart

  def initialize( file_names )
    @file_names = file_names
  end

  def post( to_url )
    boundary = '----RubyMultipartClient' + rand(1000000).to_s + 'ZZZZZ'

    parts = []
    streams = []
    @file_names.each do |param_name, filepath|
      pos = filepath.rindex('/')
      filename = filepath[pos + 1, filepath.length - pos]
      parts << StringPart.new ( "--" + boundary + "\r\n" +
      "Content-Disposition: form-data; name=\"" + param_name.to_s + "\"; filename=\"" + filename + "\"\r\n" +
      "Content-Type: video/x-msvideo\r\n\r\n")
      stream = File.open(filepath, "rb")
      streams << stream
      parts << StreamPart.new (stream, File.size(filepath))
    end
    parts << StringPart.new ( "\r\n--" + boundary + "--\r\n" )

    post_stream = MultipartStream.new( parts )

    url = URI.parse( to_url )
    req = Net::HTTP::Post.new(url.path)
    req.content_length = post_stream.size
    req.content_type = 'multipart/form-data; boundary=' + boundary
    req.body_stream = post_stream
    res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }

    streams.each do |stream|
      stream.close();
    end

    res
  end

end

class StreamPart
  def initialize( stream, size )
    @stream, @size = stream, size
  end

  def size
    @size
  end

  def read ( offset, how_much )
    @stream.read ( how_much )
  end
end

class StringPart
  def initialize ( str )
    @str = str
  end

  def size
    @str.length
  end

  def read ( offset, how_much )
    @str[offset, how_much]
  end
end

class MultipartStream
  def initialize( parts )
    @parts = parts
    @part_no = 0;
    @part_offset = 0;
  end

  def size
    total = 0
    @parts.each do |part|
      total += part.size
    end
    total
  end

  def read ( how_much )

    if @part_no >= @parts.size
      return nil;
    end

    how_much_current_part = @parts[@part_no].size - @part_offset

    how_much_current_part = if how_much_current_part > how_much
      how_much
    else
      how_much_current_part
    end

    how_much_next_part = how_much - how_much_current_part

    current_part = @parts[@part_no].read(@part_offset, how_much_current_part )

    if how_much_next_part > 0
      @part_no += 1
      @part_offset = 0
      next_part = read ( how_much_next_part  )
      current_part + if next_part
        next_part
      else
        ''
      end
    else
      @part_offset += how_much_current_part
      current_part
    end
  end
end

Answer 10

还有 nick sieger 的 multipart-post 可以添加到可能的解决方案的长列表中。

Answer 11

我遇到了同样的问题（需要发布到 jboss 网络服务器）。 Curb 对我来说很好，除了当我在代码中使用会话变量时它导致 ruby​​ 崩溃（ubuntu 8.10 上的 ruby​​ 1.8.7）。

我深入研究了 rest-client 文档，找不到多部分支持的迹象。我尝试了上面的 rest-client 示例，但 jboss 说 http 帖子不是多部分的。

Answer 12

multipart-post gem 与 Rails 4 Net::HTTP 配合得很好，没有其他特殊的 gem

def model_params
  require_params = params.require(:model).permit(:param_one, :param_two, :param_three, :avatar)
  require_params[:avatar] = model_params[:avatar].present? ? UploadIO.new(model_params[:avatar].tempfile, model_params[:avatar].content_type, model_params[:avatar].original_filename) : nil
  require_params
end

require 'net/http/post/multipart'

url = URI.parse('http://www.example.com/upload')
Net::HTTP.start(url.host, url.port) do |http|
  req = Net::HTTP::Post::Multipart.new(url, model_params)
  key = "authorization_key"
  req.add_field("Authorization", key) #add to Headers
  http.use_ssl = (url.scheme == "https")
  http.request(req)
end

https://github.com/Feuda/multipart-post/tree/patch-1

Answer 13

使用http.rbgem：

HTTP.post("https://here-you-go.com/upload",
          form: {
            file: HTTP::FormData::File.new(file_path)
          })

Details