meta-messenger 2.1.2

data/lib/facebook/messenger/incoming/delivery.rb

@@ -0,0 +1,23 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Delivery class represents the receipt of a delivered message.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-deliveries
+      class Delivery
+        include Facebook::Messenger::Incoming::Common
+
+        def ids
+          @messaging['delivery']['mids']
+        end
+
+        def at
+          Time.at(@messaging['delivery']['watermark'] / 1000)
+        end
+
+        def seq
+          @messaging['delivery']['seq']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/feed.rb

@@ -0,0 +1,16 @@
+module Facebook
+  module Messenger
+    module Incoming
+      class Feed
+        include Facebook::Messenger::Incoming::FeedCommon
+
+        def id
+          @change['value']['post_id']
+        end
+        def message
+          @change['value']['message']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/feed_common.rb

@@ -0,0 +1,17 @@
+module Facebook
+  module Messenger
+    module Incoming
+      module FeedCommon
+        attr_reader :change
+
+        def initialize(change)
+          @change = change
+        end
+
+        def item
+          @change['item']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/game_play.rb

@@ -0,0 +1,39 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The GamePlay class represents an incoming Facebook Messenger
+      #   game_play events.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_game_plays
+      class GamePlay
+        include Facebook::Messenger::Incoming::Common
+
+        def game_play
+          @messaging['game_play']
+        end
+
+        def payload
+          game_play['payload']
+        end
+
+        def score
+          game_play['score']
+        end
+
+        def game
+          game_play['game_id']
+        end
+
+        def player
+          game_play['player_id']
+        end
+
+        def context
+          {
+            context_id: game_play['context_id'],
+            context_type: game_play['context_type']
+          }
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/leadgen.rb

@@ -0,0 +1,13 @@
+module Facebook
+  module Messenger
+    module Incoming
+      class Leadgen
+        include Facebook::Messenger::Incoming::FeedCommon
+
+        def id
+          @change['value']['leadgen_id']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/message.rb

@@ -0,0 +1,159 @@
+module Facebook
+  module Messenger
+    module Incoming
+      #
+      # Message class represents an incoming Facebook Messenger message event.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messages
+      #
+      class Message
+        include Facebook::Messenger::Incoming::Common
+
+        #
+        # @return [Array] Supported attachments for message.
+        ATTACHMENT_TYPES = %w[image audio video file location fallback].freeze
+
+        #
+        # Function returns unique id of message
+        # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messages
+        #   Info about received message format.
+        #
+        # @return [String] Unique id of message.
+        #
+        def id
+          @messaging['message']['mid']
+        end
+
+        def seq
+          @messaging['message']['seq']
+        end
+
+        #
+        # Function returns text of message
+        #
+        # @return [String] Text of message.
+        #
+        def text
+          @messaging['message']['text']
+        end
+
+        #
+        # Whether message is echo or not?
+        #
+        # @return [Boolean] If message is echo return true else false.
+        #
+        def echo?
+          @messaging['message']['is_echo']
+        end
+
+        #
+        # Function returns array containing attachment data
+        # @see https://developers.facebook.com/docs/messenger-platform/send-messages#sending_attachments
+        #   More info about attachments.
+        #
+        # @return [Array] Attachment data.
+        #
+        def attachments
+          @messaging['message']['attachments']
+        end
+
+        #
+        # If facebook messenger built-in NLP is enabled, message will
+        #   contain 'nlp' key in response.
+        # @see https://developers.facebook.com/docs/messenger-platform/built-in-nlp
+        #   More information about built-in NLP.
+        #
+        #
+        # @return [Hash] NLP information about message.
+        #
+        def nlp
+          @messaging['message']['nlp']
+        end
+
+        #
+        # Function return app id from message.
+        #
+        # @return [String] App ID.
+        #
+        def app_id
+          @messaging['message']['app_id']
+        end
+
+        #
+        # This meta programming defines function for
+        #   every attachment type to check whether the attachment
+        #   in message is of defined type or not.
+        #
+        ATTACHMENT_TYPES.each do |attachment_type|
+          define_method "#{attachment_type}_attachment?" do
+            attachment_type?(attachment_type)
+          end
+        end
+
+        #
+        # Get the type of attachment in message.
+        #
+        # @return [String] Attachment type.
+        #
+        def attachment_type
+          return if attachments.nil?
+
+          attachments.first['type']
+        end
+
+        #
+        # Get the URL of attachment in message.
+        # URL is only available for attachments of type image/audio/video/file.
+        #
+        # @return [String] URL of attachment.
+        #
+        def attachment_url
+          return if attachments.nil?
+          return unless %w[image audio video file].include? attachment_type
+
+          attachments.first['payload']['url']
+        end
+
+        #
+        # Get the location coordinates if attachment type is 'location'.
+        # @example [LATITUDE, LONGITUDE]
+        #
+        # @return [Array] Location coordinates.
+        #
+        def location_coordinates
+          return [] unless attachment_type?('location')
+
+          coordinates_data = attachments.first['payload']['coordinates']
+          [coordinates_data['lat'], coordinates_data['long']]
+        end
+
+        #
+        # Get the payload of quick reply.
+        # @see https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies
+        #   More info about quick reply.
+        #
+        # @return [String] Payload string.
+        #
+        def quick_reply
+          return unless @messaging['message']['quick_reply']
+
+          @messaging['message']['quick_reply']['payload']
+        end
+
+        # @private
+        private
+
+        #
+        # Check if attachment in message is of given type or not?
+        #
+        # @param [String] attachment_type Attachment type
+        #
+        # @return [Boolean] If type of attachment in message
+        #   and provided attachment type are same then return true else false.
+        #
+        def attachment_type?(attachment_type)
+          !attachments.nil? && attachments.first['type'] == attachment_type
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/message_echo.rb

