facebook-messenger 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e91c65dbe461f44e0516eab4311854cb1e346c67
-  data.tar.gz: 8986a3265e3c79aa89ee77476569d6a9a45aa652
+  metadata.gz: ddbb553d6b155a4f6cbb160cfb404605df0705d6
+  data.tar.gz: 23899394ed7e89b77701b6f634b595e770b735f2
 SHA512:
-  metadata.gz: 03b239d5a2531fe9f11f483898a76b62c64cb24eb5ab3ae65230600c94485ac522e60526d8513be0718bfb85efc123b3e3c0a6bb0f479d7369783fc837822e7e
-  data.tar.gz: 4b22c9a53f9021b8725edb330fe48397b9bd51a571aa9bc85a5982eeef65902b064b171cbd6104848c32ff6d2c875aa823f4b4c51eda754e617d9c7e17e1b510
+  metadata.gz: b8192c8d31b9bd123d836d37a3f67fe6aa823c5aa442db7e0b5221f6dba01817d8c66d9c0a571b2350f182f106f2797d5651cb44c581caf8631bf8c439c61e8c
+  data.tar.gz: 5c3fdd4ddd9e19fdbde71cdb075b149155d8c3c8b9804163d2b2f0a344f91fbfd1e4dc60d2f1d80568a792ea704a2cb09b7076f49754d32f1dd127ea0d297d2f

data/README.md

@@ -125,7 +125,7 @@ end
 Show the human you are preparing a message for them:
 
 ```ruby
-Bot.on :message do |message|  
+Bot.on :message do |message|
   message.typing_on
 
   # Do something expensive
@@ -137,7 +137,7 @@ end
 Or that you changed your mind:
 
 ```ruby
-Bot.on :message do |message|  
+Bot.on :message do |message|
   message.typing_on
 
   if # something
@@ -204,16 +204,22 @@ Bot.on :referral do |referral|
 end
 ```
 
-#### Change thread settings
+#### Change messenger profile
 
-You can greet new humans to entice them into talking to you:
+You can greet new humans to entice them into talking to you, in different locales:
 
 ```ruby
-Facebook::Messenger::Thread.set({
-  setting_type: 'greeting',
-  greeting: {
-    text: 'Welcome to your new bot overlord!'
-  },
+Facebook::Messenger::Profile.set({
+  greeting: [
+    {
+      locale: 'default',
+      text: 'Welcome to your new bot overlord!'
+    },
+    {
+      locale: 'fr_FR',
+      text: 'Bienvenue dans le bot du Wagon !'
+    }
+  ]
 }, access_token: ENV['ACCESS_TOKEN'])
 ```
 
@@ -221,38 +227,54 @@ 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.
 
 ```ruby
-Facebook::Messenger::Thread.set({
-  setting_type: 'call_to_actions',
-  thread_state: 'new_thread',
-  call_to_actions: [
-    {
-      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_WELCOME'
-    }
-  ]
+Facebook::Messenger::Profile.set({
+  get_started: {
+    payload: 'GET_STARTED_PAYLOAD'
+  }
 }, access_token: ENV['ACCESS_TOKEN'])
 ```
 
 You can show a persistent menu to humans.
 
 ```ruby
-Facebook::Messenger::Thread.set({
-  setting_type: 'call_to_actions',
-  thread_state: 'existing_thread',
-  call_to_actions: [
-    {
-      type: 'postback',
-      title: 'Help',
-      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_HELP'
-    },
+Facebook::Messenger::Profile.set({
+  persistent_menu: [
     {
-      type: 'postback',
-      title: 'Start a New Order',
-      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_START_ORDER'
+      locale: 'default',
+      composer_input_disabled: true,
+      call_to_actions: [
+        {
+          title: 'My Account',
+          type: 'nested',
+          call_to_actions: [
+            {
+              title: 'What's a chatbot?',
+              type: 'postback',
+              payload: 'EXTERMINATE'
+            },
+            {
+              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/hyperoslo/facebook-messenger',
+          webview_height_ratio: 'full'
+        }
+      ]
     },
     {
-      type: 'web_url',
-      title: 'View Website',
-      url: 'http://example.com/'
+      locale: 'zh_CN',
+      composer_input_disabled: false
     }
   ]
 }, access_token: ENV['ACCESS_TOKEN'])
@@ -262,17 +284,14 @@ Facebook::Messenger::Thread.set({
 
 ### Create an Application on Facebook
 
-Create an Application on [developers.facebook.com] and go to the Messenger
-tab. Select the Page you want to install your bot on.
-
-Create a new webhook, enter the domain your bot is connected to and a verify
-token of your choosing.
-
-![Application settings](https://scontent-amt2-1.xx.fbcdn.net/hphotos-xfp1/t39.2178-6/12057143_211110782612505_894181129_n.png)
+Follow the [Quick Start][quick-start] guide to create an Application on
+Facebook.
 
 *Note*: Don't subscribe to `message_echoes`; it'll echo your bot's own messages
 back to you, effectively DDOSing yourself.
 
+[quick-start]: https://developers.facebook.com/docs/messenger-platform/guides/quick-start
+
 ### Make a configuration provider
 
 Use the generated access token and your verify token to configure your bot. Most
@@ -418,6 +437,14 @@ commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.or
 Bug reports and pull requests are welcome on GitHub at
 https://github.com/hyperoslo/facebook-messenger.
 
+## Projects using Facebook Messenger
+
+* [Rubotnik](https://github.com/progapandist/rubotnik-boilerplate) is a boilerplate
+for Facebook Messenger, and a great place to start if you're new to bots.
+
+* [Chatwoot](http://chatwoot.com/) use Facebook Messenger to integrate their customer
+support bots with, well, Facebook Messenger.
+
 ## Hyper loves you
 
 [Hyper] made this. We're a bunch of folks who love building things. You should

data/lib/facebook/messenger.rb

@@ -1,7 +1,7 @@
 require 'facebook/messenger/version'
 require 'facebook/messenger/error'
 require 'facebook/messenger/subscriptions'
-require 'facebook/messenger/thread'
+require 'facebook/messenger/profile'
 require 'facebook/messenger/bot'
 require 'facebook/messenger/server'
 require 'facebook/messenger/configuration'

data/lib/facebook/messenger/bot.rb

@@ -9,8 +9,9 @@ module Facebook
 
       base_uri 'https://graph.facebook.com/v2.6/me'
 
-      EVENTS = [:message, :delivery, :postback, :optin,
-                :read, :account_linking, :referral].freeze
+      EVENTS = %i[
+        message delivery postback optin read account_linking referral
+      ].freeze
 
       class << self
         # Deliver a message with the given payload.
@@ -82,6 +83,7 @@ module Facebook
         # Default HTTParty options.
         def default_options
           super.merge(
+            read_timeout: 300,
             headers: {
               'Content-Type' => 'application/json'
             }

data/lib/facebook/messenger/incoming/message.rb

@@ -5,6 +5,8 @@ module Facebook
       class Message
         include Facebook::Messenger::Incoming::Common
 
+        ATTACHMENT_TYPES = %w[image audio video file location fallback].freeze
+
         def id
           @messaging['message']['mid']
         end
@@ -25,11 +27,47 @@ module Facebook
           @messaging['message']['attachments']
         end
 
+        def app_id
+          @messaging['message']['app_id']
+        end
+
+        ATTACHMENT_TYPES.each do |attachment_type|
+          define_method "#{attachment_type}_attachment?" do
+            attachment_type?(attachment_type)
+          end
+        end
+
+        def attachment_type
+          return if attachments.nil?
+
+          attachments.first['type']
+        end
+
+        def attachment_url
+          return if attachments.nil?
+          return unless %w[image audio video file].include? attachment_type
+
+          attachments.first['payload']['url']
+        end
+
+        def location_coordinates
+          return [] unless attachment_type?('location')
+
+          coordinates_data = attachments.first['payload']['coordinates']
+          [coordinates_data['lat'], coordinates_data['long']]
+        end
+
         def quick_reply
           return unless @messaging['message']['quick_reply']
 
           @messaging['message']['quick_reply']['payload']
         end
+
+        private
+
+        def attachment_type?(attachment_type)
+          !attachments.nil? && attachments.first['type'] == attachment_type
+        end
       end
     end
   end

data/lib/facebook/messenger/{thread.rb → profile.rb}

@@ -2,10 +2,10 @@ require 'httparty'
 
 module Facebook
   module Messenger
-    # This module handles changing thread settings.
+    # This module handles changing messenger profile (menu, start & greeting).
     #
-    # https://developers.facebook.com/docs/messenger-platform/thread-settings
-    module Thread
+    # https://developers.facebook.com/docs/messenger-platform/messenger-profile
+    module Profile
       include HTTParty
 
       base_uri 'https://graph.facebook.com/v2.6/me'
@@ -15,7 +15,7 @@ module Facebook
       module_function
 
       def set(settings, access_token:)
-        response = post '/thread_settings', body: settings.to_json, query: {
+        response = post '/messenger_profile', body: settings.to_json, query: {
           access_token: access_token
         }
 
@@ -25,7 +25,7 @@ module Facebook
       end
 
       def unset(settings, access_token:)
-        response = delete '/thread_settings', body: settings.to_json, query: {
+        response = delete '/messenger_profile', body: settings.to_json, query: {
           access_token: access_token
         }
 

data/lib/facebook/messenger/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Messenger
-    VERSION = '0.12.0'.freeze
+    VERSION = '0.13.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Johannes Gorset
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -184,9 +184,9 @@ files:
 - lib/facebook/messenger/incoming/postback.rb
 - lib/facebook/messenger/incoming/read.rb
 - lib/facebook/messenger/incoming/referral.rb
+- lib/facebook/messenger/profile.rb
 - lib/facebook/messenger/server.rb
 - lib/facebook/messenger/subscriptions.rb
-- lib/facebook/messenger/thread.rb
 - lib/facebook/messenger/version.rb
 homepage: https://github.com/hyperoslo/facebook-messenger
 licenses: