urbanairship 5.7.0 → 8.0.0

data/lib/urbanairship/devices/open_channel.rb

@@ -5,11 +5,11 @@ module Urbanairship
     class OpenChannel
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :channel_id, 
-                    :open_platform, 
-                    :opt_in, 
+      attr_accessor :channel_id,
+                    :open_platform,
+                    :opt_in,
                     :address,
-                    :tags, 
+                    :tags,
                     :identifiers,
                     :template_id,
                     :alert,
@@ -21,16 +21,16 @@ module Urbanairship
                     :fields,
                     :interactive,
                     :platform_alert
-      
+
       def initialize(client: required('client'))
         @client = client
       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
-        
+
         channel_data = {
           'type': 'open',
           'open': {:open_platform_name => open_platform},
@@ -38,21 +38,21 @@ module Urbanairship
           '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}")
         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
@@ -60,7 +60,7 @@ module Urbanairship
         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},
@@ -70,34 +70,34 @@ module Urbanairship
           '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}")
         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? 
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil?
 
         if alert
           payload = {
@@ -124,7 +124,7 @@ module Urbanairship
       end
 
       def open_channel_override
-        fail TypeError, 'open_platform cannot be nil' if open_platform.nil? 
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil?
         payload = {
             'alert': platform_alert,
             'extra': extra,
@@ -147,4 +147,3 @@ module Urbanairship
     end
   end
 end
-      

data/lib/urbanairship/devices/segment.rb

@@ -28,7 +28,7 @@ module Urbanairship
         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}" }
@@ -45,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
@@ -69,7 +69,7 @@ module Urbanairship
         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}" }
@@ -80,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
@@ -98,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,7 +5,14 @@ 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
@@ -24,16 +31,40 @@ module Urbanairship
         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,
@@ -43,7 +74,7 @@ module Urbanairship
         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}")
@@ -51,8 +82,8 @@ 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,
@@ -62,7 +93,7 @@ module Urbanairship
         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}")
@@ -75,7 +106,7 @@ module Urbanairship
 
         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/static_lists.rb

@@ -13,16 +13,16 @@ module Urbanairship
         @client = client
       end
 
-      def create(description: nil, extras: nil)
+      def create(description: nil, extra: nil)
         fail ArgumentError, 'Name must be set' if name.nil?
         payload = {'name': name}
         payload['description'] = description unless description.nil?
-        payload['extras'] = extras unless extras.nil?
+        payload['extra'] = extra unless extra.nil?
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: LISTS_URL,
+          path: lists_path,
           content_type: 'application/json'
         )
         logger.info("Created static list for #{@name}")
@@ -35,7 +35,7 @@ module Urbanairship
           response = @client.send_request(
               method: 'PUT',
               body: csv_file,
-              url: LISTS_URL + @name + '/csv/',
+              path: lists_path(@name + '/csv/'),
               content_type: 'text/csv',
               encoding: gzip
           )
@@ -43,7 +43,7 @@ module Urbanairship
           response = @client.send_request(
               method: 'PUT',
               body: csv_file,
-              url: LISTS_URL + @name + '/csv/',
+              path: lists_path(@name + '/csv/'),
               content_type: 'text/csv'
           )
         end
@@ -51,17 +51,17 @@ module Urbanairship
         response
       end
 
-      def update(description: nil, extras: nil)
+      def update(description: nil, extra: nil)
         fail ArgumentError, 'Name must be set' if name.nil?
         fail ArgumentError,
-           'Either description or extras must be set to a value' if description.nil? and extras.nil?
+           'Either description or extras must be set to a value' if description.nil? and extra.nil?
         payload = {}
         payload['description'] = description unless description.nil?
-        payload['extras'] = extras unless extras.nil?
+        payload['extra'] = extra unless extra.nil?
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(payload),
-          url: LISTS_URL + @name,
+          path: lists_path(@name),
           content_type: 'application/json'
         )
         logger.info("Updating the metadata for list #{@name}")
@@ -72,7 +72,7 @@ module Urbanairship
         fail ArgumentError, 'Name must be set' if name.nil?
         response = @client.send_request(
           method: 'GET',
-          url: LISTS_URL + @name
+          path: lists_path(@name)
         )
         logger.info("Retrieving info for list #{@name}")
         response
@@ -82,7 +82,7 @@ module Urbanairship
         fail ArgumentError, 'Name must be set' if name.nil?
         response = @client.send_request(
           method: 'DELETE',
-          url: LISTS_URL + @name
+          path: lists_path(@name)
         )
         logger.info("Deleted list #{@name}")
         response
@@ -92,7 +92,7 @@ module Urbanairship
     class StaticLists < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = LISTS_URL
+        @next_page_path = lists_path
         @data_attribute = 'lists'
       end
     end

data/lib/urbanairship/push/location.rb

@@ -14,11 +14,11 @@ module Urbanairship
       def name_lookup(name: required('name'), type: nil)
         fail ArgumentError, 'name needs to be a string' unless name.is_a? String
         fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
-        url = LOCATION_URL + '?q=' + name
-        url += '&type=' + type unless type.nil?
+        path = location_path('?q=' + name)
+        path += '&type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
-          url: url
+          path: path
         )
         logger.info("Retrieved location information for #{name}")
         resp
@@ -28,11 +28,11 @@ module Urbanairship
         fail ArgumentError,
           'latitude and longitude need to be numbers' unless latitude.is_a? Numeric and longitude.is_a? Numeric
         fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
-        url = LOCATION_URL + latitude.to_s + ',' + longitude.to_s
-        url += '?type=' + type unless type.nil?
+        path = location_path(latitude.to_s + ',' + longitude.to_s)
+        path += '?type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
-          url: url
+          path: path
         )
         logger.info("Retrieved location information for latitude #{latitude} and longitude #{longitude}")
         resp
@@ -45,11 +45,11 @@ module Urbanairship
            'lat1, long1, lat2, and long2 need to be numbers' unless lat1.is_a? Numeric and long2.is_a? Numeric\
            and lat2.is_a? Numeric and long2.is_a? Numeric
         fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
-        url = LOCATION_URL + lat1.to_s + ',' + long1.to_s + ',' + lat2.to_s + ',' + long2.to_s
-        url += '?type=' + type unless type.nil?
+        path = location_path(lat1.to_s + ',' + long1.to_s + ',' + lat2.to_s + ',' + long2.to_s)
+        path += '?type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
-          url: url
+          path: path
         )
         logger.info("Retrieved location information for bounding box with lat1 #{lat1}, long1 #{long1}," +
           " lat2 #{lat2}, and long2 #{long2}")
@@ -58,20 +58,20 @@ module Urbanairship
 
       def alias_lookup(from_alias: required('from_alias'))
         fail ArgumentError, 'from_alias needs to be a string or an array of strings' unless from_alias.is_a? String or from_alias.is_a? Array
-        url = LOCATION_URL + 'from-alias?'
+        path = location_path('from-alias?')
         if from_alias.is_a? Array
           from_alias.each do |a|
             fail ArgumentError, 'from_alias needs to be a string or an array of strings' unless a.is_a? String
-            url += a + '&'
+            path += a + '&'
           end
-          url = url.chop
+          path = path.chop
         else
-          url += from_alias
+          path += from_alias
         end
 
         resp = @client.send_request(
           method: 'GET',
-          url: url
+          path: path
         )
         logger.info("Retrieved location info from alias #{from_alias}")
         resp
@@ -81,10 +81,10 @@ module Urbanairship
         fail ArgumentError, 'polygon_id needs to be a string' unless polygon_id.is_a? String
         fail ArgumentError, 'zoom needs to be an integer' unless zoom.is_a? Integer
 
-        url = LOCATION_URL + polygon_id + '?zoom=' + zoom.to_s
+        path = location_path(polygon_id + '?zoom=' + zoom.to_s)
         resp = @client.send_request(
           method: 'GET',
-          url: url
+          path: path
         )
         logger.info("Retrieved location info for polygon #{polygon_id} and zoom level #{zoom}")
         resp
@@ -93,11 +93,11 @@ module Urbanairship
       def date_ranges
         resp = @client.send_request(
           method: 'GET',
-          url: SEGMENTS_URL + 'dates/'
+          path: segments_path('dates/')
         )
         logger.info('Retrieved location date ranges')
         resp
       end
     end
   end
-end
+end