message_quickly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21279dc223fc0f6b479e69362523c487b396b574
+  data.tar.gz: 0c1ab814d05652215757b7922e05dbd7220a9153
+SHA512:
+  metadata.gz: 38cd46f284b303c47dcc3653c706c44831ee87ba04497d958b62c20dce4d3427d2032c5d2f14138cff5e55053f643af7940435916eebc5aa0dee0ebdd3c2d6df
+  data.tar.gz: 3325e5fa6b2cf9cb79ed681a8426cb045de26e70d2a2c3ce571eb1b94beb6b3ebfd4c7911d127e96de6971fd33ad4355104f4b138ea61aa04b6e1f4105fa58e4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Jaryl Sim
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MessageQuickly'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/message_quickly/index.js.erb

@@ -0,0 +1,15 @@
+window.fbAsyncInit = function() {
+    FB.init({
+    appId      : '<%= ENV['FACEBOOK_APP_ID'] %>',
+    xfbml      : true,
+    version    : 'v2.6'
+  });
+};
+
+(function(d, s, id){
+   var js, fjs = d.getElementsByTagName(s)[0];
+   if (d.getElementById(id)) {return;}
+   js = d.createElement(s); js.id = id;
+   js.src = "//connect.facebook.net/en_US/sdk.js";
+   fjs.parentNode.insertBefore(js, fjs);
+ }(document, 'script', 'facebook-jssdk'));

data/app/assets/stylesheets/message_quickly/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/app/controllers/message_quickly/application_controller.rb

@@ -0,0 +1,4 @@
+module MessageQuickly
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/message_quickly/webhooks_controller.rb

@@ -0,0 +1,23 @@
+module MessageQuickly
+  class WebhooksController < ApplicationController
+
+    skip_before_action :verify_authenticity_token
+
+    def verify
+      if params['hub.verify_token'] == ENV['FACEBOOK_MESSENGER_VERIFICATION_TOKEN']
+        render plain: params['hub.challenge'], status: 200
+      else
+        render plain: 'Wrong validation token', status: 500
+      end
+    end
+
+    def callback
+      json = JSON.parse(request.body.read)
+      ProcessMessengerCallbackJob.perform_later(json)
+      render nothing: true, status: 200
+    rescue JSON::ParserError => e
+      render plain: 'Error processing callback', status: 500
+    end
+
+  end
+end

data/app/helpers/message_quickly/application_helper.rb

@@ -0,0 +1,25 @@
+module MessageQuickly
+  module ApplicationHelper
+
+    def send_to_messenger(params = {})
+      params[:class] = 'fb-send-to-messenger'
+      params[:messenger_app_id] = ENV['FACEBOOK_APP_ID']
+      params[:page_id] = ENV['FACEBOOK_PAGE_ID']
+      params[:data] ||= {}
+      params[:data][:ref] ||= 'PASS_THROUGH_PARAM'
+      params[:color] ||= 'blue'
+      params[:size] ||= 'standard'
+      content_tag(:div, '', params)
+    end
+
+    def message_us(params = {})
+      params[:class] = 'fb-messengermessageus'
+      params[:messenger_app_id] = ENV['FACEBOOK_APP_ID']
+      params[:page_id] = ENV['FACEBOOK_PAGE_ID']
+      params[:color] ||= 'blue'
+      params[:size] ||= 'standard'
+      content_tag(:div, '', params)
+    end
+
+  end
+end

data/app/views/layouts/message_quickly/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MessageQuickly</title>
+  <%= stylesheet_link_tag    "message_quickly/application", media: "all" %>
+  <%= javascript_include_tag "message_quickly/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+MessageQuickly::Engine.routes.draw do
+  get '/' => 'webhooks#verify'
+  post '/' => 'webhooks#callback'
+end

data/lib/generators/message_quickly/callbacks/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate callbacks
+
+    This will create:
+        app/webhooks/authentication_callback.rb
+        app/webhooks/message_delivered_callback.rb
+        app/webhooks/message_received_callback.rb
+        app/webhooks/postback_callback.rb

data/lib/generators/message_quickly/callbacks/callbacks_generator.rb

@@ -0,0 +1,23 @@
+module MessageQuickly
+  module Generators
+    class CallbacksGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_webhooks
+
+        copy_file "webhooks.rb", "config/initializers/webhooks.rb"
+
+        copy_file "authentication_callback.rb", "app/webhooks/authentication_callback.rb"
+        copy_file "message_delivered_callback.rb", "app/webhooks/message_delivered_callback.rb"
+        copy_file "message_received_callback.rb", "app/webhooks/message_received_callback.rb"
+        copy_file "postback_callback.rb", "app/webhooks/postback_callback.rb"
+
+        copy_file "process_messenger_callback_job.rb", "app/jobs/process_messenger_callback_job.rb"
+        copy_file "send_messenger_delivery_job.rb", "app/jobs/send_messenger_delivery_job.rb"
+
+      end
+
+    end
+  end
+end

data/lib/generators/message_quickly/callbacks/templates/authentication_callback.rb

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

data/lib/generators/message_quickly/callbacks/templates/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/lib/generators/message_quickly/callbacks/templates/message_received_callback.rb

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

data/lib/generators/message_quickly/callbacks/templates/postback_callback.rb

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

data/lib/generators/message_quickly/callbacks/templates/process_messenger_callback_job.rb

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

data/lib/generators/message_quickly/callbacks/templates/send_messenger_delivery_job.rb

@@ -0,0 +1,20 @@
+class SendMessengerDeliveryJob < ActiveJob::Base
+
+  queue_as :messaging
+
+  def perform(hash)
+    MessageQuickly::Api::Client.create_from_hash(hash)
+  end
+
+  # To use this:
+
+  # recipient = MessageQuickly::Messaging::Recipient.new(id: '<facebook page specific id here>')
+  # delivery = MessageQuickly::Messaging::Delivery.new(recipient: recipient) do |delivery|
+  #   delivery.build_message do |message|
+  #     message.text = 'Hello'
+  #   end
+  # end
+  #
+  # SendMessengerDeliveryJob.perform_later(delivery.to_hash)
+
+end

data/lib/generators/message_quickly/callbacks/templates/webhooks.rb

@@ -0,0 +1,5 @@
+Rails.application.eager_load!
+
+MessageQuickly::Callback.subclasses.each do |callback|
+  MessageQuickly::CallbackRegistry.register(callback)
+end

data/lib/message_quickly/api/base.rb

@@ -0,0 +1,20 @@
+require "faraday"
+
+module MessageQuickly
+  module Api
+    class Base
+
+      def self.client
+        @@client ||= Client.new do |client|
+          client.page_access_token = ENV['FACEBOOK_MESSENGER_PAGE_ACCESS_TOKEN']
+          client.page_id = ENV['FACEBOOK_MESSENGER_PAGE_ID']
+        end
+      end
+
+      def initialize(override_client = nil)
+        @client = override_client || self.class.client
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/client.rb

@@ -0,0 +1,62 @@
+require "faraday"
+
+module MessageQuickly
+  module Api
+    class Client
+
+      attr_accessor :page_access_token, :page_id
+
+      def initialize(options = {})
+        options.each { |key, value| instance_variable_set("@#{key}", value) }
+        yield self if block_given?
+      end
+
+      def get(request_string, params = {})
+        params[:access_token] = page_access_token
+        response = connection.get(request_string, params)
+        parse_json(response)
+      end
+
+      def post(request_string, params = {})
+        params[:access_token] = page_access_token
+        response = connection.post(request_string) do |request|
+          if params[:filedata].present?
+            request.headers['Content-Type'] = 'multipart/form-data'
+            request.body = params
+          else
+            request.headers['Content-Type'] = 'application/json'
+            request.body = JSON.generate(params)
+          end
+        end
+        parse_json(response)
+      end
+
+      private
+
+      def parse_json(response)
+        json = JSON.parse(response.body)
+        if json['error']
+          case json['error']['type']
+          when 'OAuthException'
+            raise OauthException.new(json['error'])
+          when 'GraphMethodException'
+            raise GraphMethodException.new(json['error'])
+          else
+            raise FacebookApiException.new(json['error'])
+          end
+        end
+        json
+      end
+
+      def connection(params = {})
+        @connection ||= Faraday.new(:url => "https://graph.facebook.com/#{MessageQuickly::FB_MESSENGER_VERSION}") do |faraday|
+          faraday.request :multipart # if params[:multipart]
+          faraday.request  :url_encoded # form-encode POST params
+          faraday.response :logger unless Rails.env.test? # log requests to STDOUT
+          faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
+        end
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/facebook_api_exception.rb

@@ -0,0 +1,31 @@
+module MessageQuickly
+  module Api
+    class FacebookApiException < StandardError
+
+      attr_reader :code, :error_data, :fbtrace_id
+
+      def initialize(params = {})
+        @message = params['message']
+        @code = params['code']
+        @error_data = params['error_data']
+        @fbtrace_id = params['fbtrace_id']
+        super(message)
+      end
+
+      def message
+        "#{@message}: #{@error_data}"
+      end
+
+    end
+  end
+end
+
+# {
+#    "error":{
+#       "message":"Invalid parameter",
+#       "type":"FacebookApiException",
+#       "code":100,
+#       "error_data":"No matching user found.",
+#       "fbtrace_id":"D2kxCybrKVw"
+#    }
+# }

data/lib/message_quickly/api/graph_method_exception.rb

@@ -0,0 +1,20 @@
+module MessageQuickly
+  module Api
+    class GraphMethodException < StandardError
+
+      attr_reader :code, :fbtrace_id
+
+      def initialize(params = {})
+        @message = params['message']
+        @code = params['code']
+        @fbtrace_id = params['fbtrace_id']
+        super(message)
+      end
+
+      def message
+        @message
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/messages.rb

