Class: EventHub::Message

Inherits:
Object
  • Object
show all
Includes:
Helper
Defined in:
lib/eventhub/message.rb

Constant Summary collapse

VERSION = 
'1.0.0'
REQUIRED_HEADERS =

Headers that are required (value can be nil) in order to pass valid?

[
  'message_id',
  'version',
  'created_at',
  'origin.module_id',
  'origin.type',
  'origin.site_id',
  'process.name',
  'process.step_position',
  'process.execution_id',
  'status.retried_count',
  'status.code',
  'status.message'
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helper

#class_to_array, #duration, #format_string, #get_host, #get_ip_adresses, #now_stamp

Constructor Details

#initialize(header = nil, body = nil, raw = nil) ⇒ Message

process_step_position should be



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/eventhub/message.rb', line 47

def initialize(header=nil, body=nil,raw=nil)

  @header = header || {}
  @body   = body || {}
  @raw    = raw

  # set message defaults, that we have required headers
  @header.set('message_id',UUIDTools::UUID.timestamp_create.to_s,false)
  @header.set('version',VERSION,false)
  @header.set('created_at',now_stamp,false)

  @header.set('origin.module_id','undefined',false)
  @header.set('origin.type','undefined',false)
  @header.set('origin.site_id','undefined',false)

  @header.set('process.name','undefined',false)
  @header.set('process.execution_id',UUIDTools::UUID.timestamp_create.to_s,false)
  @header.set('process.step_position',0,false)

  @header.set('status.retried_count',0,false)
  @header.set('status.code',STATUS_INITIAL,false)
  @header.set('status.message','',false)

end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#header ⇒ Object

Returns the value of attribute header.



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

def header
  @header
end

#raw ⇒ Object

Returns the value of attribute raw.



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

def raw
  @raw
end

#routing_key ⇒ Object

Returns the value of attribute routing_key.



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

def routing_key
  @routing_key
end

#vhost ⇒ Object

Returns the value of attribute vhost.



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

def vhost
  @vhost
end

Class Method Details

.from_json(raw) ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/eventhub/message.rb', line 39

def self.from_json(raw)
  data = JSON.parse(raw)
  Message.new(data.get('header'), data.get('body'),raw)
rescue => e
  Message.new({ "status" =>  { "code" => STATUS_INVALID, "message" => "JSON parse error: #{e}" }} ,{ "original_message_base64_encoded" => Base64.encode64(raw)},raw)
end

Instance Method Details

#copy(status_code = STATUS_SUCCESS) ⇒ Object

copies the message and set’s provided status code (default: success), actual stamp, and a new message id



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/eventhub/message.rb', line 102

def copy(status_code=STATUS_SUCCESS)
  
  copied_header = self.header.dup 
  copied_body   = self.body.dup

  copied_header.set("message_id",UUIDTools::UUID.timestamp_create.to_s)
  copied_header.set("created_at",now_stamp)
  copied_header.set("status.code",status_code)

  Message.new(copied_header, copied_body)
end

#initial? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/eventhub/message.rb', line 85

def initial?
  self.status_code == STATUS_INITIAL
end

#retried? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/eventhub/message.rb', line 89

def retried?
  self.status_code == STATUS_RETRIED
end

#retry? ⇒ Boolean

Returns:

  • (Boolean) 


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

def retry?
  !success?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/eventhub/message.rb', line 77

def success?
  self.status_code == STATUS_SUCCESS
end

#to_json ⇒ Object 



93
94
95
 
# File 'lib/eventhub/message.rb', line 93

def to_json
  {'header' => self.header, 'body' => self.body}.to_json
end

#to_s ⇒ Object 



97
98
99
 
# File 'lib/eventhub/message.rb', line 97

def to_s
  "Msg: process [#{self.process_name},#{self.process_step_position},#{self.process_execution_id}], status [#{self.status_code},#{self.status_message},#{self.status_retried_count}]"
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
 
# File 'lib/eventhub/message.rb', line 72

def valid?
  # check for existence and defined value
  REQUIRED_HEADERS.all? { |key| @header.all_keys_with_path.include?(key) && !!self.send(key.gsub(/\./,"_").to_sym)}
end