bobot 2.6.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2654330704a5e64d8bae289b267366d1a911c75f
-  data.tar.gz: b055bbed851a6dfea750281e87ec3af87d04f9db
+  metadata.gz: 640a621bd564127ef1480e17a4c2359d177503b6
+  data.tar.gz: 66e4fa77192b46535e5329652ea6a7e75d68d1cf
 SHA512:
-  metadata.gz: d130c709d22e2b97a4ea0d226de55134f10bbe9636e2c6c72a43b6880cc81473109b2d8ded675a9ccbd0d793f8c0828e7d3586630edbf96c6e3fb6f14e95093b
-  data.tar.gz: c2cd9e1dd269e41df7fe8021581392382a68e9b260fd952f59ee8c147d697a5e4472d1a1fe8e2a6ef34f0988d1f9eb8b99bd5d7f3ea3d877bad77192a4115119
+  metadata.gz: 0954163b016234b5efd7c5344281a81a2c6c873574db790be3e33a5abb85d51696c9124baa03838681e859294780d0c559d17e0f183b19f928f3bfeb130b0d0a
+  data.tar.gz: 1f7592dadac8b0125648a01c98b7bf3d9789a3e8bbacbb53c450109810ee5f96589662ad2280518ced9611a0b200a14fa79afb7bcbd1dd4bd43d4fbe43d09692

data/README.md

@@ -1,76 +1,152 @@
-<p align="center">
-   <img src="https://raw.githubusercontent.com/navidemad/bobot/master/assets/images/bobot-logo.png"/>
-</p>
-
-# Bobot [Gem under development !][![Build Status](https://travis-ci.org/navidemad/bobot.svg?branch=master)](https://travis-ci.org/navidemad/bobot) [![Gem Version](https://img.shields.io/gem/v/bobot.svg?style=flat)](https://rubygems.org/gems/bobot)
-`Bobot` is a Ruby wrapped framework to build easily a Facebook Messenger Bot.
-
-## Installation
-Add this line to your application's Gemfile:
+<img src="https://raw.githubusercontent.com/navidemad/bobot/master/assets/images/bobot-logo.png" width="300" height="205" />
+ 
+[![Build Status](https://travis-ci.org/navidemad/bobot.svg?branch=master)](https://travis-ci.org/navidemad/bobot) [![Gem Version](https://img.shields.io/gem/v/bobot.svg?style=flat)](https://rubygems.org/gems/bobot)
+ 
+> Bobot is a Ruby wrapped framework to build easily a Facebook Messenger Bot.</b>
 
 ```ruby
 gem 'bobot'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install bobot
+<details>
+  <summary>First steps to setup</summary>
+  <p>
+
+    Run the command to install basic files: rails g bobot:install
+    Then, add `bobot` section into `secrets.yml`:
+
+    development:
+      bobot:
+        app_id: "123"
+        app_secret: "456"
+        verify_token: "your token"
+        domains: "whitelisted-domain.com,second-whitelisted-domain.com"
+        async: false
+        pages: 
+          - slug: "facebook_1"
+            language: "fr"
+            page_id: "789"
+            page_access_token: "abc"
+            get_started_payload: "get_started"
+
+    Now to can edit the workflow of your bot with the file:
+    - app/bobot/workflow.rb
+    
+  </p>
+</details>
+
+<details>
+  <summary>Webhook url</summary>
+  <p>
+
+    Facebook wants an url where he can send me information to communicate with my server.
+    
+    When you installed Bobot, a line has been added to your config/routes.rb
+
+    mount Bobot::Engine => "/XXXXXX", as: "bobot"
+    
+    You have to setup as url on the webhook facebook interface:
+    - https://domain.ltd/XXXXXX/facebook
+    
+    And as :verify_token, the one you set on your config/secrets.yml
+  </p>
+</details>
+
+<details>
+  <summary>Persistent Menu, Greeting Text, Whitelist domains, Get Started</summary>
+  <p>
+
+    After having define into your `config/application.rb` your I18n.available_locales.
+    
+    Then, persistent menu and the greeting text will catch the content of them from `locales/bobot.{locale}.yml`
+    - config/locales/bobot.{locale}.yml
+    
+    The whitelist domains and get_started button settings have to be set in:
+    - config/secrets.yml
+  </p>
+</details>
+  
+<details>
+  <summary>Find a page</summary>
+  <p>
+
+    You can access to page settings:
+    - `page = Bobot::Page.find(facebook_page_id)`
+    - `page = Bobot::Page.find_by_slug(facebook_page_slug)`
+    - `page = Bobot::Page[facebook_page_id]`
+    - `page = Bobot::Page[facebook_page_slug]`
+
+    After fetching the page with command above, you have access to:
+    - `page.update_facebook_setup!`
+
+    Or one by one in a Rails console:
+    - `page.subscribe_to_facebook_page!`
+    - `page.unsubscribe_to_facebook_page!`
+    - `page.unset_greeting_text!`
+    - `page.set_greeting_text!`
+    - `page.unset_whitelist_domains!`
+    - `page.set_whitelist_domains!`
+    - `page.unset_get_started_button!`
+    - `page.set_get_started_button!`
+    - `page.unset_persistent_menu!`
+    - `page.set_persistent_menu!`
+  </p>
+</details>
+
+<details>
+  <summary>Page methods: </summary>
+  <p>
+
+    The parameter :to is the facebook uid of the target.
+    - page.sender_action(sender_action:, to: nil)
+    - page.show_typing(state:, to: nil)
+    - page.mark_as_seen(to: nil)
+    - page.send(payload_message:, to: nil)
+    - page.send_text(text:, to: nil)
+    - page.send_attachment(url:, type:, to: nil)
+    - page.send_image(url:, to: nil)
+    - page.send_audio(url:, to: nil)
+    - page.send_video(url:, to: nil)
+    - page.send_file(url:, to: nil)
+    - page.send_quick_replies(text:, quick_replies:, to: nil)
+    - page.send_buttons(text:, buttons:, to: nil)
+    - page.send_generic(elements:, image_aspect_ratio: 'square', to: nil)
+    - page.send_carousel(elements:, image_aspect_ratio: 'square', to: nil)
+  </p>
+</details>
+
+<details>
+  <summary>Event methods: </summary>
+  <p>
+
+    The event is the parameter that you receive in your block when you are hooking an event on your workflow.rb
+    - event.sender_action(sender_action:)
+    - event.show_typing(state:)
+    - event.mark_as_seen
+    - event.reply(payload_message:)
+    - event.reply_with_text(text:)
+    - event.reply_with_attachment(url:, type:)
+    - event.reply_with_image(url:)
+    - event.reply_with_audio(url:)
+    - event.reply_with_video(url:)
+    - event.reply_with_file(url:)
+    - event.reply_with_quick_replies(text:, quick_replies:)
+    - event.reply_with_buttons(text:, buttons:)
+    - event.reply_with_generic(elements:, image_aspect_ratio: 'square')
+    - event.reply_with_carousel(elements:, image_aspect_ratio: 'square')
+  </p>
+</details>
+
+-----
+
+> You can find more informations on the workflow : [BOBOT_WORKFLOW](BOBOT_WORKFLOW.md)
 
 ## Requirement
-`bobot` has only requirement to have at least `ruby 2.3.1`.
-
-## Setup
-
-Typing the following command in your Rails application will add the bot to your app.
-`rails g bobot:install`
+`ruby >= 2.3.1`
 
-`config/bobot.yml` contains your bot keys
-`app/bobot/workflow.rb` contains the workflow of your bot
-
-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:
-- `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.
-Then, Bobot when you will catch the content of them from `locales/bobot.{locale}.yml`
-
-## Usage
-See example [Workflow](BOBOT_WORKFLOW.md)
 ## Wiki
 The [Messenger Platform - Facebook for Developers](https://developers.facebook.com/docs/messenger-platform) is available and provides full documentation for the API section.
 All informations related to webhook [Messenger Platform - Webhook](https://developers.facebook.com/docs/messenger-platform/webhook-reference).
 
-## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/navidemad/bobot.
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
 ## License
-The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).
-
-## Code of Conduct
-Everyone interacting in the Bobot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/navidemad/bobot/blob/master/CODE_OF_CONDUCT.md).
-
-## Contributing
-Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).

data/app/controllers/bobot/application_controller.rb

@@ -1,5 +1,4 @@
 module Bobot
   class ApplicationController < ActionController::API
-    # protect_from_forgery with: :exception
   end
 end

data/app/controllers/bobot/webhook_controller.rb

@@ -2,12 +2,6 @@ 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
-
     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
@@ -82,19 +76,11 @@ module Bobot
     end
 
     def trigger(events)
-      events['entry'.freeze].to_a.inject([]) do |payloads_sent, entry|
+      events['entry'.freeze].to_a.each do |entry|
         entry['messaging'.freeze].to_a.each do |messaging|
-          begin
-            payloads_sent << Bobot::Commander.receive(messaging)
-          rescue => e
-            payloads_sent << e.to_s
-          end
+          Bobot::Commander.receive(messaging)
         end
       end
     end
-
-    def bobot_layout
-      'bobot/application'
-    end
   end
 end

data/app/jobs/bobot/deliver_job.rb

@@ -2,10 +2,10 @@ module Bobot
   class DeliverJob < ApplicationJob
     queue_as :default
 
-    def perform(sender:, access_token:, payload_template:)
+    def perform(target_facebook_uid:, access_token:, payload_template:)
       Bobot::Commander.deliver(
         body: {
-          recipient: sender,
+          recipient: { id: target_facebook_uid },
         }.merge(payload_template),
         query: {
           access_token: access_token,

data/lib/bobot.rb

@@ -12,6 +12,7 @@ require 'bobot/user'
 require 'bobot/buttons'
 require 'bobot/commander'
 require 'bobot/event'
+require 'bobot/page'
 
 module Bobot
   def self.configure

data/lib/bobot/commander.rb

@@ -33,7 +33,7 @@ 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.config.debug_log
+        Rails.logger.debug "[ActiveJob] << Bobot::HookJob with event #{event.class}"
         # event.mark_as_seen
         job = Bobot::CommanderJob
         if Bobot.config.async
@@ -42,19 +42,19 @@ module Bobot
           job.perform_now(payload: payload)
         end
       rescue KeyError
-        warn "Ignoring #{event.class} (no hook registered)"
+        warn "[receive] 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.config.debug_log
+        Rails.logger.debug "[ActiveJob] >> Bobot::HookJob related to event #{name.class}"
         # event.show_typing(state: true)
         hook.call(event)
         # event.show_typing(state: false)
-        [event, event.payloads_sent[1..-2]]
+        event
       rescue KeyError
-        warn "Ignoring #{event.class} (no hook registered)"
+        warn "[trigger] Ignoring #{event.class} (no hook registered)"
       end
 
       def hooks

data/lib/bobot/configuration.rb

@@ -1,10 +1,11 @@
 module Bobot
   class Configuration
-    attr_accessor :app_id, :app_secret, :verify_token, :debug_log, :async, :pages
+    attr_accessor :app_id, :app_secret, :verify_token, :domains, :async, :pages
 
     def domains=(rhs)
-      return unless rhs.present?
-      if rhs.respond_to?(:to_str)
+      if rhs.nil?
+        @domains = nil
+      elsif rhs.respond_to?(:to_str)
         @domains = rhs.split(",").map(&:strip)
       elsif rhs.is_a?(Array)
         @domains = rhs
@@ -12,193 +13,5 @@ module Bobot
         raise Bobot::InvalidParameter.new(:domains, "should be a string or an array")
       end
     end
-
-    def domains
-      @domains
-    end
-
-    def find_page_by_id(page_id)
-      pages.find { |page| page.page_id.to_s == page_id.to_s }
-    end
-
-    def find_page_by_slug(slug)
-      pages.find { |page| page.slug.to_s == slug.to_s }
-    end
-
-    class Page
-      attr_accessor :slug, :language, :page_id, :page_access_token, :get_started_payload
-
-      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]
-        self.get_started_payload = options[:get_started_payload]
-      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
-
-      ## == 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
-
-      ## == 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 = []
-        if language.nil?
-          # 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
-        else
-          greeting_text = I18n.t("bobot.#{slug}.config.greeting_text", locale: language, default: nil)
-          greeting_texts << { locale: 'default', text: greeting_text } if greeting_text.present?
-        end
-        if greeting_texts.present?
-          Bobot::Profile.set(
-            body: { greeting: greeting_texts },
-            query: { access_token: page_access_token },
-          )
-        end
-      end
-
-      def unset_greeting_text!
-        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
-        Bobot::Profile.unset(
-          body: { fields: %w[greeting] },
-          query: { access_token: page_access_token },
-        )
-      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 page_access_token.present?
-        raise Bobot::InvalidParameter.new(:domains) unless Bobot.config.domains.present?
-        Bobot::Profile.set(
-          body: { whitelisted_domains: Bobot.config.domains },
-          query: { access_token: page_access_token },
-        )
-      end
-
-      def unset_whitelist_domains!
-        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
-        Bobot::Profile.unset(
-          body: { fields: ["whitelisted_domains"] },
-          query: { access_token: page_access_token },
-        )
-      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 page_access_token.present?
-        raise Bobot::InvalidParameter.new(:get_started_payload) unless get_started_payload.present?
-        Bobot::Profile.set(
-          body: { get_started: { payload: get_started_payload } },
-          query: { access_token: page_access_token },
-        )
-      end
-
-      def unset_get_started_button!
-        raise Bobot::InvalidParameter.new(:access_token) unless page_access_token.present?
-        Bobot::Profile.unset(
-          body: { fields: %w[persistent_menu get_started] },
-          query: { access_token: page_access_token },
-        )
-      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 page_access_token.present?
-        persistent_menus = []
-        # Default text
-        if language.nil?
-          persistent_menu = I18n.t("bobot.#{slug}.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.#{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
-        else
-          persistent_menu = I18n.t("bobot.#{slug}.config.persistent_menu", locale: language, 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
-        end
-        if persistent_menus.present?
-          Bobot::Profile.set(
-            body: { persistent_menu: persistent_menus },
-            query: { access_token: page_access_token },
-          )
-        end
-      end
-
-      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: page_access_token },
-        )
-      end
-    end
   end
-end
+end