bobot 1.0.53 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9abca691c0b2cccaa74e39426221e12d320ff0d4
-  data.tar.gz: 16f6c8684ae068e0ec36306cf4125061a4fd7fea
+  metadata.gz: 238ce4063aa11a3df2f3150c8a7a65e23cc0063f
+  data.tar.gz: ce018a45a1d777752c746c4b7f46e2049fdfa071
 SHA512:
-  metadata.gz: 52e6bb306d99fc08db6436822c9b29396e5ecf4031b59e62f35da3bc5af71fb9a426138faccc338dcbed38b0c695345c7b9b1ad75a813976d62fb70590c54cb6
-  data.tar.gz: bb9bf2d9500c16da7c4dc5a6233bb467b3564263028d24882a85b8104c3273f4ad315aac1bd6ab85a12a2c717ebcc4072a13bcced26d5d8d6424e003a30f2bc1
+  metadata.gz: 76f2106985520b82654e76d11340e24bcf3c4a25074c87a345f3d543f54384419538fbcc05ed82b33015ee539c4f5dc75736e5eb9f518ae38ef179e9978e0802
+  data.tar.gz: f793e2ae3e8b5bdb50bcbda3e639c16018e4db52f420bf823dd81b489ce4f208623fe78050f09337a67f53c29d3a465756f676fe3c8a62cfb53192fb26b7b54d

data/README.md

@@ -31,16 +31,26 @@ Typing the following command in your Rails application will add the bot to your
 `config/bobot.yml` contains your bot keys
 `app/bobot/workflow.rb` contains the workflow of your bot
 
-You can run in a Rails console:
-`Bobot.update_facebook_setup!`
+You can access to page settings:
+```
+Bobot.config.find_page_by_id(facebook_page_id)
+Bobot.config.find_page_by_slug(facebook_page_slug)
+```
+
+After fetching the page with command above, you have access to:
+`update_facebook_setup!`
 
 Or one by one in a Rails console:
-- `Bobot.subscribe_to_facebook_page!`
-- `Bobot.unsubscribe_to_facebook_page!`
-- `Bobot.set_greeting_text!`
-- `Bobot.set_whitelist_domains!`
-- `Bobot.set_get_started_button!`
-- `Bobot.set_persistent_menu!`
+- `subscribe_to_facebook_page!`
+- `unsubscribe_to_facebook_page!`
+- `unset_greeting_text!`
+- `set_greeting_text!`
+- `unset_whitelist_domains!`
+- `set_whitelist_domains!`
+- `unset_get_started_button!`
+- `set_get_started_button!`
+- `unset_persistent_menu!`
+- `set_persistent_menu!`
 
 Greeting Text and Persistent Menus are translated by I18n.
 You have to define into your `config/application.rb` your available_locales as I18n defined them.

data/app/controllers/bobot/webhook_controller.rb

@@ -1,28 +1,46 @@
 module Bobot
   class WebhookController < Bobot::ApplicationController
+    class BadRequestError < Error; end
+
     include ActionView::Helpers::TextHelper
 
     skip_before_action :verify_authenticity_token, raise: false
 
     layout :bobot_layout rescue nil
 
-    def notify
-      if check_integrity?
-        respond_with body: ActiveSupport::JSON.encode(trigger(parsed_body)), status: :ok
+    X_HUB_SIGNATURE_MISSING_WARNING = <<-HEREDOC.freeze
+      The X-Hub-Signature header is not present in the request. This is
+      expected for the first webhook requests. If it continues after
+      some time, check your app's secret token.
+    HEREDOC
+
+    def webhook
+      if request.get?
+        verify
+      elsif request.post?
+        receive
       else
-        respond_with status: :forbidden
+        head :method_not_allowed
       end
     end
 
     def verify
-      if verify_params['hub.mode'] == 'subscribe' &&
-         verify_params['hub.verify_token'] == Bobot.verify_token
-        respond_with body: params['hub.challenge'], status: :ok
+      if params['hub.mode'.freeze] == 'subscribe' &&
+         params['hub.verify_token'.freeze] == Bobot.config.verify_token
+        render plain: params['hub.challenge'.freeze], status: :ok
       else
-        respond_with status: :forbidden
+        render plain: "Error wrong verify token".freeze, status: :forbidden
       end
     end
 
+    def receive
+      check_integrity
+      return_json = trigger(parsed_body)
+      render plain: ActiveSupport::JSON.encode(return_json), status: :ok
+    rescue BadRequestError => error
+      render plain: error.message, status: :bad_request
+    end
+
   private
 
     def body
