urbanairship 5.2.0 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/CONTRIBUTING.md +1 -1
- data/.github/ISSUE_TEMPLATE.md +2 -2
- data/.github/PULL_REQUEST_TEMPLATE.md +7 -2
- data/.github/SUPPORT.md +3 -3
- data/CHANGELOG +7 -0
- data/LICENSE +1 -1
- data/README.rst +18 -16
- data/docs/channel_uninstall.rst +1 -1
- data/docs/conf.py +11 -6
- data/docs/devices.rst +1 -1
- data/docs/index.rst +4 -4
- data/docs/location.rst +6 -6
- data/docs/named_user.rst +5 -5
- data/docs/push.rst +11 -11
- data/docs/reports.rst +9 -9
- data/docs/segment.rst +5 -5
- data/docs/static_lists.rst +2 -2
- data/docs/tags.rst +1 -1
- data/lib/urbanairship/client.rb +1 -1
- data/lib/urbanairship/common.rb +2 -2
- data/lib/urbanairship/version.rb +1 -1
- data/urbanairship.gemspec +4 -4
- metadata +6 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 89a2dd8ea947124afb2b33d67685c2d0762494f5c7b1505d616b96dce7823716
|
|
4
|
+
data.tar.gz: 8b9b327b33f80b7ba37fcd582387cfe21969177dd2635e8eca0f10bc83fd1043
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c0cf3ac30c1e4459fc03597f72536dc3780e13c401c76fc96479df5290ad5fb002d4e13a42ac7b932688d59e9b08377599b672fd1e994e4a7f1be1635c6c8e21
|
|
7
|
+
data.tar.gz: 791b89dccbbd9580e077611ed8cb3acd8de2b1563be996653cb0cd349892a5072d9cc460c6a318dde0d9eb641dd4d6199b757f4c2cfca201a5ddc76047d16d3c
|
data/.github/CONTRIBUTING.md
CHANGED
|
@@ -6,6 +6,6 @@ The Contributor License Agreement (CLA) below is to ensure that when someone con
|
|
|
6
6
|
|
|
7
7
|
Please read through the agreement at the URL below.
|
|
8
8
|
|
|
9
|
-
If you have questions about this agreement or why we need it please contact us at https://support.
|
|
9
|
+
If you have questions about this agreement or why we need it please contact us at https://support.airship.com/.
|
|
10
10
|
|
|
11
11
|
[Contribution Agreement](https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform)
|
data/.github/ISSUE_TEMPLATE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
**All bugs, feature requests, implementation concerns or general queries should be sent to our [support team](https://support.airship.com/).**
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
You are welcome to submit an issue here for bugs, but please also reach out to our support team as well.
|
|
4
4
|
|
|
5
5
|
Before completing the form below, please check the following:
|
|
6
6
|
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
**If you want your PR addressed quickly, please also reach out to our [support team](https://support.airship.com/)
|
|
2
|
+
so we can understand when you need it reviewed and how it is impacting your use of our services.** We also generally
|
|
3
|
+
will not release new versions of our library without new feature support, a bug fix, or a clear reason from a customer
|
|
4
|
+
why an update is required to minimize how often other customers need to update.
|
|
5
|
+
|
|
1
6
|
### What does this do and why?
|
|
2
7
|
Please include link to open issue if applicable.
|
|
3
8
|
|
|
@@ -13,10 +18,10 @@ Please include link to open issue if applicable.
|
|
|
13
18
|
- [ ] 2.2.5
|
|
14
19
|
- [ ] 2.3.1
|
|
15
20
|
|
|
16
|
-
###
|
|
21
|
+
### Airship Contribution Agreement
|
|
17
22
|
[Link here](https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform)
|
|
18
23
|
|
|
19
|
-
- [ ] I've filled out and signed
|
|
24
|
+
- [ ] I've filled out and signed Airship's contribution agreement form.
|
|
20
25
|
|
|
21
26
|
### Screenshots
|
|
22
27
|
* If applicable
|
data/.github/SUPPORT.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Support Requests
|
|
2
2
|
|
|
3
|
-
All requests for support including implementation support and feature requests are made to the
|
|
3
|
+
All requests for support including implementation support and feature requests are made to the Airship support team.
|
|
4
4
|
|
|
5
|
-
You can contact them by visiting https://support.
|
|
5
|
+
You can contact them by visiting https://support.airship.com/
|
|
6
6
|
|
|
7
7
|
# Documentation
|
|
8
8
|
|
|
9
9
|
Documentation for the library can be found here:
|
|
10
|
-
https://docs.
|
|
10
|
+
https://docs.airship.com/api/libraries/ruby/
|
data/CHANGELOG
CHANGED
data/LICENSE
CHANGED
data/README.rst
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
About
|
|
5
5
|
=====
|
|
6
6
|
|
|
7
|
-
``urbanairship`` is a Ruby library for using the `
|
|
8
|
-
<http://
|
|
9
|
-
|
|
7
|
+
``urbanairship`` is a Ruby library for using the `Airship
|
|
8
|
+
<http://airship.com/>`_ REST API for push notifications, message
|
|
9
|
+
center messages, email, and SMS.
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
Requirements
|
|
@@ -26,6 +26,13 @@ Functionality
|
|
|
26
26
|
Version 5.0 is a major upgrade, as some features have been removed that were present in earlier versions. A more detailed list of changes can be found in the CHANGELOG.
|
|
27
27
|
|
|
28
28
|
|
|
29
|
+
Questions
|
|
30
|
+
=========
|
|
31
|
+
|
|
32
|
+
The best place to ask questions or report a problem is our support site:
|
|
33
|
+
http://support.airship.com/
|
|
34
|
+
|
|
35
|
+
|
|
29
36
|
Installation
|
|
30
37
|
============
|
|
31
38
|
|
|
@@ -78,11 +85,11 @@ Usage
|
|
|
78
85
|
|
|
79
86
|
Once the gem has been installed you can start sending pushes!
|
|
80
87
|
See the `full documentation
|
|
81
|
-
<http://docs.
|
|
88
|
+
<http://docs.airship.com/reference/libraries/ruby>`_,
|
|
82
89
|
`api examples
|
|
83
|
-
<http://docs.
|
|
84
|
-
`
|
|
85
|
-
<http://docs.
|
|
90
|
+
<http://docs.airship.com/topic-guides/api-examples.html>`_, as well as the
|
|
91
|
+
`Airship API Documentation
|
|
92
|
+
<http://docs.airship.com/api/>`_ for more
|
|
86
93
|
information.
|
|
87
94
|
|
|
88
95
|
|
|
@@ -112,13 +119,6 @@ Simple Tag Push
|
|
|
112
119
|
>>> p.send_push
|
|
113
120
|
|
|
114
121
|
|
|
115
|
-
Questions
|
|
116
|
-
=========
|
|
117
|
-
|
|
118
|
-
The best place to ask questions is our support site:
|
|
119
|
-
http://support.urbanairship.com/
|
|
120
|
-
|
|
121
|
-
|
|
122
122
|
Contributing
|
|
123
123
|
============
|
|
124
124
|
|
|
@@ -127,8 +127,10 @@ Contributing
|
|
|
127
127
|
3. Commit your changes ``git commit -am 'Add some feature'``
|
|
128
128
|
4. Push to the branch ``git push origin my-new-feature``
|
|
129
129
|
5. Create a new Pull Request
|
|
130
|
-
6. Sign
|
|
131
|
-
<
|
|
130
|
+
6. Sign Airship's `contribution agreement
|
|
131
|
+
<https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform>`_.
|
|
132
|
+
7. Reach out to our support team at https://support.airship.com to let
|
|
133
|
+
us know about your PR and your urgency level.
|
|
132
134
|
|
|
133
135
|
**Note**: Changes will not be approved and merged without a signed
|
|
134
136
|
contribution agreement.
|
data/docs/channel_uninstall.rst
CHANGED
|
@@ -4,7 +4,7 @@ Channel Uninstall
|
|
|
4
4
|
|
|
5
5
|
Channels can be uninstalled using ``ChannelUninstall``. There is a limit of 200 channels that
|
|
6
6
|
can be uninstalled at one time. For more information, see `the API documentation
|
|
7
|
-
<http://docs.
|
|
7
|
+
<http://docs.airship.com/api/ua.html#uninstall-channels>`__.
|
|
8
8
|
|
|
9
9
|
.. sourcecode:: ruby
|
|
10
10
|
|
data/docs/conf.py
CHANGED
|
@@ -16,6 +16,8 @@ import sys
|
|
|
16
16
|
import os
|
|
17
17
|
import shlex
|
|
18
18
|
import re
|
|
19
|
+
import sphinx_rtd_theme
|
|
20
|
+
from datetime import datetime
|
|
19
21
|
|
|
20
22
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
21
23
|
# add these directories to sys.path here. If the directory is relative to the
|
|
@@ -25,12 +27,13 @@ import re
|
|
|
25
27
|
# -- General configuration ------------------------------------------------
|
|
26
28
|
|
|
27
29
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
28
|
-
needs_sphinx = '1.
|
|
30
|
+
needs_sphinx = '1.6.7'
|
|
29
31
|
|
|
30
32
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
31
33
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
32
34
|
# ones.
|
|
33
|
-
|
|
35
|
+
|
|
36
|
+
extensions = ['sphinxcontrib.rubydomain','sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx_rtd_theme']
|
|
34
37
|
|
|
35
38
|
# Add any paths that contain templates here, relative to this directory.
|
|
36
39
|
templates_path = ['_templates']
|
|
@@ -47,9 +50,11 @@ source_suffix = '.rst'
|
|
|
47
50
|
master_doc = 'index'
|
|
48
51
|
|
|
49
52
|
# General information about the project.
|
|
53
|
+
year = datetime.now().year
|
|
50
54
|
project = u'ruby-library'
|
|
51
|
-
|
|
52
|
-
|
|
55
|
+
author = u'Airship'
|
|
56
|
+
copyright = u'%d, %s' % (year, author)
|
|
57
|
+
|
|
53
58
|
|
|
54
59
|
# The version info for the project you're documenting, acts as replacement for
|
|
55
60
|
# |version| and |release|, also used in various other places throughout the
|
|
@@ -116,7 +121,7 @@ pygments_style = 'sphinx'
|
|
|
116
121
|
|
|
117
122
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
118
123
|
# a list of builtin themes.
|
|
119
|
-
html_theme = '
|
|
124
|
+
html_theme = 'sphinx_rtd_theme'
|
|
120
125
|
|
|
121
126
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
122
127
|
# further. For a list of options available for each theme, see the
|
|
@@ -232,7 +237,7 @@ latex_elements = {
|
|
|
232
237
|
# author, documentclass [howto, manual, or own class]).
|
|
233
238
|
latex_documents = [
|
|
234
239
|
(master_doc, 'ruby-library.tex', u'ruby-library Documentation',
|
|
235
|
-
u'
|
|
240
|
+
u'Airship', 'manual'),
|
|
236
241
|
]
|
|
237
242
|
|
|
238
243
|
# The name of an image file (relative to this directory) to place at the top of
|
data/docs/devices.rst
CHANGED
|
@@ -6,7 +6,7 @@ Channel Listing
|
|
|
6
6
|
|
|
7
7
|
Device lists are fetched by instantiating an iterator object
|
|
8
8
|
using :rb:class:`ChannelList`. For more information, see `the API
|
|
9
|
-
documentation for channels <http://docs.
|
|
9
|
+
documentation for channels <http://docs.airship.com/api/ua.html#channels>`_.
|
|
10
10
|
The ``count`` method will give you the number of channels over which you have iterated.
|
|
11
11
|
|
|
12
12
|
.. code-block:: ruby
|
data/docs/index.rst
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
Airship Ruby Library
|
|
2
2
|
==========================
|
|
3
3
|
|
|
4
|
-
``urbanairship`` is a Ruby library for using the `
|
|
5
|
-
<http://
|
|
4
|
+
``urbanairship`` is a Ruby library for using the `Airship
|
|
5
|
+
<http://airship.com/>`_ web service API for push notifications and
|
|
6
6
|
rich app pages.
|
|
7
7
|
|
|
8
8
|
|
|
@@ -79,7 +79,7 @@ Indices and tables
|
|
|
79
79
|
* :ref:`search`
|
|
80
80
|
|
|
81
81
|
|
|
82
|
-
.. _channels: http://docs.
|
|
82
|
+
.. _channels: http://docs.airship.com/topic-guides/channels.html
|
|
83
83
|
.. _unirest: http://unirest.io/ruby.html
|
|
84
84
|
.. _github: https://github.com/urbanairship/ruby-library
|
|
85
85
|
.. _rspec: https://nose.readthedocs.org/en/latest/
|
data/docs/location.rst
CHANGED
|
@@ -11,7 +11,7 @@ Name Lookup
|
|
|
11
11
|
Search for a location boundary by name. The search primarily
|
|
12
12
|
uses the location names, but you can also filter the results
|
|
13
13
|
by boundary type. See `the API documentation on location
|
|
14
|
-
<http://docs.
|
|
14
|
+
<http://docs.airship.com/api/ua.html#location>`_
|
|
15
15
|
for more information.
|
|
16
16
|
|
|
17
17
|
.. code-block:: ruby
|
|
@@ -32,7 +32,7 @@ Coordinates Lookup
|
|
|
32
32
|
|
|
33
33
|
Search for a location by latitude and longitude coordinates. Type is
|
|
34
34
|
an optional parameter. See `the API documentation on coordinates lookup
|
|
35
|
-
<http://docs.
|
|
35
|
+
<http://docs.airship.com/api/ua.html#lat-long-lookup>`_
|
|
36
36
|
for more information.
|
|
37
37
|
|
|
38
38
|
.. code-block:: ruby
|
|
@@ -54,7 +54,7 @@ Bounding Box Lookup
|
|
|
54
54
|
|
|
55
55
|
Search for location using a bounding box. See `the documentation on
|
|
56
56
|
bounding box lookup
|
|
57
|
-
<http://docs.
|
|
57
|
+
<http://docs.airship.com/api/ua.html#bounding-box-lookup>`_
|
|
58
58
|
for more information.
|
|
59
59
|
|
|
60
60
|
.. code-block:: ruby
|
|
@@ -76,7 +76,7 @@ Alias Lookup
|
|
|
76
76
|
------------
|
|
77
77
|
|
|
78
78
|
Search for location by alias. See `the documentation on alias lookup
|
|
79
|
-
<http://docs.
|
|
79
|
+
<http://docs.airship.com/api/ua.html#alias-lookup>`_
|
|
80
80
|
|
|
81
81
|
.. code-block:: ruby
|
|
82
82
|
|
|
@@ -95,7 +95,7 @@ Polygon Lookup
|
|
|
95
95
|
--------------
|
|
96
96
|
|
|
97
97
|
Search for location by polygon id. See `the documentation on polygon
|
|
98
|
-
lookup <http://docs.
|
|
98
|
+
lookup <http://docs.airship.com/api/ua.html#polygon-lookup>`_
|
|
99
99
|
for more information.
|
|
100
100
|
|
|
101
101
|
.. code-block:: ruby
|
|
@@ -115,7 +115,7 @@ Location Date Ranges
|
|
|
115
115
|
--------------------
|
|
116
116
|
|
|
117
117
|
Get the possible date ranges that can be used with location endpoints. See `the documentation
|
|
118
|
-
on location date ranges <http://docs.
|
|
118
|
+
on location date ranges <http://docs.airship.com/api/ua.html#location-date-ranges>`__
|
|
119
119
|
for more information.
|
|
120
120
|
|
|
121
121
|
.. code-block:: ruby
|
data/docs/named_user.rst
CHANGED
|
@@ -7,7 +7,7 @@ Named User Listing
|
|
|
7
7
|
Named User lists are fetched by instantiating an iterator object
|
|
8
8
|
using :rb:class:`NamedUserList`.
|
|
9
9
|
For more information, see `the API documentation
|
|
10
|
-
<http://docs.
|
|
10
|
+
<http://docs.airship.com/api/ua.html#listing>`__
|
|
11
11
|
|
|
12
12
|
.. code-block:: ruby
|
|
13
13
|
|
|
@@ -25,7 +25,7 @@ Association
|
|
|
25
25
|
|
|
26
26
|
Associate a channel with a named user ID. For more information, see
|
|
27
27
|
`the API documentation
|
|
28
|
-
<http://docs.
|
|
28
|
+
<http://docs.airship.com/api/ua.html#association>`__
|
|
29
29
|
|
|
30
30
|
.. code-block:: ruby
|
|
31
31
|
|
|
@@ -45,7 +45,7 @@ Disassociation
|
|
|
45
45
|
|
|
46
46
|
Remove a channel from the list of associated channels for a named user.
|
|
47
47
|
For more information, see `the API documentation
|
|
48
|
-
<http://docs.
|
|
48
|
+
<http://docs.airship.com/api/ua.html#disassociation>`__
|
|
49
49
|
|
|
50
50
|
.. code-block:: ruby
|
|
51
51
|
|
|
@@ -66,7 +66,7 @@ Lookup
|
|
|
66
66
|
|
|
67
67
|
Look up a single named user.
|
|
68
68
|
For more information, see `the API documentation
|
|
69
|
-
<http://docs.
|
|
69
|
+
<http://docs.airship.com/api/ua.html#lookup>`__
|
|
70
70
|
|
|
71
71
|
.. code-block:: ruby
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ Tags
|
|
|
82
82
|
|
|
83
83
|
Add, remove, or set tags on a named user. For more information,
|
|
84
84
|
see `the API documentation
|
|
85
|
-
<http://docs.
|
|
85
|
+
<http://docs.airship.com/api/ua.html#tags-named-users>`__
|
|
86
86
|
|
|
87
87
|
.. code-block:: ruby
|
|
88
88
|
|
data/docs/push.rst
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Defining and Sending Push Notifications
|
|
2
2
|
=======================================
|
|
3
3
|
|
|
4
|
-
The
|
|
4
|
+
The Airship Ruby Library strives to match the standard Urban
|
|
5
5
|
Airship JSON format for specifying push notifications. When creating a
|
|
6
6
|
push notification, you:
|
|
7
7
|
|
|
@@ -140,7 +140,7 @@ Select devices that do not match the given selectors:
|
|
|
140
140
|
Select a location expression. Location selectors are made up of either an id or
|
|
141
141
|
an alias and a date period specifier. Use a date specification function to
|
|
142
142
|
generate the time period specifier. Location aliases can be found here:
|
|
143
|
-
http://docs.
|
|
143
|
+
http://docs.airship.com/reference/location_boundary_catalog.html
|
|
144
144
|
|
|
145
145
|
ID location example:
|
|
146
146
|
|
|
@@ -283,7 +283,7 @@ platform-specific alerts, and we set a number of other platform-specific options
|
|
|
283
283
|
title: 'My Title',
|
|
284
284
|
extra: { 'key' => 'value', 'key2' => 'value2' },
|
|
285
285
|
require_interaction: true,
|
|
286
|
-
icon: { 'url' => 'https://www.
|
|
286
|
+
icon: { 'url' => 'https://www.airship.com'}
|
|
287
287
|
)
|
|
288
288
|
)
|
|
289
289
|
|
|
@@ -295,12 +295,12 @@ platform-specific alerts, and we set a number of other platform-specific options
|
|
|
295
295
|
alert: 'Hello World!',
|
|
296
296
|
email: UA.email(
|
|
297
297
|
subject: 'Hello Inbox!',
|
|
298
|
-
html_body: '<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.
|
|
299
|
-
plaintext_body: 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.
|
|
298
|
+
html_body: '<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.airship.com/email/success.html\">Unsubscribe</a></p>',
|
|
299
|
+
plaintext_body: 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.airship.com/email/success.html\"]]',
|
|
300
300
|
message_type: 'commercial',
|
|
301
301
|
sender_name: 'Airship',
|
|
302
|
-
sender_address: 'team@
|
|
303
|
-
reply_to: 'no-reply@
|
|
302
|
+
sender_address: 'team@airship.com',
|
|
303
|
+
reply_to: 'no-reply@airship.com'
|
|
304
304
|
)
|
|
305
305
|
)
|
|
306
306
|
|
|
@@ -373,10 +373,10 @@ platform-specific alerts, and we set a number of other platform-specific options
|
|
|
373
373
|
Actions
|
|
374
374
|
-------
|
|
375
375
|
|
|
376
|
-
|
|
376
|
+
Airship Actions provides a convenient way to automatically
|
|
377
377
|
perform tasks by name in response to push notifications,
|
|
378
378
|
Rich App Page interactions and JavaScript. More information at
|
|
379
|
-
http://docs.
|
|
379
|
+
http://docs.airship.com/api/ua.html#actions, example:
|
|
380
380
|
|
|
381
381
|
.. code-block:: ruby
|
|
382
382
|
|
|
@@ -385,7 +385,7 @@ http://docs.urbanairship.com/api/ua.html#actions, example:
|
|
|
385
385
|
actions: UA.actions(
|
|
386
386
|
add_tag: 'new_tag',
|
|
387
387
|
remove_old: 'old_tag',
|
|
388
|
-
share: 'Check out
|
|
388
|
+
share: 'Check out Airship!',
|
|
389
389
|
open_: {
|
|
390
390
|
type: 'url',
|
|
391
391
|
content: 'http://www.example.com'
|
|
@@ -402,7 +402,7 @@ Interactive Notifications
|
|
|
402
402
|
The interactive notification payload determines the ways you can interact
|
|
403
403
|
with a notification. It contains two attributes: "type" (mandatory) and
|
|
404
404
|
"button_actions" (optional). More information at
|
|
405
|
-
http://docs.
|
|
405
|
+
http://docs.airship.com/api/ua.html#interactive-notifications
|
|
406
406
|
Example:
|
|
407
407
|
|
|
408
408
|
.. code-block:: ruby
|
data/docs/reports.rst
CHANGED
|
@@ -9,7 +9,7 @@ Returns detailed report information about a specific push notification.
|
|
|
9
9
|
Use the push_id, which is the identifier returned by the API that represents a
|
|
10
10
|
specific push message delivery.
|
|
11
11
|
For more information, see `the API documentation on individual push statistics
|
|
12
|
-
<http://docs.
|
|
12
|
+
<http://docs.airship.com/api/ua.html#individual-push-response-statistics>`_
|
|
13
13
|
|
|
14
14
|
.. code-block:: ruby
|
|
15
15
|
|
|
@@ -26,7 +26,7 @@ Devices Report
|
|
|
26
26
|
Returns an app’s opted-in and installed device counts broken out by device
|
|
27
27
|
type. This endpoint returns the same data that populates the Devices Report.
|
|
28
28
|
For more information, see `the API documentation on device reports
|
|
29
|
-
<http://docs.
|
|
29
|
+
<http://docs.airship.com/api/ua.html#devices-report-api>`_
|
|
30
30
|
|
|
31
31
|
.. code-block:: ruby
|
|
32
32
|
|
|
@@ -42,7 +42,7 @@ Push Report
|
|
|
42
42
|
|
|
43
43
|
Get the number of pushes you have sent within a specified time period.
|
|
44
44
|
For more information, see `the API documentation on push reports
|
|
45
|
-
<http://docs.
|
|
45
|
+
<http://docs.airship.com/api/ua.html#push-report>`_
|
|
46
46
|
|
|
47
47
|
.. code-block:: ruby
|
|
48
48
|
|
|
@@ -69,7 +69,7 @@ Response Report
|
|
|
69
69
|
|
|
70
70
|
Get the number of direct and influenced opens of your app. For more
|
|
71
71
|
information, see `the API documentation on reponse reports
|
|
72
|
-
<http://docs.
|
|
72
|
+
<http://docs.airship.com/api/ua.html#response-report>`_
|
|
73
73
|
|
|
74
74
|
.. code-block:: ruby
|
|
75
75
|
|
|
@@ -98,7 +98,7 @@ Get a listing of all pushes and basic response information in a given
|
|
|
98
98
|
timeframe by instantiating an iterator object using ResponseList.
|
|
99
99
|
Start and end date times are required parameters.
|
|
100
100
|
For more information, see `the API documentation on response listings
|
|
101
|
-
<http://docs.
|
|
101
|
+
<http://docs.airship.com/api/ua.html#response-listing>`_
|
|
102
102
|
|
|
103
103
|
.. code-block:: ruby
|
|
104
104
|
|
|
@@ -127,7 +127,7 @@ App Opens Report
|
|
|
127
127
|
|
|
128
128
|
Get the number of users who have opened your app within the specified time
|
|
129
129
|
period. For more information, see `the API documentation on app open reports
|
|
130
|
-
<http://docs.
|
|
130
|
+
<http://docs.airship.com/api/ua.html#app-opens-report>`_
|
|
131
131
|
|
|
132
132
|
.. code-block:: ruby
|
|
133
133
|
|
|
@@ -154,7 +154,7 @@ Time In App Report
|
|
|
154
154
|
Get the average amount of time users have spent in your app within the
|
|
155
155
|
specified time period. For more information, see `the API documentation
|
|
156
156
|
on time-in-app reports
|
|
157
|
-
<http://docs.
|
|
157
|
+
<http://docs.airship.com/api/ua.html#time-in-app-report>`_
|
|
158
158
|
|
|
159
159
|
.. code-block:: ruby
|
|
160
160
|
|
|
@@ -181,7 +181,7 @@ Opt-In Report
|
|
|
181
181
|
Get the number of opted-in push users who access the app within the specified
|
|
182
182
|
time period.
|
|
183
183
|
For more information, see `the API documentation on opt-in reports
|
|
184
|
-
<http://docs.
|
|
184
|
+
<http://docs.airship.com/api/ua.html#opt-in-report>`_
|
|
185
185
|
|
|
186
186
|
.. code-block:: ruby
|
|
187
187
|
|
|
@@ -208,7 +208,7 @@ Opt-Out Report
|
|
|
208
208
|
Get the number of opted-out push users who access the app within the specified
|
|
209
209
|
time period.
|
|
210
210
|
For more information, see `the API documentation on opt-out reports
|
|
211
|
-
<http://docs.
|
|
211
|
+
<http://docs.airship.com/api/ua.html#opt-out-report>`_
|
|
212
212
|
|
|
213
213
|
.. code-block:: ruby
|
|
214
214
|
|
data/docs/segment.rst
CHANGED
|
@@ -8,7 +8,7 @@ Segment Listing
|
|
|
8
8
|
***************
|
|
9
9
|
|
|
10
10
|
Segment lists are fetched by instantiating an iterator object using ``SegmentList``. For more
|
|
11
|
-
information, see `the API documentation <http://docs.
|
|
11
|
+
information, see `the API documentation <http://docs.airship.com/api/ua.html#segments>`__
|
|
12
12
|
|
|
13
13
|
.. sourcecode:: ruby
|
|
14
14
|
|
|
@@ -26,7 +26,7 @@ Creating a Segment
|
|
|
26
26
|
******************
|
|
27
27
|
|
|
28
28
|
Create a segment for the application. See the segment creation `API documentation
|
|
29
|
-
<http://docs.
|
|
29
|
+
<http://docs.airship.com/api/ua.html#segment-creation>`__ for more information.
|
|
30
30
|
|
|
31
31
|
.. sourcecode:: ruby
|
|
32
32
|
|
|
@@ -44,7 +44,7 @@ Modifying a Segment
|
|
|
44
44
|
*******************
|
|
45
45
|
|
|
46
46
|
Change the display name and/or criteria of a segment. For more information, see the segment
|
|
47
|
-
update `API documentation <http://docs.
|
|
47
|
+
update `API documentation <http://docs.airship.com/api/ua.html#update-segment>`__.
|
|
48
48
|
|
|
49
49
|
.. sourcecode:: ruby
|
|
50
50
|
|
|
@@ -63,7 +63,7 @@ Deleting a Segment
|
|
|
63
63
|
******************
|
|
64
64
|
|
|
65
65
|
Delete a segment. For more information, see the segment deletion `API documentation
|
|
66
|
-
<http://docs.
|
|
66
|
+
<http://docs.airship.com/api/ua.html#delete-segment>`__.
|
|
67
67
|
|
|
68
68
|
.. sourcecode:: ruby
|
|
69
69
|
|
|
@@ -80,7 +80,7 @@ Segment Lookup
|
|
|
80
80
|
**************
|
|
81
81
|
|
|
82
82
|
Fetch a particular segment's display name and criteria. See the individual segment lookup
|
|
83
|
-
`API documentation <http://docs.
|
|
83
|
+
`API documentation <http://docs.airship.com/api/ua.html#individual-segment-lookup>`__ for
|
|
84
84
|
more information.
|
|
85
85
|
|
|
86
86
|
.. sourcecode:: ruby
|
data/docs/static_lists.rst
CHANGED
|
@@ -2,12 +2,12 @@ Static Lists
|
|
|
2
2
|
============
|
|
3
3
|
|
|
4
4
|
With the Static List endpoint, you can easily target and manage
|
|
5
|
-
lists of devices that are defined in your systems outside of
|
|
5
|
+
lists of devices that are defined in your systems outside of Airship.
|
|
6
6
|
Any list or grouping of devices for which the canonical source of data about
|
|
7
7
|
the members is elsewhere is a good candidate for Static Lists, e.g., members
|
|
8
8
|
of a customer loyalty program.
|
|
9
9
|
For more information, see: `the API documentation on Static Lists
|
|
10
|
-
<http://docs.
|
|
10
|
+
<http://docs.airship.com/api/ua.html#static-lists>`__
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
Create List
|
data/docs/tags.rst
CHANGED
data/lib/urbanairship/client.rb
CHANGED
data/lib/urbanairship/common.rb
CHANGED
|
@@ -4,8 +4,8 @@ require 'urbanairship/loggable'
|
|
|
4
4
|
module Urbanairship
|
|
5
5
|
# Features mixed in to all classes
|
|
6
6
|
module Common
|
|
7
|
-
SERVER = 'go.
|
|
8
|
-
BASE_URL = 'https://go.
|
|
7
|
+
SERVER = 'go.airship.com'
|
|
8
|
+
BASE_URL = 'https://go.airship.com/api'
|
|
9
9
|
CHANNEL_URL = BASE_URL + '/channels/'
|
|
10
10
|
OPEN_CHANNEL_URL = BASE_URL + '/channels/open/'
|
|
11
11
|
DEVICE_TOKEN_URL = BASE_URL + '/device_tokens/'
|
data/lib/urbanairship/version.rb
CHANGED
data/urbanairship.gemspec
CHANGED
|
@@ -6,12 +6,12 @@ require 'urbanairship/version'
|
|
|
6
6
|
Gem::Specification.new do |spec|
|
|
7
7
|
spec.name = 'urbanairship'
|
|
8
8
|
spec.version = Urbanairship::VERSION
|
|
9
|
-
spec.authors = ['
|
|
10
|
-
spec.email = ['support@
|
|
9
|
+
spec.authors = ['Airship']
|
|
10
|
+
spec.email = ['support@airship.com']
|
|
11
11
|
spec.licenses = ['Apache-2.0']
|
|
12
12
|
|
|
13
|
-
spec.summary = 'Ruby Gem for using the
|
|
14
|
-
spec.description = 'A Ruby Library for using the
|
|
13
|
+
spec.summary = 'Ruby Gem for using the Airship API'
|
|
14
|
+
spec.description = 'A Ruby Library for using the Airship web service API for push notifications and rich app pages.'
|
|
15
15
|
spec.homepage = 'https://github.com/urbanairship/ruby-library'
|
|
16
16
|
|
|
17
17
|
spec.required_ruby_version = '>= 2.0.0'
|
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: 5.
|
|
4
|
+
version: 5.3.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
-
|
|
7
|
+
- Airship
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-
|
|
11
|
+
date: 2019-11-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rest-client
|
|
@@ -114,10 +114,10 @@ dependencies:
|
|
|
114
114
|
- - "~>"
|
|
115
115
|
- !ruby/object:Gem::Version
|
|
116
116
|
version: '1'
|
|
117
|
-
description: A Ruby Library for using the
|
|
117
|
+
description: A Ruby Library for using the Airship web service API for push notifications
|
|
118
118
|
and rich app pages.
|
|
119
119
|
email:
|
|
120
|
-
- support@
|
|
120
|
+
- support@airship.com
|
|
121
121
|
executables: []
|
|
122
122
|
extensions: []
|
|
123
123
|
extra_rdoc_files: []
|
|
@@ -201,5 +201,5 @@ requirements: []
|
|
|
201
201
|
rubygems_version: 3.0.1
|
|
202
202
|
signing_key:
|
|
203
203
|
specification_version: 4
|
|
204
|
-
summary: Ruby Gem for using the
|
|
204
|
+
summary: Ruby Gem for using the Airship API
|
|
205
205
|
test_files: []
|