bobot 1.0.52

data/lib/bobot/graph_facebook.rb

@@ -0,0 +1,90 @@
+module Bobot
+  module GraphFacebook
+    GRAPH_FB_URL = 'https://graph.facebook.com'.freeze
+    GRAPH_FB_VERSION = 'v2.10'.freeze
+
+    module ClassMethods
+      def graph_get(path, query: {})
+        uri = URI.parse(File.join(GRAPH_FB_URL, GRAPH_FB_VERSION, path))
+        uri.query = URI.encode_www_form(query)
+        req = Net::HTTP::Get.new(uri.request_uri)
+        req['Content-Type'] = 'application/json; charset=utf-8'
+        req['Accept'] = 'application/json'
+        req['User-Agent'] = nil
+        req['Accept-Encoding'] = nil
+        https = Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.read_timeout = 300
+        end
+        res = https.request(req)
+        json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
+        if Bobot.debug_log
+          puts "[GET] >> #{uri.request_uri}"
+          puts "[GET] << #{json}"
+        end
+        Bobot::ErrorParser.raise_errors_from(json)
+        json
+      end
+      module_function :graph_get
+
+      def graph_post(path, query: {}, body: {})
+        uri = URI.parse(File.join(GRAPH_FB_URL, GRAPH_FB_VERSION, path))
+        uri.query = URI.encode_www_form(query)
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req['Content-Type'] = 'application/json; charset=utf-8'
+        req['Accept'] = 'application/json'
+        req['User-Agent'] = nil
+        req['Accept-Encoding'] = nil
+        req.body = ActiveSupport::JSON.encode(body)
+        https = Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.read_timeout = 300
+        end
+        res = https.request(req)
+        json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
+        if Bobot.debug_log
+          puts "[POST] >> #{uri.request_uri}"
+          puts "[POST] << #{json}"
+        end
+        Bobot::ErrorParser.raise_errors_from(json)
+        json
+      end
+      module_function :graph_post
+
+      def graph_delete(path, query: {}, body: {})
+        uri = URI.parse(File.join(GRAPH_FB_URL, GRAPH_FB_VERSION, path))
+        uri.query = URI.encode_www_form(query)
+        req = Net::HTTP::Delete.new(uri.request_uri)
+        req['Content-Type'] = 'application/json; charset=utf-8'
+        req['Accept'] = 'application/json'
+        req['User-Agent'] = nil
+        req['Accept-Encoding'] = nil
+        req.body = ActiveSupport::JSON.encode(body)
+        https = Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.read_timeout = 300
+        end
+        res = https.request(req)
+        json = ActiveSupport::JSON.decode(res.send(:body) || '{}')
+        if Bobot.debug_log
+          puts "[DELETE] >> #{uri.request_uri}"
+          puts "[DELETE] << #{json}"
+        end
+        Bobot::ErrorParser.raise_errors_from(json)
+        json
+      end
+      module_function :graph_delete
+    end
+
+    module InstanceMethods
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/bobot/profile.rb

@@ -0,0 +1,23 @@
+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")
+      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")
+      graph_delete '/me/messenger_profile', body: body, query: {
+        access_token: query.fetch(:access_token),
+      }
+    end
+    module_function :unset
+  end
+end

data/lib/bobot/subscription.rb

@@ -0,0 +1,19 @@
+module Bobot
+  module Subscription
+    include Bobot::GraphFacebook
+
+    def set(query: {})
+      graph_post "/#{query.fetch(:page_id)}/subscribed_apps", query: {
+        access_token: query.fetch(:access_token),
+      }
+    end
+    module_function :set
+
+    def unset(query: {})
+      graph_delete "/#{query.fetch(:page_id)}/subscribed_apps", query: {
+        access_token: query.fetch(:access_token),
+      }
+    end
+    module_function :unset
+  end
+end

data/lib/bobot/user.rb

@@ -0,0 +1,13 @@
+module Bobot
+  module User
+    include Bobot::GraphFacebook
+
+    def get_profile(query:)
+      graph_get "/#{query.fetch(:fb_id)}", query: {
+        fields: query.fetch(:fields).join(','),
+        access_token: query.fetch(:access_token),
+      }
+    end
+    module_function :get_profile
+  end
+end

data/lib/bobot/version.rb

@@ -0,0 +1,14 @@
+module Bobot
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 52
+    PRE = nil
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+end

data/lib/generators/bobot/install_generator.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+require 'rails/generators'
+require File.expand_path('../utils', __FILE__)
+
+module Bobot
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    include Generators::Utils::InstanceMethods
+    extend Generators::Utils::ClassMethods
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :_namespace, type: :string, required: false, desc: 'Bot url namespace'
+    desc 'Bobot install'
+
+    def install
+      namespace = ask_for('Where do you want to mount bobot?', 'bot', _namespace)
+      create_file 'config/routes.rb'
+      gsub_file 'config/routes.rb', %r{mount Bobot::Engine => \'\/.+\'(, as: \'bot\')?}, ''
+      route("mount Bobot::Engine => '/#{namespace}', as: 'bot'")
+      template 'config/initializers/bobot.rb', 'config/initializers/bobot.rb'
+      template 'app/bobot/workflow.rb', 'app/bobot/workflow.rb'
+      copy_file 'config/bobot.yml', 'config/bobot.yml'
+      copy_file 'config/locales/bobot.en.yml', 'config/locales/bobot.en.yml'
+      copy_file 'config/locales/bobot.fr.yml', 'config/locales/bobot.fr.yml'
+      display 'Installation done', :green
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+class Message
+  def perform(message); end
+end

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

@@ -0,0 +1,22 @@
+module Bobot
+  class Postback
+    def self.perform(event)
+      payload = event.payload
+      begin
+        payload = ActiveSupport::JSON.decode(payload)
+        step    = payload["step"]
+        params  = payload["params"].hash
+      rescue ::ActiveSupport::JSON.parse_error
+        step    = payload.to_sym
+        params  = nil
+      end
+
+      bot = Postback.new(event)
+      if bot.respond_to?(step)
+        bot.public_send(*([step, params].compact))
+      else
+        bot.unknown_payload
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+Bobot::Commander.on :message do |message|
+  klass = message.quick_reply.present? ? Bobot::Postback : Bobot::Message
+  klass.perform(message)
+end
+
+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

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

@@ -0,0 +1,39 @@
+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
+
+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
+
+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"] %>
+
+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"] %>

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

@@ -0,0 +1,30 @@
+bobot_config_path = Rails.root.join("config", "bobot.yml")
+bobot_config = YAML.safe_load(ERB.new(File.read(bobot_config_path)).result)[Rails.env]
+
+if bobot_config.present?
+  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"]
+  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

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

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

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

@@ -0,0 +1,29 @@
+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."

data/lib/generators/bobot/uninstall_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require File.expand_path('../utils', __FILE__)
+
+module Bobot
+  class UninstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    include Generators::Utils::InstanceMethods
+    extend Generators::Utils::ClassMethods
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Bobot uninstall'
+
+    def uninstall
+      display 'Why you leaving so soon? :('
+      gsub_file 'config/routes.rb', %r{mount Bobot::Engine => \'\/.+\'(, as: \'bot\')?}, ''
+      remove_file 'config/initializers/bobot.rb'
+      remove_file 'app/bobot/workflow.rb'
+      remove_file 'config/bobot.yml'
+      remove_file 'config/locales/bobot.en.yml'
+      remove_file 'config/locales/bobot.fr.yml'
+      display 'Done! Bobot has been uninstalled.'
+    end
+  end
+end

data/lib/generators/bobot/utils.rb

@@ -0,0 +1,30 @@
+module Bobot
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          if override_if_present_value.present?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value
+          else
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+          end
+        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
+end

data/lib/tasks/bobot_tasks.rake

@@ -0,0 +1,11 @@
+namespace :bobot do
+  desc 'Install bobot'
+  task :install do
+    system 'rails g bobot:install'
+  end
+
+  desc 'Uninstall bobot'
+  task :uninstall do
+    system 'rails g bobot:uninstall'
+  end
+end