stealth-facebook 0.11.4 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19250a58fb081fc8724de8b9a9a39b95b0144d6389b1265202b64fc1484697ce
-  data.tar.gz: a41d56b211453c08b72717dbeb61a2ba749cc7dd0e4ea509d3aaa9b15b992022
+  metadata.gz: c5f352636c999182ab5ab0059b65ac878f233c921639c886d969140f4218092a
+  data.tar.gz: fe85dd2fd4fc0093f46b1bc922b3ff152fcf71dd2552ed9972f4531827ef8a29
 SHA512:
-  metadata.gz: b020a97a4313b5df83a523c491624c90edfe43b34e70e66e7d1b10c8a6ae55ced406e8d5f4c84e07c8ccb6b46471e8cfcf97831e4eedbc545680eb63a0eeb5a5
-  data.tar.gz: f91bf603c066150d062c181ca096c97601b2111a824ac2bddeca1acfdde7ffa11607a46b5a6bb834760e47c60ba59a586cc6ee6a5741693ebf1aa0df480c6717
+  metadata.gz: d0c9dee3070ec9efa473ab1aff1cf6596278e0fdb2adfdf8957eb0f061773df92208197a249505b9176e69a3819ba8751c7fbd4062abf958261209631c00a560
+  data.tar.gz: 962575b7130ccff7d0e10c8870b5a7caf3c2b2a4d60e1d719541e4136eef3a69bb90f50607c0935da8dd63ae1fcb9cd3bdb17beda05764bdd685ac8ef120d471

data/README.md

@@ -128,6 +128,36 @@ 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.
+
+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`:
+
+```yaml
+default: &default
+  facebook:
+    verify_token: <%= ENV['FACEBOOK_VERIFY_TOKEN'] %>
+    page_access_token: <%= ENV['FACEBOOK_ACCESS_TOKEN'] %>
+    app_id: <%= ENV['FACEBOOK_APP_ID'] %>
+    page_id: <%= ENV['FACEBOOK_PAGE_ID'] %>
+    ...
+```
+
+Then to collect a metric:
+
+```ruby
+Stealth::Services::Facebook::Client.track(recipient_id: u.recipient_id, metric: 'name of your metric', value: 2)
+```
+
+To specify additional options:
+
+```ruby
+Stealth::Services::Facebook::Client.track(recipient_id: u.recipient_id, metric: 'signup', value: 2, options: { 'fb_description' => 'A signup occured.' })
+```
+
+More info about events, such as which options are available, can be found on [Facebook's Events API docs](https://developers.facebook.com/docs/marketing-api/app-event-api) page.
+
 ## Replies
 
 Here are the supported replies for the Facebook integration:

data/VERSION

@@ -1 +1 @@
-0.11.4
+0.12.0

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

@@ -53,6 +53,39 @@ module Stealth
             raise(Stealth::Errors::ServiceError, "Facebook error #{response.status}: #{response.body}")
           end
         end
+
+        def self.track(recipient_id:, metric:, value:, options: {})
+          metric_values = [{
+            '_eventName' => metric,
+            '_valueToSum' => value
+          }]
+
+          metric_values.first.merge!(options)
+
+          params = {
+            event: 'CUSTOM_APP_EVENTS',
+            custom_events: MultiJson.dump(metric_values),
+            advertiser_tracking_enabled: 1,
+            application_tracking_enabled: 1,
+            extinfo: MultiJson.dump(['mb1']),
+            page_scoped_user_id: recipient_id,
+            page_id: Stealth.config.facebook.page_id
+          }
+
+          uri = URI::HTTPS.build(
+            host: "graph.facebook.com",
+            path: "/#{Stealth.config.facebook.app_id}/activities"
+          )
+
+          response = Faraday.post(uri.to_s, params)
+          Stealth::Logger.l(topic: "facebook", message: "Sending custom event for metric: #{metric} and value: #{value}. Response: #{response.status}: #{response.body}")
+
+          if response.status.in?(200..299)
+            MultiJson.load(response.body)
+          else
+            raise(Stealth::Errors::ServiceError, "Facebook error #{response.status}: #{response.body}")
+          end
+        end
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth-facebook
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.12.0
 platform: ruby
 authors:
 - Mauricio Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stealth