urbanairship 5.7.0 → 8.0.0

data/lib/urbanairship/push/push.rb

@@ -10,7 +10,7 @@ module Urbanairship
     class Push
       attr_writer :client
 
-      attr_accessor :device_types, 
+      attr_accessor :device_types,
                     :audience,
                     :notification,
                     :options,
@@ -52,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)
@@ -93,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)
@@ -170,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
@@ -181,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

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.7.0'
+  VERSION = '8.0.0'
 end

data/urbanairship.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.7.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Airship
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby Library for using the Airship web service API for push notifications
   and rich app pages.
 email:
@@ -139,6 +153,7 @@ files:
 - bin/setup
 - docs/Makefile
 - docs/ab_tests.rst
+- docs/attributes.rst
 - docs/automations.rst
 - docs/channel_uninstall.rst
 - docs/conf.py
@@ -167,6 +182,10 @@ files:
 - 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/attributes.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/create_and_send.rb
@@ -195,7 +214,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +229,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Airship API
 test_files: []