urbanairship 5.2.0 → 9.3.0

data/lib/urbanairship/custom_events/payload.rb

@@ -0,0 +1,89 @@
+require 'urbanairship'
+require 'urbanairship/common'
+
+module Urbanairship
+  module CustomEvents
+    module Payload
+      include Urbanairship::Common
+
+      def custom_events(
+            body: required('body'),
+            occurred: required('occurred'),
+            user: required('user')
+          )
+        compact_helper({
+          body: body,
+          occurred: format_timestamp(occurred),
+          user: user
+        })
+      end
+
+      # Body specific portion of CustomEvent Object
+      def custom_events_body(
+            interaction_id: nil, interaction_type: nil, name: required('name'),
+            properties: nil, session_id: nil, transaction: nil, value: nil
+          )
+
+        validates_name_format(name)
+        validates_value_format(value)
+
+        compact_helper({
+          interaction_id: interaction_id,
+          interaction_type: interaction_type,
+          name: name,
+          properties: properties,
+          session_id: session_id,
+          transaction: transaction,
+          value: value
+        })
+      end
+
+      # User specific portion of CustomEvent Object
+      def custom_events_user(
+            amazon_channel: nil, android_channel: nil, channel: nil,
+            ios_channel: nil, named_user_id: nil, web_channel: nil
+          )
+        res = compact_helper({
+            amazon_channel: amazon_channel,
+            android_channel: android_channel,
+            channel: channel,
+            ios_channel: ios_channel,
+            named_user_id: named_user_id,
+            web_channel: web_channel,
+          })
+
+        fail ArgumentError, 'at least one user identifier must be defined' if res.empty?
+
+        res
+      end
+
+
+      # Formatters
+      # ------------------------------------------------------------------------
+
+      def format_timestamp(timestamp)
+        return timestamp if timestamp.is_a?(String)
+
+        timestamp.strftime('%Y-%m-%dT%H:%M:%S')
+      end
+
+
+      # Validators
+      # ------------------------------------------------------------------------
+
+      NAME_REGEX = /^[a-z0-9_\-]+$/
+      def validates_name_format(name)
+        return if name =~ NAME_REGEX
+
+        fail ArgumentError, 'invalid "name": it must follows this pattern /^[a-z0-9_\-]+$/'
+      end
+
+      def validates_value_format(value)
+        return if value.nil?
+        return if value.is_a?(Numeric)
+
+        fail ArgumentError, 'invalid "value": must be a number'
+      end
+    end
+  end
+end

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/attributes.rb

@@ -0,0 +1,53 @@
+
+module Urbanairship
+  module  Devices
+    class Attributes
+
+      SET = 'set'
+      REMOVE = 'remove'
+
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def payload
+        @payload ||= { attributes: attributes_list }
+      end
+
+      private
+
+      def attributes_list
+        @attributes.map{ |attribute| attribute_payload(attribute) }
+      end
+
+      def attribute_payload(attribute)
+        if REMOVE == attribute[:action]
+          remove_payload(attribute)
+        else
+          set_payload(attribute)
+        end
+      end
+
+      def set_payload(attribute)
+        {
+          action: SET,
+          key: attribute[:key],
+          value: attribute[:value],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def remove_payload(attribute)
+        {
+          action: REMOVE,
+          key: attribute[:key],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def timestamp
+        @timestamp ||= Time.now.utc
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/channel_tags.rb

@@ -15,7 +15,7 @@ module Urbanairship
         @add_group = {}
         @remove_group = {}
         @set_group = {}
-        @url = CHANNEL_URL + 'tags/'
+        @path = channel_path('tags/')
       end
 
       def set_audience(ios: nil, android: nil, amazon: nil)
@@ -62,7 +62,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: @url,
+          path: @path,
           content_type: 'application/json'
         )
         logger.info("Set tags for audience: #{@audience}")

data/lib/urbanairship/devices/channel_uninstall.rb

@@ -23,7 +23,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(channels),
-          url: CHANNEL_URL + 'uninstall/',
+          path: channel_path('uninstall/'),
           content_type: 'application/json'
         )
 
@@ -31,33 +31,33 @@ module Urbanairship
         response
       end
     end
-    
-    
+
+
     class OpenChannelUninstall
       include Urbanairship::Common
       include Urbanairship::Loggable
       attr_reader :client
-      
+
       def initialize(client: required('client'))
         @client = client
       end
-      
+
       def uninstall(address: required('address'),
                     open_platform: required('open_platform'))
-        
+
         body = {
           address: address,
           open_platform_name: open_platform
         }
-        
+
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(body),
-          url: OPEN_CHANNEL_URL + 'uninstall/',
+          path: open_channel_path('uninstall/'),
           content_type: 'application/json'
         )
-        
-        logger.info { "Successfully unintalled open channel with address: #{address}"}
+
+        logger.info { "Successfully uninstalled open channel with address: #{address}"}
         response
       end
     end

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),
+          path: create_and_send_path,
+          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),
+          path: create_and_send_path('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),
+          path: schedules_path('create-and-send'),
+          content_type: 'application/json'
+        )
+        logger.info("Scheduling create and send operation with name #{@name}")
+        response
+      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
@@ -15,17 +17,36 @@ module Urbanairship
       def lookup(uuid: required('uuid'))
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + uuid
+          path: channel_path(uuid)
         )
         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),
+          path: channel_path('attributes'),
+          content_type: 'application/json'
+        )
+        response
+      end
     end
 
     class ChannelList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = CHANNEL_URL
+        @next_page_path = channel_path
         @data_attribute = 'channels'
       end
     end
@@ -43,7 +64,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: DEVICE_TOKEN_URL + token
+          path: device_token_path(token)
         )
         logger.info("Looking up info on device token #{token}")
         resp
@@ -56,7 +77,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = DEVICE_TOKEN_URL
+        @next_page_path = device_token_path
         @data_attribute = 'device_tokens'
       end
     end
@@ -74,7 +95,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: APID_URL + apid
+          path: apid_path(apid)
         )
         logger.info("Retrieved info on apid #{apid}")
         resp
@@ -84,9 +105,9 @@ module Urbanairship
     class APIDList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = APID_URL
+        @next_page_path = apid_path
         @data_attribute = 'apids'
       end
     end
   end
-end
+end

data/lib/urbanairship/devices/email.rb

@@ -19,16 +19,6 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @address = nil
-        @commercial_opted_in = nil
-        @commercial_opted_out = nil
-        @locale_country = nil
-        @locale_language = nil
-        @timezone = nil
-        @transactional_opted_in = nil
-        @transactional_opted_out = nil
-        @type = nil
-        @channel_id = nil
       end
 
       def register
@@ -36,25 +26,25 @@ module Urbanairship
 
         payload = {
           'channel': {
-            'address': @address,
-            'commercial_opted_in': @commercial_opted_in,
-            'commercial_opted_out': @commercial_opted_out,
-            'locale_country': @locale_country,
-            'locale_language': @locale_language,
-            'timezone': @timezone,
-            'transactional_opted_in': @transactional_opted_in,
-            'transactional_opted_out': @transactional_opted_out,
-            'type': @type
+            'address': address,
+            'commercial_opted_in': commercial_opted_in,
+            'commercial_opted_out': commercial_opted_out,
+            'locale_country': locale_country,
+            'locale_language': locale_language,
+            'timezone': timezone,
+            'transactional_opted_in': transactional_opted_in,
+            'transactional_opted_out': transactional_opted_out,
+            'type': type
           }
         }
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'email',
+          path: channel_path('email'),
           content_type: 'application/json'
         )
-        logger.info("Registering email channel with address #{@address}")
+        logger.info("Registering email channel with address #{address}")
         response
       end
 
@@ -62,16 +52,16 @@ module Urbanairship
         fail ArgumentError, 'address must be set to register email channel' if @address.nil?
 
         payload = {
-          'email_address': @address
+          'email_address': address
         }
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'email/uninstall',
+          path: channel_path('email/uninstall'),
           content_type: 'application/json'
         )
-        logger.info("Uninstalling email channel with address #{@address}")
+        logger.info("Uninstalling email channel with address #{address}")
         response
       end
 
@@ -80,32 +70,32 @@ module Urbanairship
 
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + 'email/' + @address
+          path: channel_path('email/' + address)
         )
-        logger.info("Looking up email channel with address #{@address}")
+        logger.info("Looking up email channel with address #{address}")
         response
       end
 
       def update