@@ -0,0 +1,10 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Message echo class represents an incoming Facebook Messenger message
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-echoes
+      class MessageEcho < Message
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/message_reaction.rb

@@ -0,0 +1,23 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Message echo class represents an incoming Facebook Messenger message
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-reactions
+      class MessageReaction
+        include Facebook::Messenger::Incoming::Common
+
+        def action
+          @messaging['reaction']['action']
+        end
+
+        def emoji
+          @messaging['reaction']['emoji']
+        end
+
+        def reaction
+          @messaging['reaction']['reaction']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/message_request.rb

@@ -0,0 +1,13 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Message request class represents an
+      # incoming Facebook Messenger message request accepted by the user
+      class MessageRequest < Message
+        def accept?
+          @messaging['message_request'] == 'accept'
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/optin.rb

@@ -0,0 +1,34 @@
+module Facebook
+  module Messenger
+    module Incoming
+      #
+      # The Optin class represents an incoming Facebook Messenger optin,
+      # which occurs when a user engages by using the Send-to-Messenger Plugin.
+      #
+      # @see https://developers.facebook.com/docs/messenger-platform/plugin-reference
+      #
+      class Optin
+        include Facebook::Messenger::Incoming::Common
+
+        #
+        # Function returns 'data-ref' attribute that was defined
+        #   with the entry point.
+        #
+        # @return [String] data-ref attribute.
+        #
+        def ref
+          @messaging['optin']['ref']
+        end
+
+        #
+        # Function returns 'user_ref' attribute defined in checkbox plugin.
+        #
+        # @return [String] user-ref attribute.
+        #
+        def user_ref
+          @messaging['optin']['user_ref']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/pass_thread_control.rb

@@ -0,0 +1,22 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The PassThreadControl class represents an incoming Facebook Messenger
+      # pass thread control event.
+      #
+      # @see https://developers.facebook.com/docs/messenger-platform/handover-protocol/pass-thread-control
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/handover-protocol/pass-thread-control
+      class PassThreadControl
+        include Facebook::Messenger::Incoming::Common
+
+        def new_owner_app_id
+          @messaging['pass_thread_control']['new_owner_app_id']
+        end
+
+        def metadata
+          @messaging['pass_thread_control']['metadata']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/payment.rb

@@ -0,0 +1,49 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Payment class represents a successful purchase using the Buy Button
+      #
+      # https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/payment
+      class Payment
+        include Facebook::Messenger::Incoming::Common
+
+        # The payment portion of the payload.
+        class Payment
+          def initialize(payment)
+            @payment = payment
+          end
+
+          # Return String containing developer defined payload.
+          def payload
+            @payment['payload']
+          end
+
+          # Return hash containing the requested information from user when they
+          #   click buy button.
+          def user_info
+            @payment['requested_user_info']
+          end
+
+          # Return hash containing the payment credential information.
+          def payment_credential
+            @payment['payment_credential']
+          end
+
+          # Return hash containing the information about amount of purchase.
+          def amount
+            @payment['amount']
+          end
+
+          # Return string containing option_id of selected shipping option.
+          def shipping_option_id
+            @payment['shipping_option_id']
+          end
+        end
+
+        def payment
+          @payment ||= Payment.new(@messaging['payment'])
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/policy_enforcement.rb

@@ -0,0 +1,21 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The PolicyEnforcement class represents an incoming webhook response from
+      # Facebook when they are notifying your app of a policy violation
+      #
+      # https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_policy_enforcement
+      class PolicyEnforcement
+        include Facebook::Messenger::Incoming::Common
+
+        def action
+          @messaging['policy_enforcement']['action']
+        end
+
+        def reason
+          @messaging['policy_enforcement']['reason']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/postback.rb

