bobot 1.0.52

data/lib/bobot/events/account_linking.rb

@@ -0,0 +1,15 @@
+module Bobot
+  module Event
+    class AccountLinking
+      include Bobot::Event::Common
+
+      def status
+        @messaging['account_linking']['status']
+      end
+
+      def authorization_code
+        @messaging['account_linking']['authorization_code']
+      end
+    end
+  end
+end

data/lib/bobot/events/common.rb

@@ -0,0 +1,170 @@
+module Bobot
+  module Event
+    # Common attributes for all incoming data from Facebook.
+    module Common
+      attr_reader :messaging
+      attr_accessor :delay_options
+      attr_accessor :payloads_sent
+
+      def initialize(messaging)
+        @messaging = messaging
+        @delay_options = { wait: 0, wait_until: nil }
+        @payloads_sent = []
+      end
+
+      def add_delivery(payload:)
+        @payloads_sent << payload
+      end
+
+      def sender
+        @messaging['sender']
+      end
+
+      def recipient
+        @messaging['recipient']
+      end
+
+      def delay(wait: 0, wait_until: nil)
+        raise Bobot::FieldFormat.new('wait has to be positive integer.') unless wait.present?
+        if Bobot.async
+          @delay_options[:wait] = wait if wait >= 0
+          @delay_options[:wait_until] = wait_until if wait_until.present?
+        else
+          warn "delay is ignored since you configured Bobot.async to 'false'"
+        end
+        self
+      end
+
+      def sent_at
+        Time.zone.at(@messaging['timestamp'] / 1000)
+      end
+
+      def deliver(payload_template:)
+        raise Bobot::FieldFormat.new('payload_template is required.') unless payload_template.present?
+        @payloads_sent << payload_template
+        job = Bobot::DeliverJob
+        if Bobot.async
+          job = job.set(wait: @delay_options[:wait]) if @delay_options[:wait] > 0
+          job = job.set(wait: @delay_options[:wait_until]) if @delay_options[:wait_until].present?
+          job.perform_later(sender: sender, access_token: access_token, payload_template: payload_template)
+        else
+          job.perform_now(sender: sender, access_token: access_token, payload_template: payload_template)
+        end
+      end
+
+      def sender_action(sender_action:)
+        deliver(payload_template: { sender_action: sender_action })
+      end
+
+      def show_typing(state:)
+        sender_action(sender_action: state ? 'typing_on' : 'typing_off')
+      end
+
+      def mark_as_seen
+        sender_action(sender_action: 'mark_seen')
+      end
+
+      def reply(payload_message:)
+        deliver(payload_template: { message: payload_message })
+      end
+
+      def reply_with_text(text:)
+        raise Bobot::FieldFormat.new('text is required.') unless text.present?
+        raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
+        reply(
+          payload_message: {
+            text: text,
+          },
+        )
+      end
+
+      def reply_with_attachment(url:, type:)
+        raise Bobot::FieldFormat.new('url is required.') unless url.present?
+        raise Bobot::FieldFormat.new('type is required.') unless type.present?
+        raise Bobot::FieldFormat.new('type is invalid, only "image, audio, video, file" are permitted.') unless %w[image audio video file].include?(type)
+        reply(
+          payload_message: {
+            attachment: {
+              type: type,
+              payload: {
+                url: url,
+              }.tap { |properties| properties.merge!(is_reusable: true) if type == 'image' },
+            },
+          },
+        )
+      end
+
+      def reply_with_image(url:)
+        reply_with_attachment(url: url, type: 'image')
+      end
+
+      def reply_with_audio(url:)
+        reply_with_attachment(url: url, type: 'audio')
+      end
+
+      def reply_with_video(url:)
+        reply_with_attachment(url: url, type: 'video')
+      end
+
+      def reply_with_file(url:)
+        reply_with_attachment(url: url, type: 'file')
+      end
+
+      def reply_with_quick_replies(text:, quick_replies:)
+        raise Bobot::FieldFormat.new('text is required.') unless text.present?
+        raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
+        raise Bobot::FieldFormat.new('quick_replies are required.') unless quick_replies.present?
+        raise Bobot::FieldFormat.new('quick_replies are limited to 11.') if quick_replies.size > 11
+        reply(
+          payload_message: {
+            text: text,
+            quick_replies: quick_replies,
+          },
+        )
+      end
+
+      def reply_with_buttons(text:, buttons:)
+        raise Bobot::FieldFormat.new('text is required.') unless text.present?
+        raise Bobot::FieldFormat.new('text length is limited to 640.') if text.size > 640
+        raise Bobot::FieldFormat.new('buttons are required.') unless buttons.present?
+        raise Bobot::FieldFormat.new('buttons are limited to 3.') if buttons.size > 3
+        reply(
+          payload_message: {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'button',
+                text: text,
+                buttons: buttons,
+              },
+            },
+          },
+        )
+      end
+
+      def reply_with_generic(elements:, image_aspect_ratio: 'square')
+        raise Bobot::FieldFormat.new('elements are required.') if elements.nil?
+        raise Bobot::FieldFormat.new('elements are limited to 10.') if elements.size > 10
+        raise Bobot::FieldFormat.new('image_aspect_ratio is required.') if image_aspect_ratio.nil?
+        raise Bobot::FieldFormat.new('image_aspect_ratio is invalid, only "square, horizontal" are permitted.') unless %w[square horizontal].include?(image_aspect_ratio)
+        reply(
+          payload_message: {
+            attachment: {
+              type: 'template',
+              payload: {
+                template_type: 'generic',
+                image_aspect_ratio: image_aspect_ratio,
+                elements: elements,
+              },
+            },
+          },
+        )
+      end
+      alias_method :reply_with_carousel, :reply_with_generic
+
+      def access_token
+        Bobot.page_access_token
+      end
+    end
+  end
+end

data/lib/bobot/events/delivery.rb

@@ -0,0 +1,20 @@
+module Bobot
+  module Event
+    # The Delivery class represents the receipt of a delivered message.
+    class Delivery
+      include Bobot::Event::Common
+
+      def ids
+        @messaging['delivery']['mids']
+      end
+
+      def at
+        Time.zone.at(@messaging['delivery']['watermark'] / 1000)
+      end
+
+      def seq
+        @messaging['delivery']['seq']
+      end
+    end
+  end
+end

data/lib/bobot/events/message.rb

@@ -0,0 +1,72 @@
+module Bobot
+  module Event
+    class Message
+      include Bobot::Event::Common
+
+      ATTACHMENT_TYPES = %w[image audio video file location fallback].freeze
+
+      def id
+        @messaging['message']['mid']
+      end
+
+      def seq
+        @messaging['message']['seq']
+      end
+
+      def text
+        @messaging['message']['text']
+      end
+
+      def echo?
+        @messaging['message']['is_echo']
+      end
+
+      def attachments
+        @messaging['message']['attachments']
+      end
+
+      def app_id
+        @messaging['message']['app_id']
+      end
+
+      ATTACHMENT_TYPES.each do |attachment_type|
+        define_method "#{attachment_type}_attachment?" do
+          attachment_type?(attachment_type)
+        end
+      end
+
+      def attachment_type
+        return if attachments.nil?
+
+        attachments.first['type']
+      end
+
+      def attachment_url
+        return if attachments.nil?
+        return unless %w[image audio video file].include? attachment_type
+
+        attachments.first['payload']['url']
+      end
+
+      def location_coordinates
+        return [] unless attachment_type?('location')
+
+        coordinates_data = attachments.first['payload']['coordinates']
+        [coordinates_data['lat'], coordinates_data['long']]
+      end
+
+      def quick_reply
+        return unless @messaging['message']['quick_reply']
+
+        @messaging['message']['quick_reply']['payload']
+      end
+      alias_method :payload, :quick_reply
+
+    private
+
+      def attachment_type?(attachment_type)
+        !attachments.nil? && attachments.first['type'] == attachment_type
+      end
+    end
+  end
+end

data/lib/bobot/events/message_echo.rb

@@ -0,0 +1,8 @@
+module Bobot
+  module Event
+    # The Message echo class represents an
+    # incoming Facebook Messenger message
+    class MessageEcho < Message
+    end
+  end
+end

data/lib/bobot/events/optin.rb

@@ -0,0 +1,11 @@
+module Bobot
+  module Event
+    class Optin
+      include Bobot::Event::Common
+
+      def ref
+        @messaging['optin']['ref']
+      end
+    end
+  end
+end

data/lib/bobot/events/postback.rb

@@ -0,0 +1,20 @@
+module Bobot
+  module Event
+    class Postback
+      include Bobot::Event::Common
+
+      def payload
+        @messaging['postback']['payload']
+      end
+
+      def title
+        @messaging['postback']['title']
+      end
+
+      def referral
+        return if @messaging['postback']['referral'].nil?
+        @referral ||= Referral::Referral.new(@messaging['postback']['referral'])
+      end
+    end
+  end
+end

data/lib/bobot/events/read.rb

@@ -0,0 +1,15 @@
+module Bobot
+  module Event
+    class Read
+      include Bobot::Event::Common
+
+      def at
+        Time.zone.at(@messaging['read']['watermark'] / 1000)
+      end
+
+      def seq
+        @messaging['read']['seq']
+      end
+    end
+  end
+end

data/lib/bobot/events/referral.rb

@@ -0,0 +1,33 @@
+module Bobot
+  module Event
+    class Referral
+      include Bobot::Event::Common
+
+      class Referral
+        def initialize(referral)
+          @referral = referral
+        end
+
+        def ref
+          @referral['ref']
+        end
+
+        def source
+          @referral['source']
+        end
+
+        def type
+          @referral['type']
+        end
+      end
+
+      def referral
+        @referral ||= Referral.new(@messaging['referral'])
+      end
+
+      def ref
+        referral.ref
+      end
+    end
+  end
+end

data/lib/bobot/exceptions.rb

@@ -0,0 +1,73 @@
+module Bobot
+  # Base Facebook Messenger exception.
+  class Error < ::StandardError; end
+
+  class InvalidParameter < ::ArgumentError
+    def initialize(name, description = "")
+      super("invalid value of parameter #{name}#{description.present? ? ": '#{description}'" : ''}")
+    end
+  end
+
+  class FieldFormat < ::ArgumentError
+    def initialize(description)
+      super("invalid field value with API limits: #{description}")
+    end
+  end
+
+  # Forbidden Action exception
+  class ActionNotAllowed < Bobot::Error; end
+
+  # Base error class for Facebook API errors.
+  class FacebookError < Bobot::Error
+    attr_reader :message
+    attr_reader :type
+    attr_reader :code
+    attr_reader :subcode
+    attr_reader :user_title
+    attr_reader :user_msg
+    attr_reader :fbtrace_id
+
+    def initialize(error)
+      @message = error['message']
+      @type = error['type']
+      @code = error['code']
+      @subcode = error['error_subcode']
+      @user_title = error['error_user_title']
+      @user_msg = error['error_user_msg']
+      @fbtrace_id = error['fbtrace_id']
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  # Base Facebook Messenger send API exception.
+  class SendError < Bobot::FacebookError; end
+
+  class AccessTokenError < Bobot::SendError; end
+  class AccountLinkingError < Bobot::SendError; end
+  class BadParameterError < Bobot::SendError; end
+  class InternalError < Bobot::SendError; end
+  class LimitError < Bobot::SendError; end
+  class PermissionError < Bobot::SendError; end
+
+  # Base Facebook Messenger exception.
+  class NetworkError < ::StandardError
+    attr_reader :response
+    attr_reader :description
+
+    def initialize(response, description)
+      @response = response
+      @description = description
+    end
+
+    def message
+      description
+    end
+
+    def to_s
+      message
+    end
+  end
+end