urbanairship 5.7.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d4dc107770392a93c88c327e14122fc56cb6ec8fbd17f58984df43d2661d630
-  data.tar.gz: 75c8ff88b54de9ad97fa3dbf503333bc49cd29c0fcfea2e937fe7cce5a4f3c92
+  metadata.gz: 8c91f31ef623a57075fe0acde9fe467d17dc2b0bbb634070c8da11cad54b08f5
+  data.tar.gz: eefb6b294cd953148c27fa91bae207888cbb163c6ec620301aa41b243046b46a
 SHA512:
-  metadata.gz: e6203f67400dd7581568c1307c688ae842c32c1b67532ead780a62cd3ca9aa9256511a5d6a7f0b9e68f58acc5a3e56bfc4172f5ec4bf24c622285f94f04d4bd3
-  data.tar.gz: 4c6660cdd60ed9628151f19a448ecbbdde3b43a0bff521c95ef1903874f17610c3194c467623bd37a67f95f9fea9139e1b60acaf818aa2899f0ba7f6c022591d
+  metadata.gz: 1c19a821551da7ad1593c91ef7dd0c922dd2f4637ee74a2f29a1fcecce0db4185b09e0fa908fedcc6b124897c3bcd9a41c1070d841b6cef45436ac26a5ba3382
+  data.tar.gz: 15bd6f34bf76d038d359b79443f7c12464345ea1cf3cc959254a2350b597a5a91be89940713d3de4a5caba50495cd66ea3cb39cbb6e91ad067d511f8c69af4f8

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -15,8 +15,8 @@ Please include link to open issue if applicable.
 
 * I've tested for Ruby versions:
 
-- [ ] 2.2.5
-- [ ] 2.3.1
+- [ ] 2.6.7
+- [ ] 2.7.2
 
 ### Airship Contribution Agreement
 [Link here](https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform)

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.6.7
+  - 2.7.2

data/CHANGELOG

@@ -1,3 +1,36 @@
+--------------------
+8.0.0
+--------------------
+- Updates officially supported versions to 2.6.7 and 2.7.2
+- Fixes headers to reduce warning messages
+- Fixes for multiple mis-set named user urls
+- Fix to automatically convert an integer named user to a string so it can be successfully submitted
+- Adds attribute support for named users
+
+--------------------
+7.0.0
+--------------------
+- Refactors base url naming
+
+--------------------
+6.0.0
+--------------------
+- Creates custom base url, and refactors urls within classes
+- Adds support for sending custom events
+
+--------------------
+5.9.0
+--------------------
+- Adds support for bearer token auth
+- Updates broken code for static lists
+- Adds support for update sms channel 
+
+--------------------
+5.8.0
+--------------------
+- Adds scheudling support for PTSO
+- Adds attribute support 
+
 --------------------
 5.7.0
 --------------------

data/README.rst

@@ -14,16 +14,16 @@ Requirements
 
 We officially support the following Ruby versions::
 
-   2.2.5
-   2.3.1
+   2.6.7
+   2.7.2
 
-Newer versions should work as well.
+Newer 2.x versions should work as well.
 
 
 Functionality
 =============
 
-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.
+Version 8.0 is a major upgrade, as we have changed the tested/supported versions of Ruby. A more detailed list of changes can be found in the CHANGELOG.
 
 
 Questions
@@ -38,17 +38,23 @@ Installation
 
 If you have the ``bundler`` gem (if not you can get it with
 ``$ gem install bundler``) add this line to your application's
-Gemfile::
+Gemfile:
 
-    >>> gem 'urbanairship'
+.. code-block::
 
-And then execute::
+   >>> $ gem 'urbanairship'
 
-    >>> $ bundle
+And then execute:
 
-OR install it yourself as::
+.. code-block::
 
-    >>> gem install urbanairship
+   >>> $ bundle
+
+OR install it yourself as:
+
+.. code-block::
+
+   >>> $ gem install urbanairship
 
 
 Configuration
@@ -56,27 +62,35 @@ Configuration
 
 In your app initialization, you can do something like the following:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.log_path = '/path/to/your/logfile'
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+     config.log_path = '/path/to/your/logfile'
+     config.log_level = Logger::WARN
+     config.timeout = 60
+   end
+
 
 If you want to use a custom logger (e.g Rails.logger), you can do:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.custom_logger = Rails.logger
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.custom_logger = Rails.logger
+     config.log_level = Logger::WARN
+   end
 
 Available Configurations
 ------------------------
 
 - **log_path**: Allows to define the folder where the log file will be created (the default is nil).
 - **log_level**: Allows to define the log level and only messages at that level or higher will be printed (the default is INFO).
+- **server**: Allow to define the Airship server you want to use ("go.airship.eu" or "go.urbanairship.com")
 - **timeout**: Allows to define the request timeout in seconds (the default is 5).
 
 
@@ -96,28 +110,71 @@ information.
 Broadcast to All Devices
 ------------------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.all
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
 
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.all
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
 
 Simple Tag Push
 ---------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.tag('some_tag')
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
+
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.tag('some_tag')
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
+
+Specify the Airship server used to make your requests
+-----------------------------------------------------
+By default, the request will be sent to the 'go.urbanairship.com' server:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+
+You can change the server globally in the Urbanairship configuration:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+   # request will be sent to the 'go.airship.eu' server
+
+Finally, you can change the targeted server on a request basis:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
 
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.urbanairship.com')
+   # The Urbanairship configuration is overridden by the client and the
+   # request will be sent to the 'go.urbanairship.com' server
 
 Contributing
 ============

data/docs/attributes.rst

@@ -0,0 +1,73 @@
+Attributes
+==========
+
+Set Attribute for a Channel
+---------------------------
+
+The following will set an attribute for a given channel ID.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'app_key', secret:'secret_key')
+    channel_info = UA::ChannelInfo.new(client: airship)
+    channel_info.audience = {"ios_channel": "b8f9b663-0a3b-cf45-587a-be880946e881"}
+    channel_info.attributes =  {
+        "action": "set",
+        "key": "favorite_food",
+        "value": "cake"
+    }
+    channel_info.set_attributes
+
+.. note::
+
+    This should return a 200 response
+
+Set or Remove Attributes for a Named User
+-----------------------------------------
+
+The following example shows you how to set and remove attributes on a given named user.
+    
+.. code-block:: ruby
+    
+    require 'urbanairship'
+    airship = Urbanairship::Client.new(key: 'application_key', secret: 'master_secret')
+    named_user = Urbanairship::NamedUser.new(client: airship)
+    named_user.named_user_id = 'named_user'
+    named_user.update_attributes(attributes: [
+        { action: 'set', key: 'first_name', value: 'Firstname' },
+        { action: 'remove', key: 'nickname' },
+        { action: 'set', key: 'last_name', value: 'Lastname', timestamp: Time.now.utc }
+    ])
+    
+.. note::
+
+    Timestamp is optional, if missing it will default to 'now'
+
+Send Push to Audience with Attribute Specifications
+---------------------------------------------------
+
+This will send a push to an audience who meet the specifications of attribute we
+set here. This example is using a text attribute where we are looking for audience
+members whose favorite food includes 'apple'. Some examples of what this could return
+would be 'apple', 'pineapple',  or 'apple pie'. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'app_key', secret:'secret_key')
+    new_attribute = UA::Attribute.new(client: airship)
+    new_attribute.attribute = 'favorite_food'
+    new_attribute.operator = 'contains'
+    new_attribute.value = 'apple'
+    push = airship.create_push
+    push.audience = new_attribute.payload
+    push.notification = UA.notification(alert: 'Hello')
+    push.device_types = ['android', 'ios', 'web']
+    push.send_push
+
+.. note::
+
+    This should return a 202 response

data/docs/index.rst

@@ -73,6 +73,9 @@ Contents:
    email.rst
    open_channels.rst
    sms.rst
+   automations.rst
+   ab_tests.rst
+   attributes.rst
 
 
 Indices and tables

data/docs/named_user.rst

@@ -100,3 +100,25 @@ see `the API documentation
 
     A single request may contain an add or remove field, both, or a single set
     field.
+
+Attributes
+----------
+
+Set or remove attributes on a named user. For more information, see `the API documentation
+https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-attributes-post>`__
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  airship = Urbanairship::Client.new(key: 'application_key', secret: 'master_secret')
+  named_user = Urbanairship::NamedUser.new(client: airship)
+  named_user.named_user_id = 'named_user'
+  named_user.update_attributes(attributes: [
+      { action: 'set', key: 'first_name', value: 'Firstname' },
+      { action: 'remove', key: 'nickname' },
+      { action: 'set', key: 'last_name', value: 'Lastname', timestamp: Time.now.utc }
+  ])
+
+.. note::
+
+    Timestamp is optional, if missing it will default to 'now'.

data/docs/push.rst

@@ -507,6 +507,30 @@ local time.
 If the schedule is unsuccessful, an :rb:class:`AirshipFailure` exception
 will be raised.
 
+Scheduled Delivery for Optimal Send Time
+----------------------------------------
+
+Scheduled notifications build upon the Push object, and have two other
+components: the scheduled time(s) and an optional name.
+
+This example schedules the above notification delivery for optimal send time.
+
+.. code-block:: ruby
+
+    schedule = airship.create_scheduled_push
+    schedule.push = push
+    schedule.name = "optional name for later reference"
+    schedule.schedule = UA.optimal_scheduled_time('2020-02-20')
+    response = schedule.send_push
+    print ("Created schedule. url: " + response.schedule_url)
+
+If the schedule is unsuccessful, an :rb:class:`AirshipFailure` exception
+will be raised.
+
+.. note::
+
+    Make sure the time for UA.optimal_scheduled_time is a date versus a timestamp. 
+
 
 Updating or Canceling a Schedule
 --------------------------------

data/docs/sms.rst

@@ -21,6 +21,25 @@ request with an opted_in key.
     sms_channel.opted_in = '2018-02-13T11:58:59'
     sms_channel.register
 
+Update SMS Channel
+-------------------
+
+To update an SMS channel you need a sender, MSISDN, and a channel ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    sms_channel = UA::Sms.new(client: airship)
+    sms_channel.msisdn = '15035556789'
+    sms_channel.sender = '12345'
+    sms_channel.opted_in = '2020-12-14T11:58:59'
+    sms_channel.timezone = 'America/Denver'
+    sms_channel.channel_id = 'a1b2c3d4e5f6'
+    sms_channel.update
+
+
 Opt-Out of SMS Messages
 -----------------------
 

data/docs/static_lists.rst

@@ -28,7 +28,7 @@ string keys to arbitrary JSON values.
     airship = UA::Client.new(key:'application_key', secret:'master_secret')
     static_list = UA::StaticList.new(client: airship)
     static_list.name = 'list_name'
-    static_list.create(description: 'description', extras: { 'key' => 'value' })
+    static_list.create(description: 'description', extra: {'key': 'value'})
 
 
 Upload List
@@ -71,7 +71,7 @@ Updates the metadata of a static list.
     airship = UA::Client.new(key:'application_key', secret:'master_secret')
     static_list = UA::StaticList.new(client: airship)
     static_list.name = 'list_name'
-    static_list.update(description: 'description', { 'key' => 'value' })
+    static_list.update(description: 'new description', 'extra': {'new_key': 'new_value' })
 
 
 Delete List

data/lib/urbanairship.rb

@@ -1,3 +1,5 @@
+require 'urbanairship/custom_events/custom_event'
+require 'urbanairship/custom_events/payload'
 require 'urbanairship/push/audience'
 require 'urbanairship/push/payload'
 require 'urbanairship/push/schedule'
@@ -10,6 +12,8 @@ require 'urbanairship/devices/email_notification'
 require 'urbanairship/devices/sms_notification'
 require 'urbanairship/devices/mms_notification'
 require 'urbanairship/devices/create_and_send'
+require 'urbanairship/devices/attribute'
+require 'urbanairship/devices/attributes'
 require 'urbanairship/client'
 require 'urbanairship/common'
 require 'urbanairship/configuration'
@@ -30,10 +34,13 @@ require 'urbanairship/ab_tests/experiment'
 require 'urbanairship/ab_tests/ab_test'
 
 module Urbanairship
+  extend Urbanairship::CustomEvents::Payload
+  extend Urbanairship::CustomEvents
   extend Urbanairship::Push::Audience
   extend Urbanairship::Push::Payload
   extend Urbanairship::Push::Schedule
   extend Urbanairship::Push
+  include Urbanairship::CustomEvents
   include Urbanairship::Devices
   include Urbanairship::Reports
   include Urbanairship::Push