nicksieger-multipart-post 0.9

data/Manifest.txt

@@ -0,0 +1,9 @@
+lib/composite_io.rb
+lib/multipartable.rb
+lib/parts.rb
+lib/net/http/post/multipart.rb
+Manifest.txt
+Rakefile
+README.txt
+test/test_composite_io.rb
+test/net/http/post/test_multipart.rb

data/README.txt

@@ -0,0 +1,61 @@
+= multipart-post
+
+* http://github.com/nicksieger/multipart-post
+
+== DESCRIPTION:
+
+Adds a multipart form post capability to Net::HTTP.
+
+== FEATURES/PROBLEMS:
+
+* Appears to actually work. A good feature to have.
+* Encapsulates posting of file/binary parts and name/value parameter parts, similar to 
+  most browsers' file upload forms.
+* Provides an UploadIO helper module to prepare IO objects for inclusion in the params
+  hash of the multipart post object.
+
+== SYNOPSIS:
+
+    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
+
+== REQUIREMENTS:
+
+None
+
+== INSTALL:
+
+gem install multipart-post
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007-2009 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
+'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.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+require 'rubygems'
+require 'hoe'
+
+require 'lib/multipart_post'
+
+hoe = Hoe.new("multipart-post", MultipartPost::VERSION) do |p|
+  p.rubyforge_name = "caldersphere"
+  p.author = "Nick Sieger"
+  p.url = "http://github.com/nicksieger/multipart-post"
+  p.email = "nick@nicksieger.com"
+  p.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."
+  p.summary = "Creates a multipart form post accessory for Net::HTTP."
+end
+
+task :gemspec do
+  File.open("#{hoe.name}.gemspec", "w") {|f| f << hoe.spec.to_ruby }
+end
+rescue LoadError
+  puts "You really need Hoe installed to be able to package this gem"
+end

data/lib/composite_io.rb

@@ -0,0 +1,89 @@
+#--
+# (c) Copyright 2007-2008 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+# Concatenate together multiple IO objects into a single, composite IO object
+# for purposes of reading as a single stream.
+#
+# Usage:
+#
+#     crio = CompositeReadIO.new(StringIO.new('one'), StringIO.new('two'), StringIO.new('three'))
+#     puts crio.read # => "onetwothree"
+#  
+class CompositeReadIO
+  # Create a new composite-read IO from the arguments, all of which should
+  # respond to #read in a manner consistent with IO.
+  def initialize(*ios)
+    @ios = ios.flatten
+  end
+
+  # Read from the IO object, overlapping across underlying streams as necessary.
+  def read(amount = nil, buf = nil)
+    buffer = buf || ''
+    done = if amount; nil; else ''; end
+    partial_amount = amount
+
+    loop do
+      result = done
+
+      while !@ios.empty? && (result = @ios.first.read(partial_amount)) == done
+        @ios.shift
+      end
+
+      buffer << result if result
+      partial_amount -= result.length if partial_amount && result != done
+
+      break if partial_amount && partial_amount <= 0
+      break if result == done
+    end
+
+    if buffer.length > 0
+      buffer
+    else
+      done
+    end
+  end
+end
+
+# Convenience methods for dealing with files and IO that are to be uploaded.
+module UploadIO
+  # Create an upload IO suitable for including in the params hash of a
+  # Net::HTTP::Post::Multipart.
+  #
+  # Can take two forms. The first accepts a filename and content type, and
+  # opens the file for reading (to be closed by finalizer). The second accepts
+  # an already-open IO, but also requires a third argument, the filename from
+  # which it was opened.
+  #
+  #     UploadIO.new("file.txt", "text/plain")
+  #     UploadIO.new(file_io, "text/plain", "file.txt")
+  def self.new(filename_or_io, content_type, filename = nil)
+    io = filename_or_io
+    unless io.respond_to? :read
+      io = File.open(filename_or_io)
+      filename = filename_or_io
+    end
+    convert!(io, content_type, File.basename(filename), filename)
+    io
+  end
+
+  # Enhance an existing IO for including in the params hash of a
+  # Net::HTTP::Post::Multipart by adding #content_type, #original_filename,
+  # and #local_path methods to the object's singleton class.
+  def self.convert!(io, content_type, original_filename, local_path)
+    io.instance_eval(<<-EOS, __FILE__, __LINE__)
+      def content_type
+        "#{content_type}"
+      end
+      def original_filename
+        "#{original_filename}"
+      end
+      def local_path
+        "#{local_path}"
+      end
+    EOS
+    io
+  end
+end

data/lib/multipartable.rb

@@ -0,0 +1,13 @@
+require 'parts'
+  module Multipartable
+    DEFAULT_BOUNDARY = "-----------RubyMultipartPost"
+    def initialize(path, params, headers={}, boundary = DEFAULT_BOUNDARY)
+      super(path, headers)
+      parts = params.map {|k,v| Parts::Part.new(boundary, k, v)}
+      parts << Parts::EpiloguePart.new(boundary)
+      ios = parts.map{|p| p.to_io }
+      self.set_content_type("multipart/form-data", { "boundary" => boundary })
+      self.content_length = parts.inject(0) {|sum,i| sum + i.length }
+      self.body_stream = CompositeReadIO.new(*ios)
+    end
+  end

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

