urbanairship 5.7.0 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d4dc107770392a93c88c327e14122fc56cb6ec8fbd17f58984df43d2661d630
-  data.tar.gz: 75c8ff88b54de9ad97fa3dbf503333bc49cd29c0fcfea2e937fe7cce5a4f3c92
+  metadata.gz: 0e4a3dfc0a925ebcaf22800eabbc1fec1c8c59f5fd52e26f24ca87ff7eec2d5c
+  data.tar.gz: 593f328489aaffcfad92e1da6c9a86351aabee461ab408bf94d66a374bef8625
 SHA512:
-  metadata.gz: e6203f67400dd7581568c1307c688ae842c32c1b67532ead780a62cd3ca9aa9256511a5d6a7f0b9e68f58acc5a3e56bfc4172f5ec4bf24c622285f94f04d4bd3
-  data.tar.gz: 4c6660cdd60ed9628151f19a448ecbbdde3b43a0bff521c95ef1903874f17610c3194c467623bd37a67f95f9fea9139e1b60acaf818aa2899f0ba7f6c022591d
+  metadata.gz: 5441fa97e0611f195f39d06022e30fa7a32d55a6d8a6052c0d5f366d97a687f6e789e9de9c4ceebe0f6cc192414cf706a24a0b8572bf4d5b914e147acec94c39
+  data.tar.gz: ff5234432140b9cabac03ed2df6ef29d5398f6e8ea886d1a161fc31ee0f0c758bbc10647e736597d8524b43b9d34a1be17887af24f9a9376b1d1b75c11dd196c

data/CHANGELOG

@@ -1,3 +1,9 @@
+--------------------
+5.8.0
+--------------------
+- Adds scheudling support for PTSO
+- Adds attribute support 
+
 --------------------
 5.7.0
 --------------------

data/docs/attributes.rst

@@ -0,0 +1,52 @@
+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
+
+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/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/lib/urbanairship.rb

@@ -10,6 +10,7 @@ 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/client'
 require 'urbanairship/common'
 require 'urbanairship/configuration'

data/lib/urbanairship/devices/attribute.rb

@@ -0,0 +1,54 @@
+require 'urbanairship'
+
+module Urbanairship
+    module  Devices
+        class Attribute
+            include Urbanairship::Common
+            include Urbanairship::Loggable
+            attr_accessor :attribute,
+                          :operator,
+                          :precision,
+                          :value
+
+            def initialize(client: required('client'))
+                @client = client
+            end
+
+            def payload
+                if precision
+                    date_attribute
+                elsif value.is_a? String
+                    text_attribute
+                elsif value.is_a? Integer 
+                    number_attribute
+                end
+            end
+
+            def number_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'value': value
+                }
+            end
+
+            def text_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'value': value
+                }
+            end
+
+            def date_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'precision': precision,
+                    'value': value
+                }
+            end
+
+        end
+    end
+end 

data/lib/urbanairship/devices/devicelist.rb

@@ -7,6 +7,8 @@ module Urbanairship
       include Urbanairship::Common
       include Urbanairship::Loggable
       attr_writer :client
+      attr_accessor :audience,
+                    :attributes
 
       def initialize(client: required('client'))
         @client = client
@@ -20,6 +22,25 @@ module Urbanairship
         logger.info("Retrieved channel information for #{uuid}")
         response['body']['channel']
       end
+
+      def payload
+        {
+          'audience': audience,
+          'attributes': [
+            attributes
+          ]
+        }
+      end
+
+      def set_attributes
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: CHANNEL_URL + 'attributes',
+          content_type: 'application/json'
+        )
+        response
+      end
     end
 
     class ChannelList < Urbanairship::Common::PageIterator

data/lib/urbanairship/push/schedule.rb

@@ -14,6 +14,15 @@ module Urbanairship
         payload(:local_scheduled_time, datetime)
       end
 
+      # Uses predictive analysis to send push at optimal time
+      def optimal_scheduled_time(date)
+        {
+          'best_time': {
+            'send_date': date
+          }
+        }
+      end
+
       private
 
       def payload(name, time)

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.7.0'
+  VERSION = '5.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.7.0
+  version: 5.8.0
 platform: ruby
 authors:
 - Airship
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -139,6 +139,7 @@ files:
 - bin/setup
 - docs/Makefile
 - docs/ab_tests.rst
+- docs/attributes.rst
 - docs/automations.rst
 - docs/channel_uninstall.rst
 - docs/conf.py
@@ -167,6 +168,7 @@ files:
 - lib/urbanairship/client.rb
 - lib/urbanairship/common.rb
 - lib/urbanairship/configuration.rb
+- lib/urbanairship/devices/attribute.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/create_and_send.rb