multipart-post 2.0.0 → 2.1.0

data/multipart-post.gemspec

@@ -2,21 +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.license     = "MIT"
-  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.rdoc_options = ["--main", "README.md", "-SHN", "-f", "darkfish"]
-  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/{test/net/http/post/test_multipart.rb → spec/net/http/post/multipart_spec.rb}

@@ -5,42 +5,72 @@
 #++
 
 require 'net/http/post/multipart'
-require 'test/unit'
 
-class Net::HTTP::Post::MultiPartTest < Test::Unit::TestCase
-  TEMP_FILE = "temp.txt"
-
-  HTTPPost = Struct.new("HTTPPost", :content_length, :body_stream, :content_type)
-  HTTPPost.module_eval do
-    def set_content_type(type, params = {})
-      self.content_type = type + params.map{|k,v|"; #{k}=#{v}"}.join('')
+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 teardown
-    File.delete(TEMP_FILE) rescue nil
+  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
 
-  def test_form_multipart_body
+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
-  def test_form_multipart_body_put
-    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
 
-  def test_form_multipart_body_with_stringio
+  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
 
-  def test_form_multiparty_body_with_parts_headers
+  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 }
@@ -56,55 +86,38 @@ class Net::HTTP::Post::MultiPartTest < Test::Unit::TestCase
     assert_additional_headers_added(request, headers[:parts])
   end
 
-  def test_form_multipart_body_with_array_value
+  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,
-                                          Net::HTTP::Post::Multipart::DEFAULT_BOUNDARY)
-
-    assert post.content_length && post.content_length > 0
-    assert post.body_stream
+    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
-    assert_equal 2, body.lines.grep(/name="foo"/).length
-    assert body =~ /Content-Type: application\/json; charset=UTF-8/, body
+    expect(body.lines.grep(/name="foo"/).length).to be == 2
+    expect(body) =~ /Content-Type: application\/json; charset=UTF-8/
   end
 
-  def test_form_multipart_body_with_arrayparam
+  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
 
-  def assert_results(post)
-    assert post.content_length && post.content_length > 0
-    assert post.body_stream
-    assert_equal "multipart/form-data; boundary=#{Multipartable::DEFAULT_BOUNDARY}", post['content-type']
-    body = post.body_stream.read
-    boundary_regex = Regexp.quote Multipartable::DEFAULT_BOUNDARY
-    assert body =~ /1234567890/
-    # ensure there is at least one boundary
-    assert body =~ /^--#{boundary_regex}\r\n/
-    # ensure there is an epilogue
-    assert body =~ /^--#{boundary_regex}--\r\n/
-    assert body =~ /text\/plain/
-    if (body =~ /multivalueParam/)
-    	assert_equal 2, body.scan(/^.*multivalueParam.*$/).size
-    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|
-        assert body =~ /#{k}: #{v}/
-      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

data/spec/parts_spec.rb

@@ -0,0 +1,102 @@
+# 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 'parts'
+require 'stringio'
+require 'composite_io'
+require 'tempfile'
+
+MULTIBYTE = File.dirname(__FILE__)+'/multibyte.txt'
+TEMP_FILE = "temp.txt"
+
+module AssertPartLength
+  def assert_part_length(part)
+    bytes = part.to_io.read
+    bytesize = bytes.respond_to?(:bytesize) ? bytes.bytesize : bytes.length
+    expect(bytesize).to be == part.length
+  end
+end
+
+RSpec.describe Parts do
+  let(:string_with_content_type) do
+    Class.new(String) do
+      def content_type; 'application/data'; end
+    end
+  end
+
+  it "test_file_with_upload_io" do
+    expect(Parts::Part.file?(UploadIO.new(__FILE__, "text/plain"))).to be true
+  end
+
+  it "test_file_with_modified_string" do
+    expect(Parts::Part.file?(string_with_content_type.new("Hello"))).to be false
+  end
+
+  it "test_new_with_modified_string" do
+    expect(Parts::Part.new("boundary", "multibyte", string_with_content_type.new("Hello"))).to be_kind_of(Parts::ParamPart)
+  end
+end
+
+RSpec.describe Parts::FilePart do
+  include AssertPartLength
+
+  before(:each) do
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    io =  UploadIO.new(TEMP_FILE, "text/plain")
+    @part = Parts::FilePart.new("boundary", "afile", io)
+  end
+
+  after(:each) do
+    File.delete(TEMP_FILE) rescue nil
+  end
+
+  it "test_correct_length" do
+    assert_part_length @part
+  end
+
+  it "test_multibyte_file_length" do
+    assert_part_length Parts::FilePart.new("boundary", "multibyte", UploadIO.new(MULTIBYTE, "text/plain"))
+  end
+
+  it "test_multibyte_filename" do
+    name = File.read(MULTIBYTE, 300)
+    file = Tempfile.new(name.respond_to?(:force_encoding) ? name.force_encoding("UTF-8") : name)
+    assert_part_length Parts::FilePart.new("boundary", "multibyte", UploadIO.new(file, "text/plain"))
+    file.close
+  end
+
+   it "test_force_content_type_header" do
+    part = Parts::FilePart.new("boundary", "afile", UploadIO.new(TEMP_FILE, "text/plain"), { "Content-Type" => "application/pdf" })
+    expect(part.to_io.read).to match(/Content-Type: application\/pdf/)
+  end
+end
+
+RSpec.describe Parts::ParamPart do
+  include AssertPartLength
+
+  before(:each) do
+    @part = Parts::ParamPart.new("boundary", "multibyte", File.read(MULTIBYTE))
+  end
+
+  it "test_correct_length" do
+    assert_part_length @part
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+
+if ENV['COVERAGE']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "multipart_post"
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end