urbanairship 5.6.1 → 7.0.0

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

data/lib/urbanairship/push/push.rb

@@ -8,9 +8,17 @@ module Urbanairship
 
     # A Push Notification.
     class Push
-      attr_writer :client, :audience, :notification, :options,
-                  :device_types, :message, :in_app
-      attr_reader :device_types, :audience
+      attr_writer :client
+
+      attr_accessor :device_types,
+                    :audience,
+                    :notification,
+                    :options,
+                    :message,
+                    :in_app,
+                    :campaigns,
+                    :localizations
+
       include Urbanairship::Common
       include Urbanairship::Loggable
 
@@ -23,12 +31,14 @@ module Urbanairship
 
       def payload
         compact_helper({
-          audience: @audience,
-          notification: @notification,
-          options: @options,
-          device_types: @device_types,
-          message: @message,
-          in_app: @in_app
+          audience: audience,
+          notification: notification,
+          options: options,
+          device_types: device_types,
+          message: message,
+          in_app: in_app,
+          campaigns: campaigns,
+          localizations: localizations
         })
       end
 
@@ -42,7 +52,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: PUSH_URL,
+          path: push_path,
           content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
@@ -83,7 +93,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: SCHEDULES_URL,
+          path: schedules_path,
           content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
@@ -160,7 +170,7 @@ module Urbanairship
            'schedule_id must be a string' unless schedule_id.is_a? String
         resp = @client.send_request(
           method: 'GET',
-          url: SCHEDULES_URL + schedule_id
+          path: schedules_path(schedule_id)
         )
         logger.info("Retrieved info for schedule_id #{schedule_id}")
         resp
@@ -171,7 +181,7 @@ module Urbanairship
     class ScheduledPushList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = SCHEDULES_URL
+        @next_page_path = schedules_path
         @data_attribute = 'schedules'
       end
     end

data/lib/urbanairship/push/schedule.rb

@@ -14,6 +14,15 @@ module Urbanairship
         payload(:local_scheduled_time, datetime)
       end
 
+      # Uses predictive analysis to send push at optimal time
+      def optimal_scheduled_time(date)
+        {
+          'best_time': {
+            'send_date': date
+          }
+        }
+      end
+
       private
 
       def payload(name, time)

data/lib/urbanairship/reports/response_statistics.rb

@@ -4,22 +4,33 @@ require 'time'
 module Urbanairship
   module Reports
     class Helper
-      def get_url(start_date, end_date, precision)
-        fail ArgumentError,
-           'the parameters cannot be set to nil' if start_date.nil? or end_date.nil? or precision.nil?
-        precision_array = %w(HOURLY DAILY MONTHLY)
-        fail ArgumentError,
-             "Precision must be 'HOURLY', 'DAILY', or 'MONTHLY'" unless precision_array.include?(precision)
+      def get_period_params(start_date, end_date, precision)
+        validates_parameters_presence!(start_date, end_date, precision)
+        validates_precision_format!(precision)
 
         begin
-          start_parsed = Time.parse(start_date)
-          end_parsed = Time.parse(end_date)
+          start_parsed = Time.parse(start_date).iso8601
+          end_parsed = Time.parse(end_date).iso8601
+
+          "?start=#{start_parsed}&end=#{end_parsed}&precision=#{precision}"
         rescue ArgumentError
-          fail ArgumentError,
-             'start_date and end_date must be valid date strings'
+          fail ArgumentError, 'start_date and end_date must be valid date strings'
         end
-        url = '?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601
-        url += '&precision=' + precision
+      end
+
+      private
+
+      def validates_parameters_presence!(start_date, end_date, precision)
+        return unless [start_date, end_date, precision].any?(&:nil?)
+
+        fail ArgumentError, 'the parameters cannot be set to nil'
+      end
+
+      AUTHORIZED_PRECISIONS = %w(HOURLY DAILY MONTHLY)
+      def validates_precision_format!(precision)
+        return if AUTHORIZED_PRECISIONS.include?(precision)
+
+        fail ArgumentError, 'Precision must be "HOURLY", "DAILY", or "MONTHLY"'
       end
     end
 
@@ -35,8 +46,8 @@ module Urbanairship
         fail ArgumentError,
            'push_id cannot be nil' if push_id.nil?
 
-        url = REPORTS_URL + 'responses/' + push_id
-        response = @client.send_request(method: 'GET', url: url)
+        path = reports_path('responses/' + push_id)
+        response = @client.send_request(method: 'GET', path: path)
         logger.info("Retrieved info on push_id: #{push_id}")
         response
       end
@@ -60,10 +71,10 @@ module Urbanairship
           fail ArgumentError,
                'start_date and end_date must be valid date strings'
         end
-        url = REPORTS_URL + 'responses/list?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601
-        url += '&limit' + limit.to_s unless limit.nil?
-        url += '&push_id_start&' + push_id_start unless push_id_start.nil?
-        @next_page = url
+        path = reports_path('responses/list?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601)
+        path += '&limit' + limit.to_s unless limit.nil?
+        path += '&push_id_start&' + push_id_start unless push_id_start.nil?
+        @next_page_path = path
         @data_attribute = 'pushes'
       end
     end
@@ -87,7 +98,7 @@ module Urbanairship
         end
         response = @client.send_request(
           method: 'GET',
-          url: REPORTS_URL + 'devices/?date=' + date_parsed.iso8601
+          path: reports_path('devices/?date=' + date_parsed.iso8601)
         )
         logger.info("Retrieved device report for date #{date}")
         response
@@ -98,8 +109,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'optins/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('optins/' + period_params)
         @data_attribute = 'optins'
       end
     end
@@ -108,8 +119,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'optouts/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('optouts/' + period_params)
         @data_attribute = 'optouts'
       end
     end
@@ -118,8 +129,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'sends/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('sends/' + period_params)
         @data_attribute = 'sends'
       end
     end
@@ -128,8 +139,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'responses/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('responses/' + period_params)
         @data_attribute = 'responses'
       end
     end
@@ -138,8 +149,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'opens/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('opens/' + period_params)
         @data_attribute = 'opens'
       end
     end
@@ -148,8 +159,8 @@ module Urbanairship
       def initialize(client: required('client'), start_date: required('start_date'),
                      end_date: required('end_date'), precision: required('precision'))
         super(client: client)
-        url = Helper.new.get_url(start_date, end_date, precision)
-        @next_page = REPORTS_URL + 'timeinapp/' + url
+        period_params = Helper.new.get_period_params(start_date, end_date, precision)
+        @next_page_path = reports_path('timeinapp/' + period_params)
         @data_attribute = 'timeinapp'
       end
     end