urbanairship 5.5.0 → 5.8.0

data/lib/urbanairship/devices/open_channel.rb

@@ -5,37 +5,41 @@ 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
-        }
+          '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
         
-        if @tags
-          channel_data['tags'] = @tags
-        end
-        if @identifiers
-          channel_data[:open][:identifiers] = @identifiers
-        end
+        set_identifiers
         
         body = {'channel': channel_data}
         
@@ -45,37 +49,29 @@ module Urbanairship
           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
-        }
+          '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
         
-        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
+        set_identifiers
         
         body = {'channel': channel_data}
           
@@ -85,7 +81,7 @@ module Urbanairship
           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
       
@@ -99,6 +95,55 @@ module Urbanairship
         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,8 +22,8 @@ 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',
@@ -67,8 +64,8 @@ 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),
@@ -84,9 +81,9 @@ module Urbanairship
       # @ returns [Object] response HTTP response
       def delete
         fail ArgumentError,
-          'id cannot be nil' if @id.nil?
+          'id cannot be nil' if id.nil?
 
-        url = SEGMENTS_URL + @id
+        url = SEGMENTS_URL + id
         response = @client.send_request(
           method: 'DELETE',
           url: url

data/lib/urbanairship/devices/sms.rb

@@ -9,19 +9,16 @@ module Urbanairship
 
       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(
@@ -35,12 +32,12 @@ module Urbanairship
       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 register sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to register sms channel' if msisdn.nil?
 
         payload = {
-          'msisdn': @msisdn,
-          'sender': @sender,
+          'msisdn': msisdn,
+          'sender': sender,
         }
 
         response = @client.send_request(
@@ -54,12 +51,12 @@ 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 register sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to register sms channel' if msisdn.nil?
 
         payload = {
-          'msisdn': @msisdn,
-          'sender': @sender,
+          'msisdn': msisdn,
+          'sender': sender,
         }
 
         response = @client.send_request(
@@ -73,8 +70,8 @@ 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',

data/lib/urbanairship/devices/sms_notification.rb

@@ -15,20 +15,15 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @alert = nil
-        @generic_alert = nil
-        @expiry = nil
-        @shorten_links = nil
-        @template_id = nil
       end
 
       def sms_notification_override
         {
-           "alert": @generic_alert,
+           "alert": generic_alert,
            "sms": {
-              "alert": @sms_alert,
-              "expiry": @expiry,
-              "shorten_links": @shorten_links
+              "alert": sms_alert,
+              "expiry": expiry,
+              "shorten_links": shorten_links
            }
         }
       end

data/lib/urbanairship/devices/static_lists.rb

@@ -11,12 +11,11 @@ module Urbanairship
       def initialize(client: required('client'))
         fail ArgumentError, 'Client cannot be set to nil' if client.nil?
         @client = client
-        @name = nil
       end
 
       def create(description: nil, extras: nil)
-        fail ArgumentError, 'Name must be set' if @name.nil?
-        payload = {'name' => @name}
+        fail ArgumentError, 'Name must be set' if name.nil?
+        payload = {'name': name}
         payload['description'] = description unless description.nil?
         payload['extras'] = extras unless extras.nil?
 
@@ -31,7 +30,7 @@ module Urbanairship
       end
 
       def upload(csv_file: required('csv_file'), gzip: false)
-        fail ArgumentError, 'Name must be set' if @name.nil?
+        fail ArgumentError, 'Name must be set' if name.nil?
         if gzip
           response = @client.send_request(
               method: 'PUT',
@@ -53,7 +52,7 @@ module Urbanairship
       end
 
       def update(description: nil, extras: nil)
-        fail ArgumentError, 'Name must be set' if @name.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?
         payload = {}
@@ -70,7 +69,7 @@ module Urbanairship
       end
 
       def lookup
-        fail ArgumentError, 'Name must be set' if @name.nil?
+        fail ArgumentError, 'Name must be set' if name.nil?
         response = @client.send_request(
           method: 'GET',
           url: LISTS_URL + @name
@@ -80,7 +79,7 @@ module Urbanairship
       end
 
       def delete
-        fail ArgumentError, 'Name must be set' if @name.nil?
+        fail ArgumentError, 'Name must be set' if name.nil?
         response = @client.send_request(
           method: 'DELETE',
           url: LISTS_URL + @name

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
 

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

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.5.0'
+  VERSION = '5.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.8.0
 platform: ruby
 authors:
 - Airship
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-10-02 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,15 @@ 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/devices/attribute.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/create_and_send.rb
@@ -188,7 +197,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 +213,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: []