facebook-messenger 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a67d299ebe188c1b50d8adcae153084eb694c4c
-  data.tar.gz: 2b882acad66c7260c99670b8b11dcd6771c18b1f
+  metadata.gz: 04588f9760568902f90018f5aa3fa15f9c21f99f
+  data.tar.gz: 93ae73db1af321f0bcd252ebb16671298a0a437b
 SHA512:
-  metadata.gz: 8fa27eacf08884194a942969822356c84e1de6c74d88b02451a858c5227351305a77e33d4c7eeba4dae146891b8d3c9d429924009bacb2055433db4c3947c071
-  data.tar.gz: 9f7975f548098478e922daf12433e19c28483edde278f0b7b6ee885ca2748c4d4107c06c4e25693f640210f35f1dc407fe9e3a5f461292fdade85fc4a9249933
+  metadata.gz: 8ebbc1a17931bf605c9918de42057d80b346c48ac1400f52580c42bcf73c0de26150e5d9ce05442d7cdb812ac1b9f83e31e506dfbd792340882b783c65fd939a
+  data.tar.gz: 4f00ba96f37b46e58b9a5e8519bafc67ae8bb89a65f60f331ab5089dee63feefa9f12a92127b1f4ec80de1fda175ad20b5617473baf3d9b0eff9c42921a71add

data/README.md

@@ -1,7 +1,14 @@
 <p align="center">
-  <img src="https://rawgit.com/hyperoslo/facebook-messenger/master/docs/example_conversation_with_logo.png">
+  <img src="https://rawgit.com/hyperoslo/facebook-messenger/master/docs/conversation_with_logo.gif">
 </p>
 
