multipart-post 2.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7f48186ca2c1e47dbb18d8ba20ed99e1d2dbabac5735c47a5fdf3f3de2ff6c1
+  data.tar.gz: 86bdb76a37261133d45eba29e94c6026118564fa0168120549d64a8cf89e19f7
+SHA512:
+  metadata.gz: 47022f82aba55743549c58e82cda833a1f769927ca7c348b35e8dbcfeec851ca5570ef4b43755d33c4d5957a97b915412e86d9b333769f5cd11d0b9cdeede744
+  data.tar.gz: c9c767b946971349722a5798b0594f9da22095262f0f322391656dc79e73a677a48b0fdc53942f5bfbfe58d258c7e6df8bd3fb02821b49a64f794c6f898012d5

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format documentation
+--backtrace
+--require spec_helper
+--warnings

data/.travis.yml

@@ -1,7 +1,18 @@
+language: ruby
+cache: bundler
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - jruby
-branches:
-  only:
-    - master
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: "ruby-head"
+    - rvm: "jruby-head"

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+lib/**/*.rb
+-
+History.txt
+LICENSE
+README.md

data/Gemfile

@@ -1,14 +1,6 @@
 source 'https://rubygems.org'
 gemspec
 
-platforms :mri_19 do
-  gem 'ruby-debug19'
-end
-
-platforms :mri_18 do
-  gem 'ruby-debug'
-end
-
 group :development, :test do
   gem 'rake'
 end

data/History.txt

@@ -1,3 +1,8 @@
+<!--
+# @markup rdoc
+# @title CHANGELOG
+-->
+
 === 2.0.0 / 2013-12-21
 
 - Drop Ruby 1.8 compatibility
@@ -57,4 +62,3 @@
 * 1 major enhancement
 
   * Birthday!
-

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2013 Nick Sieger nick@nicksieger.com
+Copyright, 2017, by Samuel G. D. Williams.
+
+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

@@ -1,77 +1,127 @@
-## multipart-post
+# `Multipart::Post`
 
-* http://github.com/nicksieger/multipart-post
+Adds a streamy multipart form post capability to `Net::HTTP`. Also supports other
+methods besides `POST`.
 
