stealth-facebook 0.14.0 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -0
  3. data/Gemfile.lock +72 -46
  4. data/LICENSE +4 -17
  5. data/README.md +20 -44
  6. data/VERSION +1 -1
  7. data/lib/stealth/services/facebook/client.rb +58 -17
  8. data/lib/stealth/services/facebook/events/message_event.rb +22 -11
  9. data/lib/stealth/services/facebook/events/messaging_referral_event.rb +31 -0
  10. data/lib/stealth/services/facebook/events/postback_event.rb +2 -2
  11. data/lib/stealth/services/facebook/message_handler.rb +11 -0
  12. data/lib/stealth/services/facebook/reply_handler.rb +6 -11
  13. data/stealth-facebook.gemspec +2 -2
  14. metadata +14 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 11c3547b103d3baf55fd0ca80f8aa95819e9b3cf92c526ad895cb8f8020f5ea9
4
- data.tar.gz: 17e7eb35d6d16a9ed7d1513ea8cda15df5a2e88fe3a53f576ae6be69139d733f
3
+ metadata.gz: 2eae4e1dafe5f39e579df40a4d45f3c5d52761e3b5afe00a958018448a8bcaed
4
+ data.tar.gz: 8a83fbff458909bf1cb6beb18bc6a8f2879256e5bac5bd611a28bd7cf47b489a
5
5
  SHA512:
6
- metadata.gz: db00e909d2843c39d74a7d61a557eee03ec6fd067c264bd0112c65236318452b56787d868704ed37f279b4d31c0f257d3fe5b0c5c783dc7b773b0d45f569eaf2
7
- data.tar.gz: 0c01e28b2b1cd35901f9da13c236ac6589a4a26bc607f2b14d903ff81b41c319e7b585f5663a0f1072b6147d2de0939481acd3903f933a2957ca5d3e50048791
6
+ metadata.gz: fa9b3453020fc70539bd4996bb257adf859ddd98770569f8804392a20cd9fe3147f582ca893485fff4c728ee191528a95dab5016a1b5e53a5394eb6f8152e21d
7
+ data.tar.gz: c3caf9325353e5deb40288e515c1df2464679ff6e8b711b700d3fe91859e3892e5a2f68ff54a1415fa3756f145acc475f7c8901815e0a61332a1ed0578eb4f87
data/Gemfile CHANGED
@@ -1,2 +1,5 @@
1
1
  source 'https://rubygems.org'
2
+
3
+ gem 'stealth', '>= 2.0.0.beta'
4
+
2
5
  gemspec
data/Gemfile.lock CHANGED
@@ -1,73 +1,98 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- stealth-facebook (0.11.2)
5
- faraday (~> 0.13)
6
- stealth (< 2.0)
4
+ stealth-facebook (0.22.0)
5
+ http (~> 4.4)
6
+ stealth (>= 2.0.0.beta)
7
7
 
8
8
  GEM
9
9
  remote: https://rubygems.org/
10
10
  specs:
11
- activesupport (5.2.2)
11
+ activesupport (6.0.3.3)
12
12
  concurrent-ruby (~> 1.0, >= 1.0.2)
13
13
  i18n (>= 0.7, < 2)
14
14
  minitest (~> 5.1)
15
15
  tzinfo (~> 1.1)
16
- concurrent-ruby (1.1.4)
17
- connection_pool (2.2.2)
18
- diff-lcs (1.3)
19
- faraday (0.15.4)
20
- multipart-post (>= 1.2, < 3)
21
- i18n (1.5.3)
16
+ zeitwerk (~> 2.2, >= 2.2.2)
17
+ addressable (2.7.0)
18
+ public_suffix (>= 2.0.2, < 5.0)
19
+ concurrent-ruby (1.1.7)
20
+ connection_pool (2.2.3)
21
+ diff-lcs (1.4.4)
22
+ domain_name (0.5.20190701)
23
+ unf (>= 0.0.5, < 1.0.0)
24
+ ffi (1.13.1)
25
+ ffi-compiler (1.0.1)
26
+ ffi (>= 1.0.0)
27
+ rake
28
+ http (4.4.1)
29
+ addressable (~> 2.3)
30
+ http-cookie (~> 1.0)
31
+ http-form_data (~> 2.2)
32
+ http-parser (~> 1.2.0)
33
+ http-cookie (1.0.3)
34
+ domain_name (~> 0.5)
35
+ http-form_data (2.3.0)
36
+ http-parser (1.2.1)
37
+ ffi-compiler (>= 1.0, < 2.0)
38
+ i18n (1.8.5)
22
39
  concurrent-ruby (~> 1.0)
23
- minitest (5.11.3)
24
- multi_json (1.13.1)
25
- multipart-post (2.0.0)
26
- mustermann (1.0.3)
27
- puma (3.12.0)
28
- rack (2.0.6)
29
- rack-protection (2.0.5)
40
+ minitest (5.14.2)
41
+ multi_json (1.15.0)
42
+ mustermann (1.1.1)
43
+ ruby2_keywords (~> 0.0.1)
44
+ nio4r (2.5.4)
45
+ public_suffix (4.0.6)
46
+ puma (4.3.6)
47
+ nio4r (~> 2.0)
48
+ rack (2.2.3)
49
+ rack-protection (2.1.0)
30
50
  rack
31
51
  rack-test (1.1.0)
32
52
  rack (>= 1.0, < 3)
33
- redis (4.1.0)
34
- rspec (3.8.0)
35
- rspec-core (~> 3.8.0)
36
- rspec-expectations (~> 3.8.0)
37
- rspec-mocks (~> 3.8.0)
38
- rspec-core (3.8.0)
39
- rspec-support (~> 3.8.0)
40
- rspec-expectations (3.8.1)
53
+ rake (13.0.1)
54
+ redis (4.2.2)
55
+ rspec (3.9.0)
56
+ rspec-core (~> 3.9.0)
57
+ rspec-expectations (~> 3.9.0)
58
+ rspec-mocks (~> 3.9.0)
59
+ rspec-core (3.9.2)
60
+ rspec-support (~> 3.9.3)
61
+ rspec-expectations (3.9.2)
41
62
  diff-lcs (>= 1.2.0, < 2.0)
42
- rspec-support (~> 3.8.0)
43
- rspec-mocks (3.8.0)
63
+ rspec-support (~> 3.9.0)
64
+ rspec-mocks (3.9.1)
44
65
  diff-lcs (>= 1.2.0, < 2.0)
45
- rspec-support (~> 3.8.0)
46
- rspec-support (3.8.0)
66
+ rspec-support (~> 3.9.0)
67
+ rspec-support (3.9.3)
47
68
  rspec_junit_formatter (0.4.1)
48
69
  rspec-core (>= 2, < 4, != 2.12.0)
49
- sidekiq (5.2.5)
50
- connection_pool (~> 2.2, >= 2.2.2)
51
- rack (>= 1.5.0)
52
- rack-protection (>= 1.5.0)
53
- redis (>= 3.3.5, < 5)
54
- sinatra (2.0.5)
55
- mustermann (~> 1.0)
70
+ ruby2_keywords (0.0.2)
71
+ sidekiq (6.1.2)
72
+ connection_pool (>= 2.2.2)
56
73
  rack (~> 2.0)
57
- rack-protection (= 2.0.5)
74
+ redis (>= 4.2.0)
75
+ sinatra (2.1.0)
76
+ mustermann (~> 1.0)
77
+ rack (~> 2.2)
78
+ rack-protection (= 2.1.0)
58
79
  tilt (~> 2.0)
59
- stealth (1.1.6)
60
- activesupport (~> 5.2)
80
+ stealth (2.0.0.beta1)
81
+ activesupport (~> 6.0)
61
82
  multi_json (~> 1.12)
62
- puma (~> 3.10)
63
- sidekiq (~> 5.0)
83
+ puma (>= 4.2, < 5.0)
84
+ sidekiq (~> 6.0)
64
85
  sinatra (~> 2.0)
65
- thor (~> 0.20)
66
- thor (0.20.3)
86
+ thor (~> 1.0)
87
+ thor (1.0.1)
67
88
  thread_safe (0.3.6)
68
- tilt (2.0.9)
69
- tzinfo (1.2.5)
89
+ tilt (2.0.10)
90
+ tzinfo (1.2.7)
70
91
  thread_safe (~> 0.1)
92
+ unf (0.1.4)
93
+ unf_ext
94
+ unf_ext (0.0.7.7)
95
+ zeitwerk (2.4.0)
71
96
 
72
97
  PLATFORMS
73
98
  ruby
@@ -76,7 +101,8 @@ DEPENDENCIES
76
101
  rack-test (~> 1.1)
77
102
  rspec (~> 3.6)
78
103
  rspec_junit_formatter (~> 0.3)
104
+ stealth (>= 2.0.0.beta)
79
105
  stealth-facebook!
80
106
 
81
107
  BUNDLED WITH
82
- 1.16.3
108
+ 2.1.4
data/LICENSE CHANGED
@@ -1,20 +1,7 @@
1
- Copyright (c) 2017 Mauricio Gomes, Black Ops Bureau
1
+ Copyright (c) 2017-2020 Mauricio Gomes, Mav Automation Ventures Inc.
2
2
 
3
- Permission is hereby granted, free of charge, to any person obtaining
4
- a copy of this software and associated documentation files (the
5
- "Software"), to deal in the Software without restriction, including
6
- without limitation the rights to use, copy, modify, merge, publish,
7
- distribute, sublicense, and/or sell copies of the Software, and to
8
- permit persons to whom the Software is furnished to do so, subject to
9
- the following conditions:
3
+ 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:
10
4
 
11
- The above copyright notice and this permission notice shall be
12
- included in all copies or substantial portions of the Software.
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
13
6
 
14
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
7
+ 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/README.md CHANGED
@@ -25,6 +25,14 @@ Beginning with version `0.13.0` of this gem, `message_reads` webhooks are suppor
25
25
 
26
26
  More info about `message_reads` webhooks can be found in the [Facebook Developer docs](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/message-reads).
27
27
 
28
+ ### messaging_referrals
29
+
30
+ Facebook separates referral data for users with an existing thread versus those that have initiated a new thread. For the former case, the `messaging_referrals` webhook event is used to send the referral data. For the latter case, the referral payload is sent via the `postback` event.
31
+
32
+ For both scenarios above, this driver will include the referral payload as part of the `current_message`. It can be accessed via `current_message.referral`.
33
+
34
+ More info about `messaging_referrals` webhooks and the different referral payloads can be found in the [Facebook Developer docs](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_referrals/)
35
+
28
36
  ## Configure The Integration
29
37
 
30
38
  ```yaml
@@ -79,6 +87,8 @@ test:
79
87
 
80
88
  As with all Stealth integrations, integrations can be specified by environment. You'll want to replace `FACEBOOK_VERIFY_TOKEN` and `FACEBOOK_ACCESS_TOKEN` with your respective keys from your Facebook page.
81
89
 
90
+ You may also specify a Facebook Graph API version by setting the ENV var `FACEBOOK_API_VERSION` to API version your bot has been cofnigured to use. If none is specified, this driver will currently default to version `3.2`.
91
+
82
92
  These are the supported setup options:
83
93
 
84
94
  ### greeting
@@ -179,24 +189,24 @@ These are standard text replies. It can sent like:
179
189
 
180
190
  ```yaml
181
191
  - reply_type: text
182
- text: "Hello World!"
192
+ text: Hello World!
183
193
  ```
184
194
 
185
195
  Text replies can also include suggestions, which will be rendered as quick replies:
186
196
 
187
197
  ```yaml
188
198
  - reply_type: text
189
- text: "What is your favorite color?"
199
+ text: What is your favorite color?
190
200
  suggestions:
191
201
  - text: Blue
192
202
  - text: Red
193
203
  ```
194
204
 
195
- Although not as common, text replies can also include buttons:
205
+ Text replies can also include buttons:
196
206
 
197
207
  ```yaml
198
208
  - reply_type: text
199
- text: "Would you like to give us a call?"
209
+ text: Would you like to give us a call?
200
210
  buttons:
201
211
  - type: call
202
212
  phone_number: "+15552991212"
@@ -208,7 +218,9 @@ Although not as common, text replies can also include buttons:
208
218
 
209
219
  ### suggestions
210
220
 
211
- Though suggestions are not a reply type on their own, they are frequently used to optimize the accuracy and speed of your bot. In the `text` reply type above, we used simple labels for our suggestions. Facebook supports a few special types of quick replies, however.
221
+ Though suggestions are not a reply type on their own, they are frequently used to optimize the accuracy and speed of your bot. In the `text` reply type above, we used simple labels for our suggestions. Facebook supports a few special types of quick replies, discussed below.
222
+
223
+ Please note that starting with version `0.17.0` of this gem, quick replies return their response via `current_message.message` as well as `current_message.payload`. Please make sure your `route` method in `BotController` handles that accordingly.
212
224
 
213
225
  #### Location
214
226
 
@@ -280,7 +292,7 @@ This is the most common button type. When a user presses a button that is `paylo
280
292
 
281
293
  ```yaml
282
294
  - reply_type: text
283
- text: "Please press the button below"
295
+ text: Please press the button below
284
296
  buttons:
285
297
  - type: payload
286
298
  text: 'Press me!'
@@ -296,29 +308,25 @@ The `url` button is useful when sharing a link to a website. By default, it will
296
308
 
297
309
  ```yaml
298
310
  - reply_type: text
299
- text: "Find out more via our website"
311
+ text: Find out more via our website
300
312
  buttons:
301
313
  - type: url
302
314
  text: 'Visit website'
303
315
  url: 'https://example.org'
304
- messenger_extensions: true
305
316
 
306
317
  ```
307
318
 
308
- Enabling messenger_extensions allows your webview to access a selection of features from the Messenger platform. More info [here](https://developers.facebook.com/docs/messenger-platform/webview/extensions?source=post_page). Without this parameter set to true, the webview opens in a separate tab or window if a user is visiting from the 'messenger.com' domain.
309
-
310
319
  You can also specify the height of the webview window that opens up in Messenger via: `webview_height`. You can choose between `compact`, `tall`, and `full`.
311
320
 
312
321
  More info [here](https://developers.facebook.com/docs/messenger-platform/webview).
313
322
 
314
-
315
323
  #### call
316
324
 
317
325
  The `call` button type will prompt the user to dial the specified number. The number will be pre-filled in, but the user will still have to confirm by confirming via the modal that is shown. To create a `call` button:
318
326
 
319
327
  ```yaml
320
328
  - reply_type: text
321
- text: "Give us a ring!"
329
+ text: Give us a ring!
322
330
  buttons:
323
331
  - type: call
324
332
  text: 'Call'
@@ -452,35 +460,3 @@ To send an audio clip:
452
460
  The `audio_url` should be set to URL where the video has been uploaded.
453
461
 
454
462
  Audio replies support buttons and suggestions like text replies.
455
-
456
- ### Account Linking
457
-
458
- Account Linking allows you to invite users to log-in using your own authentication flow, and to receive a Messenger page-scoped ID (PSID) upon completion. You can find more info about Facebook Account Linking [here](https://developers.facebook.com/docs/messenger-platform/identity/account-linking).
459
-
460
- #### Login
461
-
462
- The `login` button type will prompt the user to log-in using your own authentication flow in the case he or she has an account with your business. You can find more info about Facebook Log In Button [here](https://developers.facebook.com/docs/messenger-platform/reference/buttons/login).
463
-
464
- To create a `login` button:
465
-
466
- ```yaml
467
- - reply_type: text
468
- text: "Log in to access your account information."
469
- buttons:
470
- - type: login
471
- url: "https://my-app.com/login"
472
- ```
473
-
474
- #### Logout
475
-
476
- The `logout` button type is used in the account linking flow to unlink the message recipient's identity on Messenger with their account on your site. You can find more info about Facebook Log Out Button [here](https://developers.facebook.com/docs/messenger-platform/reference/buttons/logout).
477
-
478
- To create a `logout` button:
479
-
480
- ```yaml
481
- - reply_type: text
482
- text: "Log out"
483
- buttons:
484
- - type: logout
485
- ```
486
-
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.14.0
1
+ 0.22.0
data/lib/stealth/services/facebook/client.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # coding: utf-8
2
2
  # frozen_string_literal: true
3
3
 
4
- require 'faraday'
4
+ require 'http'
5
5
 
6
6
  require 'stealth/services/facebook/message_handler'
7
7
  require 'stealth/services/facebook/reply_handler'
@@ -10,9 +10,13 @@ require 'stealth/services/facebook/setup'
10
10
  module Stealth
11
11
  module Services
12
12
  module Facebook
13
-
14
13
  class Client < Stealth::Services::BaseClient
15
- FB_ENDPOINT = "https://graph.facebook.com/v2.10/me"
14
+
15
+ FB_ENDPOINT = if ENV['FACEBOOK_API_VERSION'].present?
16
+ "https://graph.facebook.com/v#{ENV['FACEBOOK_API_VERSION']}/me"
17
+ else
18
+ "https://graph.facebook.com/v3.2/me"
19
+ end
16
20
 
17
21
  attr_reader :api_endpoint, :reply
18
22
 
@@ -23,9 +27,34 @@ module Stealth
23
27
  end
24
28
 
25
29
  def transmit
26
- headers = { "Content-Type" => "application/json" }
27
- response = Faraday.post(api_endpoint, reply.to_json, headers)
28
- Stealth::Logger.l(topic: "facebook", message: "Transmitting. Response: #{response.status}: #{response.body}")
30
+ res = self
31
+ .class
32
+ .http_client
33
+ .post(api_endpoint, body: MultiJson.dump(reply))
34
+
35
+ if res.status.client_error? # HTTP 4xx error
36
+ # Messenger error sub-codes (https://developers.facebook.com/docs/messenger-platform/reference/send-api/error-codes)
37
+ case res.body
38
+ when /1545041/
39
+ raise Stealth::Errors::UserOptOut
40
+ when /2018108/
41
+ raise Stealth::Errors::UserOptOut
42
+ when /2018028/
43
+ raise Stealth::Errors::InvalidSessionID.new('Cannot message users who are not admins, developers or testers of the app until pages_messaging permission is reviewed and the app is live.')
44
+ end
45
+ end
46
+
47
+ Stealth::Logger.l(
48
+ topic: "facebook",
49
+ message: "Transmitted. Response: #{res.status.code}: #{res.body}"
50
+ )
51
+ end
52
+
53
+ def self.http_client
54
+ headers = {
55
+ 'Content-Type' => 'application/json'
56
+ }
57
+ HTTP.timeout(connect: 15, read: 60).headers(headers)
29
58
  end
30
59
 
31
60
  def self.fetch_profile(recipient_id:, fields: nil)
@@ -44,13 +73,19 @@ module Stealth
44
73
  query: query_hash.to_query
45
74
  )
46
75
 
47
- response = Faraday.get(uri.to_s)
48
- Stealth::Logger.l(topic: "facebook", message: "Requested user profile for #{recipient_id}. Response: #{response.status}: #{response.body}")
76
+ res = http_client.get(uri.to_s)
77
+ Stealth::Logger.l(topic:
78
+ 'facebook',
79
+ message: "Requested user profile for #{recipient_id}. Response: #{res.status.code}: #{res.body}"
80
+ )
49
81
 
50
- if response.status.in?(200..299)
51
- MultiJson.load(response.body)
82
+ if res.status.success?
83
+ MultiJson.load(res.body.to_s)
52
84
  else
53
- raise(Stealth::Errors::ServiceError, "Facebook error #{response.status}: #{response.body}")
85
+ raise(
86
+ Stealth::Errors::ServiceError,
87
+ "Facebook error #{res.status}: #{res.body}"
88
+ )
54
89
  end
55
90
  end
56
91
 
@@ -77,17 +112,23 @@ module Stealth
77
112
  path: "/#{Stealth.config.facebook.app_id}/activities"
78
113
  )
79
114
 
80
- response = Faraday.post(uri.to_s, params)
81
- Stealth::Logger.l(topic: "facebook", message: "Sending custom event for metric: #{metric} and value: #{value}. Response: #{response.status}: #{response.body}")
115
+ res = http_client.post(uri.to_s, body: MultiJson.dump(params))
116
+ Stealth::Logger.l(
117
+ topic: "facebook",
118
+ message: "Sent custom event for metric: #{metric} and value: #{value}. Response: #{res.status}: #{res.body}"
119
+ )
82
120
 
83
- if response.status.in?(200..299)
84
- MultiJson.load(response.body)
121
+ if res.status.success?
122
+ MultiJson.load(res.body.to_s)
85
123
  else
86
- raise(Stealth::Errors::ServiceError, "Facebook error #{response.status}: #{response.body}")
124
+ raise(
125
+ Stealth::Errors::ServiceError,
126
+ "Facebook error #{res.status}: #{res.body}"
127
+ )
87
128
  end
88
129
  end
89
- end
90
130
 
131
+ end
91
132
  end
92
133
  end
93
134
  end
data/lib/stealth/services/facebook/events/message_event.rb CHANGED
@@ -23,20 +23,21 @@ module Stealth
23
23
  private
24
24
 
25
25
  def fetch_message
26
- if params['message']['quick_reply'].present?
27
- service_message.message = params['message']['quick_reply']['payload']
28
- elsif params['message']['text'].present?
29
- service_message.message = params['message']['text']
26
+ if params.dig('message', 'quick_reply').present?
27
+ service_message.message = params.dig('message', 'text')
28
+ service_message.payload = params.dig('message', 'quick_reply', 'payload')
29
+ elsif params.dig('message', 'text').present?
30
+ service_message.message = params.dig('message', 'text')
30
31
  end
31
32
  end
32
33
 
33
34
  def fetch_location
34
- if params['message']['attachments'].present? && params['message']['attachments'].is_a?(Array)
35
- params['message']['attachments'].each do |attachment|
35
+ if params.dig('message', 'attachments').present? && params.dig('message', 'attachments').is_a?(Array)
36
+ params.dig('message', 'attachments').each do |attachment|
36
37
  next unless attachment['type'] == 'location'
37
38
 
38
- lat = attachment['payload']['coordinates']['lat']
39
- lng = attachment['payload']['coordinates']['long']
39
+ lat = attachment.dig('payload', 'coordinates', 'lat')
40
+ lng = attachment.dig('payload', 'coordinates', 'long')
40
41
 
41
42
  service_message.location = {
42
43
  lat: lat,
@@ -47,11 +48,21 @@ module Stealth
47
48
  end
48
49
 
49
50
  def fetch_attachments
50
- if params['message']['attachments'].present? && params['message']['attachments'].is_a?(Array)
51
- params['message']['attachments'].each do |attachment|
51
+ if params.dig('message', 'attachments').present? && params.dig('message', 'attachments').is_a?(Array)
52
+ params.dig('message', 'attachments').each do |attachment|
53
+ # Seems to be a bug in Messenger, but in attachments of type `fallback`
54
+ # we are seeing the URL come in at the attachment-level rather than
55
+ # nested within the payload as the API specifies:
56
+ # https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messages
57
+ payload_url = if attachment.dig('payload', 'url').present?
58
+ attachment['payload']['url']
59
+ else
60
+ attachment['url']
61
+ end
62
+
52
63
  service_message.attachments << {
53
64
  type: attachment['type'],
54
- url: attachment['payload']['url']
65
+ url: payload_url
55
66
  }
56
67
  end
57
68
  end
data/lib/stealth/services/facebook/events/messaging_referral_event.rb ADDED
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+
4
+ module Stealth
5
+ module Services
6
+ module Facebook
7
+
8
+ class MessagingReferralEvent
9
+
10
+ attr_reader :service_message, :params
11
+
12
+ def initialize(service_message:, params:)
13
+ @service_message = service_message
14
+ @params = params
15
+ end
16
+
17
+ def process
18
+ fetch_referral
19
+ end
20
+
21
+ private
22
+
23
+ def fetch_referral
24
+ service_message.referral = params['referral']
25
+ end
26
+
27
+ end
28
+
29
+ end
30
+ end
31
+ end
data/lib/stealth/services/facebook/events/postback_event.rb CHANGED
@@ -22,11 +22,11 @@ module Stealth
22
22
  private
23
23
 
24
24
  def fetch_payload
25
- service_message.payload = params['postback']['payload']
25
+ service_message.payload = params.dig('postback', 'payload')
26
26
  end
27
27
 
28
28
  def fetch_referral
29
- service_message.referral = params['postback']['referral']
29
+ service_message.referral = params.dig('postback', 'referral')
30
30
  end
31
31
 
32
32
  end
data/lib/stealth/services/facebook/message_handler.rb CHANGED
@@ -4,6 +4,7 @@
4
4
  require 'stealth/services/facebook/events/message_event'
5
5
  require 'stealth/services/facebook/events/postback_event'
6
6
  require 'stealth/services/facebook/events/message_reads_event'
7
+ require 'stealth/services/facebook/events/messaging_referral_event'
7
8
 
8
9
  module Stealth
9
10
  module Services
@@ -39,6 +40,7 @@ module Stealth
39
40
  @service_message = ServiceMessage.new(service: 'facebook')
40
41
  @facebook_message = params['entry'].first['messaging'].first
41
42
  service_message.sender_id = get_sender_id
43
+ service_message.target_id = get_target_id
42
44
  service_message.timestamp = get_timestamp
43
45
  process_facebook_event
44
46
 
@@ -63,6 +65,10 @@ module Stealth
63
65
  facebook_message['sender']['id']
64
66
  end
65
67
 
68
+ def get_target_id
69
+ facebook_message['recipient']['id']
70
+ end
71
+
66
72
  def get_timestamp
67
73
  Time.at(facebook_message['timestamp']/1000).to_datetime
68
74
  end
@@ -83,6 +89,11 @@ module Stealth
83
89
  service_message: service_message,
84
90
  params: facebook_message
85
91
  )
92
+ elsif facebook_message['referral'].present?
93
+ message_event = Stealth::Services::Facebook::MessagingReferralEvent.new(
94
+ service_message: service_message,
95
+ params: facebook_message
96
+ )
86
97
  end
87
98
 
88
99
  message_event.process
data/lib/stealth/services/facebook/reply_handler.rb CHANGED
@@ -363,6 +363,12 @@ module Stealth
363
363
  quick_reply = { "content_type" => "user_phone_number" }
364
364
  when 'email'
365
365
  quick_reply = { "content_type" => "user_email" }
366
+ when 'birthday'
367
+ quick_reply = { "content_type" => "user_birthday" }
368
+ when 'state'
369
+ quick_reply = { "content_type" => "user_state" }
370
+ when 'zip_code'
371
+ quick_reply = { "content_type" => "user_zip_code" }
366
372
  else
367
373
  quick_reply = {
368
374
  "content_type" => "text",
@@ -421,17 +427,6 @@ module Stealth
421
427
  "title" => button["text"]
422
428
  }
423
429
 
424
- when 'login'
425
- _button = {
426
- "type" => "account_link",
427
- "url" => button["url"]
428
- }
429
-
430
- when 'logout'
431
- _button = {
432
- "type" => "account_unlink"
433
- }
434
-
435
430
  when 'nested'
436
431
  _button = {
437
432
  "type" => "nested",
data/stealth-facebook.gemspec CHANGED
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
12
12
  s.author = 'Mauricio Gomes'
13
13
  s.email = 'mauricio@edge14.com'
14
14
 
15
- s.add_dependency 'stealth', '< 2.0'
16
- s.add_dependency 'faraday', '~> 0.13'
15
+ s.add_dependency 'stealth', '>= 2.0.0.beta'
16
+ s.add_dependency 'http', '~> 4.4'
17
17
 
18
18
  s.add_development_dependency 'rspec', '~> 3.6'
19
19
  s.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
metadata CHANGED
@@ -1,43 +1,43 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stealth-facebook
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.14.0
4
+ version: 0.22.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mauricio Gomes
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-23 00:00:00.000000000 Z
11
+ date: 2020-09-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: stealth
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "<"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '2.0'
19
+ version: 2.0.0.beta
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "<"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: '2.0'
26
+ version: 2.0.0.beta
27
27
  - !ruby/object:Gem::Dependency
28
- name: faraday
28
+ name: http
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: '0.13'
33
+ version: '4.4'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: '0.13'
40
+ version: '4.4'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rspec
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
99
99
  - lib/stealth/services/facebook/client.rb
100
100
  - lib/stealth/services/facebook/events/message_event.rb
101
101
  - lib/stealth/services/facebook/events/message_reads_event.rb
102
+ - lib/stealth/services/facebook/events/messaging_referral_event.rb
102
103
  - lib/stealth/services/facebook/events/postback_event.rb
103
104
  - lib/stealth/services/facebook/message_handler.rb
104
105
  - lib/stealth/services/facebook/reply_handler.rb
@@ -111,7 +112,7 @@ homepage: https://github.com/hellostealth/stealth-facebook
111
112
  licenses:
112
113
  - MIT
113
114
  metadata: {}
114
- post_install_message:
115
+ post_install_message:
115
116
  rdoc_options: []
116
117
  require_paths:
117
118
  - lib
@@ -126,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
126
127
  - !ruby/object:Gem::Version
127
128
  version: '0'
128
129
  requirements: []
129
- rubygems_version: 3.0.3
130
- signing_key:
130
+ rubygems_version: 3.1.2
131
+ signing_key:
131
132
  specification_version: 4
132
133
  summary: Stealth Facebook Messenger driver
133
134
  test_files: