urbanairship 5.2.0 → 9.3.0

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

@@ -1,6 +1,5 @@
 require 'urbanairship'
 
-
 module Urbanairship
   module Devices
     class NamedUser
@@ -13,6 +12,17 @@ module Urbanairship
         @named_user_id =  nil
       end
 
+      def update_attributes(attributes: required('attributes'))
+        response = @client.send_request(
+          method: 'POST',
+          body: Urbanairship::Attributes.new(attributes).payload.to_json,
+          path: named_users_path("#{@named_user_id}/attributes"),
+          content_type: CONTENT_TYPE,
+        )
+        logger.info { "Updated attributes for named_user #{@named_user_id}" }
+        response
+      end
+
       def associate(channel_id: required('channel_id'), device_type: nil)
         fail ArgumentError,
              'named_user_id is required for association' if @named_user_id.nil?
@@ -20,13 +30,13 @@ module Urbanairship
         payload = {}
         payload['channel_id'] = channel_id
         payload['device_type'] = device_type unless device_type.nil?
-        payload['named_user_id'] = @named_user_id
+        payload['named_user_id'] = @named_user_id.to_s
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/associate',
-          content_type: 'application/json'
+          path: named_users_path('associate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Associated channel_id #{channel_id} with named_user #{@named_user_id}" }
         response
@@ -40,8 +50,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/disassociate',
-          content_type: 'application/json'
+          path: named_users_path('disassociate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Dissociated channel_id #{channel_id}" }
         response
@@ -51,8 +61,8 @@ module Urbanairship
         fail ArgumentError,
            'named_user_id is required for lookup' if @named_user_id.nil?
         response = @client.send_request(
-            method: 'GET',
-            url: NAMED_USER_URL + '?id=' + @named_user_id,
+          method: 'GET',
+          path: named_users_path('?id=' + @named_user_id),
         )
         logger.info { "Retrieved information on named_user_id #{@named_user_id}" }
         response
@@ -65,7 +75,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @url = NAMED_USER_URL + 'tags/'
+        @path = named_users_path('tags/')
       end
 
       def set_audience(user_ids: required('user_ids'))
@@ -79,7 +89,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = NAMED_USER_URL
+        @next_page_path = named_users_path
         @data_attribute = 'named_users'
       end
     end
@@ -101,8 +111,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/uninstall',
-          content_type: 'application/json'
+          path: named_users_path('uninstall'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Uninstalled named_user_ids #{@named_user_ids} " }
         response

data/lib/urbanairship/devices/open_channel.rb

@@ -5,101 +5,145 @@ 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
-        }
-        
-        if @tags
-          channel_data['tags'] = @tags
-        end
-        if @identifiers
-          channel_data[:open][:identifiers] = @identifiers
-        end
-        
+          '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
+
+        set_identifiers
+
         body = {'channel': channel_data}
-        
+
         response = @client.send_request(
           method: 'POST',
-          url: OPEN_CHANNEL_URL,
+          path: open_channel_path,
           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
-        }
-        
-        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
-        
+          '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
+
+        set_identifiers
+
         body = {'channel': channel_data}
-          
+
         response = @client.send_request(
           method: 'POST',
-          url: OPEN_CHANNEL_URL,
+          path: open_channel_path,
           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
-      
+
       def lookup(channel_id: required('channel_id'))
         fail ArgumentError, 'channel_id needs to be a string' unless channel_id.is_a? String
-        
+
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + channel_id
+          path: channel_path(channel_id)
         )
         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
-      

data/lib/urbanairship/devices/segment.rb

@@ -12,9 +12,6 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @display_name = nil
-        @criteria = nil
-        @id = nil
       end
 
       # Build a Segment from the display_name and criteria attributes
@@ -25,13 +22,13 @@ module Urbanairship
         fail ArgumentError,
           'Both display_name and criteria must be set to a value' if display_name.nil? or criteria.nil?
         payload = {
-          :display_name => @display_name,
-          :criteria => @criteria
+          'display_name': display_name,
+          'criteria': criteria
         }
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: SEGMENTS_URL,
+          path: segments_path,
           content_type: 'application/json'
         )
         logger.info { "Successful segment creation: #{@display_name}" }
@@ -48,7 +45,7 @@ module Urbanairship
           'id must be set to a valid string' if id.nil?
         response = @client.send_request(
           method: 'GET',
-          url: SEGMENTS_URL + id
+          path: segments_path(id)
         )
         logger.info("Retrieved segment information for #{id}")
         @id = id
@@ -67,12 +64,12 @@ module Urbanairship
           'Either display_name or criteria must be set to a value' if display_name.nil? and criteria.nil?
 
         data = {}
-        data['display_name'] = @display_name
-        data['criteria'] = @criteria
+        data['display_name'] = display_name
+        data['criteria'] = criteria
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(data),
-          url: SEGMENTS_URL + @id,
+          path: segments_path(@id),
           content_type: 'application/json'
         )
         logger.info { "Successful segment update: #{@display_name}" }
@@ -83,13 +80,11 @@ module Urbanairship
       #
       # @ returns [Object] response HTTP response
       def delete
-        fail ArgumentError,
-          'id cannot be nil' if @id.nil?
+        fail ArgumentError, 'id cannot be nil' if id.nil?
 