-        fail ArgumentError, 'address must be set to update email channel' if @channel_id.nil?
-
-        channel_data =  {}
-
-        channel_data['address'] = @address if @address
-        channel_data['commercial_opted_in'] = @commercial_opted_in if @commercial_opted_in
-        channel_data['commercial_opted_out'] = @commercial_opted_out if @commercial_opted_out
-        channel_data['locale_country'] = @locale_country if @locale_country
-        channel_data['locale_language'] = @locale_language if @locale_language
-        channel_data['timezone'] = @timezone if @timezone
-        channel_data['transactional_opted_in'] = @transactional_opted_in if @transactional_opted_in
-        channel_data['transactional_opted_out'] = @transactional_opted_out if @transactional_opted_out
-        channel_data['type'] = @type if @type
-
-        payload = {channel: channel_data}
+        fail ArgumentError, 'address must be set to update email channel' if channel_id.nil?
+
+        channel_data =  {
+          'address': address,
+          'commercial_opted_in': commercial_opted_in,
+          'commercial_opted_out': commercial_opted_out,
+          'localte_country': locale_country,
+          'locale_language': locale_language,
+          'timezone': timezone,
+          'transactional_opted_in': transactional_opted_in,
+          'transactional_opted_out': transactional_opted_out,
+          'type': type
+      }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        payload = {'channel': channel_data}
 
         response = @client.send_request(
           method: 'PUT',
-          url: CHANNEL_URL + 'email/' + @channel_id,
+          path: channel_path('email/' + channel_id),
           body: JSON.dump(payload),
           content_type: 'application/json'
         )
@@ -119,7 +109,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @url = CHANNEL_URL + 'email/tags'
+        @path = channel_path('email/tags')
       end
 
       def set_audience(email_address: required('email_address'))

data/lib/urbanairship/devices/email_notification.rb

@@ -0,0 +1,92 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class EmailNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :bcc,
+                    :bypass_opt_in_level,
+                    :html_body,
+                    :message_type,
+                    :plaintext_body,
+                    :reply_to,
+                    :sender_address,
+                    :sender_name,
+                    :subject,
+                    :template_id,
+                    :variable_details,
+                    :click_tracking,
+                    :open_tracking
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def email_override
+        fail ArgumentError, 'message_type is needed for email override' if @message_type.nil?
+        fail ArgumentError, 'plaintext_body is needed for email override' if @plaintext_body.nil?
+        fail ArgumentError, 'reply_to is needed for email override' if @reply_to.nil?
+        fail ArgumentError, 'sender_address is needed for email override' if @sender_address.nil?
+        fail ArgumentError, 'sender_name is needed for email override' if @sender_name.nil?
+        fail ArgumentError, 'subject is needed for email override' if @subject.nil?
+
+        override = {
+          bcc: bcc,
+          bypass_opt_in_level: bypass_opt_in_level,
+          click_tracking: click_tracking,
+          html_body: html_body,
+          message_type: message_type,
+          open_tracking: open_tracking, 
+          plaintext_body: plaintext_body,
+          reply_to: reply_to,
+          sender_address: sender_address,
+          sender_name: sender_name,
+          subject: subject
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        {'email': override}
+      end
+
+      def email_with_inline_template
+        fail ArgumentError, 'message_type is needed for email with inline template' if @message_type.nil?
+        fail ArgumentError, 'reply_to is needed for email with inline template' if @reply_to.nil?
+        fail ArgumentError, 'sender_address is needed for email with inline template' if @sender_address.nil?
+        fail ArgumentError, 'sender_name is needed for email with inline template' if @sender_name.nil?
+
+        inline_template = {
+          bcc: bcc,
+          click_tracking: click_tracking,
+          message_type: message_type,
+          open_tracking: open_tracking,
+          reply_to: reply_to,
+          sender_address: sender_address,
+          sender_name: sender_name,
+          template: define_template_object
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs      
+
+        {'email': inline_template}
+      end
+
+      def define_template_object
+        fail ArgumentError, 'Must choose between template_id or fields object' if template_id && plaintext_body && subject
+        template_portion = {
+          template_id: template_id,
+          fields: define_fields,
+          variable_details: variable_details
+        }.delete_if {|key, value| value.nil?}
+      end
+
+      def define_fields
+        if subject && plaintext_body
+          {
+            subject: subject,
+            plaintext_body: plaintext_body
+          }
+        end
+      end
+
+    end
+  end
+end