@@ -0,0 +1,26 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Postback class represents an incoming Facebook Messenger
+      #   postback events.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_postbacks
+      class Postback
+        include Facebook::Messenger::Incoming::Common
+
+        # Return String of developer defined payload.
+        def payload
+          @messaging['postback']['payload']
+        end
+
+        # Return hash containing the referral information of user.
+        def referral
+          return if @messaging['postback']['referral'].nil?
+
+          @referral ||= Referral::Referral.new(
+            @messaging['postback']['referral']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/read.rb

@@ -0,0 +1,21 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Read class represents the user reading a delivered message.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-reads
+      class Read
+        include Facebook::Messenger::Incoming::Common
+
+        # Return time object when message is read by user.
+        def at
+          Time.at(@messaging['read']['watermark'] / 1000)
+        end
+
+        # Return Integer defining the sequence number of message.
+        def seq
+          @messaging['read']['seq']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming/referral.rb

@@ -0,0 +1,47 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # Referral class represents an incoming Facebook Messenger referral event.
+      #
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_referrals
+      class Referral
+        include Facebook::Messenger::Incoming::Common
+
+        # The referral portion of the payload.
+        class Referral
+          def initialize(referral)
+            @referral = referral
+          end
+
+          # Return String of ref data set in referrer.
+          def ref
+            @referral['ref']
+          end
+
+          # Return String of referral source.
+          def source
+            @referral['source']
+          end
+
+          # Return String of referral type.
+          def type
+            @referral['type']
+          end
+
+          # Return String of ad id.
+          def ad_id
+            @referral['ad_id'] if @referral.key?('ad_id')
+          end
+        end
+
+        def referral
+          @referral ||= Referral.new(@messaging['referral'])
+        end
+
+        def ref
+          referral.ref
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming.rb

@@ -0,0 +1,85 @@
+require 'facebook/messenger/incoming/common'
+require 'facebook/messenger/incoming/message'
+require 'facebook/messenger/incoming/message_echo'
+require 'facebook/messenger/incoming/message_request'
+require 'facebook/messenger/incoming/delivery'
+require 'facebook/messenger/incoming/postback'
+require 'facebook/messenger/incoming/optin'
+require 'facebook/messenger/incoming/read'
+require 'facebook/messenger/incoming/account_linking'
+require 'facebook/messenger/incoming/referral'
+require 'facebook/messenger/incoming/payment'
+require 'facebook/messenger/incoming/policy_enforcement'
+require 'facebook/messenger/incoming/pass_thread_control'
+require 'facebook/messenger/incoming/game_play'
+require 'facebook/messenger/incoming/message_reaction'
+require 'facebook/messenger/incoming/feed_common'
+require 'facebook/messenger/incoming/feed'
+require 'facebook/messenger/incoming/leadgen'
+
+module Facebook
+  module Messenger
+    #
+    # Module Incoming parses and abstracts incoming requests from Messenger.
+    #
+    module Incoming
+      #
+      # @return [Hash] Hash containing facebook messenger events and its event
+      #   handler classes.
+      EVENTS = {
+        'message' => Message,
+        'delivery' => Delivery,
+        'postback' => Postback,
+        'optin' => Optin,
+        'read' => Read,
+        'account_linking' => AccountLinking,
+        'referral' => Referral,
+        'message_echo' => MessageEcho,
+        'message_request' => MessageRequest,
+        'payment' => Payment,
+        'policy_enforcement' => PolicyEnforcement,
+        'pass_thread_control' => PassThreadControl,
+        'game_play' => GamePlay,
+        'reaction' => MessageReaction,
+        'feed' => Feed,
+        'leadgen' => Leadgen,
+      }.freeze
+
+      # Parse the given payload and create new object of class related
+      #   to event in payload.
+      #
+      # @see https://developers.facebook.com/docs/messenger-platform/webhook-reference
+      #
+      # @raise [Facebook::Messenger::Incoming::UnknownPayload] if event is not
+      #   registered in EVENTS constant
+      #
+      # @param [Hash] payload A Hash describing a payload from Facebook.
+      #
+      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) || payload['field'] == event
+        end
+
+        raise UnknownPayload, payload
+      end
+
+      #
+      # Check if event is echo.
+      #
+      # @param [Hash] payload Request payload from facebook.
+      #
+      # @return [Boolean] If event is echo return true else false.
+      #
+      def self.payload_is_echo?(payload)
+        payload.key?('message') && payload['message']['is_echo'] == true
+      end
+
+      #
+      # Class UnknownPayload provides errors related to incoming messages.
+      #
+      class UnknownPayload < Facebook::Messenger::Error; end
+    end
+  end
+end