multipart-post 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f48186ca2c1e47dbb18d8ba20ed99e1d2dbabac5735c47a5fdf3f3de2ff6c1
-  data.tar.gz: 86bdb76a37261133d45eba29e94c6026118564fa0168120549d64a8cf89e19f7
+  metadata.gz: f1a26f1b06e253bdd1a96889881cd28090f1bb294754de989b5d01ee173f2251
+  data.tar.gz: f0df38197a55f9470d21d0284fb12c16deabe86e1ab71e39f409bcbabfb9cf86
 SHA512:
-  metadata.gz: 47022f82aba55743549c58e82cda833a1f769927ca7c348b35e8dbcfeec851ca5570ef4b43755d33c4d5957a97b915412e86d9b333769f5cd11d0b9cdeede744
-  data.tar.gz: c9c767b946971349722a5798b0594f9da22095262f0f322391656dc79e73a677a48b0fdc53942f5bfbfe58d258c7e6df8bd3fb02821b49a64f794c6f898012d5
+  metadata.gz: 8048da79e851331b26fae693ce8e5329481c729934f3653fce804332df8b3f8edcdc566dc543a14e461ec674bb0700e87b92d26b5fe24dc4fcb13312574faf04
+  data.tar.gz: 1323dbcffd530f36bbb14e7ca5f90033ce3bf558ef669387df855638da7a6a619b4fe355ab5b2470428edfd2bb5c1fdbd267b848a940d84a0bbcb451c341c743

