facebook-messenger 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a7696b57e99d377b17191c4e5af80b046a510bc
-  data.tar.gz: f5f3833b93525960127c6bb2531cbfa127ac125f
+  metadata.gz: 4cc6286ba13cf8c0c5239c5c50645cfce5af44c6
+  data.tar.gz: 1c8ab52a23996258d2f4db0254424727471c8c3e
 SHA512:
-  metadata.gz: 7036944b12c06ba4de4263c1f17a46b2cc83f76b1b33933c1f02536144a459a36f2274f22912de0892e1e97a254a6a438cd45b73985eb63b7b706cdcd5081487
-  data.tar.gz: a261a4406b6a5ef5685ec0dd9b634aaf28554b164ec03852f1d4a8fb15a24b081ad3c89ce3ae5420dc13bb6c8b4a6408cdd8fa31e8423a4dae0ed9d39c9f762b
+  metadata.gz: 0ecf386733c99eea428f1704d569703a8f2959412e4bde1139a0d64c5e4dc94d31d34ad9daeb95bd00dfd82de0af35128d7a9a011ffb9c41cc527dfa9c47b569
+  data.tar.gz: 09382794eb526905b5aa4d809156f05ac5dad9794ab920977dc1cb6ff98b47f954a4e0a350cdb86a1555731943ce195cad2fbd543dded414708a904aa1ee36fc

data/README.md

