bobot 1.0.52

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaf59a5fc23f77c3ac873a376a706b695d816160
+  data.tar.gz: 817d2a4690326c0e9da432c4fb0da059b62dd6ae
+SHA512:
+  metadata.gz: 5c37f10f0452a0b9a591dadd1c3d9e0bb676e16d006c93b67558b9557df623f6e8677b14ca8cb7dd9e6ae8a4adfdab775df45b01bb1501587e9a817efc3794dd
+  data.tar.gz: 196ddbca0e9fbd883553f591510477d7c1b83ebb9788d8673a21da744b059e04e7de2708f8e8199561fcf04de1d97bccb7b88ac343d220141d42271034f3e7b6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Navid EMAD
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+<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:
+
+```ruby
+gem 'bobot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bobot
+
+## 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`
+
+`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!`
+
+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!`
+
+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).

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bobot'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/bobot/application_controller.rb

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

data/app/controllers/bobot/webhook_controller.rb

@@ -0,0 +1,76 @@
+module Bobot
+  class WebhookController < Bobot::ApplicationController
+    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
+      else
+        respond_with status: :forbidden
+      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
+      else
+        respond_with status: :forbidden
+      end
+    end
+
+  private
+
+    def body
+      @body ||= request.body.read
+    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
+    end
+
+    def signature(str, key = nil)
+      key ||= Bobot.app_secret
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), key, str)
+    end
+
+    def check_integrity?
+      request.headers['HTTP_X_HUB_SIGNATURE'].to_s =~ /\Asha1=([0-9a-z]{40})\z/
+      hub_signature = Regexp.last_match(1)
+      hub_signature && Rack::Utils.secure_compare(hub_signature, signature(body))
+    end
+
+    def trigger(events)
+      events['entry'].inject([]) do |payloads_sent, entry|
+        entry['messaging'].each do |messaging|
+          begin
+            payloads_sent << Bobot::Commander.receive(messaging)
+          rescue => e
+            payloads_sent << e.to_s
+          end
+        end
+      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
+  end
+end

data/app/jobs/bobot/application_job.rb

@@ -0,0 +1,4 @@
+module Bobot
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/bobot/commander_job.rb

@@ -0,0 +1,9 @@
+module Bobot
+  class CommanderJob < ApplicationJob
+    queue_as :default
+
+    def perform(payload:)
+      Bobot::Commander.trigger(payload)
+    end
+  end
+end

data/app/jobs/bobot/deliver_job.rb

@@ -0,0 +1,16 @@
+module Bobot
+  class DeliverJob < ApplicationJob
+    queue_as :default
+
+    def perform(sender:, access_token:, payload_template:)
+      Bobot::Commander.deliver(
+        body: {
+          recipient: sender,
+        }.merge(payload_template),
+        query: {
+          access_token: access_token,
+        },
+      )
+    end
+  end
+end

data/app/mailers/bobot/application_mailer.rb

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

data/app/models/bobot/application_record.rb

@@ -0,0 +1,5 @@
+module Bobot
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/config/locales/bobot.en.yml

@@ -0,0 +1,28 @@
+en:
+  bobot:
+    config:
+      facebook_locales:
+        - "en_US"
+        - "en_UD"
+        - "en_GB"
+      greeting_text: "Bobot is an intelligent robot."
+      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/config/routes.rb

@@ -0,0 +1,6 @@
+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
+  end
+end

data/lib/bobot.rb

@@ -0,0 +1,18 @@
+require 'net/https'
+require 'uri'
+
+require 'bobot/engine'
+require 'bobot/exceptions'
+require 'bobot/error_parser'
+require 'bobot/graph_facebook'
+require 'bobot/configuration'
+require 'bobot/subscription'
+require 'bobot/profile'
+require 'bobot/user'
+require 'bobot/buttons'
+require 'bobot/commander'
+require 'bobot/event'
+
+module Bobot
+  extend Configuration
+end

data/lib/bobot/buttons.rb

@@ -0,0 +1,168 @@
+module Bobot
+  module Buttons
+    def self.encode_payload(payload:)
+      unless payload.is_a?(String)
+        begin
+          payload = ActiveSupport::JSON.encode(payload)
+        rescue ::ActiveSupport::JSON.parse_error
+          raise Bobot::FieldFormat.new('payload is not string and not a valid to be JSONified.')
+        end
+      end
+      payload
+    end
+
+    def self.postback(title:, payload:)
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 20.') if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
+      payload = Bobot::Buttons.encode_payload(payload: payload)
+      raise Bobot::FieldFormat.new('payload length is limited to 1000.') if payload.bytesize > 1000
+      {
+        type: 'postback',
+        title: title,
+        payload: payload,
+      }
+    end
+
+    def self.generic_element(title:, subtitle: nil, image_url: nil, default_action_url: nil, buttons: nil)
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 80.') if title.size > 80
+      raise Bobot::FieldFormat.new('subtitle length is limited to 80.') if subtitle.present? && subtitle.size > 80
+      raise Bobot::FieldFormat.new('buttons are limited to 3.') if buttons.present? && buttons.size > 3
+      {
+        title: title,
+      }.tap do |properties|
+        properties[:image_url] = image_url if image_url.present?
+        properties[:subtitle] = subtitle if subtitle.present?
+        properties[:default_action_url] = default_action_url if default_action_url.present?
+        properties[:buttons] = buttons if buttons.present?
+      end
+    end
+    class <<self
+      alias_method :carousel_element, :generic_element
+    end
+
+    def self.quick_reply_location(image_url: nil)
+      {
+        content_type: 'location',
+      }.tap do |properties|
+        properties[:image_url] = image_url if image_url.present?
+      end
+    end
+
+    def self.quick_reply_text(title:, payload:, image_url: nil)
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 20.') if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
+      payload = Bobot::Buttons.encode_payload(payload: payload)
+      raise Bobot::FieldFormat.new('payload length is limited to 1000.') if payload.bytesize > 1000
+      {
+        content_type: 'text',
+        title: title,
+        payload: payload,
+      }.tap do |properties|
+        properties[:image_url] = image_url if image_url.present?
+      end
+    end
+
+    def self.share_basic
+      {
+        type: 'element_share',
+      }
+    end
+
+    def self.share_custom(title:, subtitle:, image_url:, web_url:, button_title:, image_aspect_ratio:)
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 80.') if title.size > 80
+      raise Bobot::FieldFormat.new('subtitle is required.') unless subtitle.present?
+      raise Bobot::FieldFormat.new('subtitle length is limited to 80.') if subtitle.size > 80
+      raise Bobot::FieldFormat.new('button_title is required.') unless button_title.present?
+      raise Bobot::FieldFormat.new('button_title length is limited to 20.') if button_title.size > 20
+      {
+        type: 'element_share',
+        share_contents: {
+          attachment: {
+            type: 'template',
+            payload: {
+              template_type: 'generic',
+              image_aspect_ratio: image_aspect_ratio,
+              elements: [
+                {
+                  title: title,
+                  subtitle: subtitle,
+                  image_url: image_url,
+                  default_action: {
+                    type: 'web_url',
+                    url: web_url,
+                  },
+                  buttons: [
+                    {
+                      type: 'web_url',
+                      url: web_url,
+                      title: button_title,
+                    },
+                  ],
+                },
+              ],
+            },
+          },
+        },
+      }
+    end
+
+    def self.default_action_url(url:, options: {})
+      raise Bobot::FieldFormat.new('url is required.') unless url.present?
+      if options.key?(:messenger_extensions) && options[:messenger_extensions] && !url.include?('https')
+        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.')
+      end
+      if options.key?(:webview_height_ratio) && !%w[compact tall full].include?(options[:webview_height_ratio])
+        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.')
+      end
+      {
+        type: 'web_url',
+        url: url,
+      }.tap do |properties|
+        properties[:webview_height_ratio] = options[:webview_height_ratio] if options.key?(:webview_height_ratio)
+        properties[:messenger_extensions] = options[:messenger_extensions] if options.key?(:messenger_extensions)
+        properties[:fallback_url] = options[:fallback_url] if options.key?(:fallback_url)
+        properties[:webview_share_button] = options[:webview_share_button] if options.key?(:webview_share_button)
+      end
+    end
+
+    def self.url(title:, url:, options: {})
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 20.') if title.size > 20
+      raise Bobot::FieldFormat.new('url is required.') unless url.present?
+      if options.key?(:messenger_extensions) && options[:messenger_extensions] && !url.include?('https')
+        raise Bobot::FieldFormat.new('must use url HTTPS protocol if messenger_extensions is true.')
+      end
+      if options.key?(:webview_height_ratio) && !%w[compact tall full].include?(options[:webview_height_ratio])
+        raise Bobot::FieldFormat.new('invalid webview_height_ratio, only "compact, tall, full" are permitted.')
+      end
+      {
+        type: 'web_url',
+        url: url,
+        title: title,
+      }.tap do |properties|
+        properties[:webview_height_ratio] = options[:webview_height_ratio] if options.key?(:webview_height_ratio)
+        properties[:messenger_extensions] = options[:messenger_extensions] if options.key?(:messenger_extensions)
+        properties[:fallback_url] = options[:fallback_url] if options.key?(:fallback_url)
+        properties[:webview_share_button] = options[:webview_share_button] if options.key?(:webview_share_button)
+      end
+    end
+
+    REGEX_PHONE_NUMBER = /\A(?:\+)(?:\d{1,3}\s*-?)?\(?(?:\d{3})?\)?[- ]?\d{3}[- ]?\d{4}\z/
+    def self.call(title:, payload:)
+      raise Bobot::FieldFormat.new('title is required.') unless title.present?
+      raise Bobot::FieldFormat.new('title length is limited to 20.') if title.size > 20
+      raise Bobot::FieldFormat.new('payload is required.') unless payload.present?
+      raise Bobot::FieldFormat.new('payload has to be only a string') unless payload.is_a?(String)
+      raise Bobot::FieldFormat.new('payload has to start with a "+" and be a valid phone number') unless REGEX_PHONE_NUMBER =~ payload
+      {
+        type: 'phone_number',
+        title: title,
+        payload: payload,
+      }
+    end
+  end
+end