Class: Communicator::InboundMessage

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
lib/communicator/inbound_message.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.create_from_json!(json_message) ⇒ Object

Creates an inbound message from a remote json hash



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/communicator/inbound_message.rb', line 15

def self.create_from_json!(json_message)
  inbound_msg = Communicator::InboundMessage.new(:body => json_message["body"])
  inbound_msg.id = json_message["id"]
  inbound_msg.save!
  Communicator.logger.info "Created inbound message from json, local id is #{inbound_msg.id}"
  inbound_msg
  
rescue => err
  # Add context to exception when using capita/exception_notification fork
  if err.respond_to?(:context)
    err.context["Validation Errors"] = "Errors: #{inbound_msg.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
    err.context["Inbound Message"] = inbound_msg.attributes.inspect
    err.context["JSON Message"] = json_message.inspect
  end
  
  raise err
end

.create_from_json_collection!(json_messages) ⇒ Object

Expects an already demarshalled collection array containing remote message data, which will then all be processed indivdually using create_from_json!



35
36
37
 
# File 'lib/communicator/inbound_message.rb', line 35

def self.create_from_json_collection!(json_messages)
  json_messages.map {|json_message| create_from_json!(json_message) }
end

.last_id ⇒ Object

Find the last ID present locally



40
41
42
 
# File 'lib/communicator/inbound_message.rb', line 40

def self.last_id
  count > 0 ? find(:first, :order => 'id DESC').id : 0
end

.valid_next_id?(from_id) ⇒ Boolean

Checks whether the given id is properly in line with the local last id The check will only be actually performed when there are any locally stored inbound messages

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/communicator/inbound_message.rb', line 46

def self.valid_next_id?(from_id)
  Communicator::InboundMessage.count == 0 or from_id.to_i == Communicator::InboundMessage.last_id + 1
end

Instance Method Details

#message_content ⇒ Object 



50
51
52
 
# File 'lib/communicator/inbound_message.rb', line 50

def message_content
  @message_content ||= JSON.parse(body).with_indifferent_access
end

#process! ⇒ Object

Figure out who is the receiver of this message and process the message



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/communicator/inbound_message.rb', line 55

def process!
  if processed_at.present? # Do not process if already processed!
    Communicator.logger.info "InboundMessage #{id} has already been processed, not processing again!"
    return false
  end
  source, content = message_content.first
  
  # We have to distinguish here between inbound messages that have an id and those that
  # don't since some databases (at least Postgres) will raise an error when the ID is set to nil on
  # the ActiveRecord instance because AR includes the id column and it's "NULL" value in the
  # INSERT statement
  if content["id"]
    Communicator.receiver_for(source).find_or_initialize_by_id(content["id"]).process_message(content)
  else
    Communicator.receiver_for(source).new.process_message(content)
  end
  self.processed_at = Time.now
  self.save!
  Communicator.logger.info "Processed inbound message ##{id} successfully"
  
rescue => err
  Communicator.logger.warn "Failed to store inbound message ##{id}! Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"

  # Add context to exception when using capita/exception_notification fork
  if err.respond_to?(:context)
    err.context["Validation Errors"] = "Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
    err.context["Inbound Message"] = self.attributes.inspect
    err.context["JSON Content"] = self.message_content.inspect
  end
  
  raise err
end