+
+[![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/hyperoslo/facebook-messenger)
+[![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)
+
 ## Installation
 
     $ gem install facebook-messenger
@@ -20,7 +27,7 @@ include Facebook::Messenger
 
 Bot.on :message do |message|
   message.id      # => 'mid.1457764197618:41d102a3e1ae206a38'
-  message.sender  # => { id: '1008372609250235' }
+  message.sender  # => { 'id' => '1008372609250235' }
   message.seq     # => 73
   message.sent_at # => 2016-04-22 21:30:36 +0200
   message.text    # => 'Hello, bot!'
@@ -98,8 +105,8 @@ When the human has selected an option, you can act on it:
 
 ```ruby
 Bot.on :postback do |postback|
-  postback.sender    # => { id: '1008372609250235' }
-  postback.recipient # => { id: '2015573629214912' }
+  postback.sender    # => { 'id' => '1008372609250235' }
+  postback.recipient # => { 'id' => '2015573629214912' }
   postback.sent_at   # => 2016-04-22 21:30:36 +0200
   postback.payload   # => 'EXTERMINATE'
 
@@ -118,10 +125,10 @@ embedded on a website, you will receive an `optin` event.
 
 ```ruby
 Bot.on :optin do |optin|
-  postback.sender    # => { id: '1008372609250235' }
-  postback.recipient # => { id: '2015573629214912' }
-  postback.sent_at   # => 2016-04-22 21:30:36 +0200
-  postback.ref       # => 'CONTACT_SKYNET'
+  optin.sender    # => { 'id' => '1008372609250235' }
+  optin.recipient # => { 'id' => '2015573629214912' }
+  optin.sent_at   # => 2016-04-22 21:30:36 +0200
+  optin.ref       # => 'CONTACT_SKYNET'
 
   Bot.deliver(
     recipient: {
@@ -132,7 +139,7 @@ Bot.on :optin do |optin|
     }
   )
 end
-
+```
 
 #### Message delivery receipts
 
@@ -141,8 +148,8 @@ You can stalk the human:
 ```ruby
 Bot.on :delivery do |delivery|
   delivery.ids       # => 'mid.1457764197618:41d102a3e1ae206a38'
-  delivery.sender    # => { id: '1008372609250235' }
-  delivery.recipient # => { id: '2015573629214912' }
+  delivery.sender    # => { 'id' => '1008372609250235' }
+  delivery.recipient # => { 'id' => '2015573629214912' }
   delivery.at        # => 2016-04-22 21:30:36 +0200
   delivery.seq       # => 37
 
@@ -154,8 +161,8 @@ end
 
 ### Create an Application on Facebook
 
-Create an Application on [developers.facebook.com][facebook-developers] and go
-to the Messenger tab. Select the Page you want to install your bot on.
+Create an Application on [developers.facebook.com] and go to the Messenger
+tab. Select the Page you want to install your bot on.
 
 Create a new webhook, enter the domain your bot is connected to and a verify
 token of your choosing.
@@ -180,6 +187,10 @@ from Facebook:
 Facebook::Messenger::Subscriptions.subscribe
 ```
 
+### Run it
+
+##### ... with Rack
+
 The bot runs on [Rack][rack], so you hook it up like you would an ordinary
 web application:
 
@@ -195,6 +206,38 @@ run Facebook::Messenger::Server
 $ rackup
 ```
 
+##### ... with Rails
+
+Rails doesn't give you much that you'll need for a bot, but if you have an
+existing application that you'd like to launch it from or just like Rails
+a lot, you can mount it:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  # ...
+
+  mount Facebook::Messenger::Server, at: 'bot'
+end
+```
+
+We suggest that you put your bot code in `app/bot`.
+
+```ruby
+# app/bot/example.rb
+
+include Facebook::Messenger
+
+Bot.on :message do |message|
+  Bot.deliver(
+    recipient: message.sender,
+    message: {
+      text: 'Hello, human!'
+    }
+  )
+end
+```
 
 ## Development
 
@@ -225,6 +268,6 @@ If you're using Facebook Messenger, we probably want to [hire you].
 [MIT License]: http://opensource.org/licenses/MIT
 [rubygems.org]: https://rubygems.org
 [message-documentation]: https://developers.facebook.com/docs/messenger-platform/send-api-reference#request
-[facebook-developers]: https://developers.facebook.com
+[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

data/lib/facebook/messenger/bot.rb

@@ -60,7 +60,7 @@ module Facebook
         # event - A String describing a Messenger event.
         # args - Arguments to pass to the hook.
         def trigger(event, *args)
-          @hooks.fetch(event).call(*args)
+          hooks.fetch(event).call(*args)
         rescue KeyError
           $stderr.puts "Ignoring #{event} (no hook registered)"
         end

data/lib/facebook/messenger/incoming.rb

@@ -8,19 +8,21 @@ module Facebook
     # The Incoming module parses and abstracts incoming requests from
     # Facebook Messenger.
     module Incoming
+      EVENTS = {
+        'message' => Message,
+        'delivery' => Delivery,
+        'postback' => Postback,
+        'optin' => Optin
+      }.freeze
+
       # Parse the given payload.
       #
       # payload - A Hash describing a payload from Facebook.
       #
       # * https://developers.facebook.com/docs/messenger-platform/webhook-reference
       def self.parse(payload)
-        {
-          'message' => Message,
-          'delivery' => Delivery,
-          'postback' => Postback,
-          'optin' => Optin
-        }.each do |key, klass|
-          return klass.new(payload) if payload.key? key
+        EVENTS.each do |event, klass|
+          return klass.new(payload) if payload.key?(event)
         end
 
         raise UnknownPayload, payload

data/lib/facebook/messenger/server.rb

@@ -6,48 +6,46 @@ module Facebook
     # This module holds the server that processes incoming messages from the
     # Facebook Messenger Platform.
     class Server
-      class << self
-        def call(env)
-          @request = Rack::Request.new(env)
-          @response = Rack::Response.new
-
-          case @request.request_method
-          when 'GET' then verify
-          when 'POST' then receive
-          else method_not_allowed
-          end
-        end
+      def self.call(env)
+        new.call(env)
+      end
 
-        def verify
-          verify_token = Facebook::Messenger.config.verify_token
+      def call(env)
+        @request = Rack::Request.new(env)
+        @response = Rack::Response.new
 
-          if @request.params['hub.verify_token'] == verify_token
-            @response.write @request.params['hub.challenge']
-          else
-            @response.write 'Error; wrong verify token'
-          end
-
-          @response.finish
+        case
+        when @request.get? then verify
+        when @request.post? then receive
+        else @response.status = 405
         end
 
-        def receive
-          hash = JSON.parse(@request.body.read)
-          # Facebook may batch several items in the 'entry' array during
-          # periods of high load.
-          hash['entry'].each do |entry|
-            # Facebook may batch several items in the 'messaging' array during
-            # periods of high load.
-            entry['messaging'].each do |messaging|
-              Facebook::Messenger::Bot.receive(messaging)
-            end
-          end
+        @response.finish
+      end
 
-          @response.finish
+      def verify
+        if @request['hub.verify_token'] == verify_token
+          @response.write @request['hub.challenge']
+        else
+          @response.write 'Error; wrong verify token'
         end
+      end
+
+      def verify_token
+        Facebook::Messenger.config.verify_token
+      end
 
-        def method_not_allowed
-          @response.status = 405
-          @response.finish
+      def receive
+        hash = JSON.parse(@request.body.read)
+
+        # Facebook may batch several items in the 'entry' array during
+        # periods of high load.
+        hash['entry'].each do |entry|
+          # Facebook may batch several items in the 'messaging' array during
+          # periods of high load.
+          entry['messaging'].each do |messaging|
+            Facebook::Messenger::Bot.receive(messaging)
+          end
         end
       end
     end

data/lib/facebook/messenger/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Messenger
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook-messenger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,14 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement