urbanairship 5.9.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dbcc6fe1884df9f5beb53e6bc29406d2d4cb51aabfab22cc45f67b714104064
-  data.tar.gz: d147e04cbeadbb51e13325ff9cd5b7af458aa22531b8aab2e4ef0c19544ae15c
+  metadata.gz: 169148502585341b7938add240f3595e2124e56228916a1ad73b72f4e457885e
+  data.tar.gz: da1a1067c809c43bed0b0df1ebfc55d28443c2adcb1d5c0c8f3311dbd070b378
 SHA512:
-  metadata.gz: 7109db5053551032e3c6f933d07e39496b1f8d530349dba64a0b0b1d0b09ed5d2cbec46f89bd3adfe340cbfc0601d0ca089bcf17d302ad498959790915819096
-  data.tar.gz: 2e6366c2f3cbb0b35bbb68e78a1752fd32ddfeefe7316ddbcaa609b5971947d8e01c898672eee1eec617ecef222bc36928a972fefcb2b18bad0406993813536b
+  metadata.gz: 6f04b2d733ed47e8bf8779cf3844d67962b0b7815c9450b5112cb706b81e8c8f566660034f21a8762a6ddc9ac6c547e43fdbc11d083e881096bac53315d9f8d2
+  data.tar.gz: fdd59798309c0dca97e596c35684ccab4f1cf04d9ffe7fb72eb6964a5466c126c6d47c236f9b50f784b4b1ba1e5a455b00950353aa9c77ffb62aa48ace89a2ee

data/CHANGELOG

@@ -1,3 +1,9 @@
+--------------------
+6.0.0
+--------------------
+- Creates custom base url, and refactors urls within classes
+- Adds support for sending custom events
+
 --------------------
 5.9.0
 --------------------

data/README.rst

@@ -58,6 +58,7 @@ In your app initialization, you can do something like the following:
 
     >>> require 'urbanairship'
     >>> Urbanairship.configure do |config|
+    >>>   config.server = 'go.airship.eu'
     >>>   config.log_path = '/path/to/your/logfile'
     >>>   config.log_level = Logger::WARN
     >>>   config.timeout = 60

data/lib/urbanairship.rb

@@ -1,3 +1,4 @@
+require 'urbanairship/custom_events/payload'
 require 'urbanairship/push/audience'
 require 'urbanairship/push/payload'
 require 'urbanairship/push/schedule'
@@ -31,10 +32,13 @@ require 'urbanairship/ab_tests/experiment'
 require 'urbanairship/ab_tests/ab_test'
 
 module Urbanairship
+  extend Urbanairship::CustomEvents::Payload
+  extend Urbanairship::CustomEvents
   extend Urbanairship::Push::Audience
   extend Urbanairship::Push::Payload
   extend Urbanairship::Push::Schedule
   extend Urbanairship::Push
+  include Urbanairship::CustomEvents
   include Urbanairship::Devices
   include Urbanairship::Reports
   include Urbanairship::Push

data/lib/urbanairship/ab_tests/ab_test.rb

@@ -11,7 +11,7 @@ module Urbanairship
                       :offset,
                       :experiment_object,
                       :experiment_id
-                      
+
             def initialize(client: required('client'))
                 @client = client
             end
@@ -19,7 +19,7 @@ module Urbanairship
             def list_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + format_url_with_params
+                    url: experiments_url(format_url_with_params)
                 )
                 logger.info("Looking up A/B Tests for project")
                 response
@@ -29,7 +29,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: EXPERIMENTS_URL,
+                    url: experiments_url,
                     content_type: 'application/json'
                 )
                 logger.info("Created A/B Test")
@@ -39,7 +39,7 @@ module Urbanairship
             def list_scheduled_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + 'scheduled' + format_url_with_params
+                    url: experiments_url('scheduled' + format_url_with_params)
                 )
                 logger.info("Looking up scheduled A/B Tests for project")
                 response
@@ -49,7 +49,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to delete individual A/B test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: EXPERIMENTS_URL + 'scheduled/' + experiment_id
+                    url: experiments_url('scheduled/' + experiment_id)
                 )
                 logger.info("Deleting A/B test with ID #{experiment_id}")
                 response
