message_quickly 1.0.0

data/lib/message_quickly/callback_parser.rb

@@ -0,0 +1,86 @@
+require 'json'
+
+require "message_quickly/messaging/base"
+require "message_quickly/messaging/attachment"
+require "message_quickly/messaging/image_attachment"
+require "message_quickly/messaging/template_attachment"
+require "message_quickly/messaging/element"
+require "message_quickly/messaging/button"
+require "message_quickly/messaging/web_url_button"
+require "message_quickly/messaging/postback_button"
+require "message_quickly/messaging/button_template_attachment"
+require "message_quickly/messaging/generic_template_attachment"
+
+require "message_quickly/messaging/receipt/address"
+require "message_quickly/messaging/receipt/adjustment"
+require "message_quickly/messaging/receipt/element"
+require "message_quickly/messaging/receipt/summary"
+require "message_quickly/messaging/receipt_template_attachment"
+
+require "message_quickly/messaging/delivery"
+require "message_quickly/messaging/message"
+require "message_quickly/messaging/entry"
+require "message_quickly/messaging/user"
+require "message_quickly/messaging/recipient"
+require "message_quickly/messaging/sender"
+
+require "message_quickly/messaging/event"
+require "message_quickly/messaging/optin_event"
+require "message_quickly/messaging/delivery_event"
+require "message_quickly/messaging/message_event"
+require "message_quickly/messaging/postback_event"
+
+module MessageQuickly
+  class CallbackParser
+
+    def initialize(json)
+      @json = json
+    end
+
+    WEBHOOK_LOOKUP = {
+      optin: MessageQuickly::Messaging::OptinEvent,
+      postback: MessageQuickly::Messaging::PostbackEvent,
+      delivery: MessageQuickly::Messaging::DeliveryEvent,
+      message: MessageQuickly::Messaging::MessageEvent
+    }
+
+    def parse
+      events = []
+      process_entry_json(@json['entry']) do |params|
+        WEBHOOK_LOOKUP.keys.each do |key|
+          if params[:messaging][key.to_s]
+            events << WEBHOOK_LOOKUP[key].new(params[:messaging])
+            break
+          end
+        end
+      end
+      events.each { |event| yield event if block_given? }
+      events
+    end
+
+    private
+
+    def process_entry_json(json)
+      json.each do |entry_json|
+        entry = Messaging::Entry.new(entry_json)
+        entry_json['messaging'].each do |event_json|
+          sender = Messaging::Sender.new(event_json['sender'])
+          recipient = Messaging::Recipient.new(event_json['recipient'])
+          timestamp = event_json['timestamp']
+          yield callback_params(entry, sender, recipient, timestamp, event_json)
+        end
+      end
+    end
+
+    def callback_params(entry, sender, recipient, timestamp, event_json)
+      {
+        entry: entry,
+        sender: sender,
+        recipient: recipient,
+        timestamp: timestamp,
+        messaging: event_json
+      }
+    end
+
+  end
+end

data/lib/message_quickly/callback_registry.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module MessageQuickly
+  class CallbackRegistry
+
+    module ClassMethods
+
+      attr_reader :callbacks
+
+      def register(klass)
+        @callbacks[klass.new.callback_name] = klass.to_s
+      end
+
+      def handler_for(webhook_name)
+        @callbacks[webhook_name]&.constantize
+      end
+
+    end
+
+    extend ClassMethods
+
+  end
+
+  CallbackRegistry.class_eval do
+    @callbacks = {}
+  end
+
+end

data/lib/message_quickly/engine.rb

@@ -0,0 +1,20 @@
+module MessageQuickly
+
+  class Engine < ::Rails::Engine
+
+    isolate_namespace MessageQuickly
+
+    initializer 'message_quickly.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper MessageQuickly::ApplicationHelper
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+
+  end
+end

data/lib/message_quickly/messaging/attachment.rb

@@ -0,0 +1,14 @@
+module MessageQuickly
+  module Messaging
+    class Attachment < Base
+
+      attr_reader :type, :payload
+
+      def file?
+        false
+      end
+
+    end
+  end
+end
+

data/lib/message_quickly/messaging/base.rb

@@ -0,0 +1,12 @@
+module MessageQuickly
+  module Messaging
+    class Base
+
+      def initialize(params = {})
+        params.each { |key, value| instance_variable_set("@#{key}", value) }
+        self
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/button.rb

@@ -0,0 +1,9 @@
+module MessageQuickly
+  module Messaging
+    class Button < Base
+
+      attr_accessor :type, :title
+
+    end
+  end
+end

data/lib/message_quickly/messaging/button_template_attachment.rb

@@ -0,0 +1,56 @@
+module MessageQuickly
+  module Messaging
+    class ButtonTemplateAttachment < TemplateAttachment
+
+      attr_accessor :text, :buttons
+
+      def initialize(params = {})
+        self.buttons ||= []
+        params['template_type'] ||= 'button'
+        super(params)
+      end
+
+      def build_button(button_type)
+        case button_type
+        when :web_url
+          button = WebUrlButton.new
+        when :postback
+          button = PostbackButton.new
+        end
+        buttons << button.tap { |button| yield button }
+      end
+
+      def to_hash
+        {
+          type: type,
+          payload: {
+            template_type: template_type,
+            text: text,
+            buttons: buttons.collect { |button| button.to_hash }
+          }
+        }
+      end
+
+    end
+  end
+end
+
+# "attachment":{
+#   "type":"template",
+#   "payload":{
+#     "template_type":"button",
+#     "text":"What do you want to do next?",
+#     "buttons":[
+#       {
+#         "type":"web_url",
+#         "url":"https://petersapparel.parseapp.com",
+#         "title":"Show Website"
+#       },
+#       {
+#         "type":"postback",
+#         "title":"Start Chatting",
+#         "payload":"USER_DEFINED_PAYLOAD"
+#       }
+#     ]
+#   }
+# }

data/lib/message_quickly/messaging/delivery.rb

@@ -0,0 +1,29 @@
+module MessageQuickly
+  module Messaging
+    class Delivery
+
+      attr_accessor :id, :recipient, :message
+      attr_accessor :notification_type # must be of values: REGULAR, SILENT_PUSH, NO_PUSH
+
+      def initialize(options = {})
+        self.message ||= MessageQuickly::Messaging::Message.new
+        options.each { |key, value| instance_variable_set("@#{key}", value) }
+        yield self if block_given?
+      end
+
+      def build_message
+        yield self.message
+      end
+
+      def to_hash
+        hash = {}
+        hash.merge!(recipient: recipient.to_hash) if recipient
+        hash.merge!(message: message.to_hash) if message
+        hash.merge!(notification_type: notification_type) if notification_type
+        hash.merge!(filedata: Faraday::UploadIO.new(message.attachment.file, message.attachment.file_type)) if message.attachment && message.attachment.file?
+        hash
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/delivery_event.rb

@@ -0,0 +1,47 @@
+require "message_quickly/messaging/event"
+
+module MessageQuickly
+  module Messaging
+    class DeliveryEvent < Event
+
+      attr_reader :mids, :watermark, :seq
+
+      def initialize(params = {})
+        initialize_params(params['delivery'])
+        super(params)
+      end
+
+      def webhook_name
+        :message_deliveries
+      end
+
+    end
+  end
+end
+
+# {
+#    "object":"page",
+#    "entry":[
+#       {
+#          "id":PAGE_ID,
+#          "time":1458668856451,
+#          "messaging":[
+#             {
+#                "sender":{
+#                   "id":USER_ID
+#                },
+#                "recipient":{
+#                   "id":PAGE_ID
+#                },
+#                "delivery":{
+#                   "mids":[
+#                      "mid.1458668856218:ed81099e15d3f4f233"
+#                   ],
+#                   "watermark":1458668856253,
+#                   "seq":37
+#                }
+#             }
+#          ]
+#       }
+#    ]
+# }

data/lib/message_quickly/messaging/element.rb

@@ -0,0 +1,33 @@
+module MessageQuickly
+  module Messaging
+    class Element < MessageQuickly::Messaging::Base
+
+      attr_accessor :title, :image_url, :subtitle, :buttons
+
+      def initialize(params = {})
+        self.buttons ||= []
+        super(params)
+      end
+
+      def build_button(button_type)
+        case button_type
+        when :web_url
+          button = WebUrlButton.new
+        when :postback
+          button = PostbackButton.new
+        end
+        buttons << button.tap { |button| yield button }
+      end
+
+      def to_hash
+        {
+          title: title,
+          image_url: image_url,
+          subtitle: subtitle,
+          buttons: buttons.collect { |button| button.to_hash }
+        }
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/entry.rb

@@ -0,0 +1,14 @@
+module MessageQuickly
+  module Messaging
+    class Entry
+
+      attr_accessor :id, :time
+
+      def initialize(params = {})
+        @id = params['id']
+        @time = params['time']
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/event.rb

@@ -0,0 +1,21 @@
+module MessageQuickly
+  module Messaging
+    class Event < Base
+
+      attr_reader :entry, :sender, :recipient, :timestamp
+
+      def initialize(params = {})
+        @sender = Sender.new(params.delete("sender"))
+        @recipient = Recipient.new(params.delete("recipient"))
+        super(params)
+      end
+
+      protected
+
+      def initialize_params(params)
+        params.each { |key, value| instance_variable_set("@#{key}", value) }
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/generic_template_attachment.rb

@@ -0,0 +1,82 @@
+module MessageQuickly
+  module Messaging
+    class GenericTemplateAttachment < TemplateAttachment
+
+      attr_accessor :text, :elements
+
+      def initialize(params = {})
+        self.elements ||= []
+        params['template_type'] ||= 'generic'
+        super(params)
+      end
+
+      def build_element
+        elements << Element.new.tap { |element| yield element }
+      end
+
+      def to_hash
+        {
+          type: type,
+          payload: {
+            template_type: template_type,
+            elements: elements.collect { |element| element.to_hash }
+          }
+        }
+      end
+
+    end
+  end
+end
+
+# "attachment":{
+#   "type":"template",
+#   "payload":{
+#     "template_type":"generic",
+#     "elements":[
+#       {
+#         "title":"Classic White T-Shirt",
+#         "image_url":"http://petersapparel.parseapp.com/img/item100-thumb.png",
+#         "subtitle":"Soft white cotton t-shirt is back in style",
+#         "buttons":[
+#           {
+#             "type":"web_url",
+#             "url":"https://petersapparel.parseapp.com/view_item?item_id=100",
+#             "title":"View Item"
+#           },
+#           {
+#             "type":"web_url",
+#             "url":"https://petersapparel.parseapp.com/buy_item?item_id=100",
+#             "title":"Buy Item"
+#           },
+#           {
+#             "type":"postback",
+#             "title":"Bookmark Item",
+#             "payload":"USER_DEFINED_PAYLOAD_FOR_ITEM100"
+#           }              
+#         ]
+#       },
+#       {
+#         "title":"Classic Grey T-Shirt",
+#         "image_url":"http://petersapparel.parseapp.com/img/item101-thumb.png",
+#         "subtitle":"Soft gray cotton t-shirt is back in style",
+#         "buttons":[
+#           {
+#             "type":"web_url",
+#             "url":"https://petersapparel.parseapp.com/view_item?item_id=101",
+#             "title":"View Item"
+#           },
+#           {
+#             "type":"web_url",
+#             "url":"https://petersapparel.parseapp.com/buy_item?item_id=101",
+#             "title":"Buy Item"
+#           },
+#           {
+#             "type":"postback",
+#             "title":"Bookmark Item",
+#             "payload":"USER_DEFINED_PAYLOAD_FOR_ITEM101"
+#           }              
+#         ]
+#       }
+#     ]
+#   }
+# }

data/lib/message_quickly/messaging/image_attachment.rb

@@ -0,0 +1,41 @@
+module MessageQuickly
+  module Messaging
+    class ImageAttachment < Attachment
+
+      attr_accessor :url, :file, :file_type
+
+      def initialize(params = {})
+        params['type'] ||= 'image'
+        super(params)
+      end
+
+      def to_hash
+        if file?
+          { type: type, payload: { _: '' } } # cannot send empty hash
+        else
+          { type: type, payload: { url: url } }
+        end
+      end
+
+      def file?
+        file.present? && file_type.present?
+      end
+
+    end
+  end
+end
+
+# "attachments":[
+#   {
+#     "type":"image",
+#     "payload":{
+#       "url":"IMAGE_URL"
+#     }
+#   }
+# ]
+
+# curl  \
+#   -F recipient='{"id":"USER_ID"}' \
+#   -F message='{"attachment":{"type":"image", "payload":{}}}' \
+#   -F filedata=@/tmp/testpng.png \
+#   "https://graph.facebook.com/v2.6/me/messages?access_token=PAGE_ACCESS_TOKEN"

data/lib/message_quickly/messaging/message.rb

@@ -0,0 +1,36 @@
+module MessageQuickly
+  module Messaging
+    class Message
+
+      attr_accessor :text, :attachment
+
+      def initialize(options = {})
+        options.each { |key, value| instance_variable_set("@#{key}", value) }
+        yield self if block_given?
+      end
+
+      def build_attachment(attachment_type)
+        case attachment_type
+        when :image
+          self.attachment = MessageQuickly::Messaging::ImageAttachment.new
+        when :generic_template
+          self.attachment = MessageQuickly::Messaging::GenericTemplateAttachment.new
+        when :button_template
+          self.attachment = MessageQuickly::Messaging::ButtonTemplateAttachment.new
+        when :receipt_template
+          self.attachment = MessageQuickly::Messaging::ReceiptTemplateAttachment.new
+        end
+        yield attachment if block_given?
+      end
+
+      def to_hash
+        if attachment
+          { attachment: attachment.to_hash }
+        else
+          { text: text }
+        end
+      end
+
+    end
+  end
+end

data/lib/message_quickly/messaging/message_event.rb

@@ -0,0 +1,60 @@
+require "message_quickly/messaging/event"
+
+module MessageQuickly
+  module Messaging
+    class MessageEvent < Event
+
+      attr_reader :mid, :seq, :text, :attachments
+
+      def initialize(params = {})
+        initialize_params(params['message'])
+        super(params)
+      end
+
+      def webhook_name
+        :messages
+      end
+
+      protected
+
+      def initialize_params(params)
+        @attachments = params.delete('attachments').collect { |attachment_params| Attachment.new(attachment_params) } if params['attachments']
+        super(params)
+      end
+
+    end
+  end
+end
+
+# {
+#   "object":"page",
+#   "entry":[
+#     {
+#       "id":PAGE_ID,
+#       "time":1458696618911,
+#       "messaging":[
+#         {
+#           "sender":{
+#             "id":USER_ID
+#           },
+#           "recipient":{
+#             "id":PAGE_ID
+#           },
+#           "timestamp":1458696618268,
+#           "message":{
+#             "mid":"mid.1458696618141:b4ef9d19ec21086067",
+#             "seq":51,
+#             "attachments":[
+#               {
+#                 "type":"image",
+#                 "payload":{
+#                   "url":"IMAGE_URL"
+#                 }
+#               }
+#             ]
+#           }
+#         }
+#       ]
+#     }
+#   ]
+# }

data/lib/message_quickly/messaging/optin_event.rb

@@ -0,0 +1,44 @@
+require "message_quickly/messaging/event"
+
+module MessageQuickly
+  module Messaging
+    class OptinEvent < Event
+
+      attr_reader :ref
+
+      def initialize(params = {})
+        initialize_params(params['optin'])
+        super(params)
+      end
+
+      def webhook_name
+        :messaging_optins
+      end
+
+    end
+  end
+end
+
+# {
+#   "object":"page",
+#   "entry":[
+#     {
+#       "id":PAGE_ID,
+#       "time":12341,
+#       "messaging":[
+#         {
+#           "sender":{
+#             "id":USER_ID
+#           },
+#           "recipient":{
+#             "id":PAGE_ID
+#           },
+#           "timestamp":1234567890,
+#           "optin":{
+#             "ref":"PASS_THROUGH_PARAM"
+#           }
+#         }
+#       ]
+#     }
+#   ]
+# }

data/lib/message_quickly/messaging/postback_button.rb

@@ -0,0 +1,24 @@
+module MessageQuickly
+  module Messaging
+    class PostbackButton < Button
+
+      attr_accessor :payload
+
+      def initialize(params = {})
+        params['type'] ||= 'postback'
+        super(params)
+      end
+
+      def to_hash
+        { type: type, title: title, payload: payload }
+      end
+
+    end
+  end
+end
+
+# {
+#   "type":"postback",
+#   "title":"Start Chatting",
+#   "payload":"USER_DEFINED_PAYLOAD"
+# }