rack-multipart_related 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,96 @@
 # Rack multipart/related middleware
 
-Rack::MultipartRelated it's a rack middleware to parse multipart/related requests and rebuild a simple/merged parameters hash.
+Rack::MultipartRelated it's a **rack middleware** to parse **multipart/related** requests and rebuild a simple/merged parameters hash.
+
+## What does it do?
+
+When a ruby webserver receives a multipart/related request:
+
+    POST /users HTTP/1.1
+    Content-Type: multipart/related; boundary="the_boundary"; type="application/json"; start="json"
+    
+    --the_boundary
+    Content-Type: application/json; charset=UTF-8
+    Content-Disposition: inline; name="json"\r
+    
+    {"user":{"name": "Jhon", "avatar": "cid:avatar_image" }}
+    --the_boundary
+    Content-Type: image/png
+    Content-Disposition: inline; name="avatar_image"; filename="avatar.png"
+    
+    <the binary content of image comes here>
+    --the_boundary--
+
+
+
+The parameters hash arrives like this:
+
+    {
+      "json" => {
+        :type => "application/json; charset=UTF-8", 
+        :tempfile => <File:/var/folders/Iu/IuwHUNlZE8OaYMACfwiapE+++TI/-Tmp-/RackMultipart20101217-30578-l17vkd-0>, # The json content
+        :head => "Content-Type: application/json; charset=UTF-8\r\nContent-Disposition: inline; name=\"json\"\r\n", 
+        :name => "json"
+      }, 
+      "avatar_image" => {
+        :type => "image/png", 
+        :filename =>"image.png", 
+        :tempfile => <File:/var/folders/Iu/IuwHUNlZE8OaYMACfwiapE+++TI/-Tmp-/RackMultipart20101217-30578-bt18q9-0>, # The binary content of image
+        :head => "Content-Type: image/gif\r\nContent-Disposition: inline; name=\"avatar_image\"; filename=\"image.png\"\r\n", 
+        :name =>"avatar_image"
+      }
+    }
+
+Pay attention that the second part of the 'request' (in our example, "avatar\_image") needs to be referenced in the first part (in the example, "json") as "cid:REFERENCE\_NAME\_OF\_THE\_SECOND\_PART"
+
+Using this middleware, the hash above is parsed and rebuilt like the code below:
+
+    {
+      "user" => {
+        "name" => "Jhon", 
+        "avatar" => <File:/var/folders/Iu/IuwHUNlZE8OaYMACfwiapE+++TI/-Tmp-/RackMultipart20101217-30578-bt18q9-0>, # The binary content of image
+      }
+    }
+    
+## Usage
+
+### Rails apps
+
+In your Gemfile:
+ 
+    gem 'rack-multipart_related'
+In your environment.rb:
+
+    require 'rack/multipart_related'
+    config.middleware.use Rack::MultipartRelated
+
+### Non-Rails apps
+
+Just 'use Rack::MultipartRelated' as any other middleware
+    
+## Restrictions
+
+At this moment, this middleware only supports JSON in the start part.
+
+## TODO
+
+ * Support other formats to start part, like XML.
+ 
+## Report bugs and suggestions
+
+  * [Issue Tracker](https://github.com/lucasfais/rack-multipart_related/issues)
+
+## Authors
+
+ * [Lucas Fais](https://github.com/lucasfais)
+ * [Marcelo Manzan](https://github.com/kawamanza)
+ 
+## Contributors
+
+ * [Eric Fer](https://github.com/ericfer)
+
+## References
+
+ * [RFC 2387](http://www.faqs.org/rfcs/rfc2387.html)
+ * [Rails on rack](http://guides.rubyonrails.org/rails_on_rack.html)
+ 

data/lib/rack/multipart_related/version.rb

@@ -1,6 +1,6 @@
 module Rack
   class MultipartRelated
-    path = File.expand_path('../../..', __FILE__)
+    path = ::File.expand_path('../../..', __FILE__)
     v = nil
     v = $1 if path =~ /\/rack-multipart_related-([\w\.\-]+)/
     if v.nil?
@@ -12,8 +12,8 @@ module Rack
       end
     end
     if v.nil?
-      path = File.expand_path('../../../../.git', __FILE__)
-      if File.exists?(path)
+      path = ::File.expand_path('../../../../.git', __FILE__)
+      if ::File.exists?(path)
         require "step-up"
         v = StepUp::Driver::Git.last_version
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-multipart_related
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Lucas Fais