-![build status](https://travis-ci.org/nicksieger/multipart-post.png)
+[![Build Status](https://secure.travis-ci.org/ioquatix/multipart-post.svg)](http://travis-ci.org/ioquatix/multipart-post)
 
-#### DESCRIPTION:
-
-Adds a streamy multipart form post capability to Net::HTTP. Also
-supports other methods besides POST.
-
-#### FEATURES/PROBLEMS:
+## Features/Problems
 
 * Appears to actually work. A good feature to have.
-* Encapsulates posting of file/binary parts and name/value parameter parts, similar to 
+* Encapsulates posting of file/binary parts and name/value parameter parts, similar to
   most browsers' file upload forms.
-* Provides an UploadIO helper class to prepare IO objects for inclusion in the params
+* Provides an `UploadIO` helper class 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
-
-To post multiple files or attachments, simply include multiple parameters with
-UploadIO values:
-
-    require 'net/http/post/multipart'
-
-    url = URI.parse('http://www.example.com/upload')
-    req = Net::HTTP::Post::Multipart.new url.path,
-      "file1" => UploadIO.new(File.new("./image.jpg"), "image/jpeg", "image.jpg"),
-      "file2" => UploadIO.new(File.new("./image2.jpg"), "image/jpeg", "image2.jpg")
-    res = Net::HTTP.start(url.host, url.port) do |http|
-      http.request(req)
-    end
-
-#### REQUIREMENTS:
-
-None
-
-#### INSTALL:
+## Installation
 
     gem install multipart-post
 
-#### LICENSE:
+or in your Gemfile
 
-(The MIT License)
+    gem 'multipart-post'
 
-Copyright (c) 2007-2013 Nick Sieger <nick@nicksieger.com>
+## Usage
 
-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:
+```ruby
+require 'net/http/post/multipart'
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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
+```
 
-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.
+To post multiple files or attachments, simply include multiple parameters with
+`UploadIO` values:
+
+```ruby
+require 'net/http/post/multipart'
+
+url = URI.parse('http://www.example.com/upload')
+req = Net::HTTP::Post::Multipart.new url.path,
+  "file1" => UploadIO.new(File.new("./image.jpg"), "image/jpeg", "image.jpg"),
+  "file2" => UploadIO.new(File.new("./image2.jpg"), "image/jpeg", "image2.jpg")
+res = Net::HTTP.start(url.host, url.port) do |http|
+  http.request(req)
+end
+```
+
+To post files with other normal, non-file params such as input values, you need to pass hashes to the `Multipart.new` method.
+
+In Rails 4 for example:
+
+```ruby
+def model_params
+  require_params = params.require(:model).permit(:param_one, :param_two, :param_three, :avatar)
+  require_params[:avatar] = model_params[:avatar].present? ? UploadIO.new(model_params[:avatar].tempfile, model_params[:avatar].content_type, model_params[:avatar].original_filename) : nil
+  require_params
+end
+
+require 'net/http/post/multipart'
+
+url = URI.parse('http://www.example.com/upload')
+Net::HTTP.start(url.host, url.port) do |http|
+  req = Net::HTTP::Post::Multipart.new(url, model_params)
+  key = "authorization_key"
+  req.add_field("Authorization", key) #add to Headers
+  http.use_ssl = (url.scheme == "https")
+  http.request(req)
+end
+```
+
+Or in plain ruby:
+
+```ruby
+def params(file)
+  params = { "description" => "A nice picture!" }
+  params[:datei] = UploadIO.new(file, "image/jpeg", "image.jpg")
+  params
+end
+
+url = URI.parse('http://www.example.com/upload')
+File.open("./image.jpg") do |file|
+  req = Net::HTTP::Post::Multipart.new(url.path, params(file))
+  res = Net::HTTP.start(url.host, url.port) do |http|
+    return http.request(req).body
+  end
+end
+```
+
+### Debugging
+
+You can debug requests and responses (e.g. status codes) for all requests by adding the following code:
+
+```ruby
+http = Net::HTTP.new(uri.host, uri.port)
+http.set_debug_output($stdout)
+```
+
+## License
+
+Released under the MIT license.
+
+Copyright (c) 2007-2013 Nick Sieger <nick@nicksieger.com>  
+Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/lib/composite_io.rb

@@ -7,11 +7,11 @@
 # 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'))
+# @example
+#     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.
@@ -56,6 +56,8 @@ end
 
 # Convenience methods for dealing with files and IO that are to be uploaded.
 class UploadIO
+  attr_reader :content_type, :original_filename, :local_path, :io, :opts
+
   # Create an upload IO suitable for including in the params hash of a
   # Net::HTTP::Post::Multipart.
   #
@@ -67,13 +69,9 @@ class UploadIO
   # uploading directly from a form in a framework, which often save the file to
   # an arbitrarily named RackMultipart file in /tmp).
   #
-  # Usage:
-  #
+  # @example
   #     UploadIO.new("file.txt", "text/plain")
   #     UploadIO.new(file_io, "text/plain", "file.txt")
-  #
-  attr_reader :content_type, :original_filename, :local_path, :io, :opts
-
   def initialize(filename_or_io, content_type, filename = nil, opts = {})
     io = filename_or_io
     local_path = ""
@@ -95,7 +93,9 @@ class UploadIO
   end
 
   def self.convert!(io, content_type, original_filename, local_path)
-    raise ArgumentError, "convert! has been removed. You must now wrap IOs using:\nUploadIO.new(filename_or_io, content_type, filename=nil)\nPlease update your code."
+    raise ArgumentError, "convert! has been removed. You must now wrap IOs " \
+                         "using:\nUploadIO.new(filename_or_io, content_type, " \
+                         "filename=nil)\nPlease update your code."
   end
 
   def method_missing(*args)

data/lib/multipart_post.rb

@@ -5,5 +5,5 @@
 #++
 
 module MultipartPost
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/multipartable.rb

@@ -5,25 +5,44 @@
 #++
 
 require 'parts'
-  module Multipartable
-    DEFAULT_BOUNDARY = "-----------RubyMultipartPost"
-    def initialize(path, params, headers={}, boundary = DEFAULT_BOUNDARY)
-      headers = headers.clone # don't want to modify the original variable
-      parts_headers = headers.delete(:parts) || {}
-      super(path, headers)
-      parts = params.map do |k,v|
-        case v
-        when Array
-          v.map {|item| Parts::Part.new(boundary, k, item, parts_headers[k]) }
-        else
-          Parts::Part.new(boundary, k, v, parts_headers[k])
-        end
-      end.flatten
-      parts << Parts::EpiloguePart.new(boundary)
-      ios = parts.map {|p| p.to_io }
-      self.set_content_type(headers["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
+require 'securerandom'
+
+module Multipartable
+  def self.secure_boundary
+    # https://tools.ietf.org/html/rfc7230
+    #      tchar          = "!" / "#" / "$" / "%" / "&" / "'" / "*"
+    #                     / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
+    #                     / DIGIT / ALPHA
+    
+    # https://tools.ietf.org/html/rfc2046
+    #      bcharsnospace := DIGIT / ALPHA / "'" / "(" / ")" /
+    #                       "+" / "_" / "," / "-" / "." /
+    #                       "/" / ":" / "=" / "?"
+    
+    "--#{SecureRandom.alphanumeric(60)}"
+  end
+  
+  def initialize(path, params, headers={}, boundary = Multipartable.secure_boundary)
+    headers = headers.clone # don't want to modify the original variable
+    parts_headers = headers.delete(:parts) || {}
+    super(path, headers)
+    parts = params.map do |k,v|
+      case v
+      when Array
+        v.map {|item| Parts::Part.new(boundary, k, item, parts_headers[k]) }
+      else
+        Parts::Part.new(boundary, k, v, parts_headers[k])
+      end
+    end.flatten
+    parts << Parts::EpiloguePart.new(boundary)
+    ios = parts.map {|p| p.to_io }
+    self.set_content_type(headers["Content-Type"] || "multipart/form-data",
+                          { "boundary" => boundary })
+    self.content_length = parts.inject(0) {|sum,i| sum + i.length }
+    self.body_stream = CompositeReadIO.new(*ios)
+    
+    @boundary = boundary
   end
+  
+  attr :boundary
+end

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

@@ -11,14 +11,15 @@ require 'composite_io'
 require 'multipartable'
 require 'parts'
 
-module Net #:nodoc:
-  class HTTP #:nodoc:
+module Net
+  class HTTP
     class Put
       class Multipart < Put
         include Multipartable
       end
     end
-    class Post #:nodoc:
+
+    class Post
       class Multipart < Post
         include Multipartable
       end

data/lib/parts.rb

@@ -5,7 +5,7 @@
 #++
 
 module Parts
-  module Part #:nodoc:
+  module Part
     def self.new(boundary, name, value, headers = {})
       headers ||= {} # avoid nil values
       if file?(value)
@@ -28,8 +28,14 @@ module Parts
     end
   end
 
+  # Represents a parametric part to be filled with given value.
   class ParamPart
     include Part
+
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param value [String]
+    # @param headers [Hash] Content-Type is used, if present.
     def initialize(boundary, name, value, headers = {})
       @part = build_part(boundary, name, value, headers)
       @io = StringIO.new(@part)
@@ -39,6 +45,10 @@ module Parts
      @part.bytesize
     end
 
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param value [String]
+    # @param headers [Hash] Content-Type is used, if present.
     def build_part(boundary, name, value, headers = {})
       part = ''
       part << "--#{boundary}\r\n"
@@ -52,7 +62,13 @@ module Parts
   # Represents a part to be filled from file IO.
   class FilePart
     include Part
+
     attr_reader :length
+
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param io [IO]
+    # @param headers [Hash]
     def initialize(boundary, name, io, headers = {})
       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,
@@ -62,25 +78,38 @@ module Parts
       @io = CompositeReadIO.new(StringIO.new(@head), io, StringIO.new(@foot))
     end
 
-    def build_head(boundary, name, filename, type, content_len, opts = {}, headers = {})
-      trans_encoding = opts["Content-Transfer-Encoding"] || "binary"
-      content_disposition = opts["Content-Disposition"] || "form-data"
+    # @param boundary [String]
+    # @param name [#to_s]
+    # @param filename [String]
+    # @param type [String]
+    # @param content_len [Integer]
+    # @param opts [Hash]
+    def build_head(boundary, name, filename, type, content_len, opts = {})
+      opts = opts.clone
+
+      trans_encoding = opts.delete("Content-Transfer-Encoding") || "binary"
+      content_disposition = opts.delete("Content-Disposition") || "form-data"
 
       part = ''
       part << "--#{boundary}\r\n"
       part << "Content-Disposition: #{content_disposition}; name=\"#{name.to_s}\"; filename=\"#{filename}\"\r\n"
       part << "Content-Length: #{content_len}\r\n"
-      if content_id = opts["Content-ID"]
+      if content_id = opts.delete("Content-ID")
         part << "Content-ID: #{content_id}\r\n"
       end
 
-      if headers["Content-Type"] != nil
-        part <<  "Content-Type: " + headers["Content-Type"] + "\r\n"
+      if opts["Content-Type"] != nil
+        part <<  "Content-Type: " + opts["Content-Type"] + "\r\n"
       else
         part << "Content-Type: #{type}\r\n"
       end
 
       part << "Content-Transfer-Encoding: #{trans_encoding}\r\n"
+
+      opts.each do |k, v|
+        part << "#{k}: #{v}\r\n"
+      end
+
       part << "\r\n"
     end
   end
@@ -88,8 +117,9 @@ module Parts
   # Represents the epilogue or closing boundary.
   class EpiloguePart
     include Part
+
     def initialize(boundary)
-      @part = "--#{boundary}--\r\n\r\n"
+      @part = "--#{boundary}--\r\n"
       @io = StringIO.new(@part)
     end
   end