@@ -0,0 +1,27 @@
+#--
+# (c) Copyright 2007-2008 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+require 'net/http'
+require 'stringio'
+require 'cgi'
+require 'composite_io'
+require 'multipartable'
+require 'parts'
+
+module Net #:nodoc:
+  class HTTP #:nodoc:
+    class Put
+      class Multipart < Put
+        include Multipartable
+      end
+    end
+    class Post #:nodoc:
+      class Multipart < Post
+        include Multipartable
+      end
+    end
+  end
+end

data/lib/parts.rb

@@ -0,0 +1,66 @@
+module Parts
+  module Part #:nodoc:
+    def self.new(boundary, name, value)
+      if value.respond_to? :content_type
+        FilePart.new(boundary, name, value)
+      else
+        ParamPart.new(boundary, name, value)
+      end
+    end
+
+    def length
+      @part.length
+    end
+
+    def to_io
+      @io
+    end
+  end
+
+  class ParamPart
+    include Part
+    def initialize(boundary, name, value)
+      @part = build_part(boundary, name, value)
+      @io = StringIO.new(@part)
+    end
+
+    def build_part(boundary, name, value)
+      part = ''
+      part << "--#{boundary}\r\n"
+      part << "Content-Disposition: form-data; name=\"#{name.to_s}\"\r\n"
+      part << "\r\n"
+      part << "#{value}\r\n"
+    end
+  end
+
+  # Represents a part to be filled from file IO.
+  class FilePart
+    include Part
+    attr_reader :length
+    def initialize(boundary, name, io)
+      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)
+      @length = @head.length + file_length
+      @io = CompositeReadIO.new(StringIO.new(@head), io, StringIO.new("\r\n"))
+    end
+
+    def build_head(boundary, name, filename, type, content_len)
+      part = ''
+      part << "--#{boundary}\r\n"
+      part << "Content-Disposition: form-data; name=\"#{name.to_s}\"; filename=\"#{filename}\"\r\n"
+      part << "Content-Length: #{content_len}\r\n"
+      part << "Content-Type: #{type}\r\n"
+      part << "Content-Transfer-Encoding: binary\r\n"
+      part << "\r\n"
+    end
+  end
+
+  # Represents the epilogue or closing boundary.
+  class EpiloguePart
+    include Part
+    def initialize(boundary)
+      @part = "--#{boundary}--\r\n"
+      @io = StringIO.new(@part)
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+#--
+# (c) Copyright 2007-2008 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+require 'net/http/post/multipart'
+
+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('')
+    end
+  end
+
+  def teardown
+    File.delete(TEMP_FILE) rescue nil
+  end
+
+  def test_form_multipart_body
+    File.open(TEMP_FILE, "w") {|f| f << "1234567890"}
+    @io = File.open(TEMP_FILE)
+    UploadIO.convert! @io, "text/plain", TEMP_FILE, 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)
+    UploadIO.convert! @io, "text/plain", TEMP_FILE, TEMP_FILE
+    assert_results Net::HTTP::Put::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
+  end
+  
+  def test_form_multipart_body_with_stringio
+    @io = StringIO.new("1234567890")
+    UploadIO.convert! @io, "text/plain", TEMP_FILE, TEMP_FILE
+    assert_results Net::HTTP::Post::Multipart.new("/foo/bar", :foo => 'bar', :file => @io)
+  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/
+  end
+end

data/test/test_composite_io.rb

@@ -0,0 +1,50 @@
+require 'composite_io'
+require 'stringio'
+require 'test/unit'
+
+class CompositeReadIOTest < Test::Unit::TestCase
+  def setup
+    @io = CompositeReadIO.new(CompositeReadIO.new(StringIO.new('the '), StringIO.new('quick ')),
+            StringIO.new('brown '), StringIO.new('fox'))
+  end
+
+  def test_full_read_from_several_ios
+    assert_equal 'the quick brown fox', @io.read
+  end
+  
+  def test_partial_read
+    assert_equal 'the quick', @io.read(9)
+  end
+  
+  def test_partial_read_to_boundary
+    assert_equal 'the quick ', @io.read(10)    
+  end
+  
+  def test_read_with_size_larger_than_available
+    assert_equal 'the quick brown fox', @io.read(32)
+  end
+  
+  def test_read_into_buffer
+    buf = ''
+    @io.read(nil, buf)
+    assert_equal 'the quick brown fox', buf
+  end
+  
+  def test_multiple_reads
+    assert_equal 'the ', @io.read(4)
+    assert_equal 'quic', @io.read(4)
+    assert_equal 'k br', @io.read(4)
+    assert_equal 'own ', @io.read(4)
+    assert_equal 'fox',  @io.read(4)
+  end
+  
+  def test_read_after_end
+    @io.read
+    assert_equal "", @io.read
+  end
+
+  def test_read_after_end_with_amount
+    @io.read(32)
+    assert_equal nil, @io.read(32)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: nicksieger-multipart-post
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+platform: ruby
+authors: 
+- Nick Sieger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+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."
+email: nick@nicksieger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+files: 
+- lib/composite_io.rb
+- lib/multipartable.rb
+- lib/parts.rb
+- lib/net/http/post/multipart.rb
+- Manifest.txt
+- Rakefile
+- README.txt
+- test/test_composite_io.rb
+- test/net/http/post/test_multipart.rb
+has_rdoc: true
+homepage: http://github.com/nicksieger/multipart-post
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: caldersphere
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Creates a multipart form post accessory for Net::HTTP.
+test_files: 
+- test/net/http/post/test_multipart.rb
+- test/test_composite_io.rb