multiparty 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by David Verhasselt (david@crowdway.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/README.md

@@ -0,0 +1,86 @@
+multiparty
+==========
+
+Easily generate a multipart/form-data header and body.
+
+Usage
+-----
+
+You can add multiple values, corresponding to multiple <input> statements:
+
+```ruby
+@multiparty = Multiparty.new
+@multiparty[:name] = "David Verhasselt"
+@multiparty[:state] = "awesome"
+@multiparty[:avatar] = {:filename => "avatar.jpg", :content => "...jpegdata..."}
+
+# Retrieve the header and body like this:
+@multiparty.header
+# Content-Type: multipart/form-data; boundary=multiparty-boundary-1342
+@multiparty.body
+# --multiparty-boundary-1342
+# Content-Disposition: form-data; name="name"
+#
+# David Verhasselt
+# --multiparty-boundary-1342
+# Content-Disposition: form-data; name="state"
+# 
+# awesome
+# --multiparty-boundary-1342
+# Content-Disposition: form-data; name="avatar"; filename="avatar.jpg"
+# Content-Type: application/octet-stream
+# Content-Transfer-Encoding: binary
+#
+# ...jpegdata...
+# --multiparty-boundary-1342--
+```
+
+You can also add files:
+
+```ruby
+@multiparty[:your_avatar] => File.open("foo.txt")
+```
+
+You can specify an optional content-type. If you don't, Multiparty will try and detect the correct MIME-type based on the filename.
+
+```ruby
+@multiparty[:your_avatar] => {:filename => "foo.jpg", :content_type => "text/plain", :content => File.read("foo.txt")}
+# -> Content-Type: text/plain
+@multiparty[:your_avatar] => {:filename => "foo.jpg", content => "not really jpeg")}
+# -> Content-Type: image/jpeg
+@multiparty[:your_avatar] => File.open("foo.jpg")
+# -> Content-Type: image/jpeg
+```
+
+Files and Tempfiles are interchangable in Multiparty:
+
+```ruby
+tempfile = Tempfile.new("foo")
+tempfile.write("Hello World!")
+tempfile.rewind
+
+@multiparty[:message] => tempfile
+# is the same as
+@multiparty[:message] => File.open(tempfile.path)
+```
+
+Installation
+------------
+
+    $ gem install multiparty
+
+Testing
+-------
+
+    $ bundle install
+    $ rake spec
+
+Todo
+----
+
+* Nested multiparts ("multipart/mixed") not yet supported
+
+Author
+------
+
+[David Verhasselt](http://davidverhasselt.com) - david@crowdway.com

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :spec
+task :test    => :spec
+
+desc "Run specs"
+task :spec do
+  exec "rspec spec/multiparty_spec.rb"
+end

data/lib/multiparty.rb

@@ -0,0 +1,74 @@
+require "mime/types"
+
+class Multiparty
+  attr_accessor :boundary
+  attr_accessor :parts
+
+  # Multiparty.new("my-boundary")
+  # Multiparty.new(:boundary => "my-boundary")
+  def initialize(options = {})
+    case options
+    when Hash
+      @boundary = options[:boundary]
+      @content_type = options[:content_type]
+    when String 
+      @boundary = options
+    end
+   
+    @parts = {}
+    @content_type ||= "multipart/form-data"
+    @boundary ||= "multiparty-boundary-#{rand(1000000000)}"
+
+    yield self if block_given?
+  end
+
+  def header
+    "Content-Type: #{@content_type}; boundary=#{@boundary}\r\n"
+  end
+
+  def body
+    result = "--#{@boundary}\r\n"
+    result << parts.map do |name, value|
+      parse_part(name, value)
+    end.join("\r\n")
+
+    result << "--"
+  end
+
+  def parse_part(name, value)
+    content_disposition = "form-data"
+    case value
+    when Hash
+      content_disposition = value[:content_disposition] if value[:content_disposition]
+      content_type = value[:content_type]
+      filename = value[:filename]
+      encoding = value[:encoding]
+      body_part = value[:content]
+    when File, Tempfile
+      content_type = "application/octet-stream"
+      filename = File.split(value.path).last
+      body_part = value.read
+    else
+      body_part = value
+    end
+    
+    if filename
+      content_type ||= MIME::Types.of(filename).first.to_s || "application/octet-stream"
+      encoding ||= "binary"
+    end
+
+    head_part = "Content-Disposition: #{content_disposition}; name=\"#{name}\""
+    head_part << "; filename=\"#{filename}\"" if filename
+    head_part << "\r\n"
+    head_part << "Content-Type: #{content_type}\r\n" if content_type
+    head_part << "Content-Transfer-Encoding: #{encoding}\r\n" if encoding
+
+    "#{head_part}\r\n#{body_part}\r\n--#{@boundary}"
+  end
+
+  def add_part(index, value)
+    parts[index] = value
+  end
+  alias_method :[]=, :add_part
+
+end

data/spec/multiparty_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "multiparty" do
+  it "should initialize" do
+    Multiparty.new.should_not be_nil
+  end
+
+  it "should accept a string as the boundary in #initialize" do
+    multiparty = Multiparty.new("my-boundary")
+    multiparty.boundary.should == "my-boundary"
+  end
+
+  it "should accept an option has in #initialize" do
+    multiparty = Multiparty.new :boundary => "my-boundary"
+    multiparty.boundary.should == "my-boundary"
+  end
+
+  it "should execute a block in #initialize" do
+    blocktest = false
+    Multiparty.new do
+      blocktest = true
+    end
+
+    blocktest.should be true 
+  end
+
+  describe "instance" do
+    before(:each) do
+      @multiparty = Multiparty.new("my-boundary")
+    end
+
+    it "should return a correct header" do
+      @multiparty.header.should == "Content-Type: multipart/form-data; boundary=my-boundary\r\n"
+    end
+
+    it "should be able to set-index a key-value pair" do
+      @multiparty[:key] = :value
+      @multiparty[:key] = {:filename => "hello.jpg", :content => ""}
+    end
+
+    it "should return a correctly formed multipart response" do
+      @multiparty.boundary = "AaB03x"
+      @multiparty['submit-name'] = "Larry"
+      @multiparty['files'] = {:filename => "file1.txt", :content_type => "text/plain", :content => "... contents of file1.txt ..."}
+
+      @multiparty.body.gsub("\r\n", "\n").should == '--AaB03x
+Content-Disposition: form-data; name="submit-name"
+
+Larry
+--AaB03x
+Content-Disposition: form-data; name="files"; filename="file1.txt"
+Content-Type: text/plain
+Content-Transfer-Encoding: binary
+
+... contents of file1.txt ...
+--AaB03x--'
+    end
+
+    it "should accept a File" do
+      begin
+        @tempfile = Tempfile.new("foo.txt")
+        @tempfile.write("Hi world!")
+        @tempfile.rewind
+        name = File.split(@tempfile.path).last
+
+        @multiparty[:bar] = @tempfile
+        @multiparty.body.gsub("\r\n", "\n").should == '--my-boundary
+Content-Disposition: form-data; name="bar"; filename="' + name + '"
+Content-Type: application/octet-stream
+Content-Transfer-Encoding: binary
+
+Hi world!
+--my-boundary--'
+      ensure
+        @tempfile.close
+        @tempfile.unlink
+      end
+    end
+  end    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'rspec'
+require 'tempfile'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require "multiparty"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: multiparty
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Verhasselt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |
+  Easily generate a multipart/form-data header and body.
+
+email: david@crowdway.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- lib/multiparty.rb
+- spec/spec_helper.rb
+- spec/multiparty_spec.rb
+has_rdoc: true
+homepage: http://github.com/dv/multiparty
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily generate a multipart/form-data header and body.
+test_files: []
+