multipart-post 1.2.0 → 2.0.0

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 *~
 *.swo
 *.swp
+/Gemfile.lock

data/.travis.yml

@@ -1,6 +1,6 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - 1.9.3
+  - 2.0.0
   - jruby
 branches:
   only:

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 platforms :mri_19 do

data/History.txt

@@ -1,3 +1,16 @@
+=== 2.0.0 / 2013-12-21
+
+- Drop Ruby 1.8 compatibility
+- GH #21: Fix FilePart length calculation for Ruby 1.9 when filename contains
+  multibyte characters (hexfet)
+- GH #20: Ensure upload responds to both #content_type and #original_filename
+  (Steven Davidovitz)
+- GH #31: Support setting headers on any part of the request (Socrates Vicente)
+- GH #30: Support array values for params (Gustav Ernberg)
+- GH #32: Fix respond_to? signature (Leo Cassarani)
+- GH #33: Update README to markdown (Jagtesh Chadha)
+- GH #35: Improved handling of array-type parameters (Steffen Grunwald)
+
 === 1.2.0 / 2013-02-25
 
 - #25: Ruby 2 compatibility (thanks mislav)

data/{README.txt → README.md}

@@ -1,13 +1,15 @@
-= multipart-post
+## multipart-post
 
 * http://github.com/nicksieger/multipart-post
 
-== DESCRIPTION:
+![build status](https://travis-ci.org/nicksieger/multipart-post.png)
+
+#### DESCRIPTION:
 
 Adds a streamy multipart form post capability to Net::HTTP. Also
 supports other methods besides POST.
 
-== FEATURES/PROBLEMS:
+#### FEATURES/PROBLEMS:
 
 * Appears to actually work. A good feature to have.
 * Encapsulates posting of file/binary parts and name/value parameter parts, similar to 
@@ -15,7 +17,7 @@ supports other methods besides POST.
 * Provides an UploadIO helper class to prepare IO objects for inclusion in the params
   hash of the multipart post object.
 
-== SYNOPSIS:
+#### SYNOPSIS:
 
     require 'net/http/post/multipart'
 
@@ -28,19 +30,32 @@ supports other methods besides POST.
       end
     end
 
-== REQUIREMENTS:
+To post multiple files or attachments, simply include multiple parameters with
+UploadIO values:
+
+    require 'net/http/post/multipart'
+
+    url = URI.parse('http://www.example.com/upload')
+    req = Net::HTTP::Post::Multipart.new url.path,
+      "file1" => UploadIO.new(File.new("./image.jpg"), "image/jpeg", "image.jpg"),
+      "file2" => UploadIO.new(File.new("./image2.jpg"), "image/jpeg", "image2.jpg")
+    res = Net::HTTP.start(url.host, url.port) do |http|
+      http.request(req)
+    end
+
+#### REQUIREMENTS:
 
 None
 
-== INSTALL:
+#### INSTALL:
 
-gem install multipart-post
+    gem install multipart-post
 
-== LICENSE:
+#### LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2007-2012 Nick Sieger <nick@nicksieger.com>
+Copyright (c) 2007-2013 Nick Sieger <nick@nicksieger.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/composite_io.rb

@@ -102,7 +102,7 @@ class UploadIO
     @io.send(*args)
   end
 
-  def respond_to?(meth)
-    @io.respond_to?(meth) || super(meth)
+  def respond_to?(meth, include_all = false)
+    @io.respond_to?(meth, include_all) || super(meth, include_all)
   end
 end

data/lib/multipart_post.rb

@@ -5,5 +5,5 @@
 #++
 
 module MultipartPost
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/lib/multipartable.rb

@@ -1,5 +1,5 @@
 #--
-# 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.
 #++
@@ -8,10 +8,19 @@ require 'parts'
   module Multipartable
     DEFAULT_BOUNDARY = "-----------RubyMultipartPost"
     def initialize(path, params, headers={}, boundary = DEFAULT_BOUNDARY)
+      headers = headers.clone # don't want to modify the original variable
+      parts_headers = headers.delete(:parts) || {}
       super(path, headers)
-      parts = params.map {|k,v| Parts::Part.new(boundary, k, v)}
+      parts = params.map do |k,v|
+        case v
+        when Array
+          v.map {|item| Parts::Part.new(boundary, k, item, parts_headers[k]) }
+        else
+          Parts::Part.new(boundary, k, v, parts_headers[k])
+        end
+      end.flatten
       parts << Parts::EpiloguePart.new(boundary)
-      ios = parts.map{|p| p.to_io }
+      ios = parts.map {|p| p.to_io }
       self.set_content_type(headers["Content-Type"] || "multipart/form-data",
                             { "boundary" => boundary })
       self.content_length = parts.inject(0) {|sum,i| sum + i.length }

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)
+    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
@@ -25,19 +30,20 @@ module Parts
 
   class ParamPart
     include Part
-    def initialize(boundary, name, value)
-      @part = build_part(boundary, name, value)
+    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)
+    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
@@ -47,16 +53,16 @@ module Parts
   class FilePart
     include Part
     attr_reader :length
-    def initialize(boundary, name, io)
+    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
 
-    def build_head(boundary, name, filename, type, content_len, opts = {})
+    def build_head(boundary, name, filename, type, content_len, opts = {}, headers = {})
       trans_encoding = opts["Content-Transfer-Encoding"] || "binary"
       content_disposition = opts["Content-Disposition"] || "form-data"
 
@@ -67,7 +73,13 @@ module Parts
       if content_id = opts["Content-ID"]
         part << "Content-ID: #{content_id}\r\n"
       end
-      part << "Content-Type: #{type}\r\n"
+
+      if headers["Content-Type"] != nil
+        part <<  "Content-Type: " + headers["Content-Type"] + "\r\n"
+      else
+        part << "Content-Type: #{type}\r\n"
+      end
+
       part << "Content-Transfer-Encoding: #{trans_encoding}\r\n"
       part << "\r\n"
     end

data/multipart-post.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |s|
   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"]
 end

data/test/net/http/post/test_multipart.rb

@@ -1,5 +1,5 @@
 #--
-# 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.
 #++
@@ -40,6 +40,47 @@ class Net::HTTP::Post::MultiPartTest < Test::Unit::TestCase
     assert_results Net::HTTP::Post::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
   end
 
+  def test_form_multiparty_body_with_parts_headers
+    @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
+
+  def test_form_multipart_body_with_array_value
+    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
+
+    body = post.body_stream.read
+    assert_equal 2, body.lines.grep(/name="foo"/).length
+    assert body =~ /Content-Type: application\/json; charset=UTF-8/, body
+  end
+
+  def test_form_multipart_body_with_arrayparam
+    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
+
   def assert_results(post)
     assert post.content_length && post.content_length > 0
     assert post.body_stream
@@ -52,5 +93,18 @@ class Net::HTTP::Post::MultiPartTest < Test::Unit::TestCase
     # 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
   end
 end

data/test/test_parts.rb

@@ -9,6 +9,7 @@ require 'test/unit'
 require 'parts'
 require 'stringio'
 require 'composite_io'
+require 'tempfile'
 
 
 MULTIBYTE = File.dirname(__FILE__)+'/multibyte.txt'
@@ -22,6 +23,27 @@ module AssertPartLength
   end
 end
 
+class PartTest < Test::Unit::TestCase
+  def setup
+    @string_with_content_type = Class.new(String) do
+      def content_type; 'application/data'; end
+    end
+  end
+
+  def test_file_with_upload_io
+    assert Parts::Part.file?(UploadIO.new(__FILE__, "text/plain"))
+  end
+
+  def test_file_with_modified_string
+    assert !Parts::Part.file?(@string_with_content_type.new("Hello"))
+  end
+
+  def test_new_with_modified_string
+    assert_kind_of Parts::ParamPart,
+      Parts::Part.new("boundary", "multibyte", @string_with_content_type.new("Hello"))
+  end
+end
+
 class FilePartTest < Test::Unit::TestCase
   include AssertPartLength
 
@@ -42,6 +64,13 @@ class FilePartTest < Test::Unit::TestCase
   def test_multibyte_file_length
     assert_part_length Parts::FilePart.new("boundary", "multibyte", UploadIO.new(MULTIBYTE, "text/plain"))
   end
+
+  def test_multibyte_filename
+    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
 end
 
 class ParamPartTest < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multipart-post
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies: []
 description: ! '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.'
@@ -22,10 +22,9 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - History.txt
 - Manifest.txt
-- README.txt
+- README.md
 - Rakefile
 - lib/composite_io.rb
 - lib/multipart_post.rb
@@ -41,7 +40,12 @@ homepage: https://github.com/nicksieger/multipart-post
 licenses:
 - MIT
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- README.md
+- -SHN
+- -f
+- darkfish
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -50,15 +54,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3851181222699685043
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3851181222699685043
 requirements: []
 rubyforge_project: caldersphere
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A multipart form post accessory for Net::HTTP.

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    multipart-post (1.2.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    archive-tar-minitar (0.5.2)
-    columnize (0.3.6)
-    linecache (0.43)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
-    rake (0.9.2.2)
-    ruby-debug (0.10.3)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
-      linecache (>= 0.3)
-    ruby-debug-base19 (0.11.25)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  multipart-post!
-  rake
-  ruby-debug
-  ruby-debug19