facebook-messenger 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6973b5c241d0124c75e08a0441e26c8190d51f24
-  data.tar.gz: 58aae6e494b7a89f58e2d4e0f5e3c33df31b89cb
+SHA256:
+  metadata.gz: f17a2863cfd6e0797b3a942f6fb5959557be525c40e1efc698542a6ab3662ac6
+  data.tar.gz: e94ac387ab7174e04429cc5afa2b27121fb1bfd03afa3067e3ed61db3b4f34ba
 SHA512:
-  metadata.gz: 0ab183695ddbe1dcb6136bd4c2537b3f619e1cc0f96ddf63c3aac981e6ca947c19ca53437db1773c98419a0a5ea42179a31ae52dc6eb3f4f62edd78470722eb4
-  data.tar.gz: 49e973311172b2fbc2e81bce8c3a35f89470e5240da931ddd12b08fcff00e3f3d3d571b295565b6c12542d401c1ff3de87384cc8ef46a19f892f0d5fb93fa3bf
+  metadata.gz: 2d673c880dfd1647805347e666586aa7478be689b2660e2a91a69084d7b63f576509c917751b7fcc10f8fa8f28147fe1ff8041a196d8aa5850a2bfa0dd1d60c5
+  data.tar.gz: 801a4fa53d78bfd7e03cf365b57899b25ac085f12507b8307d468b132dac2caeff2d149ee5eb521967548933ded81f0a27957995257e2a0e2a6f21870aec5555

data/README.md

@@ -48,9 +48,21 @@ Bot.deliver({
     text: 'Human?'
   },
   message_type: Facebook::Messenger::Bot::MessagingType::UPDATE
-}, access_token: ENV['ACCESS_TOKEN'])
+}, access_token: ENV['ACCESS_TOKEN'], app_secret_proof: app_secret_proof
+)
+```
+
+NOTE: `app_secret_proof` is an optional parameter to [secure your requests](https://developers.facebook.com/docs/graph-api/securing-requests/),
+and you can generate it from your configuration provider like so:
+
+```ruby
+configuration_provider = Facebook::Messenger::Configuration::Providers.Environment.new
+app_secret_proof = configuration_provider.app_secret_proof_for(page_id)
 ```
 
+For the methods you'll usually use (like `reply` and `typing_on`), the app secret proof will be set and sent
+automatically if you set the environment variable `APP_SECRET_PROOF_ENABLED` to `true`.
+
 ##### Messages with images
 
 The human may require visual aid to understand:
@@ -432,7 +444,10 @@ Once you've configured your bot, subscribe it to the Page to get messages
 from Facebook:
 
 ```ruby
-Facebook::Messenger::Subscriptions.subscribe(access_token: access_token)
+Facebook::Messenger::Subscriptions.subscribe(
+  access_token: access_token,
+  subscribed_fields: %w[feed mention name]
+)
 ```
 
 You only need to subscribe your page once. As long as your bot works and
@@ -536,7 +551,10 @@ require 'facebook/messenger'
 include Facebook::Messenger
 
 class Listener
-  Facebook::Messenger::Subscriptions.subscribe(access_token: ENV["FB_ACCESS_TOKEN"])
+  Facebook::Messenger::Subscriptions.subscribe(
+    access_token: ENV["FB_ACCESS_TOKEN"],
+    subscribed_fields: %w[feed mention name]
+  )
 
   Bot.on :message do |message|
     Bot.deliver({

data/lib/facebook/messenger/bot.rb

@@ -13,7 +13,7 @@ module Facebook
       include HTTParty
 
       # Define base_uri for HTTParty.
-      base_uri 'https://graph.facebook.com/v2.9/me'
+      base_uri 'https://graph.facebook.com/v3.2/me'
 
       #
       # @return [Array] Array containing the supported webhook events.
@@ -39,16 +39,22 @@ module Facebook
         #
         # @param [Hash] message A Hash describing the recipient and the message.
         # @param [String] access_token Access token.
+        # @param [String] app_secret_proof proof of the app_secret
+        # https://developers.facebook.com/docs/graph-api/securing-requests/
+        # Note: we provide a helper function available at
+        # Messenger::Configuration::Providers::Base#calculate_app_secret_proof
         #
         # Returns a String describing the message ID if the message was sent,
         # or raises an exception if it was not.
-        def deliver(message, access_token:)
+        def deliver(message, access_token:, app_secret_proof: nil)
+          query = {
+            access_token: access_token
+          }
+          query[:appsecret_proof] = app_secret_proof if app_secret_proof
           response = post '/messages',
                           body: JSON.dump(message),
                           format: :json,
-                          query: {
-                            access_token: access_token
-                          }
+                          query: query
 
           Facebook::Messenger::Bot::ErrorParser.raise_errors_from(response)
 

data/lib/facebook/messenger/configuration/app_secret_proof_calculator.rb

@@ -0,0 +1,16 @@
+module Facebook
+  module Messenger
+    class Configuration
+      # We provide a service to calculate an app_secret_proof
+      class AppSecretProofCalculator
+        def self.call(app_secret, access_token)
+          OpenSSL::HMAC.hexdigest(
+            OpenSSL::Digest.new('SHA256'.freeze),
+            app_secret,
+            access_token
+          )
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/configuration/providers/base.rb

@@ -1,3 +1,5 @@
+require 'facebook/messenger/configuration/app_secret_proof_calculator'
+
 module Facebook
   module Messenger
     class Configuration
@@ -7,6 +9,16 @@ module Facebook
         #   Be sure to implement all the functions as it raises
         #   NotImplementedError errors.
         class Base
+          # A default caching implentation of generating the app_secret_proof
+          # for a given page_id
+          def app_secret_proof_for(page_id = nil)
+            return unless fetch_app_secret_proof_enabled?
+
+            memo_key = [app_secret_for(page_id), access_token_for(page_id)]
+            memoized_app_secret_proofs[memo_key] ||=
+              calculate_app_secret_proof(*memo_key)
+          end
+
           def valid_verify_token?(*)
             raise NotImplementedError
           end
@@ -18,6 +30,23 @@ module Facebook
           def access_token_for(*)
             raise NotImplementedError
           end
+
+          private
+
+          def calculate_app_secret_proof(app_secret, access_token)
+            Facebook::Messenger::Configuration::AppSecretProofCalculator.call(
+              app_secret,
+              access_token
+            )
+          end
+
+          def memoized_app_secret_proofs
+            @memoized_app_secret_proofs ||= {}
+          end
+
+          def fetch_app_secret_proof_enabled?
+            false
+          end
         end
       end
     end

data/lib/facebook/messenger/configuration/providers/environment.rb

@@ -1,9 +1,11 @@
+require 'facebook/messenger/configuration/providers/base'
+
 module Facebook
   module Messenger
     class Configuration
       module Providers
         # The default configuration provider for environment variables.
-        class Environment
+        class Environment < Base
           def valid_verify_token?(verify_token)
             verify_token == ENV['VERIFY_TOKEN']
           end
@@ -20,6 +22,10 @@ module Facebook
           def access_token_for(*)
             ENV['ACCESS_TOKEN']
           end
+
+          def fetch_app_secret_proof_enabled?
+            ENV['APP_SECRET_PROOF_ENABLED'] == 'true'.freeze
+          end
         end
       end
     end

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

@@ -74,7 +74,7 @@ module Facebook
             sender_action: 'typing_on'
           }
 
-          Facebook::Messenger::Bot.deliver(payload, access_token: access_token)
+          deliver_payload(payload)
         end
 
         #
@@ -90,7 +90,7 @@ module Facebook
             sender_action: 'typing_off'
           }
 
-          Facebook::Messenger::Bot.deliver(payload, access_token: access_token)
+          deliver_payload(payload)
         end
 
         #
@@ -106,7 +106,7 @@ module Facebook
             sender_action: 'mark_seen'
           }
 
-          Facebook::Messenger::Bot.deliver(payload, access_token: access_token)
+          deliver_payload(payload)
         end
 
         #
@@ -123,7 +123,7 @@ module Facebook
             message_type: Facebook::Messenger::Bot::MessageType::RESPONSE
           }
 
-          Facebook::Messenger::Bot.deliver(payload, access_token: access_token)
+          deliver_payload(payload)
         end
 
         #
@@ -134,6 +134,18 @@ module Facebook
         def access_token
           Facebook::Messenger.config.provider.access_token_for(recipient)
         end
+
+        def app_secret_proof
+          Facebook::Messenger.config.provider.app_secret_proof_for(recipient)
+        end
+
+        private
+
+        def deliver_payload(payload)
+          Facebook::Messenger::Bot.deliver(payload,
+                                           access_token: access_token,
+                                           app_secret_proof: app_secret_proof)
+        end
       end
     end
   end

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

@@ -15,6 +15,7 @@ module Facebook
         # Return hash containing the referral information of user.
         def referral
           return if @messaging['postback']['referral'].nil?
+
           @referral ||= Referral::Referral.new(
             @messaging['postback']['referral']
           )

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

@@ -27,6 +27,11 @@ module Facebook
           def type
             @referral['type']
           end
+
+          # Return String of ad id.
+          def ad_id
+            @referral['ad_id'] if @referral.key?('ad_id')
+          end
         end
 
         def referral

data/lib/facebook/messenger/server.rb

@@ -160,6 +160,7 @@ module Facebook
           # If the application has subscribed to webhooks other than Messenger,
           # 'messaging' won't be available and it is not relevant to us.
           next unless entry['messaging'.freeze]
+
           # Facebook may batch several items in the 'messaging' array during
           # periods of high load.
           entry['messaging'.freeze].each do |messaging|

data/lib/facebook/messenger/version.rb

@@ -2,6 +2,6 @@ module Facebook
   module Messenger
     #
     # @return [String] Define the version of gem.
-    VERSION = '1.1.2'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -174,6 +174,7 @@ files:
 - lib/facebook/messenger/bot/messaging_type.rb
 - lib/facebook/messenger/bot/tag.rb
 - lib/facebook/messenger/configuration.rb
+- lib/facebook/messenger/configuration/app_secret_proof_calculator.rb
 - lib/facebook/messenger/configuration/providers.rb
 - lib/facebook/messenger/configuration/providers/base.rb
 - lib/facebook/messenger/configuration/providers/environment.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Facebook Messenger client