facebook-messenger 2.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b757052cad527d03939514250e2f3fc87fbc21e0e7c86e9f78c8a2087ed925f1
-  data.tar.gz: 9f18c41169ded5554f49e3faa2e22a94565f83461bc2de688ad87957426791a1
+  metadata.gz: 4f6b7cdaf4658871a6b72a385cb5e2df054abac1849f809bd7e02f760ef09bb0
+  data.tar.gz: 53a3dc676588d46a339bbf1d4117addafc88b28ecb35a81e14c49e91e0124905
 SHA512:
-  metadata.gz: 23d252fce2c080a7d95f1b25795ca423e7efac86c52e7dc158203c4f0b840d3b7c14b499919a3d9fab58cdf49e1bed274a7220f25b31c235e0e93fb457e45ff2
-  data.tar.gz: 1aa9d963cfecb848d000a4df931a1d30430005eff5b5f58cc18f8094092956077b354e589527770007e081b3f8d0cf7a67f1229da21a3b1ce453ff94a7dbca65
+  metadata.gz: cc00a75c7a6bacdb963a5fd71747788676cdb23c35eab75bc13b5bf289708451a279ccdb444d69f86938caec99ab6c82581382c5853155f06e785dadb06cfb88
+  data.tar.gz: 90eba5323395d6085bf7d4e4729e3649a046a15b9fa37497df8cca4b99969bae7e4d6fb45481a958e5a3f4c750a60593cbbff1772bf4095c49689b9cc788a1ef

data/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://rawgit.com/jgorset/facebook-messenger/master/docs/conversation_with_logo.gif">
+  <img src="https://github.com/jgorset/facebook-messenger/blob/master/docs/conversation.gif?raw=true">
 </p>
 
 
@@ -24,9 +24,7 @@ You can reply to messages sent by the human:
 # bot.rb
 require 'facebook/messenger'
 
-include Facebook::Messenger
-
-Bot.on :message do |message|
+Facebook::Messenger::Bot.on :message do |message|
   message.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
   message.sender      # => { 'id' => '1008372609250235' }
   message.recipient   # => { 'id' => '2015573629214912' }
@@ -42,29 +40,17 @@ end
 ... or even send the human messages out of the blue:
 
 ```ruby
-Bot.deliver({
+Facebook::Messenger::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:
@@ -191,7 +177,7 @@ end
 You can keep track of messages sent to the human:
 
 ```ruby
-Bot.on :message_echo do |message_echo|
+Facebook::Messenger::Bot.on :message_echo do |message_echo|
   message_echo.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
   message_echo.sender      # => { 'id' => '1008372609250235' }
   message_echo.seq         # => 73
@@ -270,7 +256,7 @@ When the human follows a m.me link with a ref parameter like http://m.me/mybot?r
 you will receive a `referral` event.
 
 ```ruby
-Bot.on :referral do |referral|
+Facebook::Messenger::Bot.on :referral do |referral|
   referral.sender    # => { 'id' => '1008372609250235' }
   referral.recipient # => { 'id' => '2015573629214912' }
   referral.sent_at   # => 2016-04-22 21:30:36 +0200
@@ -283,7 +269,7 @@ end
 Another bot can pass a human to you:
 
 ```ruby
-Bot.on :pass_thread_control do |pass_thread_control|
+Facebook::Messenger::Bot.on :pass_thread_control do |pass_thread_control|
   pass_thread_control.new_owner_app_id # => '123456789'
   pass_thread_control.metadata # => 'Additional content that the caller wants to set'
 end
@@ -305,7 +291,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 +302,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,28 +348,30 @@ 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)
 
 ```ruby
-Bot.on :'policy_enforcement' do |referral|
+Facebook::Messenger::Bot.on :'policy_enforcement' do |referral|
   referral.action # => 'block'
   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
 
 ```ruby
-Bot.deliver({
+Facebook::Messenger::Bot.deliver({
   recipient: {
     id: '45123'
   },
@@ -391,16 +379,17 @@ 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
 
 ```ruby
-Bot.deliver({
+Facebook::Messenger::Bot.deliver({
   recipient: {
     id: '45123'
   },
@@ -409,7 +398,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
@@ -545,7 +534,7 @@ We suggest that you put your bot code in `app/bot`.
 
 include Facebook::Messenger
 
-Bot.on :message do |message|
+Faceboook::Messenger::Bot.on :message do |message|
   message.reply(text: 'Hello, human!')
 end
 ```
@@ -582,6 +571,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 +579,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 +589,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 +599,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 +631,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

@@ -13,7 +13,7 @@ module Facebook
       include HTTParty
 
       # Define base_uri for HTTParty.
-      base_uri 'https://graph.facebook.com/v3.2/me'
+      base_uri 'https://graph.facebook.com/v20.0'
 
       #
       # @return [Array] Array containing the supported webhook events.
@@ -31,6 +31,8 @@ module Facebook
         pass_thread_control
         game_play
         reaction
+        feed
+        leadgen
       ].freeze
 
       class << self
@@ -40,19 +42,47 @@ 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
 
-          response = post '/messages',
+          response = post '/me/messages',
+                          body: JSON.dump(message),
+                          format: :json,
+                          query: query
+
+          Facebook::Messenger::Bot::ErrorParser.raise_errors_from(response)
+
+          response.body
+        end
+
+        # Reply to a Facebook comment.
+        # @see https://developers.facebook.com/docs/graph-api/reference/v20.0/object/comments
+        #
+        # @raise [Facebook::Messenger::Bot::SendError] if there is any error
+        #   in response while sending the comment.
+        #
+        # @param [Hash] comment The comment payload
+        # @param [String] page_id The page ID to send the comment from
+        #
+        # Returns a Hash describing the API response if the comment was sent,
+        # or raises an exception if it was not.
+        def reply_to_comment(comment_id, message, 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
+
+          response = post "/#{comment_id}/comments",
                           body: JSON.dump(message),
                           format: :json,
                           query: query
@@ -138,6 +168,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/incoming/feed.rb

@@ -0,0 +1,16 @@
+module Facebook
+  module Messenger
+    module Incoming
+      class Feed
+        include Facebook::Messenger::Incoming::FeedCommon
+
+        def id
+          @change['value']['post_id']
+        end
+        def message
+          @change['value']['message']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Facebook
+  module Messenger
+    module Incoming
+      module FeedCommon
+        attr_reader :change
+
+        def initialize(change)
+          @change = change
+        end
+
+        def item
+          @change['item']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Facebook
+  module Messenger
+    module Incoming
+      class Leadgen
+        include Facebook::Messenger::Incoming::FeedCommon
+
+        def id
+          @change['value']['leadgen_id']
+        end
+      end
+    end
+  end
+end

data/lib/facebook/messenger/incoming.rb

@@ -13,6 +13,9 @@ require 'facebook/messenger/incoming/policy_enforcement'
 require 'facebook/messenger/incoming/pass_thread_control'
 require 'facebook/messenger/incoming/game_play'
 require 'facebook/messenger/incoming/message_reaction'
+require 'facebook/messenger/incoming/feed_common'
+require 'facebook/messenger/incoming/feed'
+require 'facebook/messenger/incoming/leadgen'
 
 module Facebook
   module Messenger
@@ -37,7 +40,9 @@ module Facebook
         'policy_enforcement' => PolicyEnforcement,
         'pass_thread_control' => PassThreadControl,
         'game_play' => GamePlay,
-        'reaction' => MessageReaction
+        'reaction' => MessageReaction,
+        'feed' => Feed,
+        'leadgen' => Leadgen,
       }.freeze
 
       # Parse the given payload and create new object of class related
@@ -54,7 +59,7 @@ module Facebook
         return MessageEcho.new(payload) if payload_is_echo?(payload)
 
         EVENTS.each do |event, klass|
-          return klass.new(payload) if payload.key?(event)
+          return klass.new(payload) if payload.key?(event) || payload['field'] == event
         end
 
         raise UnknownPayload, payload

data/lib/facebook/messenger/profile.rb

@@ -10,7 +10,7 @@ module Facebook
       include HTTParty
 
       # Define base_uri for HTTParty.
-      base_uri 'https://graph.facebook.com/v3.2/me'
+      base_uri 'https://graph.facebook.com/v20.0/me'
 
       format :json
 

data/lib/facebook/messenger/server.rb

@@ -144,8 +144,8 @@ module Facebook
       #
       def parsed_body
         @parsed_body ||= JSON.parse(body)
-      rescue JSON::ParserError
-        raise BadRequestError, 'Error parsing request body format'
+      rescue JSON::ParserError => error
+        raise BadRequestError, error
       end
 
       #
@@ -157,15 +157,26 @@ module Facebook
         # Facebook may batch several items in the 'entry' array during
         # periods of high load.
         events['entry'.freeze].each do |entry|
-          # 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|
-            Facebook::Messenger::Bot.receive(messaging)
+          if entry['messaging'.freeze]
+            entry['messaging'.freeze].each do |messaging|
+              Facebook::Messenger::Bot.receive(messaging)
+            end
           end
+          if entry['changes'.freeze]
+            entry['changes'.freeze].each do |change|
+              Facebook::Messenger::Bot.receive(change)
+            end
+          end
+          # d99d
+          if entry['standby'.freeze]
+            entry['standby'.freeze].each do |messaging|
+              Facebook::Messenger::Bot.receive(messaging)
+            end
+          end
+          # .
         end
       end
 

data/lib/facebook/messenger/subscriptions.rb

@@ -9,7 +9,7 @@ module Facebook
     module Subscriptions
       include HTTParty
 
-      base_uri 'https://graph.facebook.com/v3.2/me'
+      base_uri 'https://graph.facebook.com/v20.0/me'
 
       format :json
 

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.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2025-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -183,7 +183,10 @@ files:
 - lib/facebook/messenger/incoming/account_linking.rb
 - lib/facebook/messenger/incoming/common.rb
 - lib/facebook/messenger/incoming/delivery.rb
+- lib/facebook/messenger/incoming/feed.rb
+- lib/facebook/messenger/incoming/feed_common.rb
 - lib/facebook/messenger/incoming/game_play.rb
+- lib/facebook/messenger/incoming/leadgen.rb
 - lib/facebook/messenger/incoming/message.rb
 - lib/facebook/messenger/incoming/message_echo.rb
 - lib/facebook/messenger/incoming/message_reaction.rb
@@ -219,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Facebook Messenger client