facebook-messenger 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f17a2863cfd6e0797b3a942f6fb5959557be525c40e1efc698542a6ab3662ac6
-  data.tar.gz: e94ac387ab7174e04429cc5afa2b27121fb1bfd03afa3067e3ed61db3b4f34ba
+  metadata.gz: b757052cad527d03939514250e2f3fc87fbc21e0e7c86e9f78c8a2087ed925f1
+  data.tar.gz: 9f18c41169ded5554f49e3faa2e22a94565f83461bc2de688ad87957426791a1
 SHA512:
-  metadata.gz: 2d673c880dfd1647805347e666586aa7478be689b2660e2a91a69084d7b63f576509c917751b7fcc10f8fa8f28147fe1ff8041a196d8aa5850a2bfa0dd1d60c5
-  data.tar.gz: 801a4fa53d78bfd7e03cf365b57899b25ac085f12507b8307d468b132dac2caeff2d149ee5eb521967548933ded81f0a27957995257e2a0e2a6f21870aec5555
+  metadata.gz: 23d252fce2c080a7d95f1b25795ca423e7efac86c52e7dc158203c4f0b840d3b7c14b499919a3d9fab58cdf49e1bed274a7220f25b31c235e0e93fb457e45ff2
+  data.tar.gz: 1aa9d963cfecb848d000a4df931a1d30430005eff5b5f58cc18f8094092956077b354e589527770007e081b3f8d0cf7a67f1229da21a3b1ce453ff94a7dbca65

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!'
@@ -47,7 +49,7 @@ Bot.deliver({
   message: {
     text: 'Human?'
   },
-  message_type: Facebook::Messenger::Bot::MessagingType::UPDATE
+  messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
 }, access_token: ENV['ACCESS_TOKEN'], app_secret_proof: app_secret_proof
 )
 ```
@@ -56,7 +58,7 @@ NOTE: `app_secret_proof` is an optional parameter to [secure your requests](http
 and you can generate it from your configuration provider like so:
 
 ```ruby
-configuration_provider = Facebook::Messenger::Configuration::Providers.Environment.new
+configuration_provider = Facebook::Messenger::Configuration::Providers::Environment.new
 app_secret_proof = configuration_provider.app_secret_proof_for(page_id)
 ```
 
@@ -132,6 +134,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 +215,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]
@@ -245,6 +278,17 @@ Bot.on :referral do |referral|
 end
 ```
 
+#### Pass thread control
+
+Another bot can pass a human to you:
+
+```ruby
+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
+```
+
 #### Change messenger profile
 
 You can greet new humans to entice them into talking to you, in different locales:
@@ -346,7 +390,7 @@ Bot.deliver({
   message: {
     text: 'Human?'
   },
-  message_type: Facebook::Messenger::Bot::MessagingType::UPDATE
+  messaging_type: Facebook::Messenger::Bot::MessagingType::UPDATE
 }, access_token: ENV['ACCESS_TOKEN'])
 ```
 
@@ -363,7 +407,7 @@ 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'])
 ```
@@ -438,6 +482,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

data/lib/facebook/messenger/bot.rb

@@ -28,6 +28,9 @@ module Facebook
         message_echo
         payment
         policy_enforcement
+        pass_thread_control
+        game_play
+        reaction
       ].freeze
 
       class << self
@@ -38,19 +41,17 @@ module Facebook
         #   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 [String] page_id A String describing the Facebook Page ID 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 = Facebook::Messenger.config.provider.access_token_for(page_id)
+          app_secret_proof = Facebook::Messenger.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,

data/lib/facebook/messenger/incoming.rb

@@ -10,6 +10,9 @@ require 'facebook/messenger/incoming/account_linking'
 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
@@ -31,7 +34,10 @@ module Facebook
         'message_echo' => MessageEcho,
         'message_request' => MessageRequest,
         'payment' => Payment,
-        'policy_enforcement' => PolicyEnforcement
+        'policy_enforcement' => PolicyEnforcement,
+        '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/incoming/pass_thread_control.rb

@@ -0,0 +1,22 @@
+module Facebook
+  module Messenger
+    module Incoming
+      # The PassThreadControl class represents an incoming Facebook Messenger
+      # pass thread control event.
+      #
+      # @see https://developers.facebook.com/docs/messenger-platform/handover-protocol/pass-thread-control
+      # @see https://developers.facebook.com/docs/messenger-platform/reference/handover-protocol/pass-thread-control
+      class PassThreadControl
+        include Facebook::Messenger::Incoming::Common
+
+        def new_owner_app_id
+          @messaging['pass_thread_control']['new_owner_app_id']
+        end
+
+        def metadata
+          @messaging['pass_thread_control']['metadata']
+        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.2.0'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-13 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,10 +183,13 @@ 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
 - lib/facebook/messenger/incoming/payment.rb
 - lib/facebook/messenger/incoming/policy_enforcement.rb
 - lib/facebook/messenger/incoming/postback.rb
@@ -216,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