urbanairship 5.5.1 → 5.9.0

data/docs/create_and_send.rst

@@ -487,3 +487,65 @@ shown in the line of code here:
 .. note::
 
   Should return a 202 Accepted HTTP response.
+
+Create and Send to Open Channels
+================================
+
+Create and Send to Open Channels with Template ID
+-------------------------------------------------
+
+The first few lines of code are creating an OpenChannel object, and assigning
+instance variables to that object. This is essentially creating the payload that
+will be passed to notification portion of the CreateAndSend class, which ultimately
+is sending a fully constructed payload to the API. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  open_channel_notification = UA::OpenChannel.new(client:airship)
+  open_channel_notification.open_platform = 'smart_fridge'
+  open_channel_notification.template_id = "<template_id>"
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "<ua_address>",
+      "name": "Jane"
+    }
+  ]
+  send_it.device_types = [ 'open::smart_fridge' ]
+  send_it.notification = open_channel_notification.
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+Create and Send to Open Channels Override
+------------------------------------------
+
+The first few lines of code are creating an OpenChannel object, and assigning
+instance variables to that object. This is essentially creating the payload that
+will be passed to notification portion of the CreateAndSend class, which ultimately
+is sending a fully constructed payload to the API. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  open_channel_notification = UA::OpenChannel.new(client:airship)
+  open_channel_notification.open_platform = 'smart_fridge'
+  open_channel_notification.alert = 'a general alert for all open channels'
+  open_channel_notification.platform_alert = 'an alert for specific open channel platforms'
+  open_channel_notification.media_attachment = 'https://example.com/cat_standing_up.jpeg'
+  open_channel_notification.title = 'That\'s pretty neat!'
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "<ua_address>",
+      "name": "Jane"
+    }
+  ]
+  send_it.device_types = [ 'open::smart_fridge' ]
+  send_it.notification = open_channel_notification,open_channel_override
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send

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

@@ -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'
@@ -23,6 +24,11 @@ require 'urbanairship/devices/open_channel'
 require 'urbanairship/reports/response_statistics'
 require 'urbanairship/devices/static_lists'
 require 'urbanairship/push/location'
+require 'urbanairship/automations/pipeline'
+require 'urbanairship/automations/automation'
+require 'urbanairship/ab_tests/variant'
+require 'urbanairship/ab_tests/experiment'
+require 'urbanairship/ab_tests/ab_test'
 
 module Urbanairship
   extend Urbanairship::Push::Audience
@@ -32,6 +38,8 @@ module Urbanairship
   include Urbanairship::Devices
   include Urbanairship::Reports
   include Urbanairship::Push
+  include Urbanairship::Automations
+  include Urbanairship::AbTests
 
   class << self
     attr_accessor :configuration

data/lib/urbanairship/ab_tests/ab_test.rb

@@ -0,0 +1,89 @@
+require 'uri'
+require 'urbanairship'
+require 'urbanairship/ab_tests/experiment'
+
+module Urbanairship
+    module  AbTests
+        class AbTest
+        include Urbanairship::Common
+        include Urbanairship::Loggable
+        attr_accessor :limit,
+                      :offset,
+                      :experiment_object,
+                      :experiment_id
+                      
+            def initialize(client: required('client'))
+                @client = client
+            end
+
+            def list_ab_test
+                response = @client.send_request(
+                    method: 'GET',
+                    url: EXPERIMENTS_URL + format_url_with_params
+                )
+                logger.info("Looking up A/B Tests for project")
+                response
+            end
+
+            def create_ab_test
+                response = @client.send_request(
+                    method: 'POST',
+                    body: JSON.dump(experiment_object),
+                    url: EXPERIMENTS_URL,
+                    content_type: 'application/json'
+                )
+                logger.info("Created A/B Test")
+                response
+            end
+
+            def list_scheduled_ab_test
+                response = @client.send_request(
+                    method: 'GET',
+                    url: EXPERIMENTS_URL + 'scheduled' + format_url_with_params
+                )
+                logger.info("Looking up scheduled A/B Tests for project")
+                response
+            end
+
+            def delete_ab_test
+                fail ArgumentError, 'experiment_id must be set to delete individual A/B test' if @experiment_id.nil?
+                response = @client.send_request(
+                    method: 'DELETE',
+                    url: EXPERIMENTS_URL + 'scheduled/' + experiment_id
+                )
+                logger.info("Deleting A/B test with ID #{experiment_id}")
+                response
+            end
+
+            def validate_ab_test
+                response = @client.send_request(
+                    method: 'POST',
+                    body: JSON.dump(experiment_object),
+                    url: EXPERIMENTS_URL + 'validate',
+                    content_type: 'application/json'
+                )
+                logger.info("Validating A/B Test")
+                response
+            end
+
+            def lookup_ab_test
+                fail ArgumentError, 'experiment_id must be set to lookup individual A/B Test' if @experiment_id.nil?
+                response = @client.send_request(
+                    method: 'GET',
+                    url: EXPERIMENTS_URL + experiment_id
+                )
+                logger.info("Looking up A/B test with ID #{experiment_id}")
+                response
+            end
+
+            def format_url_with_params
+                params = []
+                params << ['limit', limit] if limit
+                params << ['offset', offset] if offset
+                query = URI.encode_www_form(params)
+                '?' + query
+            end
+        end
+    end
+end 
+    

