urbanairship 5.6.0 → 6.0.0

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,
+          url: lists_url,
           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/',
+              url: lists_url(@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/',
+              url: lists_url(@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,
+          url: lists_url(@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
+          url: lists_url(@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
+          url: lists_url(@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 = lists_url
         @data_attribute = 'lists'
       end
     end

data/lib/urbanairship/push/location.rb

@@ -14,7 +14,7 @@ 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 = location_url('?q=' + name)
         url += '&type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
@@ -28,7 +28,7 @@ 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 = location_url(latitude.to_s + ',' + longitude.to_s)
         url += '?type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
@@ -45,7 +45,7 @@ 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 = location_url(lat1.to_s + ',' + long1.to_s + ',' + lat2.to_s + ',' + long2.to_s)
         url += '?type=' + type unless type.nil?
         resp = @client.send_request(
           method: 'GET',
@@ -58,7 +58,7 @@ 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?'
+        url = location_url('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
@@ -81,7 +81,7 @@ 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
+        url = location_url(polygon_id + '?zoom=' + zoom.to_s)
         resp = @client.send_request(
           method: 'GET',
           url: url
@@ -93,11 +93,11 @@ module Urbanairship
       def date_ranges
         resp = @client.send_request(
           method: 'GET',
-          url: SEGMENTS_URL + 'dates/'
+          url: segments_url('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,
+          url: push_url,
           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,
+          url: schedules_url,
           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
+          url: schedules_url(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 = schedules_url
         @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

@@ -35,7 +35,7 @@ module Urbanairship
         fail ArgumentError,
            'push_id cannot be nil' if push_id.nil?
 
-        url = REPORTS_URL + 'responses/' + push_id
+        url = reports_url('responses/' + push_id)
         response = @client.send_request(method: 'GET', url: url)
         logger.info("Retrieved info on push_id: #{push_id}")
         response
@@ -60,7 +60,7 @@ 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 = 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
@@ -87,7 +87,7 @@ module Urbanairship
         end
         response = @client.send_request(
           method: 'GET',
-          url: REPORTS_URL + 'devices/?date=' + date_parsed.iso8601
+          url: reports_url('devices/?date=' + date_parsed.iso8601)
         )
         logger.info("Retrieved device report for date #{date}")
         response
@@ -99,7 +99,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('optins/' + url)
         @data_attribute = 'optins'
       end
     end
@@ -109,7 +109,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('optouts/' + url)
         @data_attribute = 'optouts'
       end
     end
@@ -119,7 +119,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('sends/' + url)
         @data_attribute = 'sends'
       end
     end
@@ -129,7 +129,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('responses/' + url)
         @data_attribute = 'responses'
       end
     end
@@ -139,7 +139,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('opens/' + url)
         @data_attribute = 'opens'
       end
     end
@@ -149,7 +149,7 @@ module Urbanairship
                      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
+        @next_page = reports_url('timeinapp/' + url)
         @data_attribute = 'timeinapp'
       end
     end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.6.0'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Airship
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -138,6 +138,9 @@ files:
 - bin/console
 - bin/setup
 - docs/Makefile
+- docs/ab_tests.rst
+- docs/attributes.rst
+- docs/automations.rst
 - docs/channel_uninstall.rst
 - docs/conf.py
 - docs/create_and_send.rst
@@ -157,9 +160,17 @@ files:
 - docs/tags.rst
 - example/pusher.rb
 - lib/urbanairship.rb
+- lib/urbanairship/ab_tests/ab_test.rb
+- lib/urbanairship/ab_tests/experiment.rb
+- lib/urbanairship/ab_tests/variant.rb
+- lib/urbanairship/automations/automation.rb
+- lib/urbanairship/automations/pipeline.rb
 - lib/urbanairship/client.rb
 - lib/urbanairship/common.rb
 - lib/urbanairship/configuration.rb
+- lib/urbanairship/custom_events/custom_event.rb
+- lib/urbanairship/custom_events/payload.rb
+- lib/urbanairship/devices/attribute.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/create_and_send.rb
@@ -188,7 +199,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -204,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby Gem for using the Airship API
 test_files: []