Class: ChatSDK::Messenger::Adapter

Inherits:
Adapter::Base
  • Object
show all
Includes:
Adapter::MetaVerification
Defined in:
lib/chat_sdk/messenger/adapter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_secret: nil, page_access_token: nil, verify_token: nil, page_id: nil) ⇒ Adapter

Returns a new instance of Adapter.

Raises:

  • (ChatSDK::ConfigurationError) 


12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 12

def initialize(app_secret: nil, page_access_token: nil, verify_token: nil, page_id: nil)
  @app_secret = app_secret || ENV["FACEBOOK_APP_SECRET"]
  @page_access_token = page_access_token || ENV["FACEBOOK_PAGE_ACCESS_TOKEN"]
  @verify_token = verify_token || ENV["FACEBOOK_VERIFY_TOKEN"]
  @page_id = page_id || ENV["FACEBOOK_PAGE_ID"]

  raise ChatSDK::ConfigurationError, "Messenger app_secret required" unless @app_secret
  raise ChatSDK::ConfigurationError, "Messenger page_access_token required" unless @page_access_token

  @client = ApiClient.new(@page_access_token)
  @renderer = TemplateRenderer.new
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 10

def client
  @client
end

Instance Method Details

#ack_response(rack_request) ⇒ Object 



34
35
36
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 34

def ack_response(rack_request)
  meta_ack_response(rack_request, verify_token: @verify_token)
end

#mention(user_id) ⇒ Object 



73
74
75
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 73

def mention(user_id)
  user_id
end

#name ⇒ Object 



25
26
27
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 25

def name
  :messenger
end

#open_dm(user_id) ⇒ Object 



65
66
67
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 65

def open_dm(user_id)
  user_id
end

#parse_events(rack_request) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 38

def parse_events(rack_request)
  payload = read_json_body(rack_request)
  EventParser.parse(payload, bot_page_id: @page_id)
rescue JSON::ParserError
  []
end

#post_message(channel_id:, message:, thread_id: nil) ⇒ Object

Outbound



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 46

def post_message(channel_id:, message:, thread_id: nil) # rubocop:disable Lint/UnusedMethodArgument
  payload = prepare_message_payload(message)

  result = @client.send_message(
    recipient_id: channel_id,
    message: payload
  )

  parse_messenger_message(result, channel_id)
end

#render(postable_message) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 77

def render(postable_message)
  if postable_message.card?
    @renderer.render(postable_message.card)
  else
    postable_message.text
  end
end

#start_typing(channel_id:, thread_id: nil) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



69
70
71
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 69

def start_typing(channel_id:, thread_id: nil) # rubocop:disable Lint/UnusedMethodArgument
  @client.send_action(recipient_id: channel_id, action: "typing_on")
end

#upload_file(channel_id:, io:, filename:, thread_id: nil, comment: nil) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument

Raises:

  • (ChatSDK::PlatformError) 


57
58
59
60
61
62
63
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 57

def upload_file(channel_id:, io:, filename:, thread_id: nil, comment: nil) # rubocop:disable Lint/UnusedMethodArgument
  raise ChatSDK::PlatformError.new(
    "Messenger file uploads require a publicly accessible URL. Binary upload is not supported. " \
    "Host the file at a public URL and send it as an attachment.",
    adapter_name: :messenger
  )
end

#verify_request!(rack_request) ⇒ Object

Inbound



30
31
32
 
# File 'lib/chat_sdk/messenger/adapter.rb', line 30

def verify_request!(rack_request)
  verify_meta_signature!(rack_request, secret: @app_secret, platform_name: "Facebook")
end