data/lib/urbanairship/ab_tests/experiment.rb

@@ -0,0 +1,45 @@
+require 'urbanairship'
+
+module Urbanairship
+    module  AbTests
+        class Experiment
+        include Urbanairship::Common
+        include Urbanairship::Loggable
+        attr_accessor :audience,
+                      :campaigns,
+                      :control,
+                      :created_at,
+                      :description,
+                      :device_types,
+                      :id, 
+                      :name,
+                      :push_id,
+                      :variants
+                        
+            def initialize(client: required('client'))
+                @client = client
+                @variants = []
+            end
+
+            def payload
+                fail ArgumentError, 'audience is required for experiment' if @audience.nil?
+                fail ArgumentError, 'device_types is required for experiment' if @device_types.nil?
+                fail ArgumentError, 'variant cannot be empty for experiment' if @variants.empty?
+
+                {
+                    'name': name,
+                    'description': description,
+                    'control': control,
+                    'audience': audience,
+                    'device_types': device_types,
+                    'campaigns': campaigns,
+                    'variants': variants,
+                    'id': id,
+                    'created_at': created_at,
+                    'push_id': push_id
+                }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+            end
+
+        end
+    end
+end

data/lib/urbanairship/ab_tests/variant.rb

@@ -0,0 +1,34 @@
+require 'urbanairship'
+
+module Urbanairship
+    module  AbTests
+        class Variant
+        include Urbanairship::Common
+        include Urbanairship::Loggable
+        attr_accessor :description,
+                      :id,
+                      :name,
+                      :push,
+                      :schedule,
+                      :weight
+
+        def initialize(client: required('client'))
+            @client = client
+        end
+
+        def payload
+            fail ArgumentError, 'a push must be added to create a variant' if @push.nil?
+
+            {
+             'description': description,
+             'id': id,
+             'name': name,
+             'push': push,
+             'schedule': schedule,
+             'weight': weight   
+            }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+        end
+
+        end 
+    end 
+end

data/lib/urbanairship/automations/automation.rb

@@ -0,0 +1,105 @@
+require 'uri'
+require 'urbanairship'
+require 'urbanairship/automations/pipeline'
+
+module Urbanairship
+    module Automations
+        class Automation
+            include Urbanairship::Common
+            include Urbanairship::Loggable
+            attr_accessor :limit,
+                          :enabled,
+                          :offset,
+                          :start,
+                          :pipeline_id,
+                          :pipeline_object
+
+            def initialize(client: required('client'))
+                 @client = client
+            end
+
+            def create_automation
+                response = @client.send_request(
+                    method: 'POST',
+                    body: JSON.dump(pipeline_object),
+                    url: PIPELINES_URL,
+                    content_type: 'application/json'
+                )
+                logger.info("Created Automation")
+                response
+            end
+
+            def list_automations
+                response = @client.send_request(
+                    method: 'GET',
+                    url: PIPELINES_URL + format_url_with_params
+                )
+                logger.info("Looking up automations for project")
+                response
+            end
+
+            def list_deleted_automations
+                response = @client.send_request(
+                    method: 'GET',
+                    url: PIPELINES_URL + 'deleted' + format_url_with_params
+                )
+                logger.info("Looking up deleted automations for project")
+                response
+            end
+
+            def validate_automation
+                response = @client.send_request(
+                    method: 'POST',
+                    body: JSON.dump(pipeline_object),
+                    url: PIPELINES_URL + 'validate',
+                    content_type: 'application/json'
+                )
+                logger.info("Validating Automation")
+                response
+            end
+
+            def lookup_automation 
+                fail ArgumentError, 'pipeline_id must be set to lookup individual automation' if @pipeline_id.nil?
+                response = @client.send_request(
+                    method: 'GET',
+                    url: PIPELINES_URL + pipeline_id
+                )
+                logger.info("Looking up automation with id #{pipeline_id}")
+                response
+            end
+
+            def update_automation
+                fail ArgumentError, 'pipeline_id must be set to update individual automation' if @pipeline_id.nil?
+                
+                response = @client.send_request(
+                    method: 'PUT',
+                    body: JSON.dump(pipeline_object),
+                    url: PIPELINES_URL + pipeline_id,
+                    content_type: 'application/json'
+                )
+                logger.info("Validating Automation")
+                response
+            end
+
+            def delete_automation 
+                fail ArgumentError, 'pipeline_id must be set to delete individual automation' if @pipeline_id.nil?
+                response = @client.send_request(
+                    method: 'DELETE',
+                    url: PIPELINES_URL + pipeline_id
+                )
+                logger.info("Deleting automation with id #{pipeline_id}")
+                response
+            end
+
+            def format_url_with_params
+                params = []
+                params << ['limit', limit] if limit
+                params << ['enabled', enabled] if enabled
+                params << ['offset', offset] if offset
+                params << ['start', start] if start
+                query = URI.encode_www_form(params)
+                '?' + query
+            end
+        end
+    end
+end