multipart-post 1.1.5 → 2.1.1

data/lib/net/http/post/multipart.rb

@@ -11,14 +11,15 @@ require 'composite_io'
 require 'multipartable'
 require 'parts'
 
-module Net #:nodoc:
-  class HTTP #:nodoc:
+module Net
+  class HTTP
     class Put
       class Multipart < Put
         include Multipartable
       end
     end
-    class Post #:nodoc:
+
+    class Post
       class Multipart < Post
         include Multipartable
       end

data/lib/parts.rb

@@ -1,19 +1,24 @@
 #--
-# Copyright (c) 2007-2012 Nick Sieger.
+# Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for
 # software license details.
 #++
 
 module Parts
-  module Part #:nodoc:
-    def self.new(boundary, name, value)
-      if value.respond_to? :content_type
-        FilePart.new(boundary, name, value)
+  module Part
+    def self.new(boundary, name, value, headers = {})
+      headers ||= {} # avoid nil values
+      if file?(value)
+        FilePart.new(boundary, name, value, headers)
       else
-        ParamPart.new(boundary, name, value)
+        ParamPart.new(boundary, name, value, headers)
       end
     end
 
+    def self.file?(value)
+      value.respond_to?(:content_type) && value.respond_to?(:original_filename)
+    end
+
     def length
       @part.length
     end
@@ -23,21 +28,32 @@ module Parts
     end
   end
 
+  # Represents a parametric part to be filled with given value.
   class ParamPart
     include Part
-    def initialize(boundary, name, value)
-      @part = build_part(boundary, name, value)
+
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param value [String]
+    # @param headers [Hash] Content-Type is used, if present.
+    def initialize(boundary, name, value, headers = {})
+      @part = build_part(boundary, name, value, headers)
       @io = StringIO.new(@part)
     end
 
     def length
      @part.bytesize
-    end 
+    end
 
-    def build_part(boundary, name, value)
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param value [String]
+    # @param headers [Hash] Content-Type is used, if present.
+    def build_part(boundary, name, value, headers = {})
       part = ''
       part << "--#{boundary}\r\n"
       part << "Content-Disposition: form-data; name=\"#{name.to_s}\"\r\n"
+      part << "Content-Type: #{headers["Content-Type"]}\r\n" if headers["Content-Type"]
       part << "\r\n"
       part << "#{value}\r\n"
     end
@@ -46,29 +62,54 @@ module Parts
   # Represents a part to be filled from file IO.
   class FilePart
     include Part
+
     attr_reader :length
-    def initialize(boundary, name, io)
+
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param io [IO]
+    # @param headers [Hash]
+    def initialize(boundary, name, io, headers = {})
       file_length = io.respond_to?(:length) ?  io.length : File.size(io.local_path)
       @head = build_head(boundary, name, io.original_filename, io.content_type, file_length,
-                         io.respond_to?(:opts) ? io.opts : {})
+                         io.respond_to?(:opts) ? io.opts.merge(headers) : headers)
       @foot = "\r\n"
-      @length = @head.length + file_length + @foot.length
+      @length = @head.bytesize + file_length + @foot.length
       @io = CompositeReadIO.new(StringIO.new(@head), io, StringIO.new(@foot))
     end
 
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param filename [String]
+    # @param type [String]
+    # @param content_len [Integer]
+    # @param opts [Hash]
     def build_head(boundary, name, filename, type, content_len, opts = {})
-      trans_encoding = opts["Content-Transfer-Encoding"] || "binary"
-      content_disposition = opts["Content-Disposition"] || "form-data"
+      opts = opts.clone
+
+      trans_encoding = opts.delete("Content-Transfer-Encoding") || "binary"
+      content_disposition = opts.delete("Content-Disposition") || "form-data"
 
       part = ''
       part << "--#{boundary}\r\n"
       part << "Content-Disposition: #{content_disposition}; name=\"#{name.to_s}\"; filename=\"#{filename}\"\r\n"
       part << "Content-Length: #{content_len}\r\n"
-      if content_id = opts["Content-ID"]
+      if content_id = opts.delete("Content-ID")
         part << "Content-ID: #{content_id}\r\n"
       end
-      part << "Content-Type: #{type}\r\n"
+
+      if opts["Content-Type"] != nil
+        part <<  "Content-Type: " + opts["Content-Type"] + "\r\n"
+      else
+        part << "Content-Type: #{type}\r\n"
+      end
+
       part << "Content-Transfer-Encoding: #{trans_encoding}\r\n"
+
+      opts.each do |k, v|
+        part << "#{k}: #{v}\r\n"
+      end
+
       part << "\r\n"
     end
   end
@@ -76,8 +117,9 @@ module Parts
   # Represents the epilogue or closing boundary.
   class EpiloguePart
     include Part
+
     def initialize(boundary)
-      @part = "--#{boundary}--\r\n\r\n"
+      @part = "--#{boundary}--\r\n"
       @io = StringIO.new(@part)
     end
   end

data/multipart-post.gemspec

@@ -2,19 +2,22 @@
 $:.push File.expand_path("../lib", __FILE__)
 require "multipart_post"
 
-Gem::Specification.new do |s|
-  s.name        = "multipart-post"
-  s.version     = MultipartPost::VERSION
-  s.authors     = ["Nick Sieger"]
-  s.email       = ["nick@nicksieger.com"]
-  s.homepage    = "https://github.com/nicksieger/multipart-post"
-  s.summary     = %q{A multipart form post accessory for Net::HTTP.}
-  s.description = %q{Use with Net::HTTP to do multipart form posts.  IO values that have #content_type, #original_filename, and #local_path will be posted as a binary file.}
-
-  s.rubyforge_project = "caldersphere"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+Gem::Specification.new do |spec|
+  spec.name        = "multipart-post"
+  spec.version     = MultipartPost::VERSION
+  spec.authors     = ["Nick Sieger", "Samuel Williams"]
+  spec.email       = ["nick@nicksieger.com", "samuel.williams@oriontransfer.co.nz"]
+  spec.homepage    = "https://github.com/nicksieger/multipart-post"
+  spec.summary     = %q{A multipart form post accessory for Net::HTTP.}
+  spec.license     = "MIT"
+  spec.description = %q{Use with Net::HTTP to do multipart form postspec. IO values that have #content_type, #original_filename, and #local_path will be posted as a binary file.}
+  
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency 'bundler', ['>= 1.3', '< 3']
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rake'
 end

data/spec/composite_io_spec.rb

@@ -0,0 +1,138 @@
+# Copyright, 2012, by Nick Sieger.
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'composite_io'
+require 'stringio'
+require 'timeout'
+
+RSpec.shared_context "composite io" do
+  it "test_full_read_from_several_ios" do
+    expect(subject.read).to be == 'the quick brown fox'
+  end
+  
+  it "test_partial_read" do
+    expect(subject.read(9)).to be == 'the quick'
+  end
+
+  it "test_partial_read_to_boundary" do
+    expect(subject.read(10)).to be == 'the quick '
+  end
+
+  it "test_read_with_size_larger_than_available" do
+    expect(subject.read(32)).to be == 'the quick brown fox'
+  end
+  
+  it "test_read_into_buffer" do
+    buf = ''
+    subject.read(nil, buf)
+    expect(buf).to be == 'the quick brown fox'
+  end
+
+  it "test_multiple_reads" do
+    expect(subject.read(4)).to be == 'the '
+    expect(subject.read(4)).to be == 'quic'
+    expect(subject.read(4)).to be == 'k br'
+    expect(subject.read(4)).to be == 'own '
+    expect(subject.read(4)).to be == 'fox'
+  end
+
+  it "test_read_after_end" do
+    subject.read
+    expect(subject.read).to be == ""
+  end
+
+  it "test_read_after_end_with_amount" do
+    subject.read(32)
+    expect(subject.read(32)).to be_nil
+  end
+  
+  it "test_second_full_read_after_rewinding" do
+    subject.read
+    subject.rewind
+    expect(subject.read).to be == 'the quick brown fox'
+  end
+  
+  # Was apparently broken on JRuby due to http://jira.codehaus.org/browse/JRUBY-7109
+  it "test_compatible_with_copy_stream" do
+    target_io = StringIO.new
+    Timeout.timeout(1) do # Not sure why we need this in the spec?
+      IO.copy_stream(subject, target_io)
+    end
+    expect(target_io.string).to be == "the quick brown fox"
+  end
+end
+
+RSpec.describe CompositeReadIO do
+  describe "generic io" do
+    subject {StringIO.new('the quick brown fox')}
+  
+    include_context "composite io"
+  end
+  
+  describe "composite io" do
+    subject {CompositeReadIO.new(StringIO.new('the '), StringIO.new('quick '), StringIO.new('brown '), StringIO.new('fox'))}
+  
+    include_context "composite io"
+  end
+  
+  describe "nested composite io" do
+    subject {CompositeReadIO.new(CompositeReadIO.new(StringIO.new('the '), StringIO.new('quick ')), StringIO.new('brown '), StringIO.new('fox'))}
+  
+    include_context "composite io"
+  end
+  
+  describe "unicode composite io" do
+    let(:utf8_io) {File.open(File.dirname(__FILE__)+'/multibyte.txt')}
+    let(:binary_io) {StringIO.new("\x86")}
+    
+    subject {CompositeReadIO.new(binary_io, utf8_io)}
+    
+    it "test_read_from_multibyte" do
+      expect(subject.read).to be == "\x86\xE3\x83\x95\xE3\x82\xA1\xE3\x82\xA4\xE3\x83\xAB\n".b
+    end
+  end
+  
+  it "test_convert_error" do
+    expect do
+      UploadIO.convert!('tmp.txt', 'text/plain', 'tmp.txt', 'tmp.txt')
+    end.to raise_error(ArgumentError, /convert! has been removed/)
+  end
+  
+  it "test_empty" do
+    expect(subject.read).to be == ""
+  end
+
+  it "test_empty_limited" do
+    expect(subject.read(1)).to be_nil
+  end
+
+  it "test_empty_parts" do
+    io = CompositeReadIO.new(StringIO.new, StringIO.new('the '), StringIO.new, StringIO.new('quick'))
+    expect(io.read(3)).to be == "the"
+    expect(io.read(3)).to be == " qu"
+    expect(io.read(3)).to be == "ick"
+  end
+
+  it "test_all_empty_parts" do
+    io = CompositeReadIO.new(StringIO.new, StringIO.new)
+    expect(io.read(1)).to be_nil
+  end
+end

data/spec/net/http/post/multipart_spec.rb

@@ -0,0 +1,123 @@
+#--
+# Copyright (c) 2007-2013 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+require 'net/http/post/multipart'
+
+RSpec.shared_context "net http multipart" do
+  let(:temp_file) {"temp.txt"}
+  let(:http_post) do
+    Struct.new("HTTPPost", :content_length, :body_stream, :content_type) do
+      def set_content_type(type, params = {})
+        self.content_type = type + params.map{|k,v|"; #{k}=#{v}"}.join('')
+      end
+    end
+  end
+  
+  after(:each) do
+    File.delete(temp_file) rescue nil
+  end
+  
+  def assert_results(post)
+    expect(post.content_length).to be > 0
+    expect(post.body_stream).to_not be_nil
+    
+    expect(post['content-type']).to be == "multipart/form-data; boundary=#{post.boundary}"
+    
+    body = post.body_stream.read
+    boundary_regex = Regexp.quote(post.boundary)
+    
+    expect(body).to be =~ /1234567890/
+    
+    # ensure there is at least one boundary
+    expect(body).to be =~ /^--#{boundary_regex}\r\n/
+    
+    # ensure there is an epilogue
+    expect(body).to be =~ /^--#{boundary_regex}--\r\n/
+    expect(body).to be =~ /text\/plain/
+    
+    if (body =~ /multivalueParam/)
+      expect(body.scan(/^.*multivalueParam.*$/).size).to be == 2
+    end
+  end
+
+  def assert_additional_headers_added(post, parts_headers)
+    post.body_stream.rewind
+    body = post.body_stream.read
+    parts_headers.each do |part, headers|
+      headers.each do |k,v|
+        expect(body).to be =~ /#{k}: #{v}/
+      end
+    end
+  end
+end
+
+RSpec.describe Net::HTTP::Post::Multipart do
+  include_context "net http multipart"
+  
+  it "test_form_multipart_body" do
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    @io = File.open(TEMP_FILE)
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    assert_results Net::HTTP::Post::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
+  end
+
+  it "test_form_multipart_body_with_stringio" do
+    @io = StringIO.new("1234567890")
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    assert_results Net::HTTP::Post::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
+  end
+
+  it "test_form_multiparty_body_with_parts_headers" do
+    @io = StringIO.new("1234567890")
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    parts = { :text => 'bar', :file => @io }
+    headers = {
+      :parts => {
+        :text => { "Content-Type" => "part/type" },
+        :file => { "Content-Transfer-Encoding" => "part-encoding" }
+      }
+    }
+
+    request = Net::HTTP::Post::Multipart.new("/foo/bar", parts, headers)
+    assert_results request
+    assert_additional_headers_added(request, headers[:parts])
+  end
+
+  it "test_form_multipart_body_with_array_value" do
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    @io = File.open(TEMP_FILE)
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    params = {:foo => ['bar', 'quux'], :file => @io}
+    headers = { :parts => {
+        :foo => { "Content-Type" => "application/json; charset=UTF-8" } } }
+    post = Net::HTTP::Post::Multipart.new("/foo/bar", params, headers)
+    
+    expect(post.content_length).to be > 0
+    expect(post.body_stream).to_not be_nil
+
+    body = post.body_stream.read
+    expect(body.lines.grep(/name="foo"/).length).to be == 2
+    expect(body).to be =~ /Content-Type: application\/json; charset=UTF-8/
+  end
+
+  it "test_form_multipart_body_with_arrayparam" do
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    @io = File.open(TEMP_FILE)
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    assert_results Net::HTTP::Post::Multipart.new("/foo/bar", :multivalueParam => ['bar','bah'], :file => @io)
+  end
+end
+
+RSpec.describe Net::HTTP::Put::Multipart do
+  include_context "net http multipart"
+  
+  it "test_form_multipart_body_put" do
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    @io = File.open(TEMP_FILE)
+    @io = UploadIO.new @io, "text/plain", TEMP_FILE
+    assert_results Net::HTTP::Put::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
+  end
+end