@@ -30,27 +48,42 @@ module Bobot
     end
 
     def parsed_body
-      @parsed_body ||= begin
-        ActiveSupport::JSON.decode(body)
-      rescue ::ActiveSupport::JSON.parse_error
-        'payload is not string and not a valid to be JSONified.'
-      end
+      @parsed_body ||= ActiveSupport::JSON.decode(body)
+    rescue ::ActiveSupport::JSON.parse_error
+      raise BadRequestError.new("Error parsing request body format")
+    end
+
+    def valid_signature?
+      Rack::Utils.secure_compare(signature, signature_for(body))
+    end
+
+    def generate_hmac(content)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'.freeze), Bobot.config.app_secret, content)
     end
 
-    def signature(str, key = nil)
-      key ||= Bobot.app_secret
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), key, str)
+    def signature_for(string)
+      format('sha1=%s'.freeze, generate_hmac(string))
     end
 
-    def check_integrity?
-      request.headers['HTTP_X_HUB_SIGNATURE'].to_s =~ /\Asha1=([0-9a-z]{40})\z/
+    def signature
+      request.headers['HTTP_X_HUB_SIGNATURE'.freeze].to_s
+    end
+
+    def check_integrity
+      signature =~ /\Asha1=([0-9a-z]{40})\z/
       hub_signature = Regexp.last_match(1)
-      hub_signature && Rack::Utils.secure_compare(hub_signature, signature(body))
+      unless hub_signature
+        Rails.logger.error(X_HUB_SIGNATURE_MISSING_WARNING)
+        raise BadRequestError.new("Error getting integrity signature".freeze)
+      end
+      unless valid_signature?
+        raise BadRequestError.new("Error checking message integrity".freeze)
+      end
     end
 
     def trigger(events)
-      events['entry'].inject([]) do |payloads_sent, entry|
-        entry['messaging'].each do |messaging|
+      events['entry'.freeze].to_a.inject([]) do |payloads_sent, entry|
+        entry['messaging'.freeze].to_a.each do |messaging|
           begin
             payloads_sent << Bobot::Commander.receive(messaging)
           rescue => e
@@ -60,15 +93,6 @@ module Bobot
       end
     end
 
-    def respond_with(body: '', status:)
-      self.response_body = body
-      self.status = status
-    end
-
-    def verify_params
-      params.permit('hub.mode', 'hub.challenge', 'hub.verify_token')
-    end
-
     def bobot_layout
       'bobot/application'
     end

data/config/routes.rb

@@ -1,6 +1,5 @@
 Bobot::Engine.routes.draw do
   controller 'webhook' do
-    match 'facebook', action: :notify, via: :post, as: :facebook_notify
-    match 'facebook', action: :verify, via: :get, as: :facebook_verify
+    match 'facebook', action: :webhook, via: [:get, :post]
   end
 end

data/lib/bobot.rb

@@ -14,5 +14,19 @@ require 'bobot/commander'
 require 'bobot/event'
 
 module Bobot
-  extend Configuration
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  configure do |config|
+    config.pages = []
+  end
 end

data/lib/bobot/commander.rb

@@ -11,6 +11,7 @@ module Bobot
       account_linking
       referral
       message_echo
+      message_request
     ].freeze
 
     include Bobot::GraphFacebook
@@ -32,28 +33,28 @@ module Bobot
       def receive(payload)
         event = Bobot::Event.parse(payload)
         hooks.fetch(Bobot::Event::EVENTS.invert[event.class].to_sym)
-        puts "[ActiveJob] << Bobot::HookJob with event #{event.class}" if Bobot.debug_log
-        #event.mark_as_seen
+        puts "[ActiveJob] << Bobot::HookJob with event #{event.class}" if Bobot.config.debug_log
+        # event.mark_as_seen
         job = Bobot::CommanderJob
-        if Bobot.async
+        if Bobot.config.async
           job.perform_later(payload: payload)
         else
           job.perform_now(payload: payload)
         end
       rescue KeyError
-        $stderr.puts "Ignoring #{event.class} (no hook registered)"
+        warn "Ignoring #{event.class} (no hook registered)"
       end
 
       def trigger(payload)
         event = Bobot::Event.parse(payload)
         hook = hooks.fetch(Bobot::Event::EVENTS.invert[event.class].to_sym)
-        puts "[ActiveJob] >> Bobot::HookJob related to event #{name.class}" if Bobot.debug_log
-        #event.show_typing(state: true)
+        puts "[ActiveJob] >> Bobot::HookJob related to event #{name.class}" if Bobot.config.debug_log
+        # event.show_typing(state: true)
         hook.call(event)
-        #event.show_typing(state: false)
+        # event.show_typing(state: false)
         [event, event.payloads_sent[1..-2]]
       rescue KeyError
-        $stderr.puts "Ignoring #{event.class} (no hook registered)"
+        warn "Ignoring #{event.class} (no hook registered)"
       end
 
       def hooks

data/lib/bobot/configuration.rb

@@ -1,60 +1,7 @@
 module Bobot
-  # Defines constants and methods related to configuration
-  module Configuration
-    # An array of valid keys in the options hash when configuring
-    VALID_CONFIGURATION_KEYS = %i[
-      page_id
-      app_id
-      app_secret
-      page_access_token
-      verify_token
-      domains
-      debug_log
-      async
-    ].freeze
-
-    # By default, don't set a facebook page id
-    DEFAULT_PAGE_ID = nil
-
-    # By default, don't set a facebook developper app id
-    DEFAULT_APP_ID = nil
-
-    # By default, don't set a facebook developper app secret
-    DEFAULT_APP_SECRET = nil
-
-    # By default, don't set a facebook developper page access token
-    DEFAULT_PAGE_ACCESS_TOKEN = nil
-
-    # By default, don't set a facebook webhook_verify_token
-    DEFAULT_VERIFY_TOKEN = nil
-
-    # By default, don't set a facebook whitelisting domains
-    DEFAULT_DOMAINS = nil
-
-    # By default, debug log is to false
-    DEFAULT_DEBUG_LOG = false
-
-    # By default, async is to false
-    DEFAULT_ASYNC = false
-
-    # @private
-    attr_accessor(*VALID_CONFIGURATION_KEYS)
-
-    # Our host application root path
-    # We set this when the engine is initialized
-    mattr_accessor :app_root
-
-    # When this module is extended, set all configuration options to their default values
-    def self.extended(base)
-      base.reset!
-    end
-
-    # Convenience method to allow configuration options to be set in a block
-    def configure
-      yield self
-    end
+  class Configuration
+    attr_accessor :app_id, :app_secret, :verify_token, :debug_log, :async, :pages
 
-    # Custom self assignments
     def domains=(rhs)
       return unless rhs.present?
       if rhs.respond_to?(:to_str)
@@ -66,166 +13,182 @@ module Bobot
       end
     end
 
-    # Create a hash of options and their values
-    def configurations
-      VALID_CONFIGURATION_KEYS.inject({}) do |option, key|
-        option.merge!(key => send(key))
-      end
+    def find_page_by_id(page_id)
+      pages.find { |page| page.page_id == page_id }
     end
 
-    # Reset all configuration options to defaults
-    def reset!
-      self.page_id = DEFAULT_PAGE_ID
-      self.app_id = DEFAULT_APP_ID
-      self.app_secret = DEFAULT_APP_SECRET
-      self.page_access_token = DEFAULT_PAGE_ACCESS_TOKEN
-      self.verify_token = DEFAULT_VERIFY_TOKEN
-      self.domains = DEFAULT_DOMAINS
-      self.debug_log = DEFAULT_DEBUG_LOG
-      self.async = DEFAULT_ASYNC
+    def find_page_by_slug(slug)
+      pages.find { |page| page.slug == slug }
     end
 
-    def update_facebook_setup!
-      subscribe_to_facebook_page!
-      set_greeting_text!
-      set_whitelist_domains!
-      set_get_started_button!
-      set_persistent_menu!
-    end
+    class Page
+      attr_accessor :slug, :language, :page_id, :page_access_token
 
-    ## == Subcribe your bot to your page ==
-    def subscribe_to_facebook_page!
-      raise Bobot::InvalidParameter.new(:page_id)      unless Bobot.page_id.present?
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      Bobot::Subscription.set(
-        query: {
-          page_id: Bobot.page_id,
-          access_token: Bobot.page_access_token,
-        },
-      )
-    end
+      def initialize(options = {})
+        self.slug = options[:slug]
+        self.language = options[:language]
+        self.page_id = options[:page_id]
+        self.page_access_token = options[:page_access_token]
+      end
 
-    ## == Unsubcribe your bot from your page ==
-    def unsubscribe_to_facebook_page!
-      raise Bobot::InvalidParameter.new(:page_id)      unless Bobot.page_id.present?
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      Bobot::Subscription.unset(
-        query: {
-          page_id: Bobot.page_id,
-          access_token: Bobot.page_access_token,
-        },
-      )
-    end
+      def update_facebook_setup!
+        subscribe_to_facebook_page!
+        set_greeting_text!
+        set_whitelist_domains!
+        set_get_started_button!
+        set_persistent_menu!
+      end
+
+      ## == Subcribe your bot to your page ==
+      def subscribe_to_facebook_page!
+        raise Bobot::InvalidParameter.new(:page_id)      unless page_id.present?
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        Bobot::Subscription.set(
+          query: {
+            page_id: page_id,
+            access_token: page_access_token,
+          },
+        )
+      end
 
-    ## == Set bot description (only displayed on first time). ==
-    def set_greeting_text!
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      greeting_texts = []
-      # Default text
-      greeting_text = I18n.t('bobot.config.greeting_text', locale: I18n.default_locale, default: nil)
-      if greeting_text.present?
-        greeting_texts << {
-          locale: 'default',
-          text: greeting_text,
-        }
+      ## == Unsubcribe your bot from your page ==
+      def unsubscribe_to_facebook_page!
+        raise Bobot::InvalidParameter.new(:page_id)      unless page_id.present?
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        Bobot::Subscription.unset(
+          query: {
+            page_id: page_id,
+            access_token: page_access_token,
+          },
+        )
       end
-      # Each languages
-      I18n.available_locales.each do |locale|
-        greeting_text = I18n.t('bobot.config.greeting_text', locale: locale, default: nil)
-        next unless greeting_text.present?
-        facebook_locales = I18n.t('bobot.config.facebook_locales', locale: locale, default: nil)
-        facebook_locales.to_a.each do |locale_long|
-          greeting_texts << { locale: locale_long, text: greeting_text }
+
+      ## == Set bot description (only displayed on first time). ==
+      def set_greeting_text!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        greeting_texts = []
+        # Default text
+        greeting_text = I18n.t("bobot.#{slug}.config.greeting_text", locale: I18n.default_locale, default: nil)
+        greeting_texts << { locale: 'default', text: greeting_text } if greeting_text.present?
+        # Each languages
+        I18n.available_locales.each do |locale|
+          greeting_text = I18n.t("bobot.#{slug}.config.greeting_text", locale: locale, default: nil)
+          next unless greeting_text.present?
+          facebook_locales = I18n.t("bobot.#{slug}.config.facebook_locales", locale: locale, default: nil)
+          facebook_locales.to_a.each do |locale_long|
+            greeting_texts << { locale: locale_long, text: greeting_text }
+          end
+        end
+        if greeting_texts.present?
+          Bobot::Profile.set(
+            body: { greeting: greeting_texts },
+            query: { access_token: page_access_token },
+          )
+        else
+          unset_greeting_text!
         end
       end
-      if greeting_texts.present?
-        Bobot::Profile.set(
-          body: { greeting: greeting_texts },
-          query: { access_token: Bobot.page_access_token },
-        )
-      else
+
+      def unset_greeting_text!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
         Bobot::Profile.unset(
-          body: { fields: ["greeting"] },
-          query: { access_token: Bobot.page_access_token },
-        )  
+          body: { fields: %w[greeting] },
+          query: { access_token: page_access_token },
+        )
       end
-    end
 
-    ## == Set bot whitelist domains (only displayed on first time) ==
-    ## == Some features like Messenger Extensions and Checkbox Plugin require ==
-    ## == a page to specify a domain whitelist. ==
-    def set_whitelist_domains!
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      raise Bobot::InvalidParameter.new(:domains) unless Bobot.domains.present?
-      if Bobot.domains.present?
-        Bobot::Profile.set(
-          body: { whitelisted_domains: Bobot.domains },
-          query: { access_token: Bobot.page_access_token },
-        )
-      else
+      ## == Set bot whitelist domains (only displayed on first time) ==
+      ## == Some features like Messenger Extensions and Checkbox Plugin require ==
+      ## == a page to specify a domain whitelist. ==
+      def set_whitelist_domains!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        raise Bobot::InvalidParameter.new(:domains) unless domains.present?
+        if domains.present?
+          Bobot::Profile.set(
+            body: { whitelisted_domains: domains },
+            query: { access_token: page_access_token },
+          )
+        else
+          unset_whitelist_domains!
+        end
+      end
+
+      def unset_whitelist_domains!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        raise Bobot::InvalidParameter.new(:domains) unless domains.present?
         Bobot::Profile.unset(
           body: { fields: ["whitelisted_domains"] },
-          query: { access_token: Bobot.page_access_token },
-        )  
+          query: { access_token: page_access_token },
+        )
       end
-    end
 
-    ## == You can define the action to trigger when new humans click on ==
-    ## == the Get Started button. Before doing it you should check to select the ==
-    ## == messaging_postbacks field when setting up your webhook. ==
-    def set_get_started_button!
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      if I18n.exists?('bobot.config.get_started.payload')
-        Bobot::Profile.set(
-          body: { get_started: { payload: I18n.t('bobot.config.get_started.payload') } },
-          query: { access_token: Bobot.page_access_token },
-        )
-      else
+      ## == You can define the action to trigger when new humans click on ==
+      ## == the Get Started button. Before doing it you should check to select the ==
+      ## == messaging_postbacks field when setting up your webhook. ==
+      def set_get_started_button!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        if I18n.exists?("bobot.#{slug}.config.get_started.payload")
+          Bobot::Profile.set(
+            body: { get_started: { payload: I18n.t("bobot.#{slug}.config.get_started.payload") } },
+            query: { access_token: page_access_token },
+          )
+        else
+          unset_get_started_button!
+        end
+      end
+
+      def unset_get_started_button!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
         Bobot::Profile.unset(
-          body: { fields: ["persistent_menu", "get_started"] },
-          query: { access_token: Bobot.page_access_token },
+          body: { fields: %w[persistent_menu get_started] },
+          query: { access_token: page_access_token },
         )
       end
-    end
 
-    ## == You can show a persistent menu to humans. ==
-    ## == If you want to have a persistent menu, you have to set get_started ==
-    ## == button before. ==
-    def set_persistent_menu!
-      raise Bobot::InvalidParameter.new(:access_token) unless Bobot.page_access_token.present?
-      persistent_menus = []
-      # Default text
-      persistent_menu = I18n.t('bobot.config.persistent_menu', locale: I18n.default_locale, default: nil)
-      if persistent_menu.present?
-        persistent_menus << {
-          locale: 'default',
-          composer_input_disabled: persistent_menu[:composer_input_disabled],
-          call_to_actions: persistent_menu[:call_to_actions],
-        }
-      end
-      # Each languages
-      I18n.available_locales.each do |locale|
-        persistent_menu = I18n.t('bobot.config.persistent_menu', locale: locale, default: nil)
-        facebook_locales = I18n.t('bobot.config.facebook_locales', locale: locale, default: nil)
-        next unless persistent_menu.present?
-        facebook_locales.to_a.each do |locale_long|
+      ## == You can show a persistent menu to humans. ==
+      ## == If you want to have a persistent menu, you have to set get_started ==
+      ## == button before. ==
+      def set_persistent_menu!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
+        persistent_menus = []
+        # Default text
+        persistent_menu = I18n.t("bobot.#{slug}.config.persistent_menu", locale: I18n.default_locale, default: nil)
+        if persistent_menu.present?
           persistent_menus << {
-            locale: locale_long,
+            locale: 'default',
             composer_input_disabled: persistent_menu[:composer_input_disabled],
             call_to_actions: persistent_menu[:call_to_actions],
           }
         end
+        # Each languages
+        I18n.available_locales.each do |locale|
+          persistent_menu = I18n.t("bobot.#{slug}.config.persistent_menu", locale: locale, default: nil)
+          facebook_locales = I18n.t("bobot.#{slug}.config.facebook_locales", locale: locale, default: nil)
+          next unless persistent_menu.present?
+          facebook_locales.to_a.each do |locale_long|
+            persistent_menus << {
+              locale: locale_long,
+              composer_input_disabled: persistent_menu[:composer_input_disabled],
+              call_to_actions: persistent_menu[:call_to_actions],
+            }
+          end
+        end
+        if persistent_menus.present?
+          Bobot::Profile.set(
+            body: { persistent_menu: persistent_menus },
+            query: { access_token: page_access_token },
+          )
+        else
+          unset_persistent_menu!
+        end
       end
-      if persistent_menus.present?
-        Bobot::Profile.set(
-          body: { persistent_menu: persistent_menus },
-          query: { access_token: Bobot.page_access_token },
-        )
-      else
+
+      def unset_persistent_menu!
+        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
         Bobot::Profile.unset(
           body: { fields: ["persistent_menu"] },
-          query: { access_token: Bobot.page_access_token },
-        )  
+          query: { access_token: page_access_token },
+        )
       end
     end
   end