stealth-facebook 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f352636c999182ab5ab0059b65ac878f233c921639c886d969140f4218092a
-  data.tar.gz: fe85dd2fd4fc0093f46b1bc922b3ff152fcf71dd2552ed9972f4531827ef8a29
+  metadata.gz: efd8e39db98abfbcdbdae8a6203d342a3b106b1ad724375679ffd3f72ea22176
+  data.tar.gz: f5653657b82b3e6002122b4b0202e27075e9dbdee2655b0a92aabc7ddec761a1
 SHA512:
-  metadata.gz: d0c9dee3070ec9efa473ab1aff1cf6596278e0fdb2adfdf8957eb0f061773df92208197a249505b9176e69a3819ba8751c7fbd4062abf958261209631c00a560
-  data.tar.gz: 962575b7130ccff7d0e10c8870b5a7caf3c2b2a4d60e1d719541e4136eef3a69bb90f50607c0935da8dd63ae1fcb9cd3bdb17beda05764bdd685ac8ef120d471
+  metadata.gz: 591195dc3f5b845ba7fb1cdce466a1a5a3c530448369360ca9bc7c9c20e51c39732fd8842824b8d32c94b65c78486579044147f9fd1be24e7d22831e0dd2e5fa
+  data.tar.gz: aa23afc24d70d6f0284ef75428a39ed700bb9ed5d6d432e59f28a5906dd96311fcc8311dddb82aa6e14973e67928cc80fb7ac363df5323e00086055b87274bea

data/README.md

@@ -12,7 +12,18 @@ When configuring your webhooks, you'll want to enable the `messages`, `messaging
 
 <img src='fb-config.png' width='875px' alt='Facebook Config Screenshot' />
 
-Make sure you don't enable `message_reads` as that is not yet supported by this gem.
+### message_reads
+
+Beginning with version `0.13.0` of this gem, `message_reads` webhooks are supported. When enabled in your Facebook configuration, they will appear as `current_message.read`. That will return a hash:
+
+```ruby
+{
+  watermark: 1458668856253,
+  seq: 38
+}
+```
+
+More info about `message_reads` webhooks can be found in the [Facebook Developer docs](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-reads).
 
 ## Configure The Integration
 
@@ -130,9 +141,9 @@ fb_profile = Stealth::Services::Facebook::Client.fetch_profile(
 
 ### Analytics
 
-If you'd like to track custom bot metrics in addition to the ones provided automatically by Facebook Analytics, you can do so in starting in version `0.12.0` of this gem.
+If you'd like to track custom bot metrics in addition to the ones provided automatically by Facebook Analytics, you can do so starting with version `0.12.0` of this gem.
 
-In order to send these metrics, you'll need to add the `app_id` of the bot as well as the `page_id` of the Facebook page (attached to the bot) to `services.yml`:
+In order to send these metrics, you'll need to include the `app_id` of the bot as well as the `page_id` of the Facebook page (attached to the bot) to `services.yml`:
 
 ```yaml
 default: &default
@@ -150,7 +161,7 @@ Then to collect a metric:
 Stealth::Services::Facebook::Client.track(recipient_id: u.recipient_id, metric: 'name of your metric', value: 2)
 ```
 
-To specify additional options:
+You can specify additional options:
 
 ```ruby
 Stealth::Services::Facebook::Client.track(recipient_id: u.recipient_id, metric: 'signup', value: 2, options: { 'fb_description' => 'A signup occured.' })

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/lib/stealth/services/facebook/events/message_reads_event.rb

@@ -0,0 +1,49 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+
+
+module Stealth
+  module Services
+    module Facebook
+
+      class MessageReadsEvent
+
+        attr_reader :service_message, :params
+
+        def initialize(service_message:, params:)
+          @service_message = service_message
+          @params = params
+        end
+
+        def process
+          fetch_read
+        end
+
+        private
+
+          def fetch_read
+            service_message.read = { watermark: get_timestamp, seq: params['read']['seq'] }
+          end
+
+          def get_timestamp
+            Time.at(params['read']['watermark']/1000).to_datetime
+          end
+      end
+
+      module ReadsEvent
+        attr_accessor :read
+        def initialize(service:)
+          @read = {}
+          super
+        end
+      end
+
+    end
+  end
+
+
+  class ServiceMessage
+    prepend Services::Facebook::ReadsEvent
+  end
+end

data/lib/stealth/services/facebook/message_handler.rb

@@ -3,6 +3,7 @@
 
 require 'stealth/services/facebook/events/message_event'
 require 'stealth/services/facebook/events/postback_event'
+require 'stealth/services/facebook/events/message_reads_event'
 
 module Stealth
   module Services
@@ -73,6 +74,11 @@ module Stealth
                 service_message: service_message,
                 params: facebook_message
               )
+            elsif facebook_message['read'].present?
+              message_event = Stealth::Services::Facebook::MessageReadsEvent.new(
+                service_message: service_message,
+                params: facebook_message
+              )
             end
 
             message_event.process

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth-facebook
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Mauricio Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stealth
@@ -98,6 +98,7 @@ files:
 - lib/stealth/facebook.rb
 - lib/stealth/services/facebook/client.rb
 - lib/stealth/services/facebook/events/message_event.rb
+- lib/stealth/services/facebook/events/message_reads_event.rb
 - lib/stealth/services/facebook/events/postback_event.rb
 - lib/stealth/services/facebook/message_handler.rb
 - lib/stealth/services/facebook/reply_handler.rb