facebook-messenger 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b757052cad527d03939514250e2f3fc87fbc21e0e7c86e9f78c8a2087ed925f1
-  data.tar.gz: 9f18c41169ded5554f49e3faa2e22a94565f83461bc2de688ad87957426791a1
+  metadata.gz: 8b91271ca1dfd46644af4c45a6e64670c36cf2c8de5efa288ec2bf04e43bef44
+  data.tar.gz: 57611671a09c7784c4cfe92e461a9b9444e6d18e3f1ee02784291f5af2effaa1
 SHA512:
-  metadata.gz: 23d252fce2c080a7d95f1b25795ca423e7efac86c52e7dc158203c4f0b840d3b7c14b499919a3d9fab58cdf49e1bed274a7220f25b31c235e0e93fb457e45ff2
-  data.tar.gz: 1aa9d963cfecb848d000a4df931a1d30430005eff5b5f58cc18f8094092956077b354e589527770007e081b3f8d0cf7a67f1229da21a3b1ce453ff94a7dbca65
+  metadata.gz: c91d9b3fc8bf84c8acf14034f2f916477e67418b8baf7df1c6f87fb35f0e4a5f3d207a1386e33a70ed18b8ad1466023e93d50eb248a7c110b05c460f0154450f
+  data.tar.gz: aa8656efd52e1cb39980c11a86596739e1045848bb78edd13c6a568febaa1ed60f8b2ede932baa8f3f27917506f64ade3cbe2690be5892be555a7c83aaa61d4a

data/README.md

@@ -44,27 +44,15 @@ end
 ```ruby
 Bot.deliver({
   recipient: {
-    id: '45123'
+    id: YOUR_RECIPIENT_ID
   },
   message: {
     text: 'Human?'
   },
   messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
-}, access_token: ENV['ACCESS_TOKEN'], app_secret_proof: app_secret_proof
-)
+}, page_id: YOUR_PAGE_ID)
 ```
 
-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:
@@ -305,7 +293,7 @@ Facebook::Messenger::Profile.set({
       text: 'Bienvenue dans le bot du Wagon !'
     }
   ]
-}, access_token: ENV['ACCESS_TOKEN'])
+}, page_id: YOUR_PAGE_ID)
 ```
 
 You can define the action to trigger when new humans click on the Get
@@ -316,7 +304,7 @@ Facebook::Messenger::Profile.set({
   get_started: {
     payload: 'GET_STARTED_PAYLOAD'
   }
-}, access_token: ENV['ACCESS_TOKEN'])
+}, page_id: YOUR_PAGE_ID) 
 ```
 
 You can show a persistent menu to humans.
@@ -362,10 +350,9 @@ Facebook::Messenger::Profile.set({
       composer_input_disabled: false
     }
   ]
-}, access_token: ENV['ACCESS_TOKEN'])
+}, page_id: YOUR_PAGE_ID)
 ```
 
-
 #### Handle a Facebook Policy Violation
 
 See Facebook's documentation on [Messaging Policy Enforcement](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_policy_enforcement)
@@ -376,8 +363,11 @@ Bot.on :'policy_enforcement' do |referral|
   referral.reason # => "The bot violated our Platform Policies (https://developers.facebook.com/policy/#messengerplatform). Common violations include sending out excessive spammy messages or being non-functional."
 end
 ```
+
 #### messaging_type
+
 ##### Sending Messages
+
 See Facebook's documentation on [Sending Messages](https://developers.facebook.com/docs/messenger-platform/send-messages#standard_messaging)
 
 As of May 7th 2018 all messages are required to include a messaging_type
