multipart-post 1.1.5 → 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e64b8bb7510028e6d5c5ca9626ff5448a12ee4e393938a69edd9eddfedf04e70
+  data.tar.gz: dddcaa65fa823b59d0d3a025c8ad1e88eae0e2fe976469c9b69931a0bc66af6a
+SHA512:
+  metadata.gz: a046600778502bf34933ca1f4b2abd7ce0c7e8b4911ab9abc2bc74316cd42ce2f9167c6a40254ffb290ede586de81500a03500c09bfcb15ed96c0495bed19964
+  data.tar.gz: 422aa7086f923b29e545cba81cd1caca270ed4e86f0d29a50a8c61bc111ad30d546b353ef3db5eb52f63f697d03a5671e759f3119c8c200807184c9cfe3c1f58

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 *~
 *.swo
 *.swp
+/Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -1,7 +1,20 @@
+language: ruby
+cache: bundler
+
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - jruby
-branches:
-  only:
-    - master
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+  - jruby-head
+  - truffleruby
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: truffleruby

data/.yardopts

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

data/Gemfile

@@ -1,14 +1,6 @@
-source :rubygems
+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,25 @@
+<!--
+# @markup rdoc
+# @title CHANGELOG
+-->
+
+=== 2.0.0 / 2013-12-21
+
+- Drop Ruby 1.8 compatibility
+- GH #21: Fix FilePart length calculation for Ruby 1.9 when filename contains
+  multibyte characters (hexfet)
+- GH #20: Ensure upload responds to both #content_type and #original_filename
+  (Steven Davidovitz)
+- GH #31: Support setting headers on any part of the request (Socrates Vicente)
+- GH #30: Support array values for params (Gustav Ernberg)
+- GH #32: Fix respond_to? signature (Leo Cassarani)
+- GH #33: Update README to markdown (Jagtesh Chadha)
+- GH #35: Improved handling of array-type parameters (Steffen Grunwald)
+
+=== 1.2.0 / 2013-02-25
+
+- #25: Ruby 2 compatibility (thanks mislav)
+
 === 1.1.5 / 2012-02-12
 
 - Fix length/bytesize of parts in 1.9 (#7, #14) (Jason Moore)
@@ -40,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

@@ -0,0 +1,127 @@
+# Multipart::Post
+
+Adds a streamy multipart form post capability to `Net::HTTP`. Also supports other
+methods besides `POST`.
+
+[![Build Status](https://secure.travis-ci.org/socketry/multipart-post.svg)](http://travis-ci.org/socketry/multipart-post)
+
+## Features/Problems
+
+* Appears to actually work. A good feature to have.
+* 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
+  hash of the multipart post object.
+
+## Installation
+
+    gem install multipart-post
+
+or in your Gemfile
+
+    gem 'multipart-post'
+
+## Usage
+
+```ruby
+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:
+
+```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/Rakefile

@@ -1,9 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-task :default => :test
+RSpec::Core::RakeTask.new(:test)
 
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/**/test*.rb']
-end
+task :default => :test

data/lib/composite_io.rb

@@ -7,54 +7,57 @@
 # 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.
   def initialize(*ios)
     @ios = ios.flatten
+    @index = 0
   end
 
-  # Read from the IO object, overlapping across underlying streams as necessary.
-  def read(amount = nil, buf = nil)
-    buffer = buf || ''
-    done = if amount; nil; else ''; end
-    partial_amount = amount
-    parts = @ios.dup
-
-    loop do
-      result = done
+  # Read from IOs in order until `length` bytes have been received.
+  def read(length = nil, outbuf = nil)
+    got_result = false
+    outbuf = outbuf ? outbuf.replace("") : ""
 
-      while !parts.empty? && (result = parts.first.read(partial_amount)) == done
-        parts.shift
+    while io = current_io
+      if result = io.read(length)
+        got_result ||= !result.nil?
+        result.force_encoding("BINARY") if result.respond_to?(:force_encoding)
+        outbuf << result
+        length -= result.length if length
+        break if length == 0
       end
-
-      result.force_encoding("BINARY") if result.respond_to?(:force_encoding)
-      buffer << result if result
-      partial_amount -= result.length if partial_amount && result != done
-
-      break if partial_amount && partial_amount <= 0
-      break if result == done
-    end
-
-    if buffer.length > 0
-      buffer
-    else
-      done
+      advance_io
     end
+    (!got_result && length) ? nil : outbuf
   end
-  
+
   def rewind
     @ios.each { |io| io.rewind }
+    @index = 0
+  end
+
+  private
+
+  def current_io
+    @ios[@index]
+  end
+
+  def advance_io
+    @index += 1
   end
 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.
   #
@@ -66,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 = ""
@@ -94,14 +93,16 @@ 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)
     @io.send(*args)
   end
 
-  def respond_to?(meth)
-    @io.respond_to?(meth) || super(meth)
+  def respond_to?(meth, include_all = false)
+    @io.respond_to?(meth, include_all) || super(meth, include_all)
   end
 end

data/lib/multipart_post.rb

@@ -1,9 +1,9 @@
 #--
-# Copyright (c) 2007-2012 Nick Sieger.
+# Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for
 # software license details.
 #++
 
 module MultipartPost
-  VERSION = "1.1.5"
+  VERSION = "2.1.1"
 end

data/lib/multipartable.rb

@@ -1,20 +1,48 @@
 #--
-# Copyright (c) 2007-2012 Nick Sieger.
+# Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for
 # software license details.
 #++
 
 require 'parts'
-  module Multipartable
-    DEFAULT_BOUNDARY = "-----------RubyMultipartPost"
-    def initialize(path, params, headers={}, boundary = DEFAULT_BOUNDARY)
-      super(path, headers)
-      parts = params.map {|k,v| Parts::Part.new(boundary, k, v)}
-      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.uuid}"
+  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