@@ -0,0 +1,46 @@
+module MessageQuickly
+  module Api
+    class Messages < Base
+
+      def self.create(recipient = nil, delivery = nil, &block)
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #   "recipient":{
+        #       "id":"USER_ID"
+        #   },
+        #   "message":{
+        #       "text":"hello, world!"
+        #   }
+        # }' "https://graph.facebook.com/v2.6/me/messages?access_token=PAGE_ACCESS_TOKEN"
+
+        # {
+        #   "recipient_id": "1008372609250235",
+        #   "message_id": "mid.1456970487936:c34767dfe57ee6e339"
+        # }
+        Messages.new.create(recipient, delivery, &block)
+      end
+
+      def create(recipient = nil, delivery = nil, &block)
+        delivery ||= MessageQuickly::Messaging::Delivery.new(recipient: recipient)
+        block.call(delivery.message) if block
+        delivery.id = perform_call(delivery.to_hash)
+        delivery
+      end
+
+      def self.create_from_hash(hash)
+        Messages.new.create_from_hash(hash)
+      end
+
+      def create_from_hash(hash)
+        perform_call(hash)
+      end
+
+      private
+
+      def perform_call(hash)
+        json = @client.post("me/messages", hash)
+        json['message_id']
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/no_matching_user_exception.rb

@@ -0,0 +1,6 @@
+module MessageQuickly
+  module Api
+    class NoMatchingUserException < FacebookApiException
+    end
+  end
+end

data/lib/message_quickly/api/not_permitted_exception.rb

@@ -0,0 +1,6 @@
+module MessageQuickly
+  module Api
+    class NotPermittedException < FacebookApiException
+    end
+  end
+end

data/lib/message_quickly/api/oauth_exception.rb

@@ -0,0 +1,20 @@
+module MessageQuickly
+  module Api
+    class OauthException < StandardError
+
+      attr_reader :code, :fbtrace_id
+
+      def initialize(params = {})
+        @message = params['message']
+        @code = params['code']
+        @fbtrace_id = params['fbtrace_id']
+        super(message)
+      end
+
+      def message
+        @message
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/send_message_exception.rb

@@ -0,0 +1,6 @@
+module MessageQuickly
+  module Api
+    class SendMessageException < FacebookApiException
+    end
+  end
+end

data/lib/message_quickly/api/thread_settings.rb

@@ -0,0 +1,43 @@
+module MessageQuickly
+  module Api
+    class ThreadSettings < Base
+
+      def self.create(message)
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #   "setting_type":"call_to_actions",
+        #   "thread_state":"new_thread",
+        #   "call_to_actions":[
+        #     {
+        #       "message":{
+        #         "text":"Welcome to My Company!"
+        #       }
+        #     }
+        #   ]
+        # }' "https://graph.facebook.com/v2.6/<PAGE_ID>/thread_settings?access_token=<PAGE_ACCESS_TOKEN>"
+        ThreadSettings.new.create(message)
+      end
+
+      def self.delete
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #   "setting_type":"call_to_actions",
+        #   "thread_state":"new_thread",
+        #   "call_to_actions":[]
+        # }' "https://graph.facebook.com/v2.6/<PAGE_ID>/thread_settings?access_token=<PAGE_ACCESS_TOKEN>"
+        ThreadSettings.new.delete
+      end
+
+      def create(message)
+        request_string = "#{ENV['FACEBOOK_MESSENGER_PAGE_ID']}/thread_settings"
+        json = @client.post(request_string, { setting_type: 'call_to_actions', thread_state: 'new_thread', call_to_actions: [{ message: { text: message } }] })
+        json['result'] == "Successfully added new_thread's CTAs"
+      end
+
+      def delete
+        request_string = "#{ENV['FACEBOOK_MESSENGER_PAGE_ID']}/thread_settings"
+        json = @client.post(request_string, { setting_type: 'call_to_actions', thread_state: 'new_thread', call_to_actions: [] })
+        json['result'] == "Successfully removed all new_thread's CTAs"
+      end
+
+    end
+  end
+end

data/lib/message_quickly/api/user_profile.rb

@@ -0,0 +1,22 @@
+module MessageQuickly
+  module Api
+    class UserProfile < Base
+
+      def self.find(id)
+        # curl -X GET "https://graph.facebook.com/v2.6/<USER_ID>?fields=first_name,last_name,profile_pic&access_token=<PAGE_ACCESS_TOKEN>"
+        # {
+        #   "first_name": "Peter",
+        #   "last_name": "Chang",
+        #   "profile_pic": "https://fbcdn-profile-a.akamaihd.net/hprofile...70ec9c19b18"
+        # }
+        UserProfile.new.find(id)
+      end
+
+      def find(id)
+        json = @client.get(id, { fields: 'first_name,last_name,profile_pic' })
+        Messaging::User.new(json)
+      end
+
+    end
+  end
+end

data/lib/message_quickly/callback.rb

@@ -0,0 +1,4 @@
+module MessageQuickly
+  class Callback
+  end
+end