urbanairship 5.4.0 → 5.7.0

data/docs/examples.rst

@@ -37,12 +37,12 @@ Complex audience with platform specifics
     )
     push.notification = UA.notification(
         ios: UA.ios(
-            alert: "Kim Jong-Un wins U.S. Open",
+            alert: "Serena Williams wins U.S. Open",
             badge: "+1",
             extra: {"articleid" => "123456"}
         ),
         android: UA.android(
-            alert: "Breaking Android News! Glorious Leader Kim Jong-Un wins U.S. Open!",
+            alert: "Breaking Android News! Serena Williams wins U.S. Open!",
             extra: {"articleid" => "http://m.example.com/123456"}
         ),
         amazon: UA.amazon(
@@ -64,7 +64,7 @@ Single iOS push
     push = airship.create_push
     push.audience = UA.ios_channel('channel-id')
     push.notification = UA.notification(
-       ios: UA.ios(alert="Kim Jong-Un is following you on Twitter")
+       ios: UA.ios(alert="Your package is on its way!")
     )
     push.device_types = UA.device_types(['ios'])
     push.send_push
@@ -78,10 +78,10 @@ Single iOS Rich Push with notification
     push = airship.create_push
     push.audience = UA.ios_channel('channel-id')
     push.notification = UA.notification(
-       ios: UA.ios(alert="Kim Jong-Un is following you on Twitter")
+       ios: UA.ios(alert="Your package is on its way!")
     )
     push.device_types = UA.device_types(['ios'])
-    push.message = UA.message(title: "New follower", body: "<h1>OMG It's Kim Jong-Un</h1>")
+    push.message = UA.message(title: "Your package is on the way!", body: "<h1>Please complete our survey</h1>")
     push.send_push
 
 
@@ -94,8 +94,8 @@ Rich Push with extra and without notification
     push.audience = UA.all
     push.device_types = UA.all
     push.message = UA.message(
-      title: "New follower",
-      body: "<h1>OMG It's Kim Jong-Un</h1>",
+      title: "Your package is on its way!",
+      body: "<h1>Would you please complete our customer survey?</h1>",
       extra: {"articleid" => "http://m.example.com/123456"}
     )
     push.send_push
@@ -112,7 +112,7 @@ Scheduled iOS Push
     sched.push = airship.create_push
     sched.push.audience = UA.ios_channel('channel-id')
     sched.push.notification = UA.notification(
-       ios: UA.ios(alert: "Kim Jong-Un is following you on Twitter"))
+       ios: UA.ios(alert: "Your package is on its way!"))
     sched.push.device_types = UA.device_types(['ios'])
 
     sched.send_push

data/docs/index.rst

@@ -69,6 +69,10 @@ Contents:
    location.rst
    exceptions.rst
    examples.rst
+   create_and_send.rst
+   email.rst
+   open_channels.rst
+   sms.rst
 
 
 Indices and tables

data/lib/urbanairship.rb

@@ -6,6 +6,10 @@ require 'urbanairship/devices/segment'
 require 'urbanairship/devices/channel_uninstall'
 require 'urbanairship/devices/sms'
 require 'urbanairship/devices/email'
+require 'urbanairship/devices/email_notification'
+require 'urbanairship/devices/sms_notification'
+require 'urbanairship/devices/mms_notification'
+require 'urbanairship/devices/create_and_send'
 require 'urbanairship/client'
 require 'urbanairship/common'
 require 'urbanairship/configuration'
@@ -19,6 +23,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
@@ -28,6 +37,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

data/lib/urbanairship/automations/pipeline.rb

@@ -0,0 +1,52 @@
+require 'urbanairship'
+
+module Urbanairship
+  module Automations
+    class Pipeline
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :activation_time,
+                    :cancellation_trigger,
+                    :condition,
+                    :constraint,
+                    :creation_time,
+                    :deactivation_time,
+                    :historical_trigger,
+                    :immediate_trigger,
+                    :last_modified_time,
+                    :name,
+                    :status,
+                    :timing,
+                    :url,
+                    :enabled,
+                    :outcome
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def payload
+         fail ArgumentError, 'enabled must be set to create pipeline payload' if @enabled.nil?
+         fail ArgumentError, 'outcome must be set to create pipeline payload' if @outcome.nil?
+        {
+          activation_time: activation_time,
+          cancellation_trigger: cancellation_trigger,
+          condition: condition,
+          constraint: constraint,
+          creation_time: creation_time,
+          deactivation_time: deactivation_time,
+          enabled: enabled,
+          historical_trigger: historical_trigger,
+          immediate_trigger: immediate_trigger,
+          last_modified_time: last_modified_time,
+          name: name,
+          outcome: outcome,
+          status: status,
+          timing: timing,
+          url: url
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+      end
+      
+    end
+  end
+end

data/lib/urbanairship/common.rb

@@ -19,6 +19,8 @@ module Urbanairship
     PIPELINES_URL = BASE_URL + '/pipelines/'
     FEEDS_URL = BASE_URL + '/feeds/'
     LOCATION_URL = BASE_URL + '/location/'
+    CREATE_AND_SEND_URL = BASE_URL + '/create-and-send/'
+    EXPERIMENTS_URL = BASE_URL + '/experiments/'
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example

data/lib/urbanairship/devices/create_and_send.rb

@@ -0,0 +1,96 @@
+require 'urbanairship'
+require 'urbanairship/devices/email_notification'
+
+module Urbanairship
+  module Devices
+    class CreateAndSend
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :addresses,
+                    :device_types,
+                    :notification,
+                    :campaigns,
+                    :name,
+                    :scheduled_time
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def validate_address
+        @addresses.each do |address|
+          unless address.include?(:ua_address) or address.include?(:ua_msisdn && :ua_opted_in && :ua_sender)
+            fail ArgumentError, 'Missing a component in address portion of the object'
+          end
+        end
+      end
+
+      def payload
+        fail ArgumentError, 'addresses must be set for defining payload' if @addresses.nil?
+        fail ArgumentError, 'device type array must be set for defining payload' if @device_types.nil?
+        fail ArgumentError, 'notification object must be set for defining payload' if @notification.nil?
+
+        validate_address
+
+        full_payload = {
+          'audience': {
+            'create_and_send': addresses
+          },
+          'device_types': device_types,
+          'notification': notification,
+        }
+
+        if campaigns
+          campaign_object = {'categories': campaigns}
+          full_payload[:campaigns] = campaign_object
+        end
+        
+        full_payload
+      end
+
+      def create_and_send
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: CREATE_AND_SEND_URL,
+          content_type: 'application/json'
+        )
+        logger.info("Running create and send for addresses #{@addresses}")
+        response
+      end
+
+      def validate
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: CREATE_AND_SEND_URL + 'validate',
+          content_type: 'application/json'
+        )
+        logger.info("Validating payload for create and send")
+        response
+      end
+
+      def schedule
+        fail ArgumentError, 'scheduled time must be set to run an operation' if @scheduled_time.nil?
+
+        scheduled_payload = {
+          "schedule": {
+            "scheduled_time": scheduled_time
+          },
+          "name": name,
+          "push": payload
+        }
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(scheduled_payload),
+          url: SCHEDULES_URL + 'create-and-send',
+          content_type: 'application/json'
+        )
+        logger.info("Scheduling create and send operation with name #{@name}")
+        response
+      end
+
+    end
+  end
+end