Class: Ethon::Easy::Form

Inherits:
Object
  • Object
show all
Includes:
Queryable, Util
Defined in:
lib/ethon/easy/form.rb

Overview

This class represents a form and is used to send a payload in the request body via POST/PUT. It handles multipart forms, too.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Queryable

#build_query_pairs, #empty?, #file_info, included, #query_pairs, #to_s

Methods included from Util

#escape_zero_byte

Constructor Details

#initialize(easy, params) ⇒ Form

Return a new Form.

Examples:

Return a new Form.

Form.new({})

Parameters:

  • params (Hash) —

    The parameter to initialize the form with.



22
23
24
25
26
 
# File 'lib/ethon/easy/form.rb', line 22

def initialize(easy, params)
  @easy = easy
  @params = params || {}
  ObjectSpace.define_finalizer(self, self.class.finalizer(self))
end

Class Method Details

.finalizer(form) ⇒ Object

Frees form in libcurl if necessary.

Examples:

Free the form

Form.finalizer(form)

Parameters:

  • form (Form) —

    The form to free.



34
35
36
 
# File 'lib/ethon/easy/form.rb', line 34

def self.finalizer(form)
  proc { Curl.formfree(form.first) if form.multipart? }
end

Instance Method Details

#first ⇒ FFI::Pointer

Return a pointer to the first form element in libcurl.

Examples:

Return the first form element.

form.first

Returns:

  • (FFI::Pointer) —

    The first element.



44
45
46
 
# File 'lib/ethon/easy/form.rb', line 44

def first
  @first ||= FFI::MemoryPointer.new(:pointer)
end

#last ⇒ FFI::Pointer

Return a pointer to the last form element in libcurl.

Examples:

Return the last form element.

form.last

Returns:

  • (FFI::Pointer) —

    The last element.



54
55
56
 
# File 'lib/ethon/easy/form.rb', line 54

def last
  @last ||= FFI::MemoryPointer.new(:pointer)
end

#materialize ⇒ Object

Add form elements to libcurl.

Examples:

Add form to libcurl.

form.materialize


73
74
75
 
# File 'lib/ethon/easy/form.rb', line 73

def materialize
  query_pairs.each { |pair| form_add(pair.first.to_s, pair.last) }
end

#multipart? ⇒ Boolean

Return if form is multipart. The form is multipart, when it contains a file.

Examples:

Return if form is multipart.

form.multipart?

Returns:

  • (Boolean) —

    True if form is multipart, else false.



65
66
67
 
# File 'lib/ethon/easy/form.rb', line 65

def multipart?
  query_pairs.any?{|pair| pair.respond_to?(:last) && pair.last.is_a?(Array)}
end