urbanairship 5.4.0 → 5.7.0

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,15 +26,15 @@ 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
           }
         }
 
@@ -54,7 +44,7 @@ module Urbanairship
           url: CHANNEL_URL + 'email',
           content_type: 'application/json'
         )
-        logger.info("Registering email channel with address #{@address}")
+        logger.info("Registering email channel with address #{address}")
         response
       end
 
@@ -62,7 +52,7 @@ 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(
@@ -71,7 +61,7 @@ module Urbanairship
           url: CHANNEL_URL + '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
+          url: CHANNEL_URL + '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,
+          url: CHANNEL_URL + 'email/' + channel_id,
           body: JSON.dump(payload),
           content_type: 'application/json'
         )

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

data/lib/urbanairship/devices/mms_notification.rb

@@ -0,0 +1,107 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class MmsNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :fallback_text,
+                    :shorten_links,
+                    :content_length,
+                    :content_type,
+                    :url,
+                    :text,
+                    :subject,
+                    :template_id,
+                    :slide_1_text
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def validate_url
+        unless ['.jpg', '.gif', '.png', 'jpeg'].include?(@url[-4..-1])
+          fail ArgumentError, 'url must end in .gif, .jpg, .png, or .jpeg'
+        end
+      end
+
+      def mms_override
+        fail ArgumentError, 'fallback_text is needed for MMS override' if fallback_text.nil?
+        fail ArgumentError, 'content_length is needed for MMS override' if content_length.nil?
+        fail ArgumentError, 'content_type is needed for MMS override' if content_type.nil?
+        fail ArgumentError, 'url is needed for MMS override' if url.nil?
+
+        validate_url
+
+        override = {"mms": {
+                "subject": subject,
+                "fallback_text": fallback_text,
+                "shorten_links": shorten_links,
+                "slides": [
+                      {
+                         "text": text,
+                         "media": {
+                            "url": url,
+                            "content_type": content_type,
+                            "content_length": content_length
+                         }
+                      }
+                    ]
+                 }
+              }
+        override
+      end
+
+      def mms_template_with_id
+        fail ArgumentError, 'content_length is needed for MMS Inline Template with ID' if content_length.nil?
+        fail ArgumentError, 'content_type is needed for MMS Inline Template with ID' if content_type.nil?
+        fail ArgumentError, 'url is needed for MMS Inline Template with ID' if url.nil?
+        fail ArgumentError, 'template_id is needed for MMS Inline Template with ID' if template_id.nil?
+
+        {"mms": {
+            "template": {
+              "template_id": template_id
+            },
+            "shorten_links": true,
+            "slides": [
+                {
+                    "media": {
+                        "url": url,
+                        "content_type": content_type,
+                        "content_length": content_length
+                    }
+                }
+            ]
+          }
+        }
+      end
+
+      def mms_inline_template
+        fail ArgumentError, 'slide_1_text text is needed for MMS with inline template' if text.nil?
+
+          {"mms": {
+            "template": {
+              "fields": {
+                "subject": subject,
+                "fallback_text": fallback_text,
+                "slide_1_text": text
+              }
+            },
+            "slides": [
+              {
+                "media": {
+                    "url": url,
+                    "content_type": content_type,
+                    "content_length": content_length
+                }
+              }
+            ]
+          }
+        }
+      end
+
+    end
+  end
+end

data/lib/urbanairship/devices/open_channel.rb

@@ -5,37 +5,41 @@ module Urbanairship
     class OpenChannel
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :channel_id, :open_platform, :opt_in, :address,
-                    :tags, :identifiers
+      attr_accessor :channel_id, 
+                    :open_platform, 
+                    :opt_in, 
+                    :address,
+                    :tags, 
+                    :identifiers,
+                    :template_id,
+                    :alert,
+                    :extra,
+                    :media_attachment,
+                    :summary,
+                    :title,
+                    :template_id,
+                    :fields,
+                    :interactive,
+                    :platform_alert
       
       def initialize(client: required('client'))
         @client = client
-        @channel_id = nil
-        @open_platform = nil
-        @opt_in = nil
-        @address = nil
-        @tags = nil
-        @identifiers = nil
       end
       
       def create()
-        fail TypeError, 'address must be set to create open channel' unless @address.is_a? String
-        fail TypeError, 'open_platform must be set to create open channel' unless @open_platform.is_a? String
-        fail TypeError, 'opt_in must be boolean' unless [true, false].include? @opt_in
+        fail TypeError, 'address must be set to create open channel' unless address.is_a? String
+        fail TypeError, 'open_platform must be set to create open channel' unless open_platform.is_a? String
+        fail TypeError, 'opt_in must be boolean' unless [true, false].include? opt_in
         
         channel_data = {
           'type': 'open',
-          'open': {:open_platform_name => @open_platform},
-          'opt_in': @opt_in,
-          'address': @address
-        }
+          'open': {:open_platform_name => open_platform},
+          'opt_in': opt_in,
+          'address': address,
+          'tags': tags
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
         
-        if @tags
-          channel_data['tags'] = @tags
-        end
-        if @identifiers
-          channel_data[:open][:identifiers] = @identifiers
-        end
+        set_identifiers
         
         body = {'channel': channel_data}
         
@@ -45,37 +49,29 @@ module Urbanairship
           body: JSON.dump(body),
           content_type: 'application/json'
         )
-        logger.info("Registering open channel with address: #{@address}")
+        logger.info("Registering open channel with address: #{address}")
         response
       end
       
       def update(set_tags: required('set_tags'))
         fail ArgumentError, 'set_tags must be boolean' unless [true, false].include? set_tags
-        fail ArgumentError, 'set_tags cannot be true when tags are not set' unless set_tags == true && @tags != nil
-        fail TypeError, 'opt_in must be boolean' unless [true, false].include? @opt_in
-        fail TypeError, 'address or channel_id must not be nil' unless @address.is_a? String || @channel_id.is_a?(String)
-        fail TypeError, 'open_platform cannot be nil' unless @open_platform.is_a? String
-        fail TypeErorr, 'address must not be nil if opt_in is true' unless @opt_in.is_a? TrueClass
+        fail ArgumentError, 'set_tags cannot be true when tags are not set' unless set_tags == true && tags != nil
+        fail TypeError, 'opt_in must be boolean' unless [true, false].include? opt_in
+        fail TypeError, 'address or channel_id must not be nil' unless address.is_a? String || channel_id.is_a?(String)
+        fail TypeError, 'open_platform cannot be nil' unless open_platform.is_a? String
+        fail TypeErorr, 'address must not be nil if opt_in is true' unless opt_in.is_a? TrueClass
         
         channel_data = {
           'type': 'open',
-          'open': {'open_platform_name': @open_platform},
-          'opt_in': @opt_in,
-          'set_tags': set_tags
-        }
+          'open': {'open_platform_name': open_platform},
+          'opt_in': opt_in,
+          'set_tags': set_tags,
+          'channel_id': channel_id,
+          'address': address,
+          'tags': tags
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
         
-        if @channel_id
-          channel_data['channel_id'] = @channel_id
-        end
-        if @address
-          channel_data['address'] = @address
-        end
-        if @tags
-          channel_data['tags'] = @tags
-        end
-        if @identifiers
-          channel_data['open']['identifiers'] = @identifiers
-        end
+        set_identifiers
         
         body = {'channel': channel_data}
           
@@ -85,7 +81,7 @@ module Urbanairship
           body: JSON.dump(body),
           content_type: 'application/json'
         )
-        logger.info("Updating open channel with address #{@address}")
+        logger.info("Updating open channel with address #{address}")
         response
       end
       
@@ -99,6 +95,55 @@ module Urbanairship
         logger.info("Looking up info on device token #{channel_id}")
         response
       end
+
+      def notification_with_template_id
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil? 
+
+        if alert
+          payload = {
+            "open::#{open_platform}":{
+              'template': {
+                'template_id': template_id,
+                'fields': {
+                  'alert': alert
+                }
+              }
+            }
+          }
+        else
+          payload = {
+            "open::#{open_platform}":{
+              'template': {
+                'template_id': template_id,
+              }
+            }
+          }
+        end
+
+        payload
+      end
+
+      def open_channel_override
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil? 
+        payload = {
+            'alert': platform_alert,
+            'extra': extra,
+            'media_attachment': media_attachment,
+            'summary': summary,
+            'title': title,
+            'interactive': interactive
+          }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        {'alert': alert,
+         "open::#{open_platform}": payload}
+      end
+
+      def set_identifiers
+        if identifiers
+          channel_data[:open][:identifiers] = identifiers
+        end
+      end
+
     end
   end
 end