pushradar 2.0.2 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.document +5 -0
- data/.gemtest +0 -0
- data/.gitignore +35 -10
- data/.idea/.gitignore +8 -0
- data/.idea/inspectionProfiles/Project_Default.xml +5 -5
- data/.idea/misc.xml +3 -3
- data/.idea/modules.xml +7 -7
- data/.idea/{PushRadarRuby.iml → pushradar-server-ruby.iml} +15 -12
- data/.idea/vcs.xml +5 -5
- data/CHANGELOG.md +6 -31
- data/Gemfile +1 -4
- data/LICENSE +2 -2
- data/README.md +114 -78
- data/Rakefile +2 -1
- data/VERSION +1 -1
- data/lib/pushradar.rb +10 -0
- data/lib/pushradar/client.rb +119 -0
- data/lib/pushradar/version.rb +3 -0
- data/pushradar.gemspec +26 -0
- metadata +47 -23
- data/.idea/.rakeTasks +0 -7
- data/.idea/workspace.xml +0 -677
- data/PushRadar.gemspec +0 -25
- data/bin/console +0 -6
- data/bin/setup +0 -6
- data/lib/PushRadar.rb +0 -384
- data/lib/PushRadar/APIClient.rb +0 -53
- data/lib/PushRadar/Targeting.rb +0 -173
- data/lib/PushRadar/Utils.rb +0 -558
- data/lib/PushRadar/version.rb +0 -3
data/PushRadar.gemspec
DELETED
@@ -1,25 +0,0 @@
|
|
1
|
-
# coding: utf-8
|
2
|
-
lib = File.expand_path('../lib', __FILE__)
|
3
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
-
require 'PushRadar/version'
|
5
|
-
|
6
|
-
Gem::Specification.new do |spec|
|
7
|
-
spec.name = 'pushradar'
|
8
|
-
spec.version = PushRadar::VERSION
|
9
|
-
spec.authors = ['PushRadar']
|
10
|
-
spec.email = ['contact@pushradar.com']
|
11
|
-
|
12
|
-
spec.summary = %q{PushRadar's official Ruby library, wrapping the PushRadar API.}
|
13
|
-
spec.homepage = 'https://github.com/pushradar/pushradar-ruby'
|
14
|
-
spec.license = 'MIT'
|
15
|
-
|
16
|
-
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
17
|
-
f.match(%r{^(test|spec|features)/})
|
18
|
-
end
|
19
|
-
spec.bindir = 'exe'
|
20
|
-
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
21
|
-
spec.require_paths = ['lib']
|
22
|
-
|
23
|
-
spec.add_development_dependency 'bundler', '~> 1.15'
|
24
|
-
spec.add_development_dependency 'rake', '~> 10.0'
|
25
|
-
end
|
data/bin/console
DELETED
data/bin/setup
DELETED
data/lib/PushRadar.rb
DELETED
@@ -1,384 +0,0 @@
|
|
1
|
-
require 'PushRadar/version'
|
2
|
-
require 'PushRadar/Targeting'
|
3
|
-
require 'PushRadar/APIClient'
|
4
|
-
require 'json'
|
5
|
-
require 'digest/md5'
|
6
|
-
|
7
|
-
module PushRadar
|
8
|
-
|
9
|
-
# A realtime push notifications API service for the web, featuring advanced targeting
|
10
|
-
class Radar
|
11
|
-
|
12
|
-
# Creates a new instance of PushRadar with the specified API secret
|
13
|
-
def initialize(api_secret)
|
14
|
-
|
15
|
-
# Initialize data
|
16
|
-
@data = {}
|
17
|
-
|
18
|
-
# Reset the targeting options
|
19
|
-
reset_targeting
|
20
|
-
|
21
|
-
# Check that the API secret is a string
|
22
|
-
unless api_secret.is_a?(String)
|
23
|
-
raise 'The API secret must be a string value.'
|
24
|
-
end
|
25
|
-
|
26
|
-
# Trim the API secret
|
27
|
-
api_secret.strip!
|
28
|
-
|
29
|
-
# If we are running unit tests, set the unit test mode flag and skip the PushRadar API client initialisation
|
30
|
-
if api_secret == 'test-secret'
|
31
|
-
@is_unit_test_mode = true
|
32
|
-
return
|
33
|
-
else
|
34
|
-
@is_unit_test_mode = false
|
35
|
-
end
|
36
|
-
|
37
|
-
# Check that the API secret starts with sk_
|
38
|
-
unless api_secret.start_with?('sk_')
|
39
|
-
raise 'API secret invalid. You can view your PushRadar API secret at https://dashboard.pushradar.com/api'
|
40
|
-
end
|
41
|
-
|
42
|
-
# Make a new instance of a PushRadar API client with the specified API secret
|
43
|
-
@api_client = APIClient.new(api_secret)
|
44
|
-
|
45
|
-
end
|
46
|
-
|
47
|
-
# Targets the notification to clients currently using the given browser
|
48
|
-
def target_browser(browser)
|
49
|
-
|
50
|
-
# Add the browser to the list of target browsers
|
51
|
-
@targeting.target_browser browser
|
52
|
-
|
53
|
-
# Allow method chaining
|
54
|
-
self
|
55
|
-
|
56
|
-
end
|
57
|
-
|
58
|
-
# Targets the notification to clients currently using any of the given browsers
|
59
|
-
def target_browsers(*browsers)
|
60
|
-
|
61
|
-
# Target each browser
|
62
|
-
browsers.each {|x|
|
63
|
-
target_browser x
|
64
|
-
}
|
65
|
-
|
66
|
-
# Allow method chaining
|
67
|
-
self
|
68
|
-
|
69
|
-
end
|
70
|
-
|
71
|
-
# Targets the notification to clients currently located in the given country
|
72
|
-
def target_country(country_code)
|
73
|
-
|
74
|
-
# Add the country to the list of target countries
|
75
|
-
@targeting.target_country country_code
|
76
|
-
|
77
|
-
# Allow method chaining
|
78
|
-
self
|
79
|
-
|
80
|
-
end
|
81
|
-
|
82
|
-
# Targets the notification to clients currently located in any of the given countries
|
83
|
-
def target_countries(*country_codes)
|
84
|
-
|
85
|
-
# Target each country
|
86
|
-
country_codes.each {|x|
|
87
|
-
target_country x
|
88
|
-
}
|
89
|
-
|
90
|
-
# Allow method chaining
|
91
|
-
self
|
92
|
-
|
93
|
-
end
|
94
|
-
|
95
|
-
# Targets the notification to clients currently located in Asia
|
96
|
-
def target_asia
|
97
|
-
|
98
|
-
# Target the continent
|
99
|
-
@targeting.target_continent('AS')
|
100
|
-
|
101
|
-
# Allow method chaining
|
102
|
-
self
|
103
|
-
|
104
|
-
end
|
105
|
-
|
106
|
-
# Targets the notification to clients currently located in Africa
|
107
|
-
def target_africa
|
108
|
-
|
109
|
-
# Target the continent
|
110
|
-
@targeting.target_continent('AF')
|
111
|
-
|
112
|
-
# Allow method chaining
|
113
|
-
self
|
114
|
-
|
115
|
-
end
|
116
|
-
|
117
|
-
# Targets the notification to clients currently located in Antarctica
|
118
|
-
def target_antarctica
|
119
|
-
|
120
|
-
# Target the continent
|
121
|
-
@targeting.target_continent('AN')
|
122
|
-
|
123
|
-
# Allow method chaining
|
124
|
-
self
|
125
|
-
|
126
|
-
end
|
127
|
-
|
128
|
-
# Targets the notification to clients currently located in Europe
|
129
|
-
def target_europe
|
130
|
-
|
131
|
-
# Target the continent
|
132
|
-
@targeting.target_continent('EU')
|
133
|
-
|
134
|
-
# Allow method chaining
|
135
|
-
self
|
136
|
-
|
137
|
-
end
|
138
|
-
|
139
|
-
# Targets the notification to clients currently located in North America
|
140
|
-
def target_north_america
|
141
|
-
|
142
|
-
# Target the continent
|
143
|
-
@targeting.target_continent('NA')
|
144
|
-
|
145
|
-
# Allow method chaining
|
146
|
-
self
|
147
|
-
|
148
|
-
end
|
149
|
-
|
150
|
-
# Targets the notification to clients currently located in South America
|
151
|
-
def target_south_america
|
152
|
-
|
153
|
-
# Target the continent
|
154
|
-
@targeting.target_continent('SA')
|
155
|
-
|
156
|
-
# Allow method chaining
|
157
|
-
self
|
158
|
-
|
159
|
-
end
|
160
|
-
|
161
|
-
# Targets the notification to clients currently located in Oceania
|
162
|
-
def target_oceania
|
163
|
-
|
164
|
-
# Target the continent
|
165
|
-
@targeting.target_continent('OC')
|
166
|
-
|
167
|
-
# Allow method chaining
|
168
|
-
self
|
169
|
-
|
170
|
-
end
|
171
|
-
|
172
|
-
# Targets the notification to clients with the given IP address
|
173
|
-
def target_ip(ip_address)
|
174
|
-
|
175
|
-
# Add the IP address to the list of target IP addresses
|
176
|
-
@targeting.target_ip ip_address
|
177
|
-
|
178
|
-
# Allow method chaining
|
179
|
-
self
|
180
|
-
|
181
|
-
end
|
182
|
-
|
183
|
-
# Targets the notification to clients with any of the given IP addresses
|
184
|
-
def target_ips(*ip_addresses)
|
185
|
-
|
186
|
-
# Target each IP address
|
187
|
-
ip_addresses.each {|x|
|
188
|
-
target_ip x
|
189
|
-
}
|
190
|
-
|
191
|
-
# Allow method chaining
|
192
|
-
self
|
193
|
-
|
194
|
-
end
|
195
|
-
|
196
|
-
# Targets the notification to clients who have taken the given action
|
197
|
-
def target_action(action)
|
198
|
-
|
199
|
-
# Add the action to the list of target actions
|
200
|
-
@targeting.target_action action
|
201
|
-
|
202
|
-
# Allow method chaining
|
203
|
-
self
|
204
|
-
|
205
|
-
end
|
206
|
-
|
207
|
-
# Targets the notification to clients who have taken any of the given actions
|
208
|
-
def target_actions(*actions)
|
209
|
-
|
210
|
-
# Target each action
|
211
|
-
actions.each {|x|
|
212
|
-
target_action x
|
213
|
-
}
|
214
|
-
|
215
|
-
# Allow method chaining
|
216
|
-
self
|
217
|
-
|
218
|
-
end
|
219
|
-
|
220
|
-
# Targets the notification to clients who have not taken the given action
|
221
|
-
def target_not_action(action)
|
222
|
-
|
223
|
-
# Add the action to the list of target "not" actions
|
224
|
-
@targeting.target_not_action action
|
225
|
-
|
226
|
-
# Allow method chaining
|
227
|
-
self
|
228
|
-
|
229
|
-
end
|
230
|
-
|
231
|
-
# Targets the notification to clients who have not taken any of the given actions
|
232
|
-
def target_not_actions(*actions)
|
233
|
-
|
234
|
-
# Target each action
|
235
|
-
actions.each {|x|
|
236
|
-
target_not_action x
|
237
|
-
}
|
238
|
-
|
239
|
-
# Allow method chaining
|
240
|
-
self
|
241
|
-
|
242
|
-
end
|
243
|
-
|
244
|
-
# Targets the notification to a specific user (identified by their user ID)
|
245
|
-
def target_user(user_id)
|
246
|
-
|
247
|
-
# Target the user
|
248
|
-
@targeting.target_user user_id
|
249
|
-
|
250
|
-
# Allow method chaining
|
251
|
-
self
|
252
|
-
|
253
|
-
end
|
254
|
-
|
255
|
-
# Targets the notification to specific users (identified by their user IDs)
|
256
|
-
def target_users(*user_ids)
|
257
|
-
|
258
|
-
# Target the user IDs
|
259
|
-
user_ids.each {|x|
|
260
|
-
target_user x
|
261
|
-
}
|
262
|
-
|
263
|
-
# Allow method chaining
|
264
|
-
self
|
265
|
-
|
266
|
-
end
|
267
|
-
|
268
|
-
# Adds a data item to the list of data items
|
269
|
-
def add_data_item(key, value)
|
270
|
-
|
271
|
-
# Make sure the key is not empty
|
272
|
-
if key == ''
|
273
|
-
raise 'The key provided cannot be empty.'
|
274
|
-
end
|
275
|
-
|
276
|
-
# Add the data item
|
277
|
-
unless @data.keys.include?(key)
|
278
|
-
@data[key] = value
|
279
|
-
end
|
280
|
-
|
281
|
-
# Allow method chaining
|
282
|
-
self
|
283
|
-
|
284
|
-
end
|
285
|
-
|
286
|
-
# Adds multiple data items to the list of data items
|
287
|
-
def add_data_items(data = {})
|
288
|
-
|
289
|
-
# Add the data items
|
290
|
-
data.keys.each {|x|
|
291
|
-
add_data_item x, data[x]
|
292
|
-
}
|
293
|
-
|
294
|
-
# Allow method chaining
|
295
|
-
self
|
296
|
-
|
297
|
-
end
|
298
|
-
|
299
|
-
# Broadcasts data on the channel specified
|
300
|
-
def broadcast(channel, data = {})
|
301
|
-
|
302
|
-
# If we are running unit tests, throw an exception
|
303
|
-
if @is_unit_test_mode
|
304
|
-
raise 'Unit testing of the broadcast() method is not supported.'
|
305
|
-
end
|
306
|
-
|
307
|
-
# Trim the channel name
|
308
|
-
channel.strip!
|
309
|
-
|
310
|
-
# Check whether data has been provided
|
311
|
-
if data.length == 0 && @data.length == 0
|
312
|
-
raise 'There is no data to broadcast.'
|
313
|
-
end
|
314
|
-
|
315
|
-
# Check whether the channel name contains spaces
|
316
|
-
if channel.include? ' '
|
317
|
-
raise "The channel name cannot contain spaces. By convention, channel names are alphanumerical and lowercase, with optional dashes (e.g. 'test-channel')."
|
318
|
-
end
|
319
|
-
|
320
|
-
# Use the stored data if the data parameter is empty
|
321
|
-
if data.length == 0
|
322
|
-
data = @data
|
323
|
-
else
|
324
|
-
data.keys.each {|x|
|
325
|
-
@data[x] = data[x]
|
326
|
-
}
|
327
|
-
data = @data
|
328
|
-
end
|
329
|
-
|
330
|
-
# Initialize the hash of data to send to the server
|
331
|
-
data_to_send = {
|
332
|
-
notification: {
|
333
|
-
channel: channel,
|
334
|
-
data: data,
|
335
|
-
userIDs: @targeting.instance_variable_get('@target_user_ids'),
|
336
|
-
actions: @targeting.instance_variable_get('@target_actions'),
|
337
|
-
notActions: @targeting.instance_variable_get('@target_not_actions'),
|
338
|
-
continents: @targeting.instance_variable_get('@target_continents'),
|
339
|
-
countries: @targeting.instance_variable_get('@target_countries'),
|
340
|
-
ipAddresses: @targeting.instance_variable_get('@target_ips'),
|
341
|
-
browsers: @targeting.instance_variable_get('@target_browsers'),
|
342
|
-
}.to_json
|
343
|
-
}
|
344
|
-
|
345
|
-
# Broadcast the notification
|
346
|
-
@api_client.post('/broadcast', data_to_send)
|
347
|
-
|
348
|
-
# Reset the targeting options
|
349
|
-
reset_targeting
|
350
|
-
|
351
|
-
end
|
352
|
-
|
353
|
-
def channel_auth(channel)
|
354
|
-
|
355
|
-
# Trim the channel name
|
356
|
-
channel.strip!
|
357
|
-
|
358
|
-
unless (channel.start_with? "private-") || (channel.start_with? "presence-")
|
359
|
-
raise "Channel authentication can only be used with private or presence channels."
|
360
|
-
end
|
361
|
-
|
362
|
-
# Generate the channel authentication token
|
363
|
-
channel_auth_token = "channel_auth_token_" + Digest::MD5.hexdigest(channel) + "." + (0...8).map { (65 + rand(26)).chr }.join + ".0x" + (0...8).map { (65 + rand(26)).chr }.join
|
364
|
-
|
365
|
-
# Broadcast the notification
|
366
|
-
@api_client.post('/channel-auth', {
|
367
|
-
authToken: channel_auth_token
|
368
|
-
})
|
369
|
-
|
370
|
-
channel_auth_token
|
371
|
-
|
372
|
-
end
|
373
|
-
|
374
|
-
# Resets the targeting options
|
375
|
-
def reset_targeting
|
376
|
-
@targeting = Targeting.new
|
377
|
-
end
|
378
|
-
|
379
|
-
# Set which methods are private
|
380
|
-
private :reset_targeting
|
381
|
-
|
382
|
-
end
|
383
|
-
|
384
|
-
end
|
data/lib/PushRadar/APIClient.rb
DELETED
@@ -1,53 +0,0 @@
|
|
1
|
-
require 'PushRadar/version'
|
2
|
-
require 'PushRadar/Targeting'
|
3
|
-
require 'net/http'
|
4
|
-
require 'json'
|
5
|
-
require 'openssl'
|
6
|
-
|
7
|
-
module PushRadar
|
8
|
-
|
9
|
-
# A client that interacts with PushRadar's API
|
10
|
-
class APIClient
|
11
|
-
|
12
|
-
# Creates a new instance of the PushRadar API client with the specified API secret
|
13
|
-
def initialize(api_secret)
|
14
|
-
|
15
|
-
# Set the API secret
|
16
|
-
api_secret.strip!
|
17
|
-
@api_secret = api_secret
|
18
|
-
|
19
|
-
# Set the API endpoint
|
20
|
-
@api_endpoint = 'https://api.pushradar.com/v2'
|
21
|
-
|
22
|
-
end
|
23
|
-
|
24
|
-
# Performs a POST request to the API destination specified
|
25
|
-
def post(destination, data)
|
26
|
-
|
27
|
-
# Add in the fields that should be sent with each request
|
28
|
-
data['apiSecret'] = @api_secret
|
29
|
-
data['clientPlatform'] = 'ruby'
|
30
|
-
data['timestamp'] = Time.now.to_i
|
31
|
-
|
32
|
-
# Make sure the destination does not contain the base URL or forward slash characters
|
33
|
-
destination = destination.gsub('/', '')
|
34
|
-
destination.sub! @api_endpoint, ''
|
35
|
-
|
36
|
-
# Construct the actual URL to POST the data to
|
37
|
-
url = @api_endpoint + '/' + destination
|
38
|
-
|
39
|
-
# Send a POST request to the server
|
40
|
-
uri = URI.parse(url)
|
41
|
-
http = Net::HTTP.new(uri.host, uri.port)
|
42
|
-
http.use_ssl = true
|
43
|
-
req = Net::HTTP::Post.new(url)
|
44
|
-
req.content_type = 'application/x-www-form-urlencoded'
|
45
|
-
data = URI.encode_www_form(data)
|
46
|
-
req.body = data
|
47
|
-
http.request(req)
|
48
|
-
|
49
|
-
end
|
50
|
-
|
51
|
-
end
|
52
|
-
|
53
|
-
end
|