message_quickly 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50e84b3ef8343c78048a81ffe8e06a18ec160538
-  data.tar.gz: ba28b127efdcf9569202fe26ac375ddbacd6d54d
+  metadata.gz: f40defb57698c809f71d70ed577debd4a5f085d7
+  data.tar.gz: 45b8b80b3b61984b678a3bc58ae00705f1defc98
 SHA512:
-  metadata.gz: 525a00f7e6803fd9d74513c5a49be838c9c6d8e31d5e8b822e8ee2a6c23af5aa9198f6908853fc7d5671256a0098df0dd52aeedf15d0a45f6381011f9550101c
-  data.tar.gz: 16692e9535cbfdc4ec1712f848f518c6e57b136f04c36caf91d8c7348c0f63eebb6e78404d925be13764126868c7d26647c9ff9c1c899a117a7ac38445568e30
+  metadata.gz: d51150793b85d9293a90df174ecdcaf59a631e3e2ddc73fb1a0ae67394b1a3347f268a53bfdb04b17a28f3ef4e3dff1969343236892edf786367b1bfe3519f19
+  data.tar.gz: 9e326b869a79eb7ea26f7f2a8e35142b4d4430309114792f09519399afaae295bb48c2699124ecb942f1417dc1b9417293cc4069cb4f0f786874ec25bf8d0039

data/app/helpers/message_quickly/application_helper.rb

@@ -21,5 +21,9 @@ module MessageQuickly
       content_tag(:div, '', params)
     end
 
+    # def close_window(image_url = '', display_text = '')
+    #   redirect_to "https://www.messenger.com/closeWindow/?image_url=#{image_url}&display_text=#{display_text}."
+    # end
+
   end
 end

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

@@ -0,0 +1,14 @@
+class AccountLinkingCallback < MessageQuickly::Callback
+
+  def self.webhook_name
+    :account_linking
+  end
+
+  def initialize(event, json)
+    super
+  end
+
+  def run
+  end
+
+end

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

@@ -0,0 +1,14 @@
+class MessageReadCallback < MessageQuickly::Callback
+
+  def self.webhook_name
+    :message_reads
+  end
+
+  def initialize(event, json)
+    super
+  end
+
+  def run
+  end
+
+end

data/lib/message_quickly.rb

@@ -11,6 +11,7 @@ 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/api/account_link"
 
 require "message_quickly/engine"
 

data/lib/message_quickly/api/account_link.rb

@@ -0,0 +1,41 @@
+module MessageQuickly
+  module Api
+    class AccountLink < Base
+
+      def self.page_scoped_id(account_linking_token)
+        # curl -X GET "https://graph.facebook.com/v2.6/me?access_token=PAGE_ACCESS_TOKEN \
+        #   &fields=recipient \
+        #   &account_linking_token=ACCOUNT_LINKING_TOKEN"
+
+        # {
+        #   "id": "PAGE_ID",
+        #   "recipient": "PSID"
+        # }
+        AccountLink.new.page_scoped_id(account_linking_token)
+      end
+
+      def page_scoped_id(account_linking_token)
+        json = @client.get("me", { fields: 'recipient', account_linking_token: account_linking_token })
+        json['recipient']
+      end
+
+      def self.unlink_account(page_scoped_id)
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #    "psid":"PSID"
+        # }' "https://graph.facebook.com/v2.6/me/unlink_accounts?access_token=PAGE_ACCESS_TOKEN"
+
+        # {
+        #   "result": "unlink account success"
+        # }
+        AccountLink.new.unlink_account(page_scoped_id)
+      end
+
+      def unlink_account(page_scoped_id)
+        json = @client.post("me/unlink_accounts", { psid: page_scoped_id })
+        json['result'] == "unlink account success"
+      end
+
+    end
+  end
+end
+

data/lib/message_quickly/api/client.rb

@@ -31,6 +31,15 @@ module MessageQuickly
         parse_json(response)
       end
 
+      def delete(request_string, params = {})
+        params[:access_token] = page_access_token
+        response = connection.delete(request_string) do |request|
+          request.headers['Content-Type'] = 'application/json'
+          request.body = JSON.generate(params)
+        end
+        parse_json(response)
+      end
+
       private
 
       def parse_json(response)

data/lib/message_quickly/api/thread_settings.rb

@@ -2,40 +2,95 @@ module MessageQuickly
   module Api
     class ThreadSettings < Base
 
-      def self.create(message)
+      def self.greeting(text)
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #   "setting_type":"greeting",
+        #   "greeting":{
+        #       "text":"Welcome to My Company!"
+        #   }
+        # }' "https://graph.facebook.com/v2.6/<PAGE_ID>/thread_settings?access_token=<PAGE_ACCESS_TOKEN>"
+        ThreadSettings.new.greeting(text)
+      end
+
+      def self.get_started_button(payload)
         # 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!"
-        #       }
+        #       "payload":"USER_DEFINED_PAYLOAD"
         #     }
         #   ]
-        # }' "https://graph.facebook.com/v2.6/<PAGE_ID>/thread_settings?access_token=<PAGE_ACCESS_TOKEN>"
-        ThreadSettings.new.create(message)
+        # }' "https://graph.facebook.com/v2.6/me/thread_settings?access_token=PAGE_ACCESS_TOKEN"
+        ThreadSettings.new.get_started_button(payload)
       end
 
-      def self.delete
-        # curl -X POST -H "Content-Type: application/json" -d '{
+      def self.remove_get_started_button
+        # curl -X DELETE -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
+        #   "thread_state":"new_thread"
+        # }' "https://graph.facebook.com/v2.6/me/thread_settings?access_token=PAGE_ACCESS_TOKEN"
+        ThreadSettings.new.remove_get_started_button
+      end
+
+      def self.persistent_menu(payloads = [])
+        # curl -X POST -H "Content-Type: application/json" -d '{
+        #   "setting_type" : "call_to_actions",
+        #   "thread_state" : "existing_thread",
+        #   "call_to_actions":[
+        #     {
+        #       "type":"postback",
+        #       "title":"Help",
+        #       "payload":"DEVELOPER_DEFINED_PAYLOAD_FOR_HELP"
+        #     },
+        #     {
+        #       "type":"postback",
+        #       "title":"Start a New Order",
+        #       "payload":"DEVELOPER_DEFINED_PAYLOAD_FOR_START_ORDER"
+        #     },
+        #     {
+        #       "type":"web_url",
+        #       "title":"View Website",
+        #       "url":"http://petersapparel.parseapp.com/"
+        #     }
+        #   ]
+        # }' "https://graph.facebook.com/v2.6/me/thread_settings?access_token=PAGE_ACCESS_TOKEN"
+        ThreadSettings.new.persistent_menu(payloads)
+      end
+
+      def self.remove_persistent_menu
+        ThreadSettings.new.remove_persistent_menu
+      end
+
+      def greeting(text)
+        json = @client.post(request_string, { setting_type: 'greeting', greeting: { text: text } })
+        json['result'] == "Successfully updated greeting"
       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 } }] })
+      def get_started_button(payload)
+        json = @client.post(request_string, { setting_type: 'call_to_actions', thread_state: 'new_thread', call_to_actions: [payload: payload] })
         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"
+      def remove_get_started_button
+        json = @client.delete(request_string, { setting_type: 'call_to_actions', thread_state: 'new_thread' })
+        json['result'] == "Successfully deleted all new_thread's CTAs"
+      end
+
+      def persistent_menu(payloads = [])
+        json = @client.post(request_string, { setting_type: 'call_to_actions', thread_state: 'existing_thread', call_to_actions: payloads })
+        json['result'] == "Successfully added structured menu CTAs"
+      end
+
+      def remove_persistent_menu(payloads = [])
+        json = @client.delete(request_string, { setting_type: 'call_to_actions', thread_state: 'existing_thread' })
+        json['result'] == "Successfully deleted structured menu CTAs"
+      end
+
+      private
+
+      def request_string
+        "#{ENV['FACEBOOK_MESSENGER_PAGE_ID']}/thread_settings"
       end
 
     end

data/lib/message_quickly/api/user_profile.rb

@@ -13,7 +13,7 @@ module MessageQuickly
       end
 
       def find(id)
-        json = @client.get(id, { fields: 'first_name,last_name,profile_pic' })
+        json = @client.get(id, { fields: 'first_name,last_name,profile_pic,locale,timezone,gender' })
         Messaging::User.new(json)
       end
 

data/lib/message_quickly/callback_parser.rb

@@ -3,13 +3,17 @@ require 'json'
 require "message_quickly/messaging/base"
 require "message_quickly/messaging/attachment"
 require "message_quickly/messaging/image_attachment"
+require "message_quickly/messaging/video_attachment"
+require "message_quickly/messaging/audio_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/account_link_button"
 require "message_quickly/messaging/button_template_attachment"
 require "message_quickly/messaging/generic_template_attachment"
+require "message_quickly/messaging/quick_reply"
 
 require "message_quickly/messaging/receipt/address"
 require "message_quickly/messaging/receipt/adjustment"
@@ -29,6 +33,8 @@ require "message_quickly/messaging/optin_event"
 require "message_quickly/messaging/delivery_event"
 require "message_quickly/messaging/message_event"
 require "message_quickly/messaging/postback_event"
+require "message_quickly/messaging/read_event"
+require "message_quickly/messaging/account_link_event"
 
 module MessageQuickly
   class CallbackParser
@@ -41,7 +47,9 @@ module MessageQuickly
       optin: MessageQuickly::Messaging::OptinEvent,
       postback: MessageQuickly::Messaging::PostbackEvent,
       delivery: MessageQuickly::Messaging::DeliveryEvent,
-      message: MessageQuickly::Messaging::MessageEvent
+      account_linking: MessageQuickly::Messaging::AccountLinkEvent,
+      message: MessageQuickly::Messaging::MessageEvent,
+      read: MessageQuickly::Messaging::ReadEvent
     }
 
     def parse

data/lib/message_quickly/messaging/account_link_button.rb

@@ -0,0 +1,23 @@
+module MessageQuickly
+  module Messaging
+    class AccountLinkButton < Button
+
+      attr_accessor :url
+
+      def initialize(params = {})
+        params['type'] ||= 'account_link'
+        super(params)
+      end
+
+      def to_hash
+        { type: type, url: url }
+      end
+
+    end
+  end
+end
+
+# "buttons": [{
+#   "type": "account_link",
+#   "url": "https://www.example.com/oauth/authorize"
+# }]

data/lib/message_quickly/messaging/account_link_event.rb

@@ -0,0 +1,41 @@
+require "message_quickly/messaging/event"
+
+module MessageQuickly
+  module Messaging
+    class AccountLinkEvent < Event
+
+      attr_reader :status, :authorization_code
+
+      def initialize(params = {})
+
+        if params.include? :account_linking
+          @status = params[:account_linking][:status]
+          @authorization_code = params[:account_linking][:authorization_code]
+          params.delete(:account_linking)
+        end
+
+        super(params)
+
+      end
+
+      def webhook_name
+        :account_linking
+      end
+
+    end
+  end
+end
+
+# {
+#   "sender":{
+#     "id":"USER_ID"
+#   },
+#   "recipient":{
+#     "id":"PAGE_ID"
+#   },
+#   "timestamp":1234567890,
+#   "account_linking":{
+#     "status":"linked",
+#     "authorization_code":"PASS_THROUGH_AUTHORIZATION_CODE"
+#   }
+# }

data/lib/message_quickly/messaging/account_unlink_button.rb

@@ -0,0 +1,22 @@
+module MessageQuickly
+  module Messaging
+    class AccountUnlinkButton < Button
+
+      attr_accessor :url
+
+      def initialize(params = {})
+        params['type'] ||= 'account_unlink'
+        super(params)
+      end
+
+      def to_hash
+        { type: type }
+      end
+
+    end
+  end
+end
+
+# "buttons": [{
+#   "type": "account_link"
+# }]

data/lib/message_quickly/messaging/audio_attachment.rb

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

data/lib/message_quickly/messaging/button_template_attachment.rb

@@ -16,6 +16,8 @@ module MessageQuickly
           button = WebUrlButton.new
         when :postback
           button = PostbackButton.new
+        when :account_link
+          button = AccountLinkButton.new
         end
         buttons << button.tap { |button| yield button }
       end

data/lib/message_quickly/messaging/element.rb

@@ -15,6 +15,8 @@ module MessageQuickly
           button = WebUrlButton.new
         when :postback
           button = PostbackButton.new
+        when :account_link
+          button = AccountLinkButton.new
         end
         buttons << button.tap { |button| yield button }
       end

data/lib/message_quickly/messaging/image_attachment.rb

@@ -15,7 +15,7 @@ module MessageQuickly
 
       def to_hash
         if file?
-          { type: type, payload: { _: '' } } # cannot send empty hash
+          { type: type, payload: { url: '' } } # cannot send empty hash
         else
           { type: type, payload: { url: url } }
         end