urbanairship 5.3.0 → 5.6.1

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

@@ -0,0 +1,54 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class SmsNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :sms_alert,
+                    :generic_alert,
+                    :expiry,
+                    :shorten_links,
+                    :template_id
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def sms_notification_override
+        {
+           "alert": generic_alert,
+           "sms": {
+              "alert": sms_alert,
+              "expiry": expiry,
+              "shorten_links": shorten_links
+           }
+        }
+      end
+
+      def sms_inline_template
+        inline_template = {
+          "sms": {
+            "template": {}
+          }
+        }
+
+        if @template_id
+          inline_template[:sms][:template][:template_id] = @template_id
+        end
+
+        if @sms_alert
+          inline_fields= {
+            "fields": {"alert": @sms_alert}
+          }
+          inline_template[:sms][:template] = inline_fields
+        end
+        
+        inline_template
+      end
+
+    end
+  end
+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/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.3.0'
+  VERSION = '5.6.1'
 end

data/urbanairship.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - docs/Makefile
 - docs/channel_uninstall.rst
 - docs/conf.py
+- docs/create_and_send.rst
 - docs/devices.rst
 - docs/email.rst
 - docs/examples.rst
@@ -161,12 +162,16 @@ files:
 - lib/urbanairship/configuration.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
+- lib/urbanairship/devices/create_and_send.rb
 - lib/urbanairship/devices/devicelist.rb
 - lib/urbanairship/devices/email.rb
+- lib/urbanairship/devices/email_notification.rb
+- lib/urbanairship/devices/mms_notification.rb
 - lib/urbanairship/devices/named_user.rb
 - lib/urbanairship/devices/open_channel.rb
 - lib/urbanairship/devices/segment.rb
 - lib/urbanairship/devices/sms.rb
+- lib/urbanairship/devices/sms_notification.rb
 - lib/urbanairship/devices/static_lists.rb
 - lib/urbanairship/loggable.rb
 - lib/urbanairship/push/audience.rb