File: upload_io.rb

package info (click to toggle)
ruby-multipart-post 2.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 144 kB
  • sloc: ruby: 247; makefile: 4
file content (64 lines) | stat: -rw-r--r-- 2,330 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2022-2024, 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