urbanairship 5.9.0 → 8.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/PULL_REQUEST_TEMPLATE.md +2 -2
- data/.github/workflows/ci.yaml +23 -0
- data/.gitignore +1 -0
- data/CHANGELOG +25 -0
- data/README.rst +97 -41
- data/docs/attributes.rst +21 -0
- data/docs/named_user.rst +22 -0
- data/lib/urbanairship/ab_tests/ab_test.rb +8 -9
- data/lib/urbanairship/automations/automation.rb +11 -11
- data/lib/urbanairship/client.rb +14 -5
- data/lib/urbanairship/common.rb +110 -43
- data/lib/urbanairship/configuration.rb +2 -1
- data/lib/urbanairship/custom_events/custom_event.rb +60 -0
- data/lib/urbanairship/custom_events/payload.rb +89 -0
- data/lib/urbanairship/devices/attributes.rb +53 -0
- data/lib/urbanairship/devices/channel_tags.rb +2 -2
- data/lib/urbanairship/devices/channel_uninstall.rb +9 -9
- data/lib/urbanairship/devices/create_and_send.rb +4 -4
- data/lib/urbanairship/devices/devicelist.rb +8 -8
- data/lib/urbanairship/devices/email.rb +5 -5
- data/lib/urbanairship/devices/named_user.rb +22 -12
- data/lib/urbanairship/devices/open_channel.rb +22 -23
- data/lib/urbanairship/devices/segment.rb +6 -8
- data/lib/urbanairship/devices/sms.rb +8 -8
- data/lib/urbanairship/devices/static_lists.rb +7 -7
- data/lib/urbanairship/push/location.rb +18 -18
- data/lib/urbanairship/push/push.rb +5 -5
- data/lib/urbanairship/reports/response_statistics.rb +42 -31
- data/lib/urbanairship/version.rb +1 -1
- data/lib/urbanairship.rb +6 -0
- data/urbanairship.gemspec +1 -0
- metadata +24 -7
- data/.travis.yml +0 -4
@@ -4,22 +4,33 @@ require 'time'
|
|
4
4
|
module Urbanairship
|
5
5
|
module Reports
|
6
6
|
class Helper
|
7
|
-
def
|
8
|
-
|
9
|
-
|
10
|
-
precision_array = %w(HOURLY DAILY MONTHLY)
|
11
|
-
fail ArgumentError,
|
12
|
-
"Precision must be 'HOURLY', 'DAILY', or 'MONTHLY'" unless precision_array.include?(precision)
|
7
|
+
def get_period_params(start_date, end_date, precision)
|
8
|
+
validates_parameters_presence!(start_date, end_date, precision)
|
9
|
+
validates_precision_format!(precision)
|
13
10
|
|
14
11
|
begin
|
15
|
-
start_parsed = Time.parse(start_date)
|
16
|
-
end_parsed = Time.parse(end_date)
|
12
|
+
start_parsed = Time.parse(start_date).iso8601
|
13
|
+
end_parsed = Time.parse(end_date).iso8601
|
14
|
+
|
15
|
+
"?start=#{start_parsed}&end=#{end_parsed}&precision=#{precision}"
|
17
16
|
rescue ArgumentError
|
18
|
-
fail ArgumentError,
|
19
|
-
'start_date and end_date must be valid date strings'
|
17
|
+
fail ArgumentError, 'start_date and end_date must be valid date strings'
|
20
18
|
end
|
21
|
-
|
22
|
-
|
19
|
+
end
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def validates_parameters_presence!(start_date, end_date, precision)
|
24
|
+
return unless [start_date, end_date, precision].any?(&:nil?)
|
25
|
+
|
26
|
+
fail ArgumentError, 'the parameters cannot be set to nil'
|
27
|
+
end
|
28
|
+
|
29
|
+
AUTHORIZED_PRECISIONS = %w(HOURLY DAILY MONTHLY)
|
30
|
+
def validates_precision_format!(precision)
|
31
|
+
return if AUTHORIZED_PRECISIONS.include?(precision)
|
32
|
+
|
33
|
+
fail ArgumentError, 'Precision must be "HOURLY", "DAILY", or "MONTHLY"'
|
23
34
|
end
|
24
35
|
end
|
25
36
|
|
@@ -35,8 +46,8 @@ module Urbanairship
|
|
35
46
|
fail ArgumentError,
|
36
47
|
'push_id cannot be nil' if push_id.nil?
|
37
48
|
|
38
|
-
|
39
|
-
response = @client.send_request(method: 'GET',
|
49
|
+
path = reports_path('responses/' + push_id)
|
50
|
+
response = @client.send_request(method: 'GET', path: path)
|
40
51
|
logger.info("Retrieved info on push_id: #{push_id}")
|
41
52
|
response
|
42
53
|
end
|
@@ -60,10 +71,10 @@ module Urbanairship
|
|
60
71
|
fail ArgumentError,
|
61
72
|
'start_date and end_date must be valid date strings'
|
62
73
|
end
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
@
|
74
|
+
path = reports_path('responses/list?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601)
|
75
|
+
path += '&limit' + limit.to_s unless limit.nil?
|
76
|
+
path += '&push_id_start&' + push_id_start unless push_id_start.nil?
|
77
|
+
@next_page_path = path
|
67
78
|
@data_attribute = 'pushes'
|
68
79
|
end
|
69
80
|
end
|
@@ -87,7 +98,7 @@ module Urbanairship
|
|
87
98
|
end
|
88
99
|
response = @client.send_request(
|
89
100
|
method: 'GET',
|
90
|
-
|
101
|
+
path: reports_path('devices/?date=' + date_parsed.iso8601)
|
91
102
|
)
|
92
103
|
logger.info("Retrieved device report for date #{date}")
|
93
104
|
response
|
@@ -98,8 +109,8 @@ module Urbanairship
|
|
98
109
|
def initialize(client: required('client'), start_date: required('start_date'),
|
99
110
|
end_date: required('end_date'), precision: required('precision'))
|
100
111
|
super(client: client)
|
101
|
-
|
102
|
-
@
|
112
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
113
|
+
@next_page_path = reports_path('optins/' + period_params)
|
103
114
|
@data_attribute = 'optins'
|
104
115
|
end
|
105
116
|
end
|
@@ -108,8 +119,8 @@ module Urbanairship
|
|
108
119
|
def initialize(client: required('client'), start_date: required('start_date'),
|
109
120
|
end_date: required('end_date'), precision: required('precision'))
|
110
121
|
super(client: client)
|
111
|
-
|
112
|
-
@
|
122
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
123
|
+
@next_page_path = reports_path('optouts/' + period_params)
|
113
124
|
@data_attribute = 'optouts'
|
114
125
|
end
|
115
126
|
end
|
@@ -118,8 +129,8 @@ module Urbanairship
|
|
118
129
|
def initialize(client: required('client'), start_date: required('start_date'),
|
119
130
|
end_date: required('end_date'), precision: required('precision'))
|
120
131
|
super(client: client)
|
121
|
-
|
122
|
-
@
|
132
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
133
|
+
@next_page_path = reports_path('sends/' + period_params)
|
123
134
|
@data_attribute = 'sends'
|
124
135
|
end
|
125
136
|
end
|
@@ -128,8 +139,8 @@ module Urbanairship
|
|
128
139
|
def initialize(client: required('client'), start_date: required('start_date'),
|
129
140
|
end_date: required('end_date'), precision: required('precision'))
|
130
141
|
super(client: client)
|
131
|
-
|
132
|
-
@
|
142
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
143
|
+
@next_page_path = reports_path('responses/' + period_params)
|
133
144
|
@data_attribute = 'responses'
|
134
145
|
end
|
135
146
|
end
|
@@ -138,8 +149,8 @@ module Urbanairship
|
|
138
149
|
def initialize(client: required('client'), start_date: required('start_date'),
|
139
150
|
end_date: required('end_date'), precision: required('precision'))
|
140
151
|
super(client: client)
|
141
|
-
|
142
|
-
@
|
152
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
153
|
+
@next_page_path = reports_path('opens/' + period_params)
|
143
154
|
@data_attribute = 'opens'
|
144
155
|
end
|
145
156
|
end
|
@@ -148,8 +159,8 @@ module Urbanairship
|
|
148
159
|
def initialize(client: required('client'), start_date: required('start_date'),
|
149
160
|
end_date: required('end_date'), precision: required('precision'))
|
150
161
|
super(client: client)
|
151
|
-
|
152
|
-
@
|
162
|
+
period_params = Helper.new.get_period_params(start_date, end_date, precision)
|
163
|
+
@next_page_path = reports_path('timeinapp/' + period_params)
|
153
164
|
@data_attribute = 'timeinapp'
|
154
165
|
end
|
155
166
|
end
|
data/lib/urbanairship/version.rb
CHANGED
data/lib/urbanairship.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
require 'urbanairship/custom_events/custom_event'
|
2
|
+
require 'urbanairship/custom_events/payload'
|
1
3
|
require 'urbanairship/push/audience'
|
2
4
|
require 'urbanairship/push/payload'
|
3
5
|
require 'urbanairship/push/schedule'
|
@@ -11,6 +13,7 @@ require 'urbanairship/devices/sms_notification'
|
|
11
13
|
require 'urbanairship/devices/mms_notification'
|
12
14
|
require 'urbanairship/devices/create_and_send'
|
13
15
|
require 'urbanairship/devices/attribute'
|
16
|
+
require 'urbanairship/devices/attributes'
|
14
17
|
require 'urbanairship/client'
|
15
18
|
require 'urbanairship/common'
|
16
19
|
require 'urbanairship/configuration'
|
@@ -31,10 +34,13 @@ require 'urbanairship/ab_tests/experiment'
|
|
31
34
|
require 'urbanairship/ab_tests/ab_test'
|
32
35
|
|
33
36
|
module Urbanairship
|
37
|
+
extend Urbanairship::CustomEvents::Payload
|
38
|
+
extend Urbanairship::CustomEvents
|
34
39
|
extend Urbanairship::Push::Audience
|
35
40
|
extend Urbanairship::Push::Payload
|
36
41
|
extend Urbanairship::Push::Schedule
|
37
42
|
extend Urbanairship::Push
|
43
|
+
include Urbanairship::CustomEvents
|
38
44
|
include Urbanairship::Devices
|
39
45
|
include Urbanairship::Reports
|
40
46
|
include Urbanairship::Push
|
data/urbanairship.gemspec
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: urbanairship
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 8.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Airship
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-09-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rest-client
|
@@ -114,6 +114,20 @@ dependencies:
|
|
114
114
|
- - "~>"
|
115
115
|
- !ruby/object:Gem::Version
|
116
116
|
version: '1'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: timecop
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - ">="
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - ">="
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '0'
|
117
131
|
description: A Ruby Library for using the Airship web service API for push notifications
|
118
132
|
and rich app pages.
|
119
133
|
email:
|
@@ -126,9 +140,9 @@ files:
|
|
126
140
|
- ".github/ISSUE_TEMPLATE.md"
|
127
141
|
- ".github/PULL_REQUEST_TEMPLATE.md"
|
128
142
|
- ".github/SUPPORT.md"
|
143
|
+
- ".github/workflows/ci.yaml"
|
129
144
|
- ".gitignore"
|
130
145
|
- ".rspec"
|
131
|
-
- ".travis.yml"
|
132
146
|
- CHANGELOG
|
133
147
|
- Gemfile
|
134
148
|
- Guardfile
|
@@ -168,7 +182,10 @@ files:
|
|
168
182
|
- lib/urbanairship/client.rb
|
169
183
|
- lib/urbanairship/common.rb
|
170
184
|
- lib/urbanairship/configuration.rb
|
185
|
+
- lib/urbanairship/custom_events/custom_event.rb
|
186
|
+
- lib/urbanairship/custom_events/payload.rb
|
171
187
|
- lib/urbanairship/devices/attribute.rb
|
188
|
+
- lib/urbanairship/devices/attributes.rb
|
172
189
|
- lib/urbanairship/devices/channel_tags.rb
|
173
190
|
- lib/urbanairship/devices/channel_uninstall.rb
|
174
191
|
- lib/urbanairship/devices/create_and_send.rb
|
@@ -197,7 +214,7 @@ licenses:
|
|
197
214
|
- Apache-2.0
|
198
215
|
metadata:
|
199
216
|
allowed_push_host: https://rubygems.org
|
200
|
-
post_install_message:
|
217
|
+
post_install_message:
|
201
218
|
rdoc_options: []
|
202
219
|
require_paths:
|
203
220
|
- lib
|
@@ -212,8 +229,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
212
229
|
- !ruby/object:Gem::Version
|
213
230
|
version: '0'
|
214
231
|
requirements: []
|
215
|
-
rubygems_version: 3.0.
|
216
|
-
signing_key:
|
232
|
+
rubygems_version: 3.0.3
|
233
|
+
signing_key:
|
217
234
|
specification_version: 4
|
218
235
|
summary: Ruby Gem for using the Airship API
|
219
236
|
test_files: []
|
data/.travis.yml
DELETED