@@ -59,7 +59,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: EXPERIMENTS_URL + 'validate',
+                    url: experiments_url('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating A/B Test")
@@ -70,7 +70,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to lookup individual A/B Test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + experiment_id
+                    url: experiments_url(experiment_id)
                 )
                 logger.info("Looking up A/B test with ID #{experiment_id}")
                 response
@@ -85,5 +85,4 @@ module Urbanairship
             end
         end
     end
-end 
-    
+end

data/lib/urbanairship/automations/automation.rb

@@ -22,7 +22,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL,
+                    url: pipelines_url,
                     content_type: 'application/json'
                 )
                 logger.info("Created Automation")
@@ -32,7 +32,7 @@ module Urbanairship
             def list_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + format_url_with_params
+                    url: pipelines_url(format_url_with_params)
                 )
                 logger.info("Looking up automations for project")
                 response
@@ -41,7 +41,7 @@ module Urbanairship
             def list_deleted_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + 'deleted' + format_url_with_params
+                    url: pipelines_url('deleted' + format_url_with_params)
                 )
                 logger.info("Looking up deleted automations for project")
                 response
@@ -51,18 +51,18 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL + 'validate',
+                    url: pipelines_url('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
                 response
             end
 
-            def lookup_automation 
+            def lookup_automation
                 fail ArgumentError, 'pipeline_id must be set to lookup individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + pipeline_id
+                    url: pipelines_url(pipeline_id)
                 )
                 logger.info("Looking up automation with id #{pipeline_id}")
                 response
@@ -70,22 +70,22 @@ module Urbanairship
 
             def update_automation
                 fail ArgumentError, 'pipeline_id must be set to update individual automation' if @pipeline_id.nil?
-                
+
                 response = @client.send_request(
                     method: 'PUT',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL + pipeline_id,
+                    url: pipelines_url(pipeline_id),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
                 response
             end
 
-            def delete_automation 
+            def delete_automation
                 fail ArgumentError, 'pipeline_id must be set to delete individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: PIPELINES_URL + pipeline_id
+                    url: pipelines_url(pipeline_id)
                 )
                 logger.info("Deleting automation with id #{pipeline_id}")
                 response
@@ -102,4 +102,4 @@ module Urbanairship
             end
         end
     end
-end
+end

data/lib/urbanairship/common.rb

@@ -4,23 +4,69 @@ require 'urbanairship/loggable'
 module Urbanairship
   # Features mixed in to all classes
   module Common
-    SERVER = 'go.urbanairship.com'
-    BASE_URL = 'https://go.urbanairship.com/api'
-    CHANNEL_URL = BASE_URL + '/channels/'
-    OPEN_CHANNEL_URL = BASE_URL + '/channels/open/'
-    DEVICE_TOKEN_URL = BASE_URL + '/device_tokens/'
-    APID_URL = BASE_URL + '/apids/'
-    PUSH_URL = BASE_URL + '/push/'
-    SCHEDULES_URL = BASE_URL + '/schedules/'
-    SEGMENTS_URL = BASE_URL + '/segments/'
-    NAMED_USER_URL = BASE_URL + '/named_users/'
-    REPORTS_URL = BASE_URL + '/reports/'
-    LISTS_URL = BASE_URL + '/lists/'
-    PIPELINES_URL = BASE_URL + '/pipelines/'
-    FEEDS_URL = BASE_URL + '/feeds/'
-    LOCATION_URL = BASE_URL + '/location/'
-    CREATE_AND_SEND_URL = BASE_URL + '/create-and-send/'
-    EXPERIMENTS_URL = BASE_URL + '/experiments/'
+    def url_for(path)
+      "https://#{Urbanairship.configuration.server}/api#{path}"
+    end
+
+    def apid_url(path='')
+      url_for("/apids/#{path}")
+    end
+
+    def channel_url(path='')
+      url_for("/channels/#{path}")
+    end
+
+    def create_and_send_url(path='')
+      url_for("/create-and-send/#{path}")
+    end
+
+    def custom_events_url(path='')
+      url_for("/custom-events/#{path}")
+    end
+
+    def device_token_url(path='')
+      url_for("/device_tokens/#{path}")
+    end
+
+    def experiments_url(path='')
+      url_for("/experiments/#{path}")
+    end
+
+    def lists_url(path='')
+      url_for("/lists/#{path}")
+    end
+
+    def location_url(path='')
+      url_for("/location/#{path}")
+    end
+
+    def named_users_url(path='')
+      url_for("/named_users/#{path}")
+    end
+
+    def open_channel_url(path='')
+      channel_url("/open/#{path}")
+    end
+
+    def pipelines_url(path='')
+      url_for("/pipelines/#{path}")
+    end
+
+    def push_url(path='')
+      url_for("/push/#{path}")
+    end
+
+    def reports_url(path='')
+      url_for("/reports/#{path}")
+    end
+
+    def schedules_url(path='')
+      url_for("/schedules/#{path}")
+    end
+
+    def segments_url(path='')
+      url_for("/segments/#{path}")
+    end
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example

