web-dev-qa-db-ja.com

Ruby：HTTP経由でファイルをmultipart / form-dataとして投稿する方法は？

ブラウザから投稿されたHMTLフォームのように見えるHTTP POST。具体的には、いくつかのテキストフィールドとファイルフィールドを投稿します。

テキストフィールドの投稿は簡単です。net/ http rdocsに例がありますが、ファイルと一緒に投稿する方法がわかりません。

Net :: HTTPは最良のアイデアのようには見えません。 縁石 は見栄えが良い。

rubyhttppost
104
kch

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はあなたを始めさせます。

94
Pedro

Nick Siegerのmultipart-postライブラリについて十分なことを言うことはできません。

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|
36
eric

curbは優れたソリューションのように見えますが、ニーズに合わない場合は、canで実行しますNet::HTTP。マルチパートフォームポストは、いくつかの余分なヘッダーを含む慎重にフォーマットされた文字列です。すべてのRubyマルチパート投稿を行う必要のあるプログラマーは、独自の小さなライブラリを作成することになり、この機能が組み込まれていない理由を疑問に思います。たぶんそうです。とにかく、あなたの読書の楽しみのために、ここで私のソリューションを提供しますこのコードは、いくつかのブログで見つけた例に基づいていますが、もうリンクが見つからないことを残念に思います。私は自分自身のためにすべてのクレジットを取る必要があります...

このために作成したモジュールには、StringおよびFileオブジェクトのハッシュからフォームデータとヘッダーを生成するための1つのパブリッククラスが含まれています。そのため、たとえば、「title」という名前の文字列パラメーターと「document」という名前のファイルパラメーターを持つフォームを投稿する場合は、次のようにします。

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

次に、通常のPOSTとNet::HTTP：

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:[email protected]>
# 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
29
Cody Brimhall

この投稿で利用可能な他のものを試した後の私のソリューションは次のとおりです、私はそれを使用して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
17
Alex

標準ライブラリのみを使用する別の例：

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

多くのアプローチを試してみましたが、これだけがうまくいきました。

16
Vladimir Rozhkov

OK、縁石を使用した簡単な例です。

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]
7
kch

2017年に早送りすると、Rubystdlibnet/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

6
airmanx86

restClient :: Payload :: Multipartのcreate_file_fieldをオーバーライドするまで、restclientは機能しませんでした。

それは、 'Content-Disposition：multipart/form-data'を各部分に作成する必要がありました '内容の処理：form-data '。

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

あなたがそれを必要とするなら、私のフォークはここにあります：[email protected]：kcrawford/rest-client.git

3
user243633

可能性のある解決策の長いリストに追加するニックシージャーの multipart-post もあります。

1
Jan Berkel

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
1
Stanislav Vitvitskiy

同じ問題が発生しました（jboss Webサーバーに投稿する必要があります）。コードでセッション変数を使用すると、Ruby）（Ruby 1.8.7 on ubuntu 8.10）がクラッシュすることを除いて、縁石はうまく機能します。

残りのクライアントドキュメントを掘り下げましたが、マルチパートサポートの兆候が見つかりませんでした。上記のrest-clientの例を試しましたが、jbossはhttpの投稿はマルチパートではないと述べました。

0
zd

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

0
Feuda