multipart_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b5401a95c9f84dd50f880f1b3f7600f75ef67c7
+  data.tar.gz: 7dd6495855fe2ffb3352683f382871ea2e7e3d7c
+SHA512:
+  metadata.gz: 6ade21353b43a28ddbeb6c75ea07970070dfbe79692b2977ea438236f26ff43fd58d7ca6b1fca91c2e0394a4d0510931e8b5253e2b53922624db5bbeae076ed7
+  data.tar.gz: b19416e99743307d1696b7bf792c08c31416e9548b9cd14e5f67eba29fbd5282aae371a57de340f6f88eeeb00e5f73e74e3817b73510d53a2a469433b8cb31eb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multipart_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,27 @@
+
+
+Copyright (c) 2015 Benjamin Bryant
+
+
+ext/multipart_parser/multipart_parser_c.c and ext/multipart_parser/multipart_parser_c.h modified from code written by Igor Afonov https://github.com/iafonov/multipart-parser-c also issued under an MIT license.
+
+MIT License
+
+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,182 @@
+# MultipartParser
+
+A c backed multipart/form-data parser. 
+
+Ruby extenstion for https://github.com/iafonov/multipart-parser-c, modeled after http_parser.rb
+
+
+Multipart-parser C has been modfied to have a more consistent callback structure with http_parser.rb
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multipart_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multipart_parser
+
+## Usage
+
+
+
+```ruby
+
+require 'multipart_parser'
+
+parser = MultipartParser.new("Boundary+17376C87E2579930")
+
+
+# Setups callbacks
+parser.on_message_begin = proc { puts "# => on_message_begin"}
+parser.on_part_begin = proc { puts "# => on_part_begin"}
+parser.on_headers_complete = proc {|headers| puts "# => on_headers_complete: #{headers.inspect}"}
+parser.on_data = proc {|data| puts "# => on_data: #{data}"}
+parser.on_part_complete = proc {puts "# => on_part_complete"}
+parser.on_message_complete = proc {puts "# => on_message_complete"}
+
+
+parser << "--Boundary+17376C87E2579930\r\n"
+
+# => on_message_begin
+# => on_part_begin
+
+parser << "Content-Disposition: form-data; name=ID1\r\n"
+parser << "Content-Type: text/plain\r\n\r\n"
+parser << "This is the first part.\r\n"
+
+# => on_headers_complete: {"Content-Disposition"=>"form-data; name=ID1", "Content-Type"=>"text/plain"}
+# => on_data: This is the first part.
+
+
+
+parser << "--Boundary+17376C87E2579930\r\n"
+
+# => on_part_complete
+# => on_part_begin
+# => 
+parser << "Content-Disposition: form-data; name=ID2\r\n"
+parser << "Content-Type: text/plain\r\n\r\n"
+parser << "This is the second part.\r\n";
+
+parser << "--Boundary+17376C87E2579930--\r\n"
+
+# => on_headers_complete: {"Content-Disposition"=>"form-data; name=ID2", "Content-Type"=>"text/plain"}
+# => on_data: This is the second part.
+# => on_part_complete
+# => on_message_complete
+
+```
+
+```ruby
+# Also allows you to pass a callback object
+
+
+class Handler
+  def on_message_begin;  puts "# => on_message_begin"; end
+  def on_part_begin;  puts "# => on_part_begin"; end
+  def on_headers_complete(headers); puts "# => on_headers_complete: #{headers.inspect}"; end
+  def on_data(data); puts "# => on_data: #{data}"; end
+  def on_part_complete; puts "# => on_part_complete"; end
+  def on_message_complete; puts "# => on_message_complete"; end
+end
+
+
+parser = MultipartParser.new("Boundary+17376C87E2579930", Handler.new)
+
+
+parser << "--Boundary+17376C87E2579930\r\n"
+
+# => on_message_begin
+# => on_part_begin
+
+parser << "Content-Disposition: form-data; name=ID1\r\n"
+parser << "Content-Type: text/plain\r\n\r\n"
+parser << "This is the first part.\r\n"
+
+# => on_headers_complete: {"Content-Disposition"=>"form-data; name=ID1", "Content-Type"=>"text/plain"}
+# => on_data: This is the first part.
+
+parser << "--Boundary+17376C87E2579930\r\n"
+
+# => on_part_complete
+# => on_part_begin
+
+
+parser << "Content-Disposition: form-data; name=ID2\r\n"
+parser << "Content-Type: text/plain\r\n\r\n"
+parser << "This is the second part.\r\n";
+
+parser << "--Boundary+17376C87E2579930--\r\n"
+
+# => on_headers_complete: {"Content-Disposition"=>"form-data; name=ID2", "Content-Type"=>"text/plain"}
+# => on_data: This is the second part.
+# => on_part_complete
+# => on_message_complete
+
+```
+
+```ruby
+
+# Accepts a config paramter to modify how the headers are returned
+
+parser = MultipartParser.new("Boundary+17376C87E2579930", Handler.new, :arrays)
+
+# valid values are :arrays, :strings, :mixed
+
+parser << "--Boundary+17376C87E2579930\r\n"
+parser << "Content-Disposition: form-data; name=ID_A\r\n"
+parser << "Content-Disposition: form-data; name=ID_B\r\n"
+parser << "Content-Type: text/plain\r\n\r\n"
+parser << "This is the first part.\r\n"
+
+
+# => on_headers_complete: {"Content-Disposition"=>["form-data; name=ID_A", "form-data; name=ID_B"], "Content-Type"=>["text/plain"]}
+
+
+parser = MultipartParser.new("Boundary+17376C87E2579930", Handler.new, :strings)
+
+# => on_headers_complete: {"Content-Disposition"=>"form-data; name=ID_A, form-data; name=ID_B", "Content-Type"=>"text/plain"}
+
+
+
+parser = MultipartParser.new("Boundary+17376C87E2579930", Handler.new, :mixed)
+
+# => on_headers_complete: {"Content-Disposition"=>["form-data; name=ID_A", "form-data; name=ID_B"], "Content-Type"=>"text/plain"}
+
+
+```
+
+
+```ruby
+
+# Set the default(:mixed)
+
+
+MultipartParser.default_header_value_type = :arrays
+
+
+parser = MultipartParser.new("Boundary+17376C87E2579930", Handler.new)
+
+# => on_headers_complete: {"Content-Disposition"=>["form-data; name=ID_A", "form-data; name=ID_B"], "Content-Type"=>["text/plain"]}
+
+
+```
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/multipart_parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("multipart_parser") do |ext|
+  ext.lib_dir = "lib/multipart_parser"
+end

data/ext/multipart_parser/ext_help.h

@@ -0,0 +1,18 @@
+#ifndef ext_help_h
+#define ext_help_h
+
+#define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "NULL found for " # T " when shouldn't be.");
+#define DATA_GET(from,type,name) Data_Get_Struct(from,type,name); RAISE_NOT_NULL(name);
+#define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "Wrong argument type for " # V " required " # T);
+
+/* for compatibility with Ruby 1.8.5, which doesn't declare RSTRING_PTR */
+#ifndef RSTRING_PTR
+#define RSTRING_PTR(s) (RSTRING(s)->ptr)
+#endif
+
+/* for compatibility with Ruby 1.8.5, which doesn't declare RSTRING_LEN */
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(s) (RSTRING(s)->len)
+#endif
+
+#endif

data/ext/multipart_parser/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("multipart_parser/multipart_parser")