Class: Transloadit::ApiModel

Inherits:

Object

• Object
• Transloadit::ApiModel

Defined in:

lib/transloadit/api_model.rb

Overview

Represents an API class that more Transloadit specific API classes would inherit from.

Direct Known Subclasses

Assembly, Template

Instance Attribute Summary

• #options ⇒ Hash

  The options describing the Assembly.

• #transloadit ⇒ Transloadit readonly

  The associated Transloadit instance.

Instance Method Summary

• #initialize(transloadit, options = {}) ⇒ ApiModel constructor

  Creates a new API instance authenticated using the given transloadit instance.

• #inspect ⇒ String

  A human-readable version of the API.

• #to_hash ⇒ Hash

  A Transloadit-compatible Hash of the API’s contents.

• #to_json ⇒ String

  JSON-encoded String containing the API’s contents.

Constructor Details

#initialize(transloadit, options = {}) ⇒ ApiModel

Creates a new API instance authenticated using the given transloadit instance.

# File 'lib/transloadit/api_model.rb', line 21

def initialize(transloadit, options = {})
  self.transloadit = transloadit
  self.options = options
end

Instance Attribute Details

#options ⇒ Hash

# File 'lib/transloadit/api_model.rb', line 12

def options
  @options
end

#transloadit ⇒ Transloadit

# File 'lib/transloadit/api_model.rb', line 9

def transloadit
  @transloadit
end

Instance Method Details

#inspect ⇒ String

# File 'lib/transloadit/api_model.rb', line 29

def inspect
  to_hash.inspect
end

#to_hash ⇒ Hash

# File 'lib/transloadit/api_model.rb', line 36

def to_hash
  options.merge(
    auth: transloadit.to_hash
  ).delete_if { |_, v| v.nil? }
end

#to_json ⇒ String

# File 'lib/transloadit/api_model.rb', line 45

def to_json
  MultiJson.dump(to_hash)
end