@@ -8,6 +8,7 @@
 [![Dependency Status](https://img.shields.io/gemnasium/hyperoslo/facebook-messenger.svg?style=flat)](https://gemnasium.com/hyperoslo/facebook-messenger)
 [![Code Climate](https://img.shields.io/codeclimate/github/hyperoslo/facebook-messenger.svg?style=flat)](https://codeclimate.com/github/hyperoslo/facebook-messenger)
 [![Coverage Status](https://img.shields.io/coveralls/hyperoslo/facebook-messenger.svg?style=flat)](https://coveralls.io/r/hyperoslo/facebook-messenger)
+[![Join the chat at https://gitter.im/hyperoslo/facebook-messenger](https://badges.gitter.im/hyperoslo/facebook-messenger.svg)](https://gitter.im/hyperoslo/facebook-messenger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Installation
 
@@ -26,11 +27,12 @@ require 'facebook/messenger'
 include Facebook::Messenger
 
 Bot.on :message do |message|
-  message.id      # => 'mid.1457764197618:41d102a3e1ae206a38'
-  message.sender  # => { 'id' => '1008372609250235' }
-  message.seq     # => 73
-  message.sent_at # => 2016-04-22 21:30:36 +0200
-  message.text    # => 'Hello, bot!'
+  message.id          # => 'mid.1457764197618:41d102a3e1ae206a38'
+  message.sender      # => { 'id' => '1008372609250235' }
+  message.seq         # => 73
+  message.sent_at     # => 2016-04-22 21:30:36 +0200
+  message.text        # => 'Hello, bot!'
+  message.attachments # => [ { 'type' => 'image', 'payload' => { 'url' => 'https://www.example.com/1.jpg' } } ]
 
   Bot.deliver(
     recipient: message.sender,
@@ -129,9 +131,7 @@ Bot.on :optin do |optin|
   optin.ref       # => 'CONTACT_SKYNET'
 
   Bot.deliver(
-    recipient: {
-      id: '45123'
-    },
+    recipient: optin.sender,
     message: {
       text: 'Ah, human!'
     }
@@ -169,13 +169,24 @@ token of your choosing.
 
 Use the generated access token and your verify token to configure your bot:
 
+##### ... pass a block, or
+
 ```ruby
 Facebook::Messenger.configure do |config|
   config.access_token = 'EAAG6WgW...'
+  config.app_secret = '__app_secret_here__'
   config.verify_token = 'my_voice_is_my_password_verify_me'
 end
 ```
 
+##### ... set directly
+
+```ruby
+Facebook::Messenger.config.access_token = 'EAAG6WgW...'
+Facebook::Messenger.config.app_secret = '__app_secret_here__'
+Facebook::Messenger.config.verify_token = 'my_voice_is_my_password_verify_me'
+```
+
 ### Subscribe your Application to a Page
 
 Once you've configured your bot, subscribe it to the Page to get messages
@@ -243,11 +254,14 @@ reference constants. You'll need to explicitly load `app/bot`, then:
 
 ```ruby
 # config/initializers/bot.rb
-if Rails.env.production?
+unless Rails.env.production?
   Dir["#{Rails.root}/app/bot/**/*.rb"].each { |file| require file }
 end
 ```
 
+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.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run
@@ -280,3 +294,4 @@ If you're using Facebook Messenger, we probably want to [hire you].
 [developers.facebook.com]: https://developers.facebook.com/
 [rack]: https://github.com/rack/rack
 [send-to-messenger-plugin]: https://developers.facebook.com/docs/messenger-platform/plugin-reference
+[ngrok]: https://ngrok.com/

data/lib/facebook/messenger.rb

@@ -10,11 +10,15 @@ module Facebook
   # All the code for this gem resides in this module.
   module Messenger
     def self.configure
-      yield Configuration
+      yield config
     end
 
     def self.config
-      Configuration
+      @config ||= Configuration.new
+    end
+
+    def self.config=(config)
+      @config = config
     end
 
     configure do |config|

data/lib/facebook/messenger/bot.rb

@@ -45,13 +45,13 @@ module Facebook
         #
         # * https://developers.facebook.com/docs/messenger-platform/webhook-reference
         def receive(payload)
-          klass = Facebook::Messenger::Incoming.parse(payload)
+          callback = Facebook::Messenger::Incoming.parse(payload)
 
-          case klass
-          when Incoming::Message then trigger(:message, klass)
-          when Incoming::Delivery then trigger(:delivery, klass)
-          when Incoming::Postback then trigger(:postback, klass)
-          when Incoming::Optin then trigger(:optin, klass)
+          case callback
+          when Incoming::Message then trigger(:message, callback)
+          when Incoming::Delivery then trigger(:delivery, callback)
+          when Incoming::Postback then trigger(:postback, callback)
+          when Incoming::Optin then trigger(:optin, callback)
           end
         end
 

data/lib/facebook/messenger/configuration.rb

@@ -1,11 +1,10 @@
 module Facebook
   module Messenger
     # This module holds the configuration.
-    module Configuration
-      class << self
-        attr_accessor :access_token
-        attr_accessor :verify_token
-      end
+    class Configuration
+      attr_accessor :access_token
+      attr_accessor :app_secret
+      attr_accessor :verify_token
     end
   end
 end

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

@@ -3,28 +3,30 @@ module Facebook
     module Incoming
       # The Delivery class represents the receipt of a delivered message.
       class Delivery
-        def initialize(payload)
-          @payload = payload
+        attr_reader :messaging
+
+        def initialize(messaging)
+          @messaging = messaging
         end
 
         def ids
-          @payload['delivery']['mids']
+          @messaging['delivery']['mids']
         end
 
         def at
-          Time.at(@payload['delivery']['watermark'] / 1000)
+          Time.at(@messaging['delivery']['watermark'] / 1000)
         end
 
         def seq
-          @payload['delivery']['seq']
+          @messaging['delivery']['seq']
         end
 
         def sender
-          @payload['sender']
+          @messaging['sender']
         end
 
         def recipient
-          @payload['recipient']
+          @messaging['recipient']
         end
       end
     end

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

@@ -3,28 +3,34 @@ module Facebook
     module Incoming
       # The Message class represents an incoming Facebook Messenger message.
       class Message
-        def initialize(payload)
-          @payload = payload
+        attr_reader :messaging
+
+        def initialize(messaging)
+          @messaging = messaging
         end
 
         def id
-          @payload['message']['mid']
+          @messaging['message']['mid']
         end
 
         def sender
-          @payload['sender']
+          @messaging['sender']
         end
 
         def seq
-          @payload['message']['seq']
+          @messaging['message']['seq']
         end
 
         def sent_at
-          Time.at(@payload['timestamp'] / 1000)
+          Time.at(@messaging['timestamp'] / 1000)
         end
 
         def text
-          @payload['message']['text']
+          @messaging['message']['text']
+        end
+
+        def attachments
+          @messaging['message']['attachments']
         end
       end
     end

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

@@ -6,24 +6,26 @@ module Facebook
       #
       # https://developers.facebook.com/docs/messenger-platform/plugin-reference
       class Optin
-        def initialize(payload)
-          @payload = payload
+        attr_reader :messaging
+
+        def initialize(messaging)
+          @messaging = messaging
         end
 
         def sender
-          @payload['sender']
+          @messaging['sender']
         end
 
         def recipient
-          @payload['recipient']
+          @messaging['recipient']
         end
 
         def sent_at
-          Time.at(@payload['timestamp'] / 1000)
+          Time.at(@messaging['timestamp'] / 1000)
         end
 
         def ref
-          @payload['optin']['ref']
+          @messaging['optin']['ref']
         end
       end
     end

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

@@ -3,24 +3,26 @@ module Facebook
     module Incoming
       # The Postback class represents an incoming Facebook Messenger postback.
       class Postback
-        def initialize(payload)
-          @payload = payload
+        attr_reader :messaging
+
+        def initialize(messaging)
+          @messaging = messaging
         end
 
         def sender
-          @payload['sender']
+          @messaging['sender']
         end
 
         def recipient
-          @payload['recipient']
+          @messaging['recipient']
         end
 
         def sent_at
-          Time.at(@payload['timestamp'] / 1000)
+          Time.at(@messaging['timestamp'] / 1000)
         end
 
         def payload
-          @payload['postback']['payload']
+          @messaging['postback']['payload']
         end
       end
     end

data/lib/facebook/messenger/server.rb

@@ -1,5 +1,6 @@
 require 'rack'
 require 'json'
+require 'openssl'
 
 module Facebook
   module Messenger
@@ -14,18 +15,19 @@ module Facebook
         @request = Rack::Request.new(env)
         @response = Rack::Response.new
 
-        case
-        when @request.get? then verify
-        when @request.post? then receive
+        if @request.get? then verify
+        elsif @request.post? then receive
         else @response.status = 405
         end
 
         @response.finish
       end
 
+      private
+
       def verify
-        if @request['hub.verify_token'] == verify_token
-          @response.write @request['hub.challenge']
+        if @request.params['hub.verify_token'] == verify_token
+          @response.write @request.params['hub.challenge']
         else
           @response.write 'Error; wrong verify token'
         end
@@ -36,6 +38,8 @@ module Facebook
       end
 
       def receive
+        return if app_secret && !integrity?
+
         hash = JSON.parse(@request.body.read)
 
         # Facebook may batch several items in the 'entry' array during
@@ -48,6 +52,32 @@ module Facebook
           end
         end
       end
+
+      def integrity?
+        Rack::Utils.secure_compare(x_hub_signature, signature)
+      end
+
+      def x_hub_signature
+        @request.env['HTTP_X_HUB_SIGNATURE'.freeze]
+      end
+
+      def signature
+        format('sha1=%s'.freeze, generate_hmac(@request.body.read))
+      ensure
+        @request.body.rewind
+      end
+
+      def generate_hmac(content)
+        OpenSSL::HMAC.hexdigest(
+          OpenSSL::Digest.new('sha1'),
+          app_secret,
+          content
+        )
+      end
+
+      def app_secret
+        Facebook::Messenger.config.app_secret
+      end
     end
   end
 end

data/lib/facebook/messenger/subscriptions.rb

@@ -8,30 +8,38 @@ module Facebook
 
       base_uri 'https://graph.facebook.com/v2.6/me'
 
-      def self.subscribe
-        response = post '/subscribed_apps', format: :json, query: {
-          access_token: Facebook::Messenger.config.access_token
-        }
+      format :json
+
+      module_function
+
+      def subscribe
+        response = post '/subscribed_apps'
 
         raise_errors(response)
 
         true
       end
 
-      def self.unsubscribe
-        response = delete '/subscribed_apps', format: :json, query: {
-          access_token: Facebook::Messenger.config.access_token
-        }
+      def unsubscribe
+        response = delete '/subscribed_apps'
 
         raise_errors(response)
 
         true
       end
 
-      def self.raise_errors(response)
+      def raise_errors(response)
         raise Error, response['error']['message'] if response.key? 'error'
       end
 
+      def default_options
+        super.merge(
+          query: {
+            access_token: Facebook::Messenger.config.access_token
+          }
+        )
+      end
+
       class Error < Facebook::Messenger::Error; end
     end
   end

data/lib/facebook/messenger/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Messenger
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,14 +28,14 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency