facebook-messenger 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddbb553d6b155a4f6cbb160cfb404605df0705d6
-  data.tar.gz: 23899394ed7e89b77701b6f634b595e770b735f2
+  metadata.gz: d44d493f7a90af8ada14c7bdcece0b54fa033abf
+  data.tar.gz: 5299267b035cda79e916beb6752fc736c9ec9853
 SHA512:
-  metadata.gz: b8192c8d31b9bd123d836d37a3f67fe6aa823c5aa442db7e0b5221f6dba01817d8c66d9c0a571b2350f182f106f2797d5651cb44c581caf8631bf8c439c61e8c
-  data.tar.gz: 5c3fdd4ddd9e19fdbde71cdb075b149155d8c3c8b9804163d2b2f0a344f91fbfd1e4dc60d2f1d80568a792ea704a2cb09b7076f49754d32f1dd127ea0d297d2f
+  metadata.gz: 5707bbee02a68b2bf370d841d8644c7b6bdd2acadbcc93083c0c76743d337e1aad126c731a2374a92b064e233a4bd8e1f02df7d1f958700ea81c084b04ccff63
+  data.tar.gz: 4db0e0fcd018f909478a98162275bbc91691a81ac1c40106ecec4eb0c2f4e276b16c1598713e6fbfcbadb580b212f2fa85266f1e66e4ca551749b7b6a9244909

data/README.md

@@ -158,6 +158,24 @@ Bot.on :message do |message|
 end
 ```
 
+##### Record messages
+
+You can keep track of messages sent to the human:
+
+```ruby
+Bot.on :message_echo do |message_echo|
+  message_echo.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
+  message_echo.sender      # => { 'id' => '1008372609250235' }
+  message_echo.seq         # => 73
+  message_echo.sent_at     # => 2016-04-22 21:30:36 +0200
+  message_echo.text        # => 'Hello, bot!'
+  message_echo.attachments # => [ { 'type' => 'image', 'payload' => { 'url' => 'https://www.example.com/1.jpg' } } ]
+
+  # Log or store in your storage method of choice.
+end
+```
+
+
 #### Send to Facebook
 
 When the human clicks the [Send to Messenger button][send-to-messenger-plugin]
@@ -287,9 +305,6 @@ Facebook::Messenger::Profile.set({
 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
@@ -342,6 +357,11 @@ from Facebook:
 Facebook::Messenger::Subscriptions.subscribe(access_token: access_token)
 ```
 
+You only need to subscribe your page once. As long as your bot works and
+responds to Messenger's requests in a timely fashion it will remain
+subscribed, but if your bot crashes or otherwise becomes unavailable Messenger
+may unsubscribe it and you'll have to subscribe again.
+
 ### Run it
 
 ##### ... on Rack
@@ -401,7 +421,7 @@ unless Rails.env.production?
     bot_files.each{ |file| require_dependency file }
   end
 
-  ActionDispatch::Callbacks.to_prepare do
+  ActiveSupport::Reloader.to_prepare do
     bot_reloader.execute_if_updated
   end
 
@@ -445,6 +465,8 @@ 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.
 
+* [Botamp](https://botamp.com) is the all-in-one solution for Marketing Automation via messaging apps.
+
 ## Hyper loves you
 
 [Hyper] made this. We're a bunch of folks who love building things. You should

data/lib/facebook/messenger/bot.rb

@@ -10,7 +10,14 @@ module Facebook
       base_uri 'https://graph.facebook.com/v2.6/me'
 
       EVENTS = %i[
-        message delivery postback optin read account_linking referral
+        message
+        delivery
+        postback
+        optin
+        read
+        account_linking
+        referral
+        message_echo
       ].freeze
 
       class << self

data/lib/facebook/messenger/incoming.rb

@@ -1,5 +1,6 @@
 require 'facebook/messenger/incoming/common'
 require 'facebook/messenger/incoming/message'
+require 'facebook/messenger/incoming/message_echo'
 require 'facebook/messenger/incoming/delivery'
 require 'facebook/messenger/incoming/postback'
 require 'facebook/messenger/incoming/optin'
@@ -19,7 +20,8 @@ module Facebook
         'optin' => Optin,
         'read' => Read,
         'account_linking' => AccountLinking,
-        'referral' => Referral
+        'referral' => Referral,
+        'message_echo' => MessageEcho
       }.freeze
 
       # Parse the given payload.
@@ -28,6 +30,8 @@ module Facebook
       #
       # * https://developers.facebook.com/docs/messenger-platform/webhook-reference
       def self.parse(payload)
+        return MessageEcho.new(payload) if payload_is_echo?(payload)
+
         EVENTS.each do |event, klass|
           return klass.new(payload) if payload.key?(event)
         end
@@ -35,6 +39,10 @@ module Facebook
         raise UnknownPayload, payload
       end
 
+      def self.payload_is_echo?(payload)
+        payload.key?('message') && payload['message']['is_echo'] == true
+      end
+
       class UnknownPayload < Facebook::Messenger::Error; end
     end
   end

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

@@ -0,0 +1,10 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Message echo class represents an
+      # incoming Facebook Messenger message
+      class MessageEcho < Message
+      end
+    end
+  end
+end

data/lib/facebook/messenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -180,6 +180,7 @@ files:
 - lib/facebook/messenger/incoming/common.rb
 - lib/facebook/messenger/incoming/delivery.rb
 - lib/facebook/messenger/incoming/message.rb
+- lib/facebook/messenger/incoming/message_echo.rb
 - lib/facebook/messenger/incoming/optin.rb
 - lib/facebook/messenger/incoming/postback.rb
 - lib/facebook/messenger/incoming/read.rb