Module: Facebook::Messenger::Incoming

Defined in:
lib/facebook/messenger/incoming.rb,
lib/facebook/messenger/incoming/read.rb,
lib/facebook/messenger/incoming/optin.rb,
lib/facebook/messenger/incoming/common.rb,
lib/facebook/messenger/incoming/message.rb,
lib/facebook/messenger/incoming/delivery.rb,
lib/facebook/messenger/incoming/postback.rb,
lib/facebook/messenger/incoming/referral.rb,
lib/facebook/messenger/incoming/message_echo.rb,
lib/facebook/messenger/incoming/account_linking.rb

Overview

The Incoming module parses and abstracts incoming requests from Facebook Messenger.

Defined Under Namespace

Modules: Common Classes: AccountLinking, Delivery, Message, MessageEcho, Optin, Postback, Read, Referral, UnknownPayload

Constant Summary collapse

EVENTS = 
{
  'message' => Message,
  'delivery' => Delivery,
  'postback' => Postback,
  'optin' => Optin,
  'read' => Read,
  'account_linking' => AccountLinking,
  'referral' => Referral,
  'message_echo' => MessageEcho
}.freeze

Class Method Summary collapse

Class Method Details

.parse(payload) ⇒ Object

Parse the given payload.

payload - A Hash describing a payload from Facebook.

Raises:



32
33
34
35
36
37
38
39
40
 
# File 'lib/facebook/messenger/incoming.rb', line 32

def self.parse(payload)
  return MessageEcho.new(payload) if payload_is_echo?(payload)

  EVENTS.each do |event, klass|
    return klass.new(payload) if payload.key?(event)
  end

  raise UnknownPayload, payload
end

.payload_is_echo?(payload) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/facebook/messenger/incoming.rb', line 42

def self.payload_is_echo?(payload)
  payload.key?('message') && payload['message']['is_echo'] == true
end