multipart_body 0.1.0

data/lib/multipart_body.rb

@@ -0,0 +1,2 @@
+require 'multipart_body/multipart_body'
+require 'multipart_body/part'

data/lib/multipart_body/multipart_body.rb

@@ -0,0 +1,26 @@
+class MultipartBody
+  attr_accessor :parts, :boundary
+  
+  def initialize(parts = nil, boundary = nil)
+    @parts = []
+    @boundary = boundary || "----multipart-boundary-#{rand(1000000)}"
+    
+    if parts.is_a? Hash
+      @parts = parts.map {|name, body| Part.new(:name => name, :body => body) }
+    elsif parts.is_a?(Array) && parts.first.is_a?(Part)
+      @parts = parts
+    end
+    
+    self
+  end
+  
+  def self.from_hash(parts_hash)
+    multipart = self.new(parts_hash)
+  end
+  
+  def to_s
+    output = "--#{@boundary}\r\n"
+    output << @parts.join("\r\n--#{@boundary}\r\n")
+    output << "\r\n--#{@boundary}--"
+  end
+end

data/lib/multipart_body/part.rb

@@ -0,0 +1,43 @@
+class Part < Struct.new(:name, :body, :filename, :content_type, :encoding)
+  def initialize(*args)
+    if args.flatten.first.is_a? Hash
+      from_hash(args.flatten.first)
+    elsif args.length > 0
+      from_args(*args)
+    end
+  end
+  
+  def from_hash(hash)
+    hash.each_pair do |k, v|
+      self[k] = v
+    end
+  end
+  
+  def from_args(name, body, filename=nil)
+    self[:name] = name
+    self[:body] = body
+    self[:filename] = filename
+  end
+  
+  def header
+    header = "Content-Disposition: form-data; name=\"#{name}\""
+    header << "; filename=\"#{filename}\"" if filename
+    header << "\r\nContent-Type: #{content_type}" if content_type
+    header << "\r\nContent-Transfer-Encoding: #{encoding}" if encoding
+    header
+  end
+  
+  # TODO: Implement encodings
+  def encoded_body
+    case encoding
+    when nil
+      body
+    else
+      raise "Encodings have not been implemented"
+    end
+  end
+  
+  def to_s
+    "#{header}\r\n\r\n#{encoded_body}"
+  end
+end

data/readme.md

@@ -0,0 +1,30 @@
+# MultipartBody
+The multipart body is an attempt to bring consistency to multipart content in Ruby. When developing CloudMailin we struggled to find a gem to help us create multipart bodies. Many different libraries had implemented multipart bodies through their own implementation but non could be used independently.
+
+The aim of MultipartBody is to ensure consistency when creating (and parsing in future) multipart content
+
+## Usage
+
+    require 'multipart_body'
+
+    # From a hash
+    multipart = Multipart.new(:field1 => 'content', :field2 => 'something else')
+
+    # With parts
+    part = Part.new(:name => 'name', :body => 'body', :filename => 'f.txt', :content_type => 'text/plain', :encoding => :base64)
+    
+    # or to specify just the name, body and optional filename
+    part = Part.new('name', 'content', 'file.txt')
+    multipart = Multipart.new([part])
+
+    # Output
+    part.to_s #=> The part with headers and content
+    multipart.to_s #=> The full list of parts joined by boundaries
+
+## TODO
+  * Implement Parsing
+  * Add different encodings
+  * Add the ability to automatically add files and have the filename set
+
+## License
+Copyright 2010 by Steve Smith ([CloudMailin](http://cloudmailin.com)) and is released under the MIT license.

data/test/test.rb

@@ -0,0 +1,122 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MultipartBodyTest < Test::Unit::TestCase
+  context "MultipartBodyBody" do
+    setup do
+      @hash = {:test => 'test', :two => 'two'}
+      @parts = [Part.new('name', 'value'), Part.new('name2', 'value2')]
+    end
+    
+    should "return a new multipart when sent #from_hash" do
+      multipart = MultipartBody.from_hash(@hash)
+      assert_equal MultipartBody, multipart.class
+    end
+    
+    should "create a list of parts from the hash when sent #from_hash" do
+      multipart = MultipartBody.from_hash(@hash)
+      assert_equal @hash, Hash[multipart.parts.map{|part| [part.name, part.body] }]
+    end
+    
+    should "add to the list of parts when sent #new with a hash" do
+      multipart = MultipartBody.new(@hash)
+      assert_equal @hash, Hash[multipart.parts.map{|part| [part.name, part.body] }]
+    end
+    
+    should "correctly add parts sent #new with parts" do
+      multipart = MultipartBody.new(@parts)
+      assert_same_elements @parts, multipart.parts
+    end
+    
+    should "assign a boundary if it is not given" do
+      multpart = MultipartBody.new()
+      assert_match /[\w\d-]{10,}/, multpart.boundary
+    end
+    
+    should "use the boundary provided if given" do
+      multipart = MultipartBody.new(nil, "my-boundary")
+      assert_equal "my-boundary", multipart.boundary
+    end
+    
+    should "starts with a boundary when sent #to_s" do
+      multipart = MultipartBody.new(@parts)
+      assert_match /^--#{multipart.boundary}/i, multipart.to_s
+    end
+    
+    should "end with a boundary when sent #to_s" do
+      multipart = MultipartBody.new(@parts)
+      assert_match /--#{multipart.boundary}--\z/i, multipart.to_s
+    end
+    
+    should "contain the parts joined by a boundary when sent #to_s" do
+      multipart = MultipartBody.new(@parts)
+      assert_match multipart.parts.join("\r\n--#{multipart.boundary}\r\n"), multipart.to_s
+    end
+  end
+  
+  context "a Part" do
+    setup do
+      @part = Part
+    end
+    
+    should "assign values when sent #new with a hash" do
+      part = Part.new(:name => 'test', :body => 'content', :filename => 'name')
+      assert_equal 'test', part.name
+      assert_equal 'content', part.body
+      assert_equal 'name', part.filename
+    end
+    
+    should "assign values when sent #new with values" do
+      part = Part.new('test', 'content', 'name')
+      assert_equal 'test', part.name
+      assert_equal 'content', part.body
+      assert_equal 'name', part.filename
+    end
+    
+    should "be happy when sent #new with args without a filename" do
+      part = Part.new('test', 'content')
+      assert_equal 'test', part.name
+      assert_equal 'content', part.body
+      assert_equal nil, part.filename
+    end
+    
+    should "create an empty part when sent #new with nothing" do
+      part = Part.new()
+      assert_equal nil, part.name
+      assert_equal nil, part.body
+      assert_equal nil, part.filename
+    end
+    
+    should "include a content disposition when sent #header name" do
+      part = Part.new(:name => 'key', :body => 'content')
+      assert_match /content-disposition: form-data; name="key"/i, part.header
+    end
+    
+    should "include no filename when sent #header and a filename is not set" do
+      part = Part.new(:name => 'key', :body => 'content')
+      assert_no_match /content-disposition: .+; name=".+"; filename="?.*"?/i, part.header
+    end
+    
+    should "include a filename when sent #header and a filename is set" do
+      part = Part.new(:name => 'key', :body => 'content', :filename => 'file.jpg')
+      assert_match /content-disposition: .+; name=".+"; filename="file.jpg"/i, part.header
+    end
+    
+    should "return the original body if encoding is not set" do
+      part = Part.new(:name => 'key', :body => 'content')
+      assert_equal 'content', part.encoded_body
+    end
+    
+    # TODO: Implement encoding tests
+    should "raise an exception when an encoding is passed" do
+      part = Part.new(:name => 'key', :body => 'content', :encoding => :base64)
+      assert_raises RuntimeError do
+        part.encoded_body
+      end
+    end
+    
+    should "output the header and body when sent #to_s" do
+      part = Part.new(:name => 'key', :body => 'content')
+      assert_equal "#{part.header}\r\n\r\n#{part.body}", part.to_s
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'multipart_body'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: multipart_body
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-17 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A ruby library to create multipart bodies.
+email: gems@scsworld.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- readme.md
+- lib/multipart_body/multipart_body.rb
+- lib/multipart_body/part.rb
+- lib/multipart_body.rb
+- test/test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cloudmailin/multipart_body
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: MultipartBody allows you to create consistant multipart bodies
+test_files: 
+- test/test.rb
+- test/test_helper.rb