-        url = SEGMENTS_URL + @id
         response = @client.send_request(
           method: 'DELETE',
-          url: url
+          path: segments_path(id)
         )
         logger.info { "Successful segment deletion: #{@display_name}" }
         response
@@ -101,7 +96,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = SEGMENTS_URL
+        @next_page_path = segments_path
         @data_attribute = 'segments'
       end
     end

data/lib/urbanairship/devices/sms.rb

@@ -5,48 +5,76 @@ module Urbanairship
     class Sms
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :msisdn, :sender, :opted_in, :sender
+      attr_accessor :msisdn,
+                    :sender,
+                    :opted_in,
+                    :sender,
+                    :locale_country,
+                    :locale_language,
+                    :timezone,
+                    :channel_id
 
       def initialize(client: required('client'))
         @client = client
-        @sender = nil
-        @msisdn = nil
-        @opted_in = nil
       end
 
       def register
-        fail ArgumentError, 'sender must be set to register sms channel' if @sender.nil?
-        fail ArgumentError, 'msisdn must be set to register sms channel' if @msisdn.nil?
+        fail ArgumentError, 'sender must be set to register sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to register sms channel' if msisdn.nil?
 
         payload = {
-          'msisdn': @msisdn,
-          'sender': @sender,
-          'opted_in': @opted_in
+          'msisdn': msisdn,
+          'sender': sender,
+          'opted_in': opted_in
         }
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms',
+          path: channel_path('sms'),
           content_type: 'application/json'
         )
         logger.info("Registering SMS channel with msisdn #{@msisdn}")
         response
       end
 
+      def update
+        fail ArgumentError, 'sender must be set to update sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to update sms channel' if msisdn.nil?
+        fail ArgumentError, 'channel_id must be set to update sms channel' if channel_id.nil?
+
+        payload = {
+          'msisdn': msisdn,
+          'sender': sender,
+          'opted_in': opted_in,
+          'locale_country': locale_country,
+          'locale_language': locale_language,
+          'timezone': timezone
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        response = @client.send_request(
+          method: 'PUT',
+          body: JSON.dump(payload),
+          path: channel_path('sms/' + channel_id),
+          content_type: 'application/json'
+        )
+        logger.info("Updating SMS channel with msisdn #{@channel_id}")
+        response
+      end
+
       def opt_out
-        fail ArgumentError, 'sender must be set to register sms channel' if @sender.nil?
-        fail ArgumentError, 'msisdn must be set to register sms channel' if @msisdn.nil?
+        fail ArgumentError, 'sender must be set to opt out sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to opt out sms channel' if msisdn.nil?
 
         payload = {
-          'msisdn': @msisdn,
-          'sender': @sender,
+          'msisdn': msisdn,
+          'sender': sender,
         }
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms/opt-out',
+          path: channel_path('sms/opt-out'),
           content_type: 'application/json'
         )
         logger.info("Opting Out of SMS messages for #{@msisdn}")
@@ -54,18 +82,18 @@ module Urbanairship
       end
 
       def uninstall
-        fail ArgumentError, 'sender must be set to register sms channel' if @sender.nil?
-        fail ArgumentError, 'msisdn must be set to register sms channel' if @msisdn.nil?
+        fail ArgumentError, 'sender must be set to uninstall sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to uninstall sms channel' if msisdn.nil?
 
         payload = {
-          'msisdn': @msisdn,
-          'sender': @sender,
+          'msisdn': msisdn,
+          'sender': sender,
         }
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms/uninstall',
+          path: channel_path('sms/uninstall'),
           content_type: 'application/json'
         )
         logger.info("Uninstalling SMS channel for #{@msisdn}")
@@ -73,12 +101,12 @@ module Urbanairship
       end
 
       def lookup
-        fail ArgumentError,'msisdn is required for lookup' if @msisdn.nil?
-        fail ArgumentError,'sender is required for lookup' if @sender.nil?
+        fail ArgumentError,'msisdn is required for lookup' if msisdn.nil?
+        fail ArgumentError,'sender is required for lookup' if sender.nil?
 
         response = @client.send_request(
             method: 'GET',
-            url: CHANNEL_URL + 'sms/' + @msisdn + '/' + @sender
+            path: channel_path('sms/' + @msisdn + '/' + @sender)
         )
         logger.info { "Retrieved information for msisdn #{@msisdn}" }
         response

data/lib/urbanairship/devices/sms_notification.rb

@@ -0,0 +1,54 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class SmsNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :sms_alert,
+                    :generic_alert,
+                    :expiry,
+                    :shorten_links,
+                    :template_id
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def sms_notification_override
+        {
+           "alert": generic_alert,
+           "sms": {
+              "alert": sms_alert,
+              "expiry": expiry,
+              "shorten_links": shorten_links
+           }
+        }
+      end
+
+      def sms_inline_template
+        inline_template = {
+          "sms": {
+            "template": {}
+          }
+        }
+
+        if @template_id
+          inline_template[:sms][:template][:template_id] = @template_id
+        end
+
+        if @sms_alert
+          inline_fields= {
+            "fields": {"alert": @sms_alert}
+          }
+          inline_template[:sms][:template] = inline_fields
+        end
+        
+        inline_template
+      end
+
+    end
+  end
+end