data/changelog.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## Unreleased
+
+### Added
+
+- Add the ability to set Content-ID header for ParamPart [#62](https://github.com/socketry/multipart-post/pull/62)
+- Allow mixed key types for parts headers [#79](https://github.com/socketry/multipart-post/pull/79)
+
+### Changed
+
+- Refactor `Parts` into a `Multipart::Post` namespace  [#65](https://github.com/socketry/multipart-post/pull/65)
+- Use mutable strings where needed [#70](https://github.com/socketry/multipart-post/pull/70)
+- Use `frozen_string_literal` everywhere [#78](https://github.com/socketry/multipart-post/pull/78)

data/lib/composite_io.rb

@@ -1,108 +1,17 @@
-#--
-# Copyright (c) 2007-2012 Nick Sieger.
-# See the file README.txt included with the distribution for
-# software license details.
-#++
-
-# Concatenate together multiple IO objects into a single, composite IO object
-# for purposes of reading as a single stream.
-#
-# @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 IOs in order until `length` bytes have been received.
-  def read(length = nil, outbuf = nil)
-    got_result = false
-    outbuf = outbuf ? outbuf.replace("") : ""
-
-    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
-      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.
-  #
-  # Can take two forms. The first accepts a filename and content type, and
-  # opens the file for reading (to be closed by finalizer).
-  #
-  # The second accepts an already-open IO, but also requires a third argument,
-  # the filename from which it was opened (particularly useful/recommended if
-  # uploading directly from a form in a framework, which often save the file to
-  # an arbitrarily named RackMultipart file in /tmp).
-  #
-  # @example
-  #     UploadIO.new("file.txt", "text/plain")
-  #     UploadIO.new(file_io, "text/plain", "file.txt")
-  def initialize(filename_or_io, content_type, filename = nil, opts = {})
-    io = filename_or_io
-    local_path = ""
-    if io.respond_to? :read
-      # in Ruby 1.9.2, StringIOs no longer respond to path
-      # (since they respond to :length, so we don't need their local path, see parts.rb:41)
-      local_path = filename_or_io.respond_to?(:path) ? filename_or_io.path : "local.path"
-    else
-      io = File.open(filename_or_io)
-      local_path = filename_or_io
-    end
-    filename ||= local_path
-
-    @content_type = content_type
-    @original_filename = File.basename(filename)
-    @local_path = local_path
-    @io = io
-    @opts = opts
-  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."
-  end
-
-  def method_missing(*args)
-    @io.send(*args)
-  end
-
-  def respond_to?(meth, include_all = false)
-    @io.respond_to?(meth, include_all) || super(meth, include_all)
-  end
-end
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2006-2013, by Nick Sieger.
+# Copyright, 2010, by Tohru Hashimoto.
+# Copyright, 2011, by Jeff Hodges.
+# Copyright, 2011, by Alex Koppel.
+# Copyright, 2011, by Christine Yen.
+# Copyright, 2011, by Gerrit Riessen.
+# Copyright, 2011, by Luke Redpath.
+# Copyright, 2013, by Mislav Marohnić.
+# Copyright, 2013, by Leo Cassarani.
+# Copyright, 2019, by Olle Jonsson.
+# Copyright, 2022, by Samuel Williams.
+
+warn "Top level ::CompositeIO is deprecated, require 'multipart/post' and use `Multipart::Post::CompositeReadIO` instead!"
+require_relative 'multipart/post'

data/lib/multipart/post/composite_read_io.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2006-2013, by Nick Sieger.
+# Copyright, 2010, by Tohru Hashimoto.
+# Copyright, 2011, by Jeff Hodges.
+# Copyright, 2011, by Alex Koppel.
+# Copyright, 2011, by Christine Yen.
+# Copyright, 2011, by Gerrit Riessen.
+# Copyright, 2011, by Luke Redpath.
+# Copyright, 2013, by Mislav Marohnić.
+# Copyright, 2013, by Leo Cassarani.
+# Copyright, 2019, by Olle Jonsson.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2021, by Lewis Cowles.
+# Copyright, 2021-2022, by Samuel Williams.
+
+module Multipart
+  module Post
+    # Concatenate together multiple IO objects into a single, composite IO object
+    # for purposes of reading as a single stream.
+    #
+    # @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 IOs in order until `length` bytes have been received.
+      def read(length = nil, outbuf = nil)
+        got_result = false
+        outbuf = outbuf ? outbuf.replace("") : String.new
+
+        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
+          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
+  end
+end
+
+CompositeIO = Multipart::Post::CompositeReadIO
+Object.deprecate_constant :CompositeIO

data/lib/multipart/post/multipartable.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2008, by McClain Looney.
+# Copyright, 2008-2013, by Nick Sieger.
+# Copyright, 2011, by Gerrit Riessen.
+# Copyright, 2013, by Vincent Pellé.
+# Copyright, 2013, by Gustav Ernberg.
+# Copyright, 2013, by Socrates Vicente.
+# Copyright, 2013, by Steffen Grunwald.
+# Copyright, 2019, by Olle Jonsson.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2022, by Jason York.
+
+require_relative 'parts'
+require_relative 'composite_read_io'
+
+require 'securerandom'
+
+module Multipart
+  module Post
+    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 = symbolize_keys(headers.delete(:parts) || {})
+
+        super(path, headers)
+        parts = symbolize_keys(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
+
+      private
+
+      if RUBY_VERSION >= "2.5.0"
+        def symbolize_keys(hash)
+          hash.transform_keys(&:to_sym)
+        end
+      else
+        def symbolize_keys(hash)
+          hash.map{|key,value| [key.to_sym, value]}.to_h
+        end
+      end
+    end
+  end
+end

data/lib/multipart/post/parts.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2008-2009, by McClain Looney.
+# Copyright, 2009-2013, by Nick Sieger.
+# Copyright, 2011, by Johannes Wagener.
+# Copyright, 2011, by Gerrit Riessen.
+# Copyright, 2011, by Jason Moore.
+# Copyright, 2012, by Steven Davidovitz.
+# Copyright, 2012, by hexfet.
+# Copyright, 2013, by Vincent Pellé.
+# Copyright, 2013, by Gustav Ernberg.
+# Copyright, 2013, by Socrates Vicente.
+# Copyright, 2017, by David Moles.
+# Copyright, 2017, by Matt Colyer.
+# Copyright, 2017, by Eric Hutzelman.
+# Copyright, 2019-2021, by Olle Jonsson.
+# Copyright, 2019, by Ethan Turkeltaub.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2021-2022, by Samuel Williams.
+
+require 'stringio'
+
+module Multipart
+  module Post
+    module Parts
+      module Part
+        def self.new(boundary, name, value, headers = {})
+          headers ||= {} # avoid nil values
+          if file?(value)
+            FilePart.new(boundary, name, value, headers)
+          else
+            ParamPart.new(boundary, name, value, headers)
+          end
+        end
+
+        def self.file?(value)
+          value.respond_to?(:content_type) && value.respond_to?(:original_filename)
+        end
+
+        def length
+          @part.length
+        end
+
+        def to_io
+          @io
+        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 and Content-ID are used, if present.
+        def initialize(boundary, name, value, headers = {})
+          @part = build_part(boundary, name, value, headers)
+          @io = StringIO.new(@part)
+        end
+
+        def length
+          @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 = String.new
+          part << "--#{boundary}\r\n"
+          part << "Content-ID: #{headers["Content-ID"]}\r\n" if headers["Content-ID"]
+          part << "Content-Disposition: form-data; name=\"#{name.to_s}\"\r\n"
+          part << "Content-Type: #{headers["Content-Type"]}\r\n" if headers["Content-Type"]
+          part << "\r\n"
+          part << "#{value}\r\n"
+        end
+      end
+
+      # 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,
+                             io.respond_to?(:opts) ? io.opts.merge(headers) : headers)
+          @foot = "\r\n"
+          @length = @head.bytesize + file_length + @foot.length
+          @io = CompositeReadIO.new(StringIO.new(@head), io, StringIO.new(@foot))
+        end
+
+        # @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 = String.new
+          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.delete("Content-ID")
+            part << "Content-ID: #{content_id}\r\n"
+          end
+
+          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
+
+      # Represents the epilogue or closing boundary.
+      class EpiloguePart
+        include Part
+
+        def initialize(boundary)
+          @part = String.new("--#{boundary}--\r\n")
+          @io = StringIO.new(@part)
+        end
+      end
+    end
+  end
+end

data/lib/multipart/post/upload_io.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+module Multipart
+  module Post
+    # 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.
+      #
+      # Can take two forms. The first accepts a filename and content type, and
+      # opens the file for reading (to be closed by finalizer).
+      #
+      # The second accepts an already-open IO, but also requires a third argument,
+      # the filename from which it was opened (particularly useful/recommended if
+      # uploading directly from a form in a framework, which often save the file to
+      # an arbitrarily named RackMultipart file in /tmp).
+      #
+      # @example
+      #     UploadIO.new("file.txt", "text/plain")
+      #     UploadIO.new(file_io, "text/plain", "file.txt")
+      def initialize(filename_or_io, content_type, filename = nil, opts = {})
+        io = filename_or_io
+        local_path = ""
+        if io.respond_to? :read
+          # in Ruby 1.9.2, StringIOs no longer respond to path
+          # (since they respond to :length, so we don't need their local path, see parts.rb:41)
+          local_path = filename_or_io.respond_to?(:path) ? filename_or_io.path : "local.path"
+        else
+          io = File.open(filename_or_io)
+          local_path = filename_or_io
+        end
+        filename ||= local_path
+
+        @content_type = content_type
+        @original_filename = File.basename(filename)
+        @local_path = local_path
+        @io = io
+        @opts = opts
+      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."
+      end
+
+      def method_missing(*args)
+        @io.send(*args)
+      end
+
+      def respond_to?(meth, include_all = false)
+        @io.respond_to?(meth, include_all) || super(meth, include_all)
+      end
+    end
+  end
+end
+
+UploadIO = Multipart::Post::UploadIO
+Object.deprecate_constant :UploadIO

data/lib/multipart/post/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2021-2023, by Samuel Williams.
+
+module Multipart
+  module Post
+    VERSION = "2.3.0"
+  end
+end

data/lib/multipart/post.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2021-2022, by Samuel Williams.
+
+require_relative 'post/multipartable'
+require_relative 'post/upload_io'

data/lib/multipart_post.rb

@@ -1,9 +1,11 @@
-#--
-# Copyright (c) 2007-2013 Nick Sieger.
-# See the file README.txt included with the distribution for
-# software license details.
-#++
+# frozen_string_literal: true
 
-module MultipartPost
-  VERSION = "2.1.0"
-end
+# Released under the MIT License.
+# Copyright, 2009-2013, by Nick Sieger.
+# Copyright, 2019-2022, by Samuel Williams.
+
+warn "Top level ::MultipartPost is deprecated, require 'multipart/post' and use `Multipart::Post` instead!"
+require_relative 'multipart/post'
+
+MultipartPost = Multipart::Post
+Object.deprecate_constant :MultipartPost

data/lib/multipartable.rb

@@ -1,48 +1,19 @@
-#--
-# Copyright (c) 2007-2013 Nick Sieger.
-# See the file README.txt included with the distribution for
-# software license details.
-#++
+# frozen_string_literal: true
 
-require 'parts'
-require 'securerandom'
+# Released under the MIT License.
+# Copyright, 2008, by McClain Looney.
+# Copyright, 2008-2013, by Nick Sieger.
+# Copyright, 2011, by Gerrit Riessen.
+# Copyright, 2013, by Vincent Pellé.
+# Copyright, 2013, by Gustav Ernberg.
+# Copyright, 2013, by Socrates Vicente.
+# Copyright, 2013, by Steffen Grunwald.
+# Copyright, 2019, by Olle Jonsson.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019, by Patrick Davey.
 
-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
+warn "Top level ::Multipartable is deprecated, require 'multipart/post' and use `Multipart::Post::Multipartable` instead!"
+require_relative 'multipart/post'
+
+Multipartable = Multipart::Post::Multipartable
+Object.deprecate_constant :Multipartable

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

@@ -1,27 +1,27 @@
-#--
-# Copyright (c) 2007-2012 Nick Sieger.
-# See the file README.txt included with the distribution for
-# software license details.
-#++
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2006-2012, by Nick Sieger.
+# Copyright, 2008, by McClain Looney.
+# Copyright, 2019, by Olle Jonsson.
+# Copyright, 2019, by Patrick Davey.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require 'net/http'
-require 'stringio'
-require 'cgi'
-require 'composite_io'
-require 'multipartable'
-require 'parts'
+
+require_relative '../../../multipart/post'
 
 module Net
   class HTTP
     class Put
       class Multipart < Put
-        include Multipartable
+        include ::Multipart::Post::Multipartable
       end
     end
 
     class Post
       class Multipart < Post
-        include Multipartable
+        include ::Multipart::Post::Multipartable
       end
     end
   end