facebook-messenger 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a97b014f458381225a5cf3b76148fdf1b240348a
-  data.tar.gz: 6a3d1c139c2aa42f3891864b1080b8af1f782ecc
+  metadata.gz: 74caac0b724839aa50f8bed0364c1af2d648644f
+  data.tar.gz: 72d8baa4473043a681a43f888aab08632dc325a2
 SHA512:
-  metadata.gz: bb9b1c17ab1057e49489153deb9fa94384abcbe550114101f1b2f16cdd5b8b3fba9b8640b241af14ada44f51f1502b345e1168d5b7e089144f4b7afd50be4ecc
-  data.tar.gz: d4b2d577c290b9caf6cb02861f6a1e592bb2e313918e875d5a4055db3751da9eec7651af67fcfe82b7213b7a561e823a5e8affb9c8c81121db3dd4e25bd97a0c
+  metadata.gz: 7714a102ac46e9da46277b21b585c5a7e537d926a31471a4ba6cb4966168751cb52a8471136f3c809dc23a9ed75aa0d013a8b37e201b0f26c7b5058e5f0b4c9c
+  data.tar.gz: a88801bcff664d54f7bddb67cfddcb6a50b900fcbe61184dca1a8299b9f87694a1883a96e504d13ce8bd47646010efb235b568637ebb91dce16756c867730d28

data/README.md

@@ -155,12 +155,58 @@ Bot.on :delivery do |delivery|
 end
 ```
 
-#### Set a welcome message
+#### Change thread settings
 
 You can greet new humans to entice them into talking to you:
 
 ```ruby
-Facebook::Messenger::Welcome.set text: 'Hello, human!'
+Facebook::Messenger::Thread.set(
+  setting_type: 'greeting',
+  greeting: {
+    text: 'Welcome to your new bot overlord!'
+  }
+)
+```
+
+You can define the action to trigger when new humans click on the Get
+Started button.
+
+```ruby
+Facebook::Messenger::Thread.set(
+  setting_type: 'call_to_actions',
+  thread_state: 'new_thread',
+  call_to_actions: [
+    {
+      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_WELCOME'
+    }
+  ]
+)
+```
+
+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'
+    },
+    {
+      type: 'postback',
+      title: 'Start a New Order',
+      payload: 'DEVELOPER_DEFINED_PAYLOAD_FOR_START_ORDER'
+    },
+    {
+      type: 'web_url',
+      title: 'View Website',
+      url: 'http://example.com/'
+    }
+  ]
+)
 ```
 
 ## Configuration
@@ -175,6 +221,9 @@ token of your choosing.
 
 ![Application settings](https://scontent-amt2-1.xx.fbcdn.net/hphotos-xfp1/t39.2178-6/12057143_211110782612505_894181129_n.png)
 
+*Note*: Don't subscribe to `message_echoes`; it'll echo your bot's own messages
+back to you, effectively DDOSing yourself.
+
 Use the generated access token and your verify token to configure your bot:
 
 ##### ... pass a block, or

data/lib/facebook/messenger.rb

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

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

@@ -17,6 +17,10 @@ module Facebook
           @messaging['sender']
         end
 
+        def recipient
+          @messaging['recipient']
+        end
+
         def seq
           @messaging['message']['seq']
         end

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

@@ -2,10 +2,10 @@ require 'httparty'
 
 module Facebook
   module Messenger
-    # This module handles setting welcome messages.
+    # This module handles changing thread settings.
     #
-    # https://developers.facebook.com/docs/messenger-platform/send-api-reference#welcome_message_configuration
-    module Welcome
+    # https://developers.facebook.com/docs/messenger-platform/thread-settings
+    module Thread
       include HTTParty
 
       base_uri 'https://graph.facebook.com/v2.6/me'
@@ -14,18 +14,18 @@ module Facebook
 
       module_function
 
-      def set(message)
+      def set(settings)
         response = post '/thread_settings',
-                        body: welcome_setting_for(message).to_json
+                        body: settings.to_json
 
         raise_errors(response)
 
         true
       end
 
-      def unset
-        response = post '/thread_settings',
-                        body: welcome_setting_for(nil).to_json
+      def unset(settings)
+        response = delete '/thread_settings',
+                          body: settings.to_json
 
         raise_errors(response)
 
@@ -47,14 +47,6 @@ module Facebook
         )
       end
 
-      def welcome_setting_for(payload)
-        {
-          setting_type: 'call_to_actions',
-          thread_state: 'new_thread',
-          call_to_actions: payload ? [{ message: payload }] : []
-        }
-      end
-
       class Error < Facebook::Messenger::Error; end
     end
   end

data/lib/facebook/messenger/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Messenger
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -172,8 +172,8 @@ files:
 - lib/facebook/messenger/incoming/read.rb
 - lib/facebook/messenger/server.rb
 - lib/facebook/messenger/subscriptions.rb
+- lib/facebook/messenger/thread.rb
 - lib/facebook/messenger/version.rb
-- lib/facebook/messenger/welcome.rb
 homepage: https://github.com/hyperoslo/facebook-messenger
 licenses:
 - MIT