RubyGems - bobot - Versions diffs - 1.0.53 → 2.1.0 - Mend

bobot 1.0.53 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

checksums.yaml +4 -4
data/README.md +18 -8
data/app/controllers/bobot/webhook_controller.rb +54 -30
data/config/routes.rb +1 -2
data/lib/bobot.rb +15 -1
data/lib/bobot/commander.rb +9 -8
data/lib/bobot/configuration.rb +149 -186
data/lib/bobot/engine.rb +0 -4
data/lib/bobot/events/common.rb +4 -4
data/lib/bobot/events/delivery.rb +0 -1
data/lib/bobot/events/message.rb +4 -0
data/lib/bobot/events/message_echo.rb +3 -2
data/lib/bobot/events/message_request.rb +9 -0
data/lib/bobot/graph_facebook.rb +4 -4
data/lib/bobot/profile.rb +2 -6
data/lib/bobot/version.rb +3 -3
data/lib/generators/bobot/templates/app/bobot/workflow.rb +9 -11
data/lib/generators/bobot/templates/config/bobot.yml +41 -32
data/lib/generators/bobot/templates/config/initializers/bobot.rb +25 -9
data/lib/generators/bobot/templates/config/locales/bobot.en.yml +29 -28
data/lib/generators/bobot/templates/config/locales/bobot.fr.yml +28 -27
data/lib/generators/bobot/utils.rb +0 -9
data/spec/bobot/bobot_spec.rb +18 -12
data/spec/bobot/event/common_spec.rb +3 -1
data/spec/bobot/event/message_spec.rb +7 -0
data/spec/bobot/profile_spec.rb +3 -1
data/spec/bobot/subscription_spec.rb +4 -2
data/spec/bobot/user_spec.rb +4 -2
data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
data/spec/dummy/app/mailers/application_mailer.rb +4 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
data/spec/dummy/bin/setup +0 -8
data/spec/dummy/bin/update +0 -3
data/spec/dummy/config/application.rb +3 -2
data/spec/dummy/config/cable.yml +10 -0
data/spec/dummy/config/environments/development.rb +5 -3
data/spec/dummy/config/environments/production.rb +5 -3
data/spec/dummy/config/environments/test.rb +6 -2
data/spec/dummy/config/initializers/application_controller_renderer.rb +6 -4
data/spec/dummy/config/initializers/wrap_parameters.rb +0 -5
data/spec/dummy/config/routes.rb +1 -1
data/spec/dummy/config/secrets.yml +2 -2
data/spec/dummy/log/development.log +0 -0
data/spec/dummy/log/test.log +2 -0
data/spec/dummy/tmp/generator/app/bobot/workflow.rb +15 -0
data/spec/dummy/tmp/generator/config/bobot.yml +48 -0
data/spec/dummy/tmp/generator/config/initializers/bobot.rb +46 -0
data/spec/dummy/tmp/generator/config/locales/bobot.en.yml +31 -0
data/spec/dummy/tmp/generator/config/locales/bobot.fr.yml +30 -0
data/spec/dummy/tmp/generator/config/routes.rb +0 -0
data/spec/rails_helper.rb +8 -10
metadata +43 -34
data/app/mailers/bobot/application_mailer.rb +0 -6
data/app/models/bobot/application_record.rb +0 -5
data/lib/generators/bobot/templates/app/bobot/message.rb +0 -3
data/lib/generators/bobot/templates/app/bobot/postback.rb +0 -22
data/spec/dummy/app/bobot/workflow.rb +0 -17
data/spec/dummy/app/models/application_record.rb +0 -3
data/spec/dummy/config/bobot.yml +0 -27
data/spec/dummy/config/database.yml +0 -19
data/spec/dummy/config/initializers/bobot.rb +0 -30
data/spec/dummy/config/locales/bobot.en.yml +0 -28
data/spec/dummy/config/locales/bobot.fr.yml +0 -27
data/spec/dummy/db/schema.rb +0 -15

data/spec/bobot/event/common_spec.rb CHANGED

@@ -37,7 +37,9 @@ RSpec.describe Bobot::Dummy do
   let(:access_token) { 'access_token' }
   before do
-    Bobot.page_access_token = access_token
+    Bobot.config.pages << Bobot::Configuration::Page.new(
+      page_access_token: access_token,
+    )
   end
   subject { described_class.new(payload) }

data/spec/bobot/event/message_spec.rb CHANGED

@@ -248,11 +248,18 @@ RSpec.describe Bobot::Event::Message do
       )
     end
   end
   describe '.app_id' do
     it 'returns the app_id from which the message was sent' do
       expect(subject.app_id).to eq(payload['message']['app_id'])
     end
   end
+  describe '.nlp' do
+    it 'returns the nlp from which the message was sent' do
+      expect(subject.nlp).to eq(payload['message']['nlp'])
+    end
+  end
   describe '.quick_reply' do
     context 'when a quick reply was used' do

data/spec/bobot/profile_spec.rb CHANGED

@@ -13,7 +13,9 @@ RSpec.describe Bobot::Profile do
   end
   before do
-    Bobot.page_access_token = access_token
+    Bobot.config.pages << Bobot::Configuration::Page.new(
+      page_access_token: access_token,
+    )
   end
   describe '.set' do

data/spec/bobot/subscription_spec.rb CHANGED

@@ -15,8 +15,10 @@ RSpec.describe Bobot::Subscription do
   end
   before do
-    Bobot.page_access_token = access_token
-    Bobot.page_id = page_id
+    Bobot.config.pages << Bobot::Configuration::Page.new(
+      page_access_token: access_token,
+      page_id:           page_id,
+    )
   end
   describe '.set' do

data/spec/bobot/user_spec.rb CHANGED

@@ -16,8 +16,10 @@ RSpec.describe Bobot::User do
   end
   before do
-    Bobot.page_access_token = access_token
-    Bobot.page_id = page_id
+    Bobot.config.pages << Bobot::Configuration::Page.new(
+      page_access_token: access_token,
+      page_id:           page_id,
+    )
   end
   describe '.get_profile' do

data/spec/dummy/app/channels/application_cable/channel.rb ADDED

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb ADDED

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/mailers/application_mailer.rb ADDED

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/views/layouts/mailer.html.erb ADDED

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= yield %>

data/spec/dummy/bin/setup CHANGED

@@ -19,14 +19,6 @@ chdir APP_ROOT do
   system('bundle check') || system!('bundle install')
-  # puts "\n== Copying sample files =="
-  # unless File.exist?('config/database.yml')
-  #   cp 'config/database.yml.sample', 'config/database.yml'
-  # end
-  puts "\n== Preparing database =="
-  system! 'bin/rails db:setup'
   puts "\n== Removing old logs and tempfiles =="
   system! 'bin/rails log:clear tmp:clear'

data/spec/dummy/bin/update CHANGED

@@ -18,9 +18,6 @@ chdir APP_ROOT do
   system! 'gem install bundler --conservative'
   system('bundle check') || system!('bundle install')
-  puts "\n== Updating database =="
-  system! 'bin/rails db:migrate'
   puts "\n== Removing old logs and tempfiles =="
   system! 'bin/rails log:clear tmp:clear'

data/spec/dummy/config/application.rb CHANGED

@@ -1,10 +1,10 @@
 require_relative 'boot'
 # Pick the frameworks you want:
-require "active_record/railtie"
+# require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-# require "action_mailer/railtie"
+require "action_mailer/railtie"
 require "active_job/railtie"
 # require "action_cable/engine"
 # require "rails/test_unit/railtie"
@@ -28,3 +28,4 @@ module Dummy
     config.api_only = true
   end
 end

data/spec/dummy/config/cable.yml ADDED

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+test:
+  adapter: async
+production:
+  adapter: redis
+  url: redis://localhost:6379/1
+  channel_prefix: dummy_production

data/spec/dummy/config/environments/development.rb CHANGED

@@ -26,12 +26,14 @@ Rails.application.configure do
     config.cache_store = :null_store
   end
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.perform_caching = false
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
-  # Raise an error on page load if there are pending migrations.
-  config.active_record.migration_error = :page_load
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true

data/spec/dummy/config/environments/production.rb CHANGED

@@ -52,6 +52,11 @@ Rails.application.configure do
   # Use a real queuing backend for Active Job (and separate queues per environment)
   # config.active_job.queue_adapter     = :resque
   # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
   # the I18n.default_locale when a translation cannot be found).
@@ -72,7 +77,4 @@ Rails.application.configure do
     logger.formatter = config.log_formatter
     config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end
-  # Do not dump schema after migrations.
-  config.active_record.dump_schema_after_migration = false
 end

data/spec/dummy/config/environments/test.rb CHANGED

@@ -27,12 +27,16 @@ Rails.application.configure do
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
-  config.active_job.queue_adapter = :test
 end

data/spec/dummy/config/initializers/application_controller_renderer.rb CHANGED

