Ruby: Como postar um arquivo via HTTP como multipart / form-data?

112

Quero fazer um HTTP POST que se pareça com um formulário HMTL postado de um navegador. Especificamente, poste alguns campos de texto e um campo de arquivo.

A postagem de campos de texto é simples, há um exemplo bem ali no net / http rdocs, mas não consigo descobrir como postar um arquivo junto com ele.

Net :: HTTP não parece ser a melhor ideia. freio é bom olhar.

kch
fonte

Respostas:

102

Eu gosto do RestClient . Ele encapsula net / http com recursos interessantes, como dados de formulário multipartes:

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

Ele também suporta streaming.

gem install rest-client irá ajudá-lo a começar.

Pedro
fonte
Retiro o que disse, uploads de arquivos agora funcionam. O problema que estou tendo agora é que o servidor fornece um 302 e o resto do cliente segue o RFC (o que nenhum navegador faz) e lança uma exceção (já que os navegadores devem alertar sobre esse comportamento). A outra alternativa é meio-fio, mas nunca tive sorte ao instalar meio-fio em janelas.
Matt Wolfe
7
A API mudou um pouco desde que foi postado pela primeira vez, multipart agora é invocado como: RestClient.post ' localhost: 3000 / foo ',: upload => File.new ('/ path / tofile')) Consulte github.com/ archiloque / rest-client para mais detalhes.
Clinton
2
rest_client não suporta o fornecimento de cabeçalhos de solicitação. Muitos aplicativos REST requerem / esperam tipos específicos de cabeçalhos, portanto o cliente de descanso não funcionará nesse caso. Por exemplo, JIRA requer um token X-Atlassian-Token.
conhecido em
É possível obter o andamento do upload do arquivo? por exemplo, 40% é carregado.
Ankush,
1
+1 para adicionar as partes gem install rest-cliente require 'rest_client'. Essa informação foi omitida em muitos exemplos de rubi.
dansalmo
36

Não posso dizer coisas boas o suficiente sobre a biblioteca multipartes de Nick Sieger.

Ele adiciona suporte para postagem de várias partes diretamente no Net :: HTTP, eliminando a necessidade de se preocupar manualmente com limites ou grandes bibliotecas que podem ter objetivos diferentes dos seus.

Aqui está um pequeno exemplo de como usá-lo do 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

Você pode verificar a biblioteca aqui: http://github.com/nicksieger/multipart-post

ou instale-o com:

$ sudo gem install multipart-post

Se você estiver se conectando via SSL, precisará iniciar a conexão assim:

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|
Eric
fonte
3
Aquele fez isso por mim, exatamente o que eu estava procurando e exatamente o que deveria ser incluído sem a necessidade de uma gema. Ruby está muito à frente, mas muito atrás.
Trey
incrível, isso vem como um envio de Deus! usei isso para fazer um monkeypatch da gem OAuth para suportar uploads de arquivos. levou apenas 5 minutos.
Matthias,
@matthias Estou tentando fazer upload de uma foto com a gema OAuth, mas falhou. você poderia me dar algum exemplo de seu monkeypatch?
Hooopo
1
O patch era bastante específico para meu script (rápido e sujo), mas dê uma olhada nele e talvez você possa fazer um pouco com uma abordagem mais genérica ( gist.github.com/974084 )
Matthias
3
Multipart não suporta cabeçalhos de solicitação. Portanto, se você, por exemplo, quiser usar a interface JIRA REST, multipart será apenas uma perda de tempo valioso.
conhecido em
30

curbparece uma ótima solução, mas caso não atenda às suas necessidades, você pode fazer com Net::HTTP. Um post de formulário com várias partes é apenas uma string cuidadosamente formatada com alguns cabeçalhos extras. Parece que todo programador Ruby que precisa fazer postagens com várias partes acaba escrevendo sua própria pequena biblioteca para isso, o que me faz pensar por que essa funcionalidade não está embutida. Talvez seja ... De qualquer forma, para o seu prazer de leitura, vou prosseguir e dar aqui a minha solução. Este código é baseado em exemplos que encontrei em alguns blogs, mas lamento não poder encontrar mais os links. Então eu acho que só tenho que levar todo o crédito para mim ...

O módulo que escrevi para isso contém uma classe pública, para gerar os dados de formulário e cabeçalhos de um hash de Stringe Fileobjetos. Portanto, por exemplo, se você quiser postar um formulário com um parâmetro de string denominado "title" e um parâmetro de arquivo denominado "document", você faria o seguinte:

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

Então você apenas faz um normal POSTcom Net::HTTP:

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

Ou qualquer outra coisa que você queira fazer POST. O ponto é que Multipartretorna os dados e cabeçalhos que você precisa enviar. E é isso! Simples, certo? Aqui está o código para o módulo Multipart (você precisa da mime-typesgema):

# 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
Cody Brimhall
fonte
Oi! Qual é a licença deste código? Além disso: pode ser bom adicionar o URL desta postagem nos comentários no topo. Obrigado!
docwhat
5
O código desta postagem está licenciado pela WTFPL ( sam.zoy.org/wtfpl ). Aproveitar!
Cody Brimhall
você não deve passar o filestream para a chamada de inicialização da FileParamclasse. A atribuição no to_multipartmétodo copia o conteúdo do arquivo novamente, o que é desnecessário! Em vez disso, passe apenas o descritor de arquivo e leia-o noto_multipart
mober
1
Este código é ótimo! Porque funciona. Rest-client e Siegers Multipart-post NÃO suportam cabeçalhos de solicitação. Se você precisar de cabeçalhos de solicitação, perderá muito tempo valioso com o resto do cliente e a postagem com várias partes do Siegers.
conhecido em
Na verdade, @Onno, agora ele suporta cabeçalhos de solicitação. Veja meu comentário sobre a resposta de
Eric
24

Outro usando apenas bibliotecas padrão:

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

Tentei várias abordagens, mas só funcionou para mim.

Vladimir Rozhkov
fonte
3
Obrigado por isso. Um ponto menor, a linha 1 deve ser: uri = URI('https://some.end.point/some/path') Dessa forma, você pode chamar uri.porte uri.hostsem erros mais tarde.
davidkovsky
1
uma pequena alteração, se não o arquivo temporário e você quiser fazer upload de um arquivo do seu disco, você File.opennão deve usarFile.read
Anil Yanduri
1
na maioria dos casos, um nome de arquivo é necessário, esta é a forma como eu adicionei: form_data = [['arquivo', File.read (file_name), {filename: file_name}]]
ZsJoska
4
Essa é a resposta correta. as pessoas devem parar de usar joias de invólucro quando possível e voltar ao básico.
Carlos Roque de
18

Aqui está minha solução depois de tentar outras disponíveis neste post, estou usando para fazer upload de fotos no 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
Alex
fonte
1
Apesar de parecer um pouco hackeado, esta é provavelmente a melhor solução para mim. Muito obrigado por essa sugestão!
Bo Jeanes
Apenas uma nota para os incautos, o media = @ ... é o que torna o curl coisa que ... é um arquivo e não apenas uma string. Um pouco confuso com a sintaxe do ruby, mas @ # {photo.path} não é o mesmo que #{@photo.path}. Esta solução é uma das melhores imho.
Evgeny
7
Isso parece bom, mas se o seu @username contiver "foo && rm -rf /", isso ficará muito ruim :-P
gaspard
8

Avançando para 2017, ruby stdlib net/httpvem integrado desde 1.9.3

Net :: HTTPRequest # set_form): Adicionado para oferecer suporte a application / x-www-form-urlencoded e multipart / form-data.

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

Podemos até usar o IOque não oferece suporte :sizepara transmitir os dados do formulário.

Esperando que esta resposta possa realmente ajudar alguém :)

PS Eu só testei isso no ruby ​​2.3.1

airmanx86
fonte
7

Ok, aqui está um exemplo simples usando meio-fio.

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

restclient não funcionou para mim até que eu substituísse create_file_field em RestClient :: Payload :: Multipart.

Ele estava criando um 'Content-Disposition: multipart / form-data' em cada parte onde deveria ser 'Content-Disposition: form-data' .

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

Meu fork está aqui se você precisar: [email protected]: kcrawford / rest-client.git


fonte
Isso foi corrigido no último restclient.
1

Bem, a solução com NetHttp tem uma desvantagem que, ao postar arquivos grandes, ele carrega o arquivo inteiro primeiro na memória.

Depois de brincar um pouco, descobri a seguinte solução:

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

fonte
O que é a classe StreamPart?
Marlin Pierce
1

há também o post multiparte de nick sieger para adicionar à longa lista de soluções possíveis.

Jan Berkel
fonte
1
multipart-post não suporta cabeçalhos de solicitação.
conhecido em
Na verdade, @Onno, agora ele suporta cabeçalhos de solicitação. Veja meu comentário sobre a resposta de
Eric
0

Eu tive o mesmo problema (preciso postar no servidor web jboss). O Curb funciona bem para mim, exceto que fazia o ruby ​​travar (ruby 1.8.7 no ubuntu 8.10) quando eu uso variáveis ​​de sessão no código.

Eu vasculhei os documentos do cliente restante, não consegui encontrar indicação de suporte a várias partes. Tentei os exemplos rest-client acima, mas jboss disse que a postagem http não é multiparte.


fonte
0

A gem multipart-post funciona muito bem com Rails 4 Net :: HTTP, nenhuma outra gem especial

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

Feuda
fonte