Class: Enginn::Project

Inherits:
Resource show all
Defined in:
lib/enginn/project.rb

Instance Attribute Summary collapse

Attributes inherited from Resource

#attributes, #errors, #project

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#destroy, #destroy!, #fetch, #fetch!, #inspect, #save, #save!

Constructor Details

#initialize(client, attributes = {}) ⇒ Project

Returns a new instance of Project.

Parameters:

  • client (Enginn::Client) —

    The client to use with this project and its sub-resources



12
13
14
15
 
# File 'lib/enginn/project.rb', line 12

def initialize(client, attributes = {})
  @client = client
  super(self, attributes)
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



9
10
11
 
# File 'lib/enginn/project.rb', line 9

def client
  @client
end

Class Method Details

.path ⇒ Object 



5
6
7
 
# File 'lib/enginn/project.rb', line 5

def self.path
  'projects'
end

Instance Method Details

#characters ⇒ Enginn::CharactersIndex

Retrieve the characters present in this project.

Returns:



19
20
21
 
# File 'lib/enginn/project.rb', line 19

def characters
  CharactersIndex.new(self)
end

#dictionary_entries ⇒ Enginn::DictionaryEntriesIndex Also known as: dictionary

Retrieve the dictionary entries present in this project.

Returns:



25
26
27
 
# File 'lib/enginn/project.rb', line 25

def dictionary_entries
  DictionaryEntriesIndex.new(self)
end

#line_tags ⇒ Enginn::LineTagsIndex

Retrieve the line_tags present in this project.

Returns:



51
52
53
 
# File 'lib/enginn/project.rb', line 51

def line_tags
  LineTagsIndex.new(self)
end

#lines ⇒ Enginn::LinesIndex

Retrieve the lines present in this project.

Returns:



45
46
47
 
# File 'lib/enginn/project.rb', line 45

def lines
  LinesIndex.new(self)
end

#route ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



68
69
70
 
# File 'lib/enginn/project.rb', line 68

def route
  "#{self.class.path}/#{@attributes[:id]}"
end

#scenes ⇒ Enginn::ScenesIndex

Retrieve the scenes present in this project.

Returns:



39
40
41
 
# File 'lib/enginn/project.rb', line 39

def scenes
  ScenesIndex.new(self)
end

#synthesis_exports ⇒ Enginn::SynthesisExportsIndex

Retrieve the synthesis exports present in this project.

Returns:



33
34
35
 
# File 'lib/enginn/project.rb', line 33

def synthesis_exports
  SynthesisExportsIndex.new(self)
end

#take_batches ⇒ Enginn::TakeBatchesIndex

Retrieve the take_batches present in this project.

Returns:



63
64
65
 
# File 'lib/enginn/project.rb', line 63

def take_batches
  TakeBatchesIndex.new(self)
end

#takes ⇒ Enginn::TakesIndex

Retrieve the takes present in this project.

Returns:



57
58
59
 
# File 'lib/enginn/project.rb', line 57

def takes
  TakesIndex.new(self)
end