Class: Refile::Signature

Inherits:

Object

• Object
• Refile::Signature

Defined in:

lib/refile/signature.rb

Overview

A signature summarizes an HTTP request a client can make to upload a file to directly upload a file to a backend. This signature is usually generated by a backend's presign method.

Instance Attribute Summary

• #as ⇒ String readonly

  The name of the field that the file will be uploaded as.

• #fields ⇒ String readonly

  Additional fields to be sent alongside the file.

• #id ⇒ String readonly

  The id the file will receive once uploaded.

• #url ⇒ String readonly

  The url the file should be uploaded to.

Instance Method Summary

• #as_json ⇒ Hash{Symbol => Object}

  An object suitable for serialization to JSON.

Instance Attribute Details

#as ⇒ String (readonly)

# File 'lib/refile/signature.rb', line 7

def as
  @as
end

#fields ⇒ String (readonly)

# File 'lib/refile/signature.rb', line 16

def fields
  @fields
end

#id ⇒ String (readonly)

# File 'lib/refile/signature.rb', line 10

def id
  @id
end

#url ⇒ String (readonly)

# File 'lib/refile/signature.rb', line 13

def url
  @url
end

Instance Method Details

#as_json ⇒ Hash{Symbol => Object}

# File 'lib/refile/signature.rb', line 27

def as_json(*)
  { as: @as, id: @id, url: @url, fields: @fields }
end