Class: Transloadit

Inherits:
Object
  • Object
show all
Defined in:
lib/transloadit.rb,
lib/transloadit/version.rb

Overview

Implements the Transloadit REST API in Ruby. Check the README for usage instructions.

Defined Under Namespace

Classes: Assembly, Request, Response, Step

Constant Summary collapse

VERSION =
'1.2.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Transloadit

Creates a new instance of the Transloadit API.

Parameters:

  • options (Hash) (defaults to: {})

    a hash of options, which can be any of:

Options Hash (options):

  • :key (String)

    your auth key from the credentials page (required)

  • :secret (String)

    your auth secret from the credentials page, for signing requests (optional)


37
38
39
40
41
42
43
44
# File 'lib/transloadit.rb', line 37

def initialize(options = {})
  self.key      = options[:key]
  self.secret   = options[:secret]
  self.duration = options[:duration] || 5 * 60
  self.max_size = options[:max_size]

  _ensure_key_provided
end

Instance Attribute Details

#durationInteger

Returns the duration in seconds that signed API requests generated from this instance remain valid

Returns:

  • (Integer)

    the duration in seconds that signed API requests generated from this instance remain valid


22
23
24
# File 'lib/transloadit.rb', line 22

def duration
  @duration
end

#keyString

Returns your Transloadit auth key

Returns:

  • (String)

    your Transloadit auth key


15
16
17
# File 'lib/transloadit.rb', line 15

def key
  @key
end

#max_sizeObject

Returns the value of attribute max_size


24
25
26
# File 'lib/transloadit.rb', line 24

def max_size
  @max_size
end

#secretString

Returns your Transloadit auth secret, for signing requests

Returns:

  • (String)

    your Transloadit auth secret, for signing requests


18
19
20
# File 'lib/transloadit.rb', line 18

def secret
  @secret
end

Instance Method Details

#assembly(options = {}) ⇒ Object

Creates a Transloadit::Assembly ready to be sent to the REST API.

Parameters:

  • options (Hash) (defaults to: {})

    additional parameters to send with the assembly submission; for a full list of parameters, see the official documentation on templates.

Options Hash (options):

  • :steps (Step, Array<Step>)

    the steps to perform in this assembly

  • :notify_url (String)

    A URL to be POSTed when the assembly has finished processing

  • :template_id (String)

    the ID of a template to use instead of specifying options here directly


74
75
76
# File 'lib/transloadit.rb', line 74

def assembly(options = {})
  Transloadit::Assembly.new(self, options)
end

#inspectString

Returns a human-readable version of the Transloadit.

Returns:

  • (String)

    a human-readable version of the Transloadit.


81
82
83
# File 'lib/transloadit.rb', line 81

def inspect
  self.to_hash.inspect
end

#step(name, robot, options = {}) ⇒ Step

Creates a Transloadit::Step describing a step in an upload assembly.

Parameters:

  • name (String)

    the name to give the step

  • robot (String)

    the robot to use in this step (e.g., '/image/resize')

  • options (Hash) (defaults to: {})

    a hash of options to customize the robot's operation; see the online documentation for robot-specific options

Returns:

  • (Step)

    the created Step


56
57
58
# File 'lib/transloadit.rb', line 56

def step(name, robot, options = {})
  Transloadit::Step.new(name, robot, options)
end

#to_hashHash

Returns a Transloadit-compatible Hash of the instance's contents

Returns:

  • (Hash)

    a Transloadit-compatible Hash of the instance's contents


88
89
90
91
92
93
# File 'lib/transloadit.rb', line 88

def to_hash
  result = { :key => self.key }
  result.update(:max_size => self.max_size) unless self.max_size.nil?
  result.update(:expires => _generate_expiry) unless self.secret.nil?
  result
end

#to_jsonString

Returns JSON-encoded String containing the object's hash contents

Returns:

  • (String)

    JSON-encoded String containing the object's hash contents


98
99
100
# File 'lib/transloadit.rb', line 98

def to_json
  MultiJson.dump(self.to_hash)
end