Class: PuzzlyApiPlugin::Module

Inherits:
Metadata show all
Defined in:
lib/puzzly_api_plugin/metadata/module.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Metadata

#id, #name, #path, #to_identity

Methods inherited from JSONable

#copy_to_hash, #to_s

Constructor Details

#initialize(document, context_id, name, description, consumesTopics, producesTopics) ⇒ Module

Returns a new instance of Module.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 14

def initialize(document, context_id, name, description, consumesTopics, producesTopics)
  super(document, name)
  self[MetadataFields::CONTEXT_ID] = context_id
  self[MetadataFields::DESCRIPTION] = description
  if(consumesTopics.nil?)
    consumesTopics = ""
  end
  self[MetadataFields::CONSUMES_TOPICS] = consumesTopics.split(",")
  
  if(producesTopics.nil?)
    producesTopics = ""
  end
  self[MetadataFields::PRODUCES_TOPICS] = producesTopics.split(",")

  validate
end

Class Method Details

.create(document) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 5

def self.create(document)
  Module.new(document,
             document.data[YAMLFields::CONTEXT_ID],
             document.data[YAMLFields::MODULE_NAME],
             document.data[YAMLFields::MODULE_DESCRIPTION], 
             document.data[YAMLFields::MODULE_CONSUMES_TOPICS],
             document.data[YAMLFields::MODULE_PRODUCES_TOPICS])
end

Instance Method Details

#consumesTopics ⇒ Object 



61
62
63
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 61

def consumesTopics
  self[MetadataFields::CONSUMES_TOPICS]
end

#context_id ⇒ Object 



53
54
55
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 53

def context_id
  self[MetadataFields::CONTEXT_ID]
end

#description ⇒ Object 



57
58
59
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 57

def description
  self[MetadataFields::DESCRIPTION]
end

#producesTopics ⇒ Object 



65
66
67
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 65

def producesTopics
  self[MetadataFields::PRODUCES_TOPICS]
end

#validate ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/puzzly_api_plugin/metadata/module.rb', line 31

def validate     
  if(context_id.nil?)
    warn "Please set #{YAMLFields::CONTEXT_ID} property"
  end

  if(name.nil?)
    warn "Please set #{YAMLFields::MODULE_NAME} property"
  end

  if(description.nil?)
    warn "Please set #{YAMLFields::MODULE_DESCRIPTION} property"
  end

  if(consumesTopics.nil?)
    warn "Please set #{YAMLFields::MODULE_CONSUMES_TOPICS} property"
  end

  if(producesTopics.nil?)
    warn "Please set #{YAMLFields::MODULE_PRODUCES_TOPICS} property"
  end
end