@@ -1,6 +1,8 @@
 # Be sure to restart your server when you modify this file.
-# ApplicationController.renderer.defaults.merge!(
-#   http_host: 'example.org',
-#   https: false
-# )
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/spec/dummy/config/initializers/wrap_parameters.rb CHANGED

@@ -7,8 +7,3 @@
 ActiveSupport.on_load(:action_controller) do
   wrap_parameters format: [:json]
 end
-# To enable root element in JSON for ActiveRecord objects.
-# ActiveSupport.on_load(:active_record) do
-#   self.include_root_in_json = true
-# end

data/spec/dummy/config/routes.rb CHANGED

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  mount Bobot::Engine => '/bobot', as: 'bobot'
+  mount Bobot::Engine => "/bobot", as: "bobot"
 end

data/spec/dummy/config/secrets.yml CHANGED

@@ -18,10 +18,10 @@
 # Environmental secrets are only available for that specific environment.
 development:
-  secret_key_base: 4bacd5b4c06821a6d4ede98c4580cb3107a5b0da461805673af89b4bdbffa32ccbf6cf28af193a6084e7a7fa2d20e9a72ced26d1562ef8683382cac3e4de9bd5
+  secret_key_base: f4f2ac74911f4d6de200718f3c152e218936381f52e7ec705d2b644307c7e9e26fd1acc729cb0e67f1fc371aec3b053dd8cba1b02c2cf036c783f5e7b95d6685
 test:
-  secret_key_base: 5b1c674644a5f68b2e25bfee83235783496908ef0344dc80d2f523a3632bede3e9d5cda162f5aaef120f8ad12f7a250e320daf46216eaa261ded978f24ca952e
+  secret_key_base: e6a624b1245f7ece0682019b0d33da8cb7055c7e22ef6358e943fcc0bb502ab9f12d722ca413058c3fed6e71e1057fbc91daaec3c94843691ee20a8302a64654
 # Do not keep production secrets in the unencrypted secrets file.
 # Instead, either read values from the environment.

data/spec/dummy/log/development.log ADDED

File without changes

data/spec/dummy/log/test.log ADDED

	@@ -0,0 +1,2 @@
1	+ [ActiveJob] Enqueued Bobot::CommanderJob (Job ID: 8a80c687-421f-4bd4-8bba-a022b265e12f) to Test(default) with arguments: {"sender"=>{"id"=>"2"}, "recipient"=>{"id"=>"3"}, "timestamp"=>1457764197627, "message"=>{"mid"=>"mid.1457764197618:41d102a3e1ae206a38", "seq"=>73, "text"=>"Hello, bot!"}}
2	+ [ActiveJob] Enqueued Bobot::CommanderJob (Job ID: e295aa69-c9c8-4900-8409-e43a19b6a500) to Test(default) with arguments: {"sender"=>{"id"=>"2"}, "recipient"=>{"id"=>"3"}, "timestamp"=>1457764197627, "message"=>{"mid"=>"mid.1457764197618:41d102a3e1ae206a38", "seq"=>73, "text"=>"Hello, bot!"}}

data/spec/dummy/tmp/generator/app/bobot/workflow.rb ADDED

@@ -0,0 +1,15 @@
+# message received or quick replies
+Bobot::Commander.on :message do |message|
+end
+# get started and click on any buttons
+Bobot::Commander.on :postback do |postback|
+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/spec/dummy/tmp/generator/config/bobot.yml ADDED

@@ -0,0 +1,48 @@
+development:
+  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"
+  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"] %>
+  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"] %>
+  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/spec/dummy/tmp/generator/config/initializers/bobot.rb ADDED

@@ -0,0 +1,46 @@
+bobot_config_path = Rails.root.join("config", "bobot.yml")
+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.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."
+end
+unless Rails.env.production?
+  bot_files = Dir[Rails.root.join("app", "bobot", "**", "*.rb")]
+  bot_reloader = ActiveSupport::FileUpdateChecker.new(bot_files) do
+    bot_files.each { |file| require_dependency file }
+  end
+  ActiveSupport::Reloader.to_prepare do
+    bot_reloader.execute_if_updated
+  end
+  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/spec/dummy/tmp/generator/config/locales/bobot.en.yml ADDED

@@ -0,0 +1,31 @@
+en:
+  bobot:
+    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/spec/dummy/tmp/generator/config/locales/bobot.fr.yml ADDED

@@ -0,0 +1,30 @@
+fr:
+  bobot:
+    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."