data/lib/urbanairship/configuration.rb

@@ -1,8 +1,9 @@
 module Urbanairship
   class Configuration
-    attr_accessor :custom_logger, :log_path, :log_level, :timeout
+    attr_accessor :custom_logger, :log_path, :log_level, :server, :timeout
 
     def initialize
+      @server = 'go.urbanairship.com'
       @custom_logger = nil
       @log_path = nil
       @log_level = Logger::INFO

data/lib/urbanairship/custom_events/custom_event.rb

@@ -0,0 +1,60 @@
+require 'uri'
+require 'urbanairship'
+require 'urbanairship/common'
+require 'urbanairship/loggable'
+
+module Urbanairship
+  module CustomEvents
+    class CustomEvent
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :events
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def create
+        fail ArgumentError, 'events must be an array of custom events' unless events.is_a?(Array)
+
+        response = @client.send_request(
+          auth_type: :bearer,
+          body: JSON.dump(events),
+          content_type: 'application/json',
+          method: 'POST',
+          url: custom_events_url
+        )
+        cer = CustomEventResponse.new(body: response['body'], code: response['code'])
+        logger.info { cer.format }
+
+        cer
+      end
+    end
+
+    # Response to a successful custom event creation.
+    class CustomEventResponse
+      attr_reader :ok, :operation_id, :payload, :status_code
+
+      def initialize(body: nil, code: nil)
+        @payload = (body.nil? || body.empty?) ? {} : body
+        @ok = payload['ok']
+        @operation_id = payload['operationId']
+        @status_code = code
+      end
+
+      # String Formatting of the CustomEventResponse
+      #
+      # @return [Object] String Formatted CustomEventResponse
+      def format
+        "Received [#{status_code}] response code.\nBody:\n#{formatted_body}"
+      end
+
+      def formatted_body
+        payload
+          .map { |key, value| "#{key}:\t#{value.to_s || 'None'}" }
+          .join("\n")
+      end
+    end
+  end
+end

data/lib/urbanairship/custom_events/payload.rb

@@ -0,0 +1,89 @@
+require 'urbanairship'
+require 'urbanairship/common'
+
+module Urbanairship
+  module CustomEvents
+    module Payload
+      include Urbanairship::Common
+
+      def custom_events(
+            body: required('body'),
+            occurred: required('occurred'),
+            user: required('user')
+          )
+        compact_helper({
+          body: body,
+          occurred: format_timestamp(occurred),
+          user: user
+        })
+      end
+
+      # Body specific portion of CustomEvent Object
+      def custom_events_body(
+            interaction_id: nil, interaction_type: nil, name: required('name'),
+            properties: nil, session_id: nil, transaction: nil, value: nil
+          )
+
+        validates_name_format(name)
+        validates_value_format(value)
+
+        compact_helper({
+          interaction_id: interaction_id,
+          interaction_type: interaction_type,
+          name: name,
+          properties: properties,
+          session_id: session_id,
+          transaction: transaction,
+          value: value
+        })
+      end
+
+      # User specific portion of CustomEvent Object
+      def custom_events_user(
+            amazon_channel: nil, android_channel: nil, channel: nil,
+            ios_channel: nil, named_user_id: nil, web_channel: nil
+          )
+        res = compact_helper({
+            amazon_channel: amazon_channel,
+            android_channel: android_channel,
+            channel: channel,
+            ios_channel: ios_channel,
+            named_user_id: named_user_id,
+            web_channel: web_channel,
+          })
+
+        fail ArgumentError, 'at least one user identifier must be defined' if res.empty?
+
+        res
+      end
+
+
+      # Formatters
+      # ------------------------------------------------------------------------
+
+      def format_timestamp(timestamp)
+        return timestamp if timestamp.is_a?(String)
+
+        timestamp.strftime('%Y-%m-%dT%H:%M:%S')
+      end
+
+
+      # Validators
+      # ------------------------------------------------------------------------
+
+      NAME_REGEX = /^[a-z0-9_\-]+$/
+      def validates_name_format(name)
+        return if name =~ NAME_REGEX
+
+        fail ArgumentError, 'invalid "name": it must follows this pattern /^[a-z0-9_\-]+$/'
+      end
+
+      def validates_value_format(value)
+        return if value.nil?
+        return if value.is_a?(Numeric)
+
+        fail ArgumentError, 'invalid "value": must be a number'
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/channel_tags.rb

@@ -15,7 +15,7 @@ module Urbanairship
         @add_group = {}
         @remove_group = {}
         @set_group = {}
-        @url = CHANNEL_URL + 'tags/'
+        @url = channel_url('tags/')
       end
 
       def set_audience(ios: nil, android: nil, amazon: nil)

data/lib/urbanairship/devices/channel_uninstall.rb

@@ -23,7 +23,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(channels),
-          url: CHANNEL_URL + 'uninstall/',
+          url: channel_url('uninstall/'),
           content_type: 'application/json'
         )
 
@@ -31,32 +31,32 @@ module Urbanairship
         response
       end
     end
-    
-    
+
+
     class OpenChannelUninstall
       include Urbanairship::Common
       include Urbanairship::Loggable
       attr_reader :client
-      
+
       def initialize(client: required('client'))
         @client = client
       end
-      
+
       def uninstall(address: required('address'),
                     open_platform: required('open_platform'))
-        
+
         body = {
           address: address,
           open_platform_name: open_platform
         }
-        
+
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(body),
-          url: OPEN_CHANNEL_URL + 'uninstall/',
+          url: open_channel_url('uninstall/'),
           content_type: 'application/json'
         )
-        
+
         logger.info { "Successfully uninstalled open channel with address: #{address}"}
         response
       end

data/lib/urbanairship/devices/create_and_send.rb

@@ -44,7 +44,7 @@ module Urbanairship
           campaign_object = {'categories': campaigns}
           full_payload[:campaigns] = campaign_object
         end
-        
+
         full_payload
       end
 
@@ -52,7 +52,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CREATE_AND_SEND_URL,
+          url: create_and_send_url,
           content_type: 'application/json'
         )
         logger.info("Running create and send for addresses #{@addresses}")
@@ -63,7 +63,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CREATE_AND_SEND_URL + 'validate',
+          url: create_and_send_url('validate'),
           content_type: 'application/json'
         )
         logger.info("Validating payload for create and send")
@@ -84,7 +84,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(scheduled_payload),
-          url: SCHEDULES_URL + 'create-and-send',
+          url: schedules_url('create-and-send'),
           content_type: 'application/json'
         )
         logger.info("Scheduling create and send operation with name #{@name}")

data/lib/urbanairship/devices/devicelist.rb

@@ -17,7 +17,7 @@ module Urbanairship
       def lookup(uuid: required('uuid'))
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + uuid
+          url: channel_url(uuid)
         )
         logger.info("Retrieved channel information for #{uuid}")
         response['body']['channel']
@@ -36,7 +36,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'attributes',
+          url: channel_url('attributes'),
           content_type: 'application/json'
         )
         response
@@ -46,7 +46,7 @@ module Urbanairship
     class ChannelList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = CHANNEL_URL
+        @next_page = channel_url
         @data_attribute = 'channels'
       end
     end
@@ -64,7 +64,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: DEVICE_TOKEN_URL + token
+          url: device_token_url(token)
         )
         logger.info("Looking up info on device token #{token}")
         resp
@@ -77,7 +77,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = DEVICE_TOKEN_URL
+        @next_page = device_token_url
         @data_attribute = 'device_tokens'
       end
     end
@@ -95,7 +95,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: APID_URL + apid
+          url: apid_url(apid)
         )
         logger.info("Retrieved info on apid #{apid}")
         resp
@@ -105,9 +105,9 @@ module Urbanairship
     class APIDList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = APID_URL
+        @next_page = apid_url
         @data_attribute = 'apids'
       end
     end
   end
-end
+end

data/lib/urbanairship/devices/email.rb

@@ -41,7 +41,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'email',
+          url: channel_url('email'),
           content_type: 'application/json'
         )
         logger.info("Registering email channel with address #{address}")
@@ -58,7 +58,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'email/uninstall',
+          url: channel_url('email/uninstall'),
           content_type: 'application/json'
         )
         logger.info("Uninstalling email channel with address #{address}")
@@ -70,7 +70,7 @@ module Urbanairship
 
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + 'email/' + address
+          url: channel_url('email/' + address)
         )
         logger.info("Looking up email channel with address #{address}")
         response
@@ -95,7 +95,7 @@ module Urbanairship
 
         response = @client.send_request(
           method: 'PUT',
-          url: CHANNEL_URL + 'email/' + channel_id,
+          url: channel_url('email/' + channel_id),
           body: JSON.dump(payload),
           content_type: 'application/json'
         )
@@ -109,7 +109,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @url = CHANNEL_URL + 'email/tags'
+        @url = channel_url('email/tags')
       end
 
       def set_audience(email_address: required('email_address'))

data/lib/urbanairship/devices/named_user.rb

@@ -25,7 +25,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/associate',
+          url: named_users_url('/associate'),
           content_type: 'application/json'
         )
         logger.info { "Associated channel_id #{channel_id} with named_user #{@named_user_id}" }
@@ -40,7 +40,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/disassociate',
+          url: named_users_url('/disassociate'),
           content_type: 'application/json'
         )
         logger.info { "Dissociated channel_id #{channel_id}" }
@@ -52,7 +52,7 @@ module Urbanairship
            'named_user_id is required for lookup' if @named_user_id.nil?
         response = @client.send_request(
             method: 'GET',
-            url: NAMED_USER_URL + '?id=' + @named_user_id,
+            url: named_users_url('?id=' + @named_user_id),
         )
         logger.info { "Retrieved information on named_user_id #{@named_user_id}" }
         response
@@ -65,7 +65,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @url = NAMED_USER_URL + 'tags/'
+        @url = named_users_url('tags/')
       end
 
       def set_audience(user_ids: required('user_ids'))
@@ -79,7 +79,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = NAMED_USER_URL
+        @next_page = named_users_url
         @data_attribute = 'named_users'
       end
     end
@@ -101,7 +101,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/uninstall',
+          url: named_users_url('/uninstall'),
           content_type: 'application/json'
         )
         logger.info { "Uninstalled named_user_ids #{@named_user_ids} " }

data/lib/urbanairship/devices/open_channel.rb

@@ -5,11 +5,11 @@ module Urbanairship
     class OpenChannel
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :channel_id, 
-                    :open_platform, 
-                    :opt_in, 
+      attr_accessor :channel_id,
+                    :open_platform,
+                    :opt_in,
                     :address,
-                    :tags, 
+                    :tags,
                     :identifiers,
                     :template_id,
                     :alert,
@@ -21,16 +21,16 @@ module Urbanairship
                     :fields,
                     :interactive,
                     :platform_alert
-      
+
       def initialize(client: required('client'))
         @client = client
       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
-        
+
         channel_data = {
           'type': 'open',
           'open': {:open_platform_name => open_platform},
@@ -38,21 +38,21 @@ module Urbanairship
           'address': address,
           'tags': tags
         }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
-        
+
         set_identifiers
-        
+
         body = {'channel': channel_data}
-        
+
         response = @client.send_request(
           method: 'POST',
-          url: OPEN_CHANNEL_URL,
+          url: open_channel_url,
           body: JSON.dump(body),
           content_type: 'application/json'
         )
         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
@@ -60,7 +60,7 @@ module Urbanairship
         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},
@@ -70,34 +70,34 @@ module Urbanairship
           'address': address,
           'tags': tags
         }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
-        
+
         set_identifiers
-        
+
         body = {'channel': channel_data}
-          
+
         response = @client.send_request(
           method: 'POST',
-          url: OPEN_CHANNEL_URL,
+          url: open_channel_url,
           body: JSON.dump(body),
           content_type: 'application/json'
         )
         logger.info("Updating open channel with address #{address}")
         response
       end
-      
+
       def lookup(channel_id: required('channel_id'))
         fail ArgumentError, 'channel_id needs to be a string' unless channel_id.is_a? String
-        
+
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + channel_id
+          url: channel_url(channel_id)
         )
         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? 
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil?
 
         if alert
           payload = {
@@ -124,7 +124,7 @@ module Urbanairship
       end
 
       def open_channel_override
-        fail TypeError, 'open_platform cannot be nil' if open_platform.nil? 
+        fail TypeError, 'open_platform cannot be nil' if open_platform.nil?
         payload = {
             'alert': platform_alert,
             'extra': extra,
@@ -147,4 +147,3 @@ module Urbanairship
     end
   end
 end
-      

data/lib/urbanairship/devices/segment.rb

@@ -28,7 +28,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: SEGMENTS_URL,
+          url: segments_url,
           content_type: 'application/json'
         )
         logger.info { "Successful segment creation: #{@display_name}" }
@@ -45,7 +45,7 @@ module Urbanairship
           'id must be set to a valid string' if id.nil?
         response = @client.send_request(
           method: 'GET',
-          url: SEGMENTS_URL + id
+          url: segments_url(id)
         )
         logger.info("Retrieved segment information for #{id}")
         @id = id
@@ -69,7 +69,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(data),
-          url: SEGMENTS_URL + @id,
+          url: segments_url(@id),
           content_type: 'application/json'
         )
         logger.info { "Successful segment update: #{@display_name}" }
@@ -83,7 +83,7 @@ module Urbanairship
         fail ArgumentError,
           'id cannot be nil' if id.nil?
 
-        url = SEGMENTS_URL + id
+        url = segments_url(id)
         response = @client.send_request(
           method: 'DELETE',
           url: url
@@ -98,7 +98,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = SEGMENTS_URL
+        @next_page = segments_url
         @data_attribute = 'segments'
       end
     end

data/lib/urbanairship/devices/sms.rb

@@ -5,9 +5,9 @@ module Urbanairship
     class Sms
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :msisdn, 
-                    :sender, 
-                    :opted_in, 
+      attr_accessor :msisdn,
+                    :sender,
+                    :opted_in,
                     :sender,
                     :locale_country,
                     :locale_language,
@@ -31,7 +31,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms',
+          url: channel_url('sms'),
           content_type: 'application/json'
         )
         logger.info("Registering SMS channel with msisdn #{@msisdn}")
@@ -55,7 +55,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms/' + channel_id,
+          url: channel_url('sms/' + channel_id),
           content_type: 'application/json'
         )
         logger.info("Updating SMS channel with msisdn #{@channel_id}")
@@ -74,7 +74,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms/opt-out',
+          url: channel_url('sms/opt-out'),
           content_type: 'application/json'
         )
         logger.info("Opting Out of SMS messages for #{@msisdn}")
@@ -93,7 +93,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'sms/uninstall',
+          url: channel_url('sms/uninstall'),
           content_type: 'application/json'
         )
         logger.info("Uninstalling SMS channel for #{@msisdn}")
@@ -106,7 +106,7 @@ module Urbanairship
 
         response = @client.send_request(
             method: 'GET',
-            url: CHANNEL_URL + 'sms/' + @msisdn + '/' + @sender
+            url: channel_url('sms/' + @msisdn + '/' + @sender)
         )
         logger.info { "Retrieved information for msisdn #{@msisdn}" }
         response

data/lib/urbanairship/devices/static_lists.rb

@@ -22,7 +22,7 @@ module Urbanairship
         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
@@ -61,7 +61,7 @@ module Urbanairship
         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

@@ -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,
+          url: push_url,
           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,
+          url: schedules_url,
           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
+          url: schedules_url(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 = schedules_url
         @data_attribute = 'schedules'
       end
     end

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.9.0'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.9.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Airship
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -168,6 +168,8 @@ 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/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb