Skip to content

Commit

Permalink
Merge pull request #108 from urbanairship/TOOLSLIBS-795
Browse files Browse the repository at this point in the history
Changelog/version updates for 9.1.0 release
  • Loading branch information
pdxmele authored Jun 9, 2022
2 parents 962ebed + fd33b42 commit b30dcfd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 15 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
--------------------
9.1.0
--------------------
- All requests will now automatically attempt to authenticate with bearer token auth if a
token is included in the instantiation of the client. Previously, only custom events requests
could use bearer token auth in this library. You can find more information about how to use
bearer token auth in the README.
- Also fixes an issue where a secret was required even when bearer token auth was being used
(it is no longer required).

--------------------
9.0.0
--------------------
- Adds Tag List API Support
- Removes location lookup endpoints
- Removes location-based audience selectors

--------------------
8.0.1
--------------------
Expand Down
25 changes: 11 additions & 14 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Airship Ruby Library
==========================
====================

``urbanairship`` is a Ruby library for using the `Airship
<http://airship.com/>`_ web service API for push notifications and
rich app pages.
<http://airship.com/>`_ web service API for messaging.


Installation
Expand All @@ -29,8 +28,7 @@ The library is intended to be used with the small footprint of a single
import. To get started, import the package, and create an
:rb:class:`Airship` object representing a single Airship project.

Note that channels are preferred over ``device_token`` and ``apid``. See:
`documentation on channels <channels>`_.
The library uses `rest-client <https://github.com/rest-client/rest-client>`_ for communication with the Airship API.

.. code-block:: ruby
Expand All @@ -43,15 +41,20 @@ Note that channels are preferred over ``device_token`` and ``apid``. See:
p.device_types = UA.device_types(['ios','android'])
p.send_push
The library uses `unirest`_ for communication with the UA API.
We in the process of migrating code examples away from these docs and into the
regular `Airship API reference <https://docs.airship.com/api/ua/>`_
(select "Ruby Library"), so please check there for more examples.

Please also see `the README <https://github.com/urbanairship/ruby-library/blob/main/README.rst>`_
for detailed instructions on how to use bearer token auth and alternative servers.


Development
-----------

The library source code is `available on GitHub <github>`_.
The library source code is `available on GitHub <https://github.com/urbanairship/ruby-library>`_.

Tests can be run with rspec_:
Tests can be run with `rspec <https://rspec.info/>`_.

Contents:

Expand Down Expand Up @@ -84,9 +87,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. _channels: http://docs.airship.com/topic-guides/channels.html
.. _unirest: http://unirest.io/ruby.html
.. _github: https://github.com/urbanairship/ruby-library
.. _rspec: https://nose.readthedocs.org/en/latest/
2 changes: 1 addition & 1 deletion lib/urbanairship/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Urbanairship
VERSION = '9.0.0'
VERSION = '9.1.0'
end

0 comments on commit b30dcfd

Please sign in to comment.