bobot 1.0.53 → 2.1.0

data/lib/bobot/engine.rb

@@ -8,10 +8,6 @@ module Bobot
 
     config.action_dispatch.rescue_responses['Bobot::ActionNotAllowed'] = :forbidden
 
-    initializer 'bobot.load_app_root' do |app|
-      Bobot.app_root = app.root
-    end
-
     initializer 'Bobot setup middlewares' do |app|
       app.config.middleware.use ActionDispatch::Flash
     end

data/lib/bobot/events/common.rb

@@ -26,11 +26,11 @@ module Bobot
 
       def delay(wait: 0, wait_until: nil)
         raise Bobot::FieldFormat.new('wait has to be positive integer.') unless wait.present?
-        if Bobot.async
+        if Bobot.config.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'"
+          warn "delay is ignored since you configured Bobot.config.async to 'false'"
         end
         self
       end
@@ -43,7 +43,7 @@ module Bobot
         raise Bobot::FieldFormat.new('payload_template is required.') unless payload_template.present?
         @payloads_sent << payload_template
         job = Bobot::DeliverJob
-        if Bobot.async
+        if Bobot.config.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)
@@ -163,7 +163,7 @@ module Bobot
       alias_method :reply_with_carousel, :reply_with_generic
 
       def access_token
-        Bobot.page_access_token
+        Bobot.config.find_page_by_id(recipient["id"]).try(:page_access_token)
       end
     end
   end

data/lib/bobot/events/delivery.rb

@@ -1,6 +1,5 @@
 module Bobot
   module Event
-    # The Delivery class represents the receipt of a delivered message.
     class Delivery
       include Bobot::Event::Common
 

data/lib/bobot/events/message.rb

@@ -25,6 +25,10 @@ module Bobot
         @messaging['message']['attachments']
       end
 
+      def nlp
+        @messaging['message']['nlp']
+      end
+
       def app_id
         @messaging['message']['app_id']
       end

data/lib/bobot/events/message_echo.rb

@@ -1,8 +1,9 @@
 module Bobot
   module Event
-    # The Message echo class represents an
-    # incoming Facebook Messenger message
     class MessageEcho < Message
+      def access_token
+        Bobot.config.find_page_by_id(sender["id"]).try(:page_access_token)
+      end
     end
   end
 end

data/lib/bobot/events/message_request.rb

@@ -0,0 +1,9 @@
+module Bobot
+  module Event
+    class MessageRequest < Message
+      def accept?
+        @messaging['message_request'] == 'accept'
+      end
+    end
+  end
+end

data/lib/bobot/graph_facebook.rb

@@ -1,7 +1,7 @@
 module Bobot
   module GraphFacebook
     GRAPH_FB_URL = 'https://graph.facebook.com'.freeze
-    GRAPH_FB_VERSION = 'v2.10'.freeze
+    GRAPH_FB_VERSION = 'v2.11'.freeze
 
     module ClassMethods
       def graph_get(path, query: {})
@@ -19,7 +19,7 @@ module Bobot
         end
         res = https.request(req)
         json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
-        if Bobot.debug_log
+        if Bobot.config.debug_log
           puts "[GET] >> #{uri.request_uri}"
           puts "[GET] << #{json}"
         end
@@ -44,7 +44,7 @@ module Bobot
         end
         res = https.request(req)
         json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
-        if Bobot.debug_log
+        if Bobot.config.debug_log
           puts "[POST] >> #{uri.request_uri}"
           puts "[POST] << #{json}"
         end
@@ -69,7 +69,7 @@ module Bobot
         end
         res = https.request(req)
         json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
-        if Bobot.debug_log
+        if Bobot.config.debug_log
           puts "[DELETE] >> #{uri.request_uri}"
           puts "[DELETE] << #{json}"
         end

data/lib/bobot/profile.rb

@@ -2,18 +2,14 @@ module Bobot
   module Profile
     include Bobot::GraphFacebook
 
-    def set(body:, query: nil)
-      query ||= { access_token: Bobot.page_access_token }
-      query[:access_token] = Bobot.page_access_token unless query.key?("access_token")
+    def set(body:, query:)
       graph_post '/me/messenger_profile', body: body, query: {
         access_token: query.fetch(:access_token),
       }
     end
     module_function :set
 
-    def unset(body:, query: nil)
-      query ||= { access_token: Bobot.page_access_token }
-      query[:access_token] = Bobot.page_access_token unless query.key?("access_token")
+    def unset(body:, query:)
       graph_delete '/me/messenger_profile', body: body, query: {
         access_token: query.fetch(:access_token),
       }

data/lib/bobot/version.rb

@@ -1,8 +1,8 @@
 module Bobot
   class Version
-    MAJOR = 1
-    MINOR = 0
-    PATCH = 53
+    MAJOR = 2
+    MINOR = 1
+    PATCH = 0
     PRE = nil
 
     class << self

data/lib/generators/bobot/templates/app/bobot/workflow.rb

@@ -1,17 +1,15 @@
+# message received or quick replies
 Bobot::Commander.on :message do |message|
-  klass = message.quick_reply.present? ? Bobot::Postback : Bobot::Message
-  klass.perform(message)
 end
 
+# get started and click on any buttons
 Bobot::Commander.on :postback do |postback|
-  klass = Bobot::Postback
-  klass.perform(postback)
 end
 
-# Bobot::Commander.on :optin do |optin|
-#   optin.reply_with_text(text: 'Ah, human! Clicked on Send To Messenger')
-# end
-#
-# Bobot::Commander.on :referral do |referral|
-#   optin.reply_with_text(text: "Great you came from #{referal.ref}")
-# end
+# referral by m.me/XXX?ref=
+Bobot::Commander.on :referral do |referral|
+end
+
+# referral by param ref into send to messenger plugin
+Bobot::Commander.on :optin do |optin|
+end

data/lib/generators/bobot/templates/config/bobot.yml

@@ -1,39 +1,48 @@
 development:
-  app_id:             "123"
-  app_secret:         "456"
-  page_id:            "789"
-  page_access_token:  "abc"
-  verify_token:       "your token"
-  domains:            "whitelisted-domain.com,second-whitelisted-domain.com"
-  debug_log:          true
-  async:              false
+  app_id: "123"
+  app_secret: "456"
+  verify_token: "your token"
+  domains: "whitelisted-domain.com,second-whitelisted-domain.com"
+  debug_log: true
+  async: false
+  pages: 
+    - slug: "facebook_1"
+      language: "fr"
+      page_id: "789"
+      page_access_token: "abc"
 
 test:
-  app_id:             "123"
-  app_secret:         "456"
-  page_id:            "789"
-  page_access_token:  "abc"
-  verify_token:       "your token"
-  domains:            "whitelisted-domain.com,second-whitelisted-domain.com"
-  debug_log:          true
-  async:              false
+  app_id: "123"
+  app_secret: "456"
+  verify_token: "your token"
+  domains: "whitelisted-domain.com,second-whitelisted-domain.com"
+  debug_log: true
+  async: false
+  pages: 
+    - slug: "facebook_1"
+      page_id: "789"
+      page_access_token: "abc"
 
 staging:
