Class: Philiprehberger::Multipart::Part

Inherits:
Object
  • Object
show all
Defined in:
lib/philiprehberger/multipart/part.rb

Overview

Represents a single part in a multipart/form-data body

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, value, filename: nil, content_type: nil) ⇒ Part

Returns a new instance of Part.

Parameters:

  • name (Symbol) —

    the field name

  • value (String) —

    the part value

  • filename (String, nil) (defaults to: nil) —

    the original filename

  • content_type (String, nil) (defaults to: nil) —

    the MIME content type



23
24
25
26
27
28
 
# File 'lib/philiprehberger/multipart/part.rb', line 23

def initialize(name, value, filename: nil, content_type: nil)
  @name = name
  @value = value
  @filename = filename
  @content_type = content_type
end

Instance Attribute Details

#content_type ⇒ String?

Returns the content type.

Returns:

  • (String, nil) —

    the content type



17
18
19
 
# File 'lib/philiprehberger/multipart/part.rb', line 17

def content_type
  @content_type
end

#filename ⇒ String?

Returns the original filename.

Returns:

  • (String, nil) —

    the original filename



14
15
16
 
# File 'lib/philiprehberger/multipart/part.rb', line 14

def filename
  @filename
end

#name ⇒ Symbol (readonly)

Returns the field name.

Returns:

  • (Symbol) —

    the field name



8
9
10
 
# File 'lib/philiprehberger/multipart/part.rb', line 8

def name
  @name
end

#value ⇒ String

Returns the part value / body content.

Returns:

  • (String) —

    the part value / body content



11
12
13
 
# File 'lib/philiprehberger/multipart/part.rb', line 11

def value
  @value
end

Instance Method Details

#body ⇒ String

Alias for value — the body content of this part

Returns:

  • (String) 


33
34
35
 
# File 'lib/philiprehberger/multipart/part.rb', line 33

def body
  @value
end

#file? ⇒ Boolean

Whether this part represents a file upload

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/philiprehberger/multipart/part.rb', line 40

def file?
  !@filename.nil?
end

#size ⇒ Integer

Byte size of this part’s value

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/philiprehberger/multipart/part.rb', line 54

def size
  @value.bytesize
end

#text? ⇒ Boolean

Whether this part is a plain text field (not a file upload)

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/philiprehberger/multipart/part.rb', line 47

def text?
  !file?
end

#to_s(boundary) ⇒ String

Render this part as a multipart body segment

Parameters:

  • boundary (String) —

    the multipart boundary

Returns:

  • (String) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/philiprehberger/multipart/part.rb', line 62

def to_s(boundary)
  lines = []
  lines << "--#{boundary}\r\n"

  if file?
    lines << "Content-Disposition: form-data; name=\"#{@name}\"; filename=\"#{@filename}\"\r\n"
    lines << "Content-Type: #{@content_type || 'application/octet-stream'}\r\n"
  else
    lines << "Content-Disposition: form-data; name=\"#{@name}\"\r\n"
  end

  lines << "\r\n"
  lines << @value
  lines << "\r\n"
  lines.join
end