message_quickly 1.0.0

data/lib/message_quickly/messaging/postback_event.rb

@@ -0,0 +1,44 @@
+require "message_quickly/messaging/event"
+
+module MessageQuickly
+  module Messaging
+    class PostbackEvent < Event
+
+      attr_reader :payload
+
+      def initialize(params = {})
+        initialize_params(params['postback'])
+        super(params)
+      end
+
+      def webhook_name
+        :messaging_postbacks
+      end
+
+    end
+  end
+end
+
+# {
+#   "object":"page",
+#   "entry":[
+#     {
+#       "id":PAGE_ID,
+#       "time":1458692752478,
+#       "messaging":[
+#         {
+#           "sender":{
+#             "id":USER_ID
+#           },
+#           "recipient":{
+#             "id":PAGE_ID
+#           },
+#           "timestamp":1458692752478,
+#           "postback":{
+#             "payload":"USER_DEFINED_PAYLOAD"
+#           }
+#         }
+#       ]
+#     }
+#   ]
+# }

data/lib/message_quickly/messaging/receipt/address.rb

@@ -0,0 +1,31 @@
+module MessageQuickly
+  module Messaging
+    module Receipt
+      class Address < MessageQuickly::Messaging::Base
+
+        attr_accessor :street_1, :street_2, :city, :postal_code, :state, :country
+
+        def to_hash
+          {
+            street_1: street_1,
+            street_2: street_2,
+            city: city,
+            postal_code: postal_code,
+            state: state,
+            country: country
+          }
+        end
+
+      end
+    end
+  end
+end
+
+# "address":{
+#   "street_1":"1 Hacker Way",
+#   "street_2":"",
+#   "city":"Menlo Park",
+#   "postal_code":"94025",
+#   "state":"CA",
+#   "country":"US"
+# }

data/lib/message_quickly/messaging/receipt/adjustment.rb

@@ -0,0 +1,23 @@
+module MessageQuickly
+  module Messaging
+    module Receipt
+      class Adjustment < MessageQuickly::Messaging::Base
+
+        attr_accessor :name, :amount
+
+        def to_hash
+          {
+            name: name,
+            amount: amount
+          }
+        end
+
+      end
+    end
+  end
+end
+
+# {
+#   "name":"New Customer Discount",
+#   "amount":20
+# }

data/lib/message_quickly/messaging/receipt/element.rb

@@ -0,0 +1,22 @@
+module MessageQuickly
+  module Messaging
+    module Receipt
+      class Element < MessageQuickly::Messaging::Element
+
+        attr_accessor :quantity, :price, :currency
+
+        def to_hash
+          {
+            title: title,
+            subtitle: subtitle,
+            quantity: quantity,
+            price: price,
+            currency: currency,
+            image_url: image_url
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/message_quickly/messaging/receipt/summary.rb

@@ -0,0 +1,27 @@
+module MessageQuickly
+  module Messaging
+    module Receipt
+      class Summary < MessageQuickly::Messaging::Base
+
+        attr_accessor :subtotal, :shipping_cost, :total_tax, :total_cost
+
+        def to_hash
+          {
+            subtotal: subtotal,
+            shipping_cost: shipping_cost,
+            total_tax: total_tax,
+            total_cost: total_cost
+          }
+        end
+
+      end
+    end
+  end
+end
+
+# "summary":{
+#   "subtotal":75.00,
+#   "shipping_cost":4.95,
+#   "total_tax":6.19,
+#   "total_cost":56.14
+# }

data/lib/message_quickly/messaging/receipt_template_attachment.rb

@@ -0,0 +1,108 @@
+module MessageQuickly
+  module Messaging
+    class ReceiptTemplateAttachment < TemplateAttachment
+
+      attr_accessor :recipient_name, :order_number, :currency, :payment_method, :order_url, :timestamp, :elements, :address, :summary, :adjustments
+
+      def initialize(params = {})
+        self.elements ||= []
+        self.address ||= Receipt::Address.new
+        self.summary ||= Receipt::Summary.new
+        self.adjustments ||= []
+        params['template_type'] ||= 'receipt'
+        super(params)
+      end
+
+      def build_element
+        elements << Receipt::Element.new.tap { |element| yield element }
+      end
+
+      def build_address
+        yield address
+      end
+
+      def build_summary
+        yield summary
+      end
+
+      def build_adjustment
+        adjustments << Receipt::Adjustment.new.tap { |adjustment| yield adjustment }
+      end
+
+      def to_hash
+        {
+          type: type,
+          payload: {
+            template_type: template_type,
+            recipient_name: recipient_name,
+            order_number: order_number,
+            currency: currency,
+            payment_method: payment_method,
+            order_url: order_url,
+            timestamp: timestamp,
+            elements: elements.collect { |element| element.to_hash },
+            address: address.to_hash,
+            summary: summary.to_hash,
+            adjustments: adjustments.collect { |adjustment| adjustment.to_hash }
+          }
+        }
+      end
+
+    end
+  end
+end
+
+# "attachment":{
+#   "type":"template",
+#   "payload":{
+#     "template_type":"receipt",
+#     "recipient_name":"Stephane Crozatier",
+#     "order_number":"12345678902",
+#     "currency":"USD",
+#     "payment_method":"Visa 2345",        
+#     "order_url":"http://petersapparel.parseapp.com/order?order_id=123456",
+#     "timestamp":"1428444852", 
+#     "elements":[
+#       {
+#         "title":"Classic White T-Shirt",
+#         "subtitle":"100% Soft and Luxurious Cotton",
+#         "quantity":2,
+#         "price":50,
+#         "currency":"USD",
+#         "image_url":"http://petersapparel.parseapp.com/img/whiteshirt.png"
+#       },
+#       {
+#         "title":"Classic Gray T-Shirt",
+#         "subtitle":"100% Soft and Luxurious Cotton",
+#         "quantity":1,
+#         "price":25,
+#         "currency":"USD",
+#         "image_url":"http://petersapparel.parseapp.com/img/grayshirt.png"
+#       }
+#     ],
+#     "address":{
+#       "street_1":"1 Hacker Way",
+#       "street_2":"",
+#       "city":"Menlo Park",
+#       "postal_code":"94025",
+#       "state":"CA",
+#       "country":"US"
+#     },
+#     "summary":{
+#       "subtotal":75.00,
+#       "shipping_cost":4.95,
+#       "total_tax":6.19,
+#       "total_cost":56.14
+#     },
+#     "adjustments":[
+#       {
+#         "name":"New Customer Discount",
+#         "amount":20
+#       },
+#       {
+#         "name":"$10 Off Coupon",
+#         "amount":10
+#       }
+#     ]
+#   }
+# }

data/lib/message_quickly/messaging/recipient.rb

@@ -0,0 +1,17 @@
+module MessageQuickly
+  module Messaging
+    class Recipient < User
+
+      attr_accessor :phone_number
+
+      def to_hash
+        if id.present?
+          { id: id }
+        else
+          { phone_number: phone_number }
+        end
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/sender.rb

@@ -0,0 +1,6 @@
+module MessageQuickly
+  module Messaging
+    class Sender < User
+    end
+  end
+end

data/lib/message_quickly/messaging/template_attachment.rb

@@ -0,0 +1,14 @@
+module MessageQuickly
+  module Messaging
+    class TemplateAttachment < Attachment
+
+      attr_accessor :template_type
+
+      def initialize(params = {})
+        params['type'] ||= 'template'
+        super(params)
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/user.rb

@@ -0,0 +1,23 @@
+module MessageQuickly
+  module Messaging
+    class User < Base
+
+      attr_reader :id, :first_name, :last_name, :profile_pic
+
+      def first_name
+        @first_name || user_profile.first_name
+      end
+
+      def last_name
+        @last_name || user_profile.last_name
+      end
+
+      private
+
+      def user_profile
+        @user_profile ||= MessageQuickly::Api::UserProfile.find(id)
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/web_url_button.rb

@@ -0,0 +1,24 @@
+module MessageQuickly
+  module Messaging
+    class WebUrlButton < Button
+
+      attr_accessor :url
+
+      def initialize(params = {})
+        params['type'] ||= 'web_url'
+        super(params)
+      end
+
+      def to_hash
+        { type: type, url: url, title: title }
+      end
+
+    end
+  end
+end
+
+# {
+#   "type":"web_url",
+#   "url":"https://petersapparel.parseapp.com",
+#   "title":"Show Website"
+# }

data/lib/message_quickly/version.rb

@@ -0,0 +1,4 @@
+module MessageQuickly
+  VERSION = "1.0.0"
+  FB_MESSENGER_VERSION = "v2.6"
+end

data/lib/message_quickly.rb

@@ -0,0 +1,22 @@
+require "message_quickly/version"
+
+require "message_quickly/api/client"
+require "message_quickly/api/base"
+require "message_quickly/api/messages"
+require "message_quickly/api/facebook_api_exception"
+require "message_quickly/api/oauth_exception"
+require "message_quickly/api/graph_method_exception"
+require "message_quickly/api/no_matching_user_exception"
+require "message_quickly/api/not_permitted_exception"
+require "message_quickly/api/send_message_exception"
+require "message_quickly/api/thread_settings"
+require "message_quickly/api/user_profile"
+
+require "message_quickly/engine"
+
+require "message_quickly/callback"
+require "message_quickly/callback_parser"
+require "message_quickly/callback_registry"
+
+module MessageQuickly
+end

data/spec/callback_parser_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module MessageQuickly
+
+  describe CallbackParser do
+    
+    context 'with a optin request' do
+
+      let(:optin_json) { JSON.parse(File.read("spec/fixtures/optin_request.json")) }
+
+      subject { CallbackParser.new(optin_json) }
+
+      it { expect { |b| subject.parse(&b) }.to yield_with_args(Messaging::OptinEvent) }
+      it { expect(subject.parse).not_to be_empty }
+
+    end
+
+    context 'with a delivery request' do
+
+      let(:delivery_json) { JSON.parse(File.read("spec/fixtures/delivery_request.json")) }
+
+      subject { CallbackParser.new(delivery_json) }
+
+      it { expect { |b| subject.parse(&b) }.to yield_with_args(Messaging::DeliveryEvent) }
+      it { expect(subject.parse).not_to be_empty }
+
+    end
+
+    context 'with a message request' do
+
+      let(:message_json) { JSON.parse(File.read("spec/fixtures/message_request.json")) }
+
+      subject { CallbackParser.new(message_json) }
+
+      it { expect { |b| subject.parse(&b) }.to yield_with_args(Messaging::MessageEvent) }
+      it { expect(subject.parse).not_to be_empty }
+
+    end
+
+    context 'with a postback request' do
+
+      let(:postback_json) { JSON.parse(File.read("spec/fixtures/postback_request.json")) }
+
+      subject { CallbackParser.new(postback_json) }
+
+      it { expect { |b| subject.parse(&b) }.to yield_with_args(Messaging::PostbackEvent) }
+      it { expect(subject.parse).not_to be_empty }
+
+    end
+
+  end
+
+end

data/spec/callback_registry_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module MessageQuickly
+  describe CallbackRegistry do
+
+  end
+end

data/spec/controllers/webhooks_controller_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe MessageQuickly::WebhooksController, type: :controller do
+
+  routes { MessageQuickly::Engine.routes }
+
+  describe 'GET #verify' do
+
+    context 'with valid token' do
+      before { get :verify, 'hub.verify_token': ENV['FACEBOOK_MESSENGER_VERIFICATION_TOKEN'], 'hub.challenge': '123456' }
+      it { expect(response.body).to eq('123456') }
+      it { expect(response).to have_http_status(200) }
+    end
+
+    context 'with invalid token' do
+      before { get :verify, 'hub.verify_token': '<invalid token>', 'hub.challenge': '123456' }
+      it { expect(response.body).to eq('Wrong validation token') }
+      it { expect(response).to have_http_status(500) }
+    end
+    
+  end
+
+  describe 'POST #callback' do
+
+    context 'with an optin request' do
+
+      let(:optin_json) { File.read("spec/fixtures/optin_request.json") }
+
+      context 'with valid params' do
+        before { post :callback, optin_json }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      context 'with invalid params' do
+        before { post :callback, 'invalid json' }
+        it { expect(response.body).to eq('Error processing callback') }
+        it { expect(response).to have_http_status(500) }
+      end
+
+    end
+
+    context 'with a delivery request' do
+
+      let(:optin_json) { File.read("spec/fixtures/delivery_request.json") }
+
+      context 'with valid params' do
+        before { post :callback, optin_json }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      context 'with invalid params' do
+        before { post :callback, 'invalid json' }
+        it { expect(response.body).to eq('Error processing callback') }
+        it { expect(response).to have_http_status(500) }
+      end
+
+    end
+
+    context 'with a message request' do
+
+      let(:optin_json) { File.read("spec/fixtures/message_request.json") }
+
+      context 'with valid params' do
+        before { post :callback, optin_json }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      context 'with invalid params' do
+        before { post :callback, 'invalid json' }
+        it { expect(response.body).to eq('Error processing callback') }
+        it { expect(response).to have_http_status(500) }
+      end
+
+    end
+
+    context 'with a postback request' do
+
+      let(:optin_json) { File.read("spec/fixtures/postback_request.json") }
+
+      context 'with valid params' do
+        before { post :callback, optin_json }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      context 'with invalid params' do
+        before { post :callback, 'invalid json' }
+        it { expect(response.body).to eq('Error processing callback') }
+        it { expect(response).to have_http_status(500) }
+      end
+
+    end
+
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/process_messenger_callback_job.rb

@@ -0,0 +1,13 @@
+class ProcessMessengerCallbackJob < ActiveJob::Base
+
+  queue_as :messaging
+
+  def perform(json)
+    MessageQuickly::CallbackParser.new(json.deep_dup).parse do |event|
+      callback_handler = MessageQuickly::CallbackRegistry.handler_for(event.webhook_name)
+      return unless callback_handler.present?
+      callback_handler.new.run(event, json)
+    end
+  end
+
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/webhooks/authentication_callback.rb

@@ -0,0 +1,10 @@
+class AuthenticationCallback < MessageQuickly::Callback
+
+  def callback_name
+    :messaging_optins
+  end
+
+  def run(event, json)
+  end
+
+end

data/spec/dummy/app/webhooks/message_delivered_callback.rb

@@ -0,0 +1,10 @@
+class MessageDeliveredCallback < MessageQuickly::Callback
+
+  def callback_name
+    :message_deliveries
+  end
+
+  def run(event, json)
+  end
+
+end

data/spec/dummy/app/webhooks/message_received_callback.rb

@@ -0,0 +1,10 @@
+class MessageReceivedCallback < MessageQuickly::Callback
+
+  def callback_name
+    :messages
+  end
+
+  def run(event, json)
+  end
+
+end