facebook-messenger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f510182ff271bbc196d32186dc1ffb79cfc85a8b
-  data.tar.gz: 7280598efce0fb8f35a5a553bcbad5c62e461064
+  metadata.gz: 3a67d299ebe188c1b50d8adcae153084eb694c4c
+  data.tar.gz: 2b882acad66c7260c99670b8b11dcd6771c18b1f
 SHA512:
-  metadata.gz: aa769ba01fb9ec3415e6536a83fe73836e7d54c2f6278176aa9f19356f6d930337f11f22b6e97f85852f5956323f1c25deffec4de4e5c2e4282e6e53cb5a9695
-  data.tar.gz: 4b36aa6de38e44616b07663d8a94112cb0c45aa5875cb786128ee3ed698ee0ba02d1fae3e611b0ad2b1b9f9fb52905a59f202b45ecf0c0fe38d827707c66b382
+  metadata.gz: 8fa27eacf08884194a942969822356c84e1de6c74d88b02451a858c5227351305a77e33d4c7eeba4dae146891b8d3c9d429924009bacb2055433db4c3947c071
+  data.tar.gz: 9f7975f548098478e922daf12433e19c28483edde278f0b7b6ee885ca2748c4d4107c06c4e25693f640210f35f1dc407fe9e3a5f461292fdade85fc4a9249933

data/README.md

@@ -111,6 +111,29 @@ end
 
 *See Facebook's [documentation][message-documentation] for all message options.*
 
+#### Send to Facebook
+
+When the human clicks the [Send to Messenger button][send-to-messenger-plugin]
+embedded on a website, you will receive an `optin` event.
+
+```ruby
+Bot.on :optin do |optin|
+  postback.sender    # => { id: '1008372609250235' }
+  postback.recipient # => { id: '2015573629214912' }
+  postback.sent_at   # => 2016-04-22 21:30:36 +0200
+  postback.ref       # => 'CONTACT_SKYNET'
+
+  Bot.deliver(
+    recipient: {
+      id: '45123'
+    },
+    message: {
+      text: 'Ah, human!'
+    }
+  )
+end
+
+
 #### Message delivery receipts
 
 You can stalk the human:
@@ -123,7 +146,7 @@ Bot.on :delivery do |delivery|
   delivery.at        # => 2016-04-22 21:30:36 +0200
   delivery.seq       # => 37
 
-  puts "Human received messages before #{delivery.at}"
+  puts "Human was online at #{delivery.at}"
 end
 ```
 
@@ -204,3 +227,4 @@ If you're using Facebook Messenger, we probably want to [hire you].
 [message-documentation]: https://developers.facebook.com/docs/messenger-platform/send-api-reference#request
 [facebook-developers]: https://developers.facebook.com
 [rack]: https://github.com/rack/rack
+[send-to-messenger-plugin]: https://developers.facebook.com/docs/messenger-platform/plugin-reference

data/lib/facebook/messenger/bot.rb

@@ -6,7 +6,7 @@ module Facebook
 
       base_uri 'https://graph.facebook.com/v2.6/me'
 
-      EVENTS = [:message, :delivery].freeze
+      EVENTS = [:message, :delivery, :postback, :optin].freeze
 
       class << self
         # Deliver a message with the given payload.
@@ -51,6 +51,7 @@ module Facebook
           when Incoming::Message then trigger(:message, klass)
           when Incoming::Delivery then trigger(:delivery, klass)
           when Incoming::Postback then trigger(:postback, klass)
+          when Incoming::Optin then trigger(:optin, klass)
           end
         end
 

data/lib/facebook/messenger/incoming.rb

@@ -1,6 +1,7 @@
 require 'facebook/messenger/incoming/message'
 require 'facebook/messenger/incoming/delivery'
 require 'facebook/messenger/incoming/postback'
+require 'facebook/messenger/incoming/optin'
 
 module Facebook
   module Messenger
@@ -16,7 +17,8 @@ module Facebook
         {
           'message' => Message,
           'delivery' => Delivery,
-          'postback' => Postback
+          'postback' => Postback,
+          'optin' => Optin
         }.each do |key, klass|
           return klass.new(payload) if payload.key? key
         end

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

@@ -0,0 +1,31 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Optin class represents an incoming Facebook Messenger optin,
+      # which occurs when a user engages by using the Send-to-Messenger Plugin.
+      #
+      # https://developers.facebook.com/docs/messenger-platform/plugin-reference
+      class Optin
+        def initialize(payload)
+          @payload = payload
+        end
+
+        def sender
+          @payload['sender']
+        end
+
+        def recipient
+          @payload['recipient']
+        end
+
+        def sent_at
+          Time.at(@payload['timestamp'] / 1000)
+        end
+
+        def ref
+          @payload['optin']['ref']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Messenger
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -153,6 +153,7 @@ files:
 - lib/facebook/messenger/incoming.rb
 - lib/facebook/messenger/incoming/delivery.rb
 - lib/facebook/messenger/incoming/message.rb
+- lib/facebook/messenger/incoming/optin.rb
 - lib/facebook/messenger/incoming/postback.rb
 - lib/facebook/messenger/server.rb
 - lib/facebook/messenger/subscriptions.rb