-  app_id:             <%= ENV["STAGING_BOBOT_APP_ID"] %>
-  app_secret:         <%= ENV["STAGING_BOBOT_APP_SECRET"] %>
-  page_id:            <%= ENV["STAGING_BOBOT_PAGE_ID"] %>
-  page_access_token:  <%= ENV["STAGING_BOBOT_PAGE_ACCESS_TOKEN"] %>
-  verify_token:       <%= ENV["STAGING_BOBOT_VERIFY_TOKEN"] %>
-  domains:            <%= ENV["STAGING_BOBOT_DOMAINS"] %>
-  debug_log:          <%= ENV["STAGING_BOBOT_DEBUG_LOG"] %>
-  async:              <%= ENV["STAGING_BOBOT_ASYNC"] %>
+  app_id: <%= ENV["STAGING_BOBOT_APP_ID"] %>
+  app_secret: <%= ENV["STAGING_BOBOT_APP_SECRET"] %>
+  verify_token: <%= ENV["STAGING_BOBOT_VERIFY_TOKEN"] %>
+  domains: <%= ENV["STAGING_BOBOT_DOMAINS"] %>
+  debug_log: <%= ENV["STAGING_BOBOT_DEBUG_LOG"] %>
+  async: <%= ENV["STAGING_BOBOT_ASYNC"] %>
+  pages: 
+    - slug: <%= ENV["STAGING_BOBOT_PAGE_SLUG"] %>
+      page_id: <%= ENV["STAGING_BOBOT_PAGE_ID"] %>
+      page_access_token: <%= ENV["STAGING_BOBOT_PAGE_ACCESS_TOKEN"] %>
 
 production:
-  app_id:             <%= ENV["PRODUCTION_BOBOT_APP_ID"] %>
-  app_secret:         <%= ENV["PRODUCTION_BOBOT_APP_SECRET"] %>
-  page_id:            <%= ENV["PRODUCTION_BOBOT_PAGE_ID"] %>
-  page_access_token:  <%= ENV["PRODUCTION_BOBOT_PAGE_ACCESS_TOKEN"] %>
-  verify_token:       <%= ENV["PRODUCTION_BOBOT_VERIFY_TOKEN"] %>
-  domains:            <%= ENV["PRODUCTION_BOBOT_DOMAINS"] %>
-  debug_log:          <%= ENV["PRODUCTION_BOBOT_DEBUG_LOG"] %>
-  async:              <%= ENV["PRODUCTION_BOBOT_ASYNC"] %>
+  app_id: <%= ENV["PRODUCTION_BOBOT_APP_ID"] %>
+  app_secret: <%= ENV["PRODUCTION_BOBOT_APP_SECRET"] %>
+  verify_token: <%= ENV["PRODUCTION_BOBOT_VERIFY_TOKEN"] %>
+  domains: <%= ENV["PRODUCTION_BOBOT_DOMAINS"] %>
+  debug_log: <%= ENV["PRODUCTION_BOBOT_DEBUG_LOG"] %>
+  async: <%= ENV["PRODUCTION_BOBOT_ASYNC"] %>
+  pages: 
+    - slug: <%= ENV["PRODUCTION_BOBOT_PAGE_SLUG"] %>
+      page_id: <%= ENV["PRODUCTION_BOBOT_PAGE_ID"] %>
+      page_access_token: <%= ENV["PRODUCTION_BOBOT_PAGE_ACCESS_TOKEN"] %>

data/lib/generators/bobot/templates/config/initializers/bobot.rb

@@ -1,16 +1,25 @@
 bobot_config_path = Rails.root.join("config", "bobot.yml")
-bobot_config = YAML.safe_load(ERB.new(File.read(bobot_config_path)).result)[Rails.env]
+bobot_config = YAML.safe_load(ERB.new(File.read(bobot_config_path)).result, [], [], true)[Rails.env]
 
 if bobot_config.present?
+  unless bobot_config.key?("pages")
+    raise "Bobot: #{bobot_config_path} required an array key :pages (cf. https://github.com/navidemad/bobot)"
+  end
   Bobot.configure do |config|
-    config.app_id            = bobot_config["app_id"]
-    config.app_secret        = bobot_config["app_secret"]
-    config.page_access_token = bobot_config["page_access_token"]
-    config.page_id           = bobot_config["page_id"]
-    config.verify_token      = bobot_config["verify_token"]
-    config.domains           = bobot_config["domains"]
-    config.debug_log         = bobot_config["debug_log"]
-    config.async             = bobot_config["async"]
+    config.app_id        = bobot_config["app_id"],
+    config.app_secret    = bobot_config["app_secret"],
+    config.verify_token  = bobot_config["verify_token"],
+    config.domains       = bobot_config["domains"],
+    config.debug_log     = bobot_config["debug_log"],
+    config.async         = bobot_config["async"],
+    bobot_config["pages"].each do |page|
+      config.pages << Bobot::Configuration::Page.new(
+        name:              page["name"],
+        language:          page["language"],
+        page_access_token: page["page_access_token"],
+        page_id:           page["page_id"],
+      )
+    end
   end
 else
   warn "#{bobot_config_path} not configured yet in #{Rails.env} environment."
@@ -28,3 +37,10 @@ unless Rails.env.production?
 
   bot_files.each { |file| require_dependency file }
 end
+
+if defined?(Rails::Server)
+  Rails.application.config.after_initialize do
+    Rails.application.config.paths.add File.join("app", "bobot"), glob: File.join("**", "*.rb")
+    Rails.application.config.autoload_paths += Dir[Rails.root.join("app", "bobot", "*")]
+  end
+end

data/lib/generators/bobot/templates/config/locales/bobot.en.yml

@@ -1,30 +1,31 @@
 en:
   bobot:
-    config:
-      facebook_locales:
-        - "en_US"
-        - "en_UD"
-        - "en_GB"
-      greeting_text: "Bobot is an intelligent robot."
-      get_started:
-        payload: 'get_started'
-      persistent_menu:
-        composer_input_disabled: false
-        call_to_actions:
-          - title: "My Account"
-            type: "nested"
-            call_to_actions:
-              - title: "What is a chatbot?"
-                type: "postback"
-                payload: "WHAT_IS_A_CHATBOT"
-              - title: "History"
-                type: "postback"
-                payload: "HISTORY_PAYLOAD"
-              - title: "Contact Info"
-                type: "postback"
-                payload: "CONTACT_INFO_PAYLOAD"
-          - type: "web_url"
-            title: "Get some help"
-            url: "https://github.com/navidemad/bobot"
-            webview_height_ratio: "full"
-    what_is_a_chatbot: "A chatbot is a computer program which conducts a conversation via auditory or textual methods."
+    facebook_1:
+      config:
+        facebook_locales:
+          - "en_US"
+          - "en_UD"
+          - "en_GB"
+        greeting_text: "Bobot is an intelligent robot."
+        get_started:
+          payload: 'get_started'
+        persistent_menu:
+          composer_input_disabled: false
+          call_to_actions:
+            - title: "My Account"
+              type: "nested"
+              call_to_actions:
+                - title: "What is a chatbot?"
+                  type: "postback"
+                  payload: "WHAT_IS_A_CHATBOT"
+                - title: "History"
+                  type: "postback"
+                  payload: "HISTORY_PAYLOAD"
+                - title: "Contact Info"
+                  type: "postback"
+                  payload: "CONTACT_INFO_PAYLOAD"
+            - type: "web_url"
+              title: "Get some help"
+              url: "https://github.com/navidemad/bobot"
+              webview_height_ratio: "full"
+      what_is_a_chatbot: "A chatbot is a computer program which conducts a conversation via auditory or textual methods."

data/lib/generators/bobot/templates/config/locales/bobot.fr.yml

@@ -1,29 +1,30 @@
 fr:
   bobot:
-    config:
-      facebook_locales:
-        - "fr_FR"
-        - "fr_CA"
-      greeting_text: 'Bobot est un robot intelligent.'
-      get_started:
-        payload: 'get_started'
-      persistent_menu:
-        composer_input_disabled: false
-        call_to_actions:
-          - title: "Mon compte"
-            type: "nested"
-            call_to_actions:
-              - title: "C'est quoi un chatbot ?"
-                type: "postback"
-                payload: "WHAT_IS_A_CHATBOT"
-              - title: "Historique"
-                type: "postback"
-                payload: "HISTORY_PAYLOAD"
-              - title: "Contact Info"
-                type: "postback"
-                payload: "CONTACT_INFO_PAYLOAD"
-          - type: "web_url"
-            title: "Obtenir de l'aide"
-            url: "https://github.com/navidemad/bobot"
-            webview_height_ratio: "full"
-    what_is_a_chatbot: "Un chatbot est un programme qui tente de converser avec une personne durant quelques minutes ou plus en lui donnant l'impression de converser elle-même avec une personne."
+    facebook_1:
+      config:
+        facebook_locales:
+          - "fr_FR"
+          - "fr_CA"
+        greeting_text: 'Bobot est un robot intelligent.'
+        get_started:
+          payload: 'get_started'
+        persistent_menu:
+          composer_input_disabled: false
+          call_to_actions:
+            - title: "Mon compte"
+              type: "nested"
+              call_to_actions:
+                - title: "C'est quoi un chatbot ?"
+                  type: "postback"
+                  payload: "WHAT_IS_A_CHATBOT"
+                - title: "Historique"
+                  type: "postback"
+                  payload: "HISTORY_PAYLOAD"
+                - title: "Contact Info"
+                  type: "postback"
+                  payload: "CONTACT_INFO_PAYLOAD"
+            - type: "web_url"
+              title: "Obtenir de l'aide"
+              url: "https://github.com/navidemad/bobot"
+              webview_height_ratio: "full"
+      what_is_a_chatbot: "Un chatbot est un programme qui tente de converser avec une personne durant quelques minutes ou plus en lui donnant l'impression de converser elle-même avec une personne."

data/lib/generators/bobot/utils.rb

@@ -15,15 +15,6 @@ module Bobot
         end
       end
       module ClassMethods
-        def next_migration_number(dirname)
-          if ActiveRecord::Base.timestamped_migrations
-            migration_number = Time.current.strftime("%Y%m%d%H%M%S").to_i
-            migration_number += 1
-            migration_number.to_s
-          else
-            format("%.3d", current_migration_number(dirname) + 1)
-          end
-        end
       end
     end
   end

data/spec/bobot/bobot_spec.rb

@@ -4,21 +4,27 @@ RSpec.describe Bobot do
   describe '#configure' do
     it 'sets correct configuration' do
       Bobot.configure do |config|
-        config.app_id = '1'
-        config.app_secret = '2'
-        config.page_access_token = '3'
-        config.verify_token = '4'
-        config.page_id = '5'
+        config.app_id = 'app_id'
+        config.app_secret = 'app_secret'
+        config.verify_token = 'verify_token'
         config.debug_log = true
         config.async = true
+        config.pages << Bobot::Configuration::Page.new(
+          slug: 'slug',
+          language: 'language',
+          page_access_token: 'page_access_token',
+          page_id: 'page_id',
+        )
       end
-      expect(Bobot.app_id).to eql('1')
-      expect(Bobot.app_secret).to eql('2')
-      expect(Bobot.page_access_token).to eql('3')
-      expect(Bobot.verify_token).to eql('4')
-      expect(Bobot.page_id).to eql('5')
-      expect(Bobot.debug_log).to eql(true)
-      expect(Bobot.async).to eql(true)
+      expect(Bobot.config.app_id).to eql('app_id')
+      expect(Bobot.config.app_secret).to eql('app_secret')
+      expect(Bobot.config.verify_token).to eql('verify_token')
+      expect(Bobot.config.debug_log).to eql(true)
+      expect(Bobot.config.async).to eql(true)
+      expect(Bobot.config.pages[0].slug).to eql('slug')
+      expect(Bobot.config.pages[0].language).to eql('language')
+      expect(Bobot.config.pages[0].page_access_token).to eql('page_access_token')
+      expect(Bobot.config.pages[0].page_id).to eql('page_id')
     end
   end
 end