facebook-messenger 1.3.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbeade2fa81a2b697fa7635b0fbe0e4bead497dadce5191405efa0b1eab4ad3c
-  data.tar.gz: efadea4a20f49814f28148993b2e87b5ccd310c2d513f8feea4a1f62526118ce
+  metadata.gz: 8b91271ca1dfd46644af4c45a6e64670c36cf2c8de5efa288ec2bf04e43bef44
+  data.tar.gz: 57611671a09c7784c4cfe92e461a9b9444e6d18e3f1ee02784291f5af2effaa1
 SHA512:
-  metadata.gz: 2222ed8d1a46dab7dd554017ffb7a7a3619476cc688f81ce7acd303d50cec9f7d0da3bbe642bd548502ec62ffafde5516d5fde6cc04f840d22c4123c6b99d2e1
-  data.tar.gz: 014b6a913f77baf595d2672a97d9c13e8804c63862e7d7fb84ff50f51e5b34ee1fc31da1bf1446ddbe3330cb3d206b88b3871c119556902b63ffc5496b492b1e
+  metadata.gz: c91d9b3fc8bf84c8acf14034f2f916477e67418b8baf7df1c6f87fb35f0e4a5f3d207a1386e33a70ed18b8ad1466023e93d50eb248a7c110b05c460f0154450f
+  data.tar.gz: aa8656efd52e1cb39980c11a86596739e1045848bb78edd13c6a568febaa1ed60f8b2ede932baa8f3f27917506f64ade3cbe2690be5892be555a7c83aaa61d4a

data/README.md

@@ -4,9 +4,10 @@
 
 
 [![Gem Version](https://img.shields.io/gem/v/facebook-messenger.svg?style=flat)](https://rubygems.org/gems/facebook-messenger)
-[![Build Status](https://img.shields.io/travis/hyperoslo/facebook-messenger.svg?style=flat)](https://travis-ci.org/jgorset/facebook-messenger)
-[![Code Climate](https://img.shields.io/codeclimate/github/hyperoslo/facebook-messenger.svg?style=flat)](https://codeclimate.com/github/jgorset/facebook-messenger)
-[![Coverage Status](https://img.shields.io/coveralls/hyperoslo/facebook-messenger.svg?style=flat)](https://coveralls.io/r/jgorset/facebook-messenger)
+[![Gem Downloads](https://img.shields.io/gem/dt/facebook-messenger.svg)](https://rubygems.org/gems/facebook-messenger)
+[![Build Status](https://img.shields.io/travis/jgorset/facebook-messenger.svg?style=flat)](https://travis-ci.org/jgorset/facebook-messenger)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/jgorset/facebook-messenger.svg)](https://codeclimate.com/github/jgorset/facebook-messenger)
+[![Coverage Status](https://coveralls.io/repos/github/jgorset/facebook-messenger/badge.svg?branch=master)](https://coveralls.io/github/jgorset/facebook-messenger?branch=master)
 [![Documentation Coverage](http://inch-ci.org/github/jgorset/facebook-messenger.svg?branch=master)](http://inch-ci.org/github/jgorset/facebook-messenger)
 
 ## Installation
@@ -28,6 +29,7 @@ include Facebook::Messenger
 Bot.on :message do |message|
   message.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
   message.sender      # => { 'id' => '1008372609250235' }
+  message.recipient   # => { 'id' => '2015573629214912' }
   message.seq         # => 73
   message.sent_at     # => 2016-04-22 21:30:36 +0200
   message.text        # => 'Hello, bot!'
@@ -42,27 +44,15 @@ end
 ```ruby
 Bot.deliver({
   recipient: {
-    id: '45123'
+    id: YOUR_RECIPIENT_ID
   },
   message: {
     text: 'Human?'
   },
-  message_type: Facebook::Messenger::Bot::MessagingType::UPDATE
-}, 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)
+  messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
+}, page_id: YOUR_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:
@@ -132,6 +122,20 @@ end
 
 *See Facebook's [documentation][message-documentation] for all message options.*
 
+##### Reactions
+
+Humans have feelings, and they can react to your messages. You can pretend to understand:
+
+```ruby
+Bot.on :reaction do |message|
+  message.emoji # => "👍"
+  message.action # => "react"
+  message.reaction # => "like"
+
+  message.reply(text: 'Your feelings have been registered')
+end
+```
+
 ##### Typing indicator
 
 Show the human you are preparing a message for them:
@@ -199,6 +203,23 @@ Bot.on :message_request do |message_request|
 end
 ```
 
+##### Record instant game progress
+
+You can keep track of instant game progress:
+
+```ruby
+Bot.on :game_play do |game_play|
+  game_play.sender    # => { 'id' => '1008372609250235' }
+  game_play.recipient # => { 'id' => '2015573629214912' }
+  game_play.sent_at   # => 2016-04-22 21:30:36 +0200
+  game_play.game      # => "<GAME-APP-ID>"
+  game_play.player    # => "<PLAYER-ID>"
+  game_play.context   # => { 'context_type' => "<CONTEXT-TYPE:SOLO|THREAD>", 'context_id' => "<CONTEXT-ID>" }
+  game_play.score     # => 100
+  game_play.payload   # => "<PAYLOAD>"
+end
+```
+
 #### Send to Facebook
 
 When the human clicks the [Send to Messenger button][send-to-messenger-plugin]
@@ -272,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
@@ -283,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.
@@ -329,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)
@@ -343,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
@@ -357,11 +380,12 @@ Bot.deliver({
   message: {
     text: 'Human?'
   },
-  message_type: Facebook::Messenger::Bot::MessagingType::UPDATE
-}, access_token: ENV['ACCESS_TOKEN'])
+  messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
+}, 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
@@ -374,9 +398,9 @@ Bot.deliver({
   message: {
     text: 'Human?'
   },
-  message_type: Facebook::Messenger::Bot::MessagingType::MESSAGE_TAG
+  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
@@ -449,6 +473,8 @@ Facebook::Messenger.configure do |config|
 end
 ```
 
+You can get the current configuration provider with `Facebook::Messenger.config.provider`.
+
 ### Subscribe your Application to a Page
 
 Once you've configured your bot, subscribe it to the Page to get messages
@@ -547,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.
 
@@ -554,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'
@@ -563,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]
   )
 
@@ -573,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'
 
@@ -603,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

@@ -29,6 +29,8 @@ module Facebook
         payment
         policy_enforcement
         pass_thread_control
+        game_play
+        reaction
       ].freeze
 
       class << self
@@ -38,20 +40,18 @@ 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] 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
+        # @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, access_token:, app_secret_proof: nil)
-          query = {
-            access_token: access_token
-          }
+        def deliver(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 '/messages',
                           body: JSON.dump(message),
                           format: :json,
@@ -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/incoming.rb

@@ -11,6 +11,8 @@ require 'facebook/messenger/incoming/referral'
 require 'facebook/messenger/incoming/payment'
 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'
 
 module Facebook
   module Messenger
@@ -33,7 +35,9 @@ module Facebook
         'message_request' => MessageRequest,
         'payment' => Payment,
         'policy_enforcement' => PolicyEnforcement,
-        'pass_thread_control' => PassThreadControl
+        'pass_thread_control' => PassThreadControl,
+        'game_play' => GamePlay,
+        'reaction' => MessageReaction
       }.freeze
 
       # Parse the given payload and create new object of class related

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

@@ -18,6 +18,7 @@ module Facebook
 
         #
         # Function return PSID of sender.
+        #
         # @see https://developers.facebook.com/docs/messenger-platform/identity
         #   Info about PSID.
         # @see https://developers.facebook.com/docs/messenger-platform/webhook#format
@@ -30,7 +31,7 @@ module Facebook
         end
 
         #
-        # Function return the page of id from which the message is arrived.
+        # Function return id of the page from which the message has arrived.
         #
         # @return [String] Facebook page id.
         #
@@ -54,7 +55,6 @@ module Facebook
         #
         # Function return timestamp when message is sent.
         #
-        #
         # @return [Object] Message time sent.
         #
         def sent_at
@@ -74,7 +74,7 @@ module Facebook
             sender_action: 'typing_on'
           }
 
-          deliver_payload(payload)
+          Facebook::Messenger::Bot.deliver(payload, page_id: recipient['id'])
         end
 
         #
@@ -90,7 +90,7 @@ module Facebook
             sender_action: 'typing_off'
           }
 
-          deliver_payload(payload)
+          Facebook::Messenger::Bot.deliver(payload, page_id: recipient['id'])
         end
 
         #
@@ -106,7 +106,7 @@ module Facebook
             sender_action: 'mark_seen'
           }
 
-          deliver_payload(payload)
+          Facebook::Messenger::Bot.deliver(payload, page_id: recipient['id'])
         end
 
         #
@@ -123,28 +123,7 @@ module Facebook
             message_type: Facebook::Messenger::Bot::MessageType::RESPONSE
           }
 
-          deliver_payload(payload)
-        end
-
-        #
-        # Function returns the configured access token.
-        #
-        # @return [String] Access token.
-        #
-        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)
+          Facebook::Messenger::Bot.deliver(payload, page_id: recipient['id'])
         end
       end
     end

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

@@ -0,0 +1,39 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The GamePlay class represents an incoming Facebook Messenger
+      #   game_play events.
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_game_plays
+      class GamePlay
+        include Facebook::Messenger::Incoming::Common
+
+        def game_play
+          @messaging['game_play']
+        end
+
+        def payload
+          game_play['payload']
+        end
+
+        def score
+          game_play['score']
+        end
+
+        def game
+          game_play['game_id']
+        end
+
+        def player
+          game_play['player_id']
+        end
+
+        def context
+          {
+            context_id: game_play['context_id'],
+            context_type: game_play['context_type']
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The Message echo class represents an incoming Facebook Messenger message
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-reactions
+      class MessageReaction
+        include Facebook::Messenger::Incoming::Common
+
+        def action
+          @messaging['reaction']['action']
+        end
+
+        def emoji
+          @messaging['reaction']['emoji']
+        end
+
+        def reaction
+          @messaging['reaction']['reaction']
+        end
+      end
+    end
+  end
+end

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/v2.9/me'
+      base_uri 'https://graph.facebook.com/v3.2/me'
 
       format :json
 

data/lib/facebook/messenger/subscriptions.rb

@@ -28,10 +28,12 @@ module Facebook
       # @return [Boolean] TRUE
       #
       def subscribe(access_token:, subscribed_fields: [])
-        response = post '/subscribed_apps', query: {
-          access_token: access_token,
-          subscribed_fields: subscribed_fields
-        }
+        response = post '/subscribed_apps',
+                        headers: { 'Content-Type' => 'application/json' },
+                        body: {
+                          access_token: access_token,
+                          subscribed_fields: subscribed_fields
+                        }.to_json
 
         raise_errors(response)
 

data/lib/facebook/messenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -106,28 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 3.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 3.8.1
 description: Facebook Messenger client
 email:
 - jgorset@gmail.com
@@ -183,8 +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/game_play.rb
 - lib/facebook/messenger/incoming/message.rb
 - lib/facebook/messenger/incoming/message_echo.rb
+- lib/facebook/messenger/incoming/message_reaction.rb
 - lib/facebook/messenger/incoming/message_request.rb
 - lib/facebook/messenger/incoming/optin.rb
 - lib/facebook/messenger/incoming/pass_thread_control.rb
@@ -217,8 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Facebook Messenger client