Class: Synapse::MessageBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/synapse/common/message_builder.rb

Overview

Builder that is used to easily create and populate messages

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ String

Returns:

  • (String) 


5
6
7
 
# File 'lib/synapse/common/message_builder.rb', line 5

def id
  @id
end

#metadata ⇒ Hash

Returns:

  • (Hash) 


8
9
10
 
# File 'lib/synapse/common/message_builder.rb', line 8

def metadata
  @metadata
end

#payload ⇒ Object

Returns:

  • (Object) 


11
12
13
 
# File 'lib/synapse/common/message_builder.rb', line 11

def payload
  @payload
end

Class Method Details

.build {|MessageBuilder| ... } ⇒ Message

Convenience method that yields a new builder, populates defaults and returns the newly built message instance

Yields:

Returns:



18
19
20
21
22
23
24
25
 
# File 'lib/synapse/common/message_builder.rb', line 18

def self.build
  builder = self.new

  yield builder if block_given?

  builder.populate_defaults
  builder.build
end

Instance Method Details

#build ⇒ Message

Returns:



28
29
30
 
# File 'lib/synapse/common/message_builder.rb', line 28

def build
  Message.new @id, @metadata, @payload
end

#populate_defaults ⇒ undefined

Returns:

  • (undefined) 


33
34
35
36
 
# File 'lib/synapse/common/message_builder.rb', line 33

def populate_defaults
  @id ||= IdentifierFactory.instance.generate
  @metadata ||= Hash.new
end