urbanairship 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5417adc316435f2d47f4962983571399b1bf4dea0015cd126ea12077260e50eb
-  data.tar.gz: ccbaafa7f7f6bb5820c3a9e1834c23b5a8972debc6b964a204a73cb7630dc2b8
+  metadata.gz: 4271dd0c7f5cc4da7c6438cfec017d10be9ddb8c28145f541cf026ec1c179258
+  data.tar.gz: 609aa096ad24c679a32ab69fca8487ebe7e939150505d9f91c506937ce8e8ac0
 SHA512:
-  metadata.gz: 36063a93db8505fa64180ef1980068112d3e14b6b0330e97fa772bd7081c25ab0500aaa7db442ba086a7b12ae8e2c588bbdce7f34144998287a242e401c49c6c
-  data.tar.gz: d0cccf9b2713aa344d268c8a997a549525166f88e98e78d63b2a16a12e4123ce999e9be430c0c63a167cf5ff09505cc846755fc02ec822504b898146389aa799
+  metadata.gz: d743974f8312e3d42f890873a3bd78f44483be14a4593c169f6587be560358771667127b1dabc30286cf3577161f573f9f73a13a9b6eb25840a686bf7d917e4f
+  data.tar.gz: 1abaa92b5fa0fea9afd3274ffac2bcc44a91280c514e05e11aab3612d0b886bfa11d4a9c1fa42ea887dd3638cdf6d336c187f6e8518f2618175e6b59f46fd3c2

data/CHANGELOG

@@ -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
 --------------------

data/README.rst

@@ -175,6 +175,22 @@ Finally, you can change the targeted server on a request basis:
    # The Urbanairship configuration is overridden by the client and the
    # request will be sent to the 'go.urbanairship.com' server
 
+Using Bearer Token Auth
+-----------------------
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
+   airship = UA::Client.new(key:'application_key', token:'token')
+   # Then continue as you would otherwise
+
+**Note**: If you include a token in your instantiation, the request
+will use bearer token auth. Bearer token auth is required for some
+endpoints, but not supported by others. Please check `the Airship
+docs site <https://docs.airship.com/>`_ to see where it is supported.
+
 Contributing
 ============
 

data/docs/index.rst

@@ -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
@@ -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
 
@@ -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:
 
@@ -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/

data/lib/urbanairship/client.rb

@@ -15,10 +15,9 @@ module Urbanairship
       # @param [Object] secret Application Secret
       # @param [String] server Airship server to use ("go.airship.eu" or "go.urbanairship.com").
       #                        Used only when the request is sent with a "path", not an "url".
-      # @param [String] token Application Auth Token (for custom events endpoint)
+      # @param [String] token Application Auth Token
       # @return [Object] Client
-      def initialize(key: required('key'), secret: required('secret'),
-                     server: Urbanairship.configuration.server, token: nil)
+      def initialize(key: required('key'), secret: nil, server: Urbanairship.configuration.server, token: nil)
         @key = key
         @secret = secret
         @server = server
@@ -57,6 +56,10 @@ module Urbanairship
         headers['Content-Type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
 
+        if @token != nil
+          auth_type = :bearer
+        end
+
         if auth_type == :bearer
           raise ArgumentError.new('token must be provided as argument if auth_type=bearer') if @token.nil?
           headers['X-UA-Appkey'] = @key
@@ -82,6 +85,7 @@ module Urbanairship
         }
 
         if auth_type == :basic
+          raise ArgumentError.new('secret must be provided as argument if auth_type=basic') if @secret.nil?
           params[:user] = @key
           params[:password] = @secret
         end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '9.0.0'
+  VERSION = '9.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client