@@ -391,10 +381,11 @@ Bot.deliver({
     text: 'Human?'
   },
   messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
-}, access_token: ENV['ACCESS_TOKEN'])
+}, page_id: YOUR_PAGE_ID)
 ```
 
 ##### MESSAGE_TAG
+
 See Facebook's documentation on [Message Tags](https://developers.facebook.com/docs/messenger-platform/send-messages/message-tags)
 
 When sending a message with messaging_type: MESSAGE_TAG (Facebook::Messenger::Bot::MessagingType::MESSAGE_TAG) you must ensure you add a tag: parameter
@@ -409,7 +400,7 @@ Bot.deliver({
   },
   messaging_type: Facebook::Messenger::Bot::MessagingType::MESSAGE_TAG
   tag: Facebook::Messenger::Bot::Tag::NON_PROMOTIONAL_SUBSCRIPTION
-}, access_token: ENV['ACCESS_TOKEN'])
+}, page_id: YOUR_PAGE_ID) 
 ```
 
 ## Configuration
@@ -582,6 +573,7 @@ config.autoload_paths += Dir[Rails.root.join('app', 'bot', '*')]
 ### Test it...
 
 ##### ...locally
+
 To test your locally running bot, you can use [ngrok]. This will create a secure
 tunnel to localhost so that Facebook can reach the webhook.
 
@@ -589,7 +581,8 @@ tunnel to localhost so that Facebook can reach the webhook.
 
 In order to test that behaviour when a new event from Facebook is registered, you can use the gem's `trigger` method. This method accepts as its first argument the type of event that it will receive, and can then be followed by other arguments that mock objects received from Messenger. Using Ruby's [Struct](https://ruby-doc.org/core-2.5.0/Struct.html) class can be very useful for creating these mock objects.
 
-In this case, subscribing to Messenger events has been extracted into a `Listener` class.   
+In this case, subscribing to Messenger events has been extracted into a `Listener` class.
+
 ```ruby
 # app/bot/listener.rb
 require 'facebook/messenger'
@@ -598,7 +591,7 @@ include Facebook::Messenger
 
 class Listener
   Facebook::Messenger::Subscriptions.subscribe(
-    access_token: ENV["FB_ACCESS_TOKEN"],
+    access_token: ENV['ACCESS_TOKEN'],
     subscribed_fields: %w[feed mention name]
   )
 
@@ -608,11 +601,13 @@ class Listener
       message: {
         text: 'Uploading your message to skynet.'
       }
-    }, access_token: ENV['FB_ACCESS_TOKEN'])
+    }, access_token: ENV['ACCESS_TOKEN'])
   end
 end
 ```
+
 Its respective test file then ensures that the `Bot` object receives a call to `deliver`. This is just a basic test, but check out the [RSpec docs](http://rspec.info/) for more information on testing with RSpec.
+
 ```ruby
 require 'rails_helper'
 
@@ -638,7 +633,6 @@ RSpec.describe Listener do
 end
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run

data/lib/facebook/messenger/bot.rb

@@ -40,14 +40,14 @@ module Facebook
         # @raise [Facebook::Messenger::Bot::SendError] if there is any error
         #   in response while sending message.
         #
-        # @param [Hash] message A Hash describing the recipient and the message.
-        # @param [String] page_id A String describing the Facebook Page ID to send the message from.
+        # @param [Hash] message The message payload
+        # @param [String] page_id The page to send the message from
         #
         # Returns a String describing the message ID if the message was sent,
         # or raises an exception if it was not.
         def deliver(message, page_id:)
-          access_token = Facebook::Messenger.config.provider.access_token_for(page_id)
-          app_secret_proof = Facebook::Messenger.config.provider.app_secret_proof_for(page_id)
+          access_token = config.provider.access_token_for(page_id)
+          app_secret_proof = config.provider.app_secret_proof_for(page_id)
 
           query = { access_token: access_token }
           query[:appsecret_proof] = app_secret_proof if app_secret_proof
@@ -138,6 +138,12 @@ module Facebook
             }
           )
         end
+
+        private
+
+        def config
+          Facebook::Messenger.config
+        end
       end
     end
   end

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

@@ -12,8 +12,6 @@ module Facebook
           # 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)
@@ -43,10 +41,6 @@ module Facebook
           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

@@ -22,10 +22,6 @@ 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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Johannes Gorset