urbanairship 5.7.0 → 8.0.0

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

@@ -0,0 +1,54 @@
+require 'urbanairship'
+
+module Urbanairship
+    module  Devices
+        class Attribute
+            include Urbanairship::Common
+            include Urbanairship::Loggable
+            attr_accessor :attribute,
+                          :operator,
+                          :precision,
+                          :value
+
+            def initialize(client: required('client'))
+                @client = client
+            end
+
+            def payload
+                if precision
+                    date_attribute
+                elsif value.is_a? String
+                    text_attribute
+                elsif value.is_a? Integer 
+                    number_attribute
+                end
+            end
+
+            def number_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'value': value
+                }
+            end
+
+            def text_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'value': value
+                }
+            end
+
+            def date_attribute
+                {
+                    'attribute': attribute,
+                    'operator': operator,
+                    'precision': precision,
+                    'value': value
+                }
+            end
+
+        end
+    end
+end 

data/lib/urbanairship/devices/attributes.rb

@@ -0,0 +1,53 @@
+
+module Urbanairship
+  module  Devices
+    class Attributes
+
+      SET = 'set'
+      REMOVE = 'remove'
+
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def payload
+        @payload ||= { attributes: attributes_list }
+      end
+
+      private
+
+      def attributes_list
+        @attributes.map{ |attribute| attribute_payload(attribute) }
+      end
+
+      def attribute_payload(attribute)
+        if REMOVE == attribute[:action]
+          remove_payload(attribute)
+        else
+          set_payload(attribute)
+        end
+      end
+
+      def set_payload(attribute)
+        {
+          action: SET,
+          key: attribute[:key],
+          value: attribute[:value],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def remove_payload(attribute)
+        {
+          action: REMOVE,
+          key: attribute[:key],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def timestamp
+        @timestamp ||= Time.now.utc
+      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/'
+        @path = channel_path('tags/')
       end
 
       def set_audience(ios: nil, android: nil, amazon: nil)
@@ -62,7 +62,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: @url,
+          path: @path,
           content_type: 'application/json'
         )
         logger.info("Set tags for audience: #{@audience}")

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/',
+          path: channel_path('uninstall/'),
           content_type: 'application/json'
         )
 
@@ -31,33 +31,33 @@ 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/',
+          path: open_channel_path('uninstall/'),
           content_type: 'application/json'
         )
-        
-        logger.info { "Successfully unintalled open channel with address: #{address}"}
+
+        logger.info { "Successfully uninstalled open channel with address: #{address}"}
         response
       end
     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,
+          path: create_and_send_path,
           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',
+          path: create_and_send_path('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',
+          path: schedules_path('create-and-send'),
           content_type: 'application/json'
         )
         logger.info("Scheduling create and send operation with name #{@name}")

data/lib/urbanairship/devices/devicelist.rb

@@ -7,6 +7,8 @@ module Urbanairship
       include Urbanairship::Common
       include Urbanairship::Loggable
       attr_writer :client
+      attr_accessor :audience,
+                    :attributes
 
       def initialize(client: required('client'))
         @client = client
@@ -15,17 +17,36 @@ module Urbanairship
       def lookup(uuid: required('uuid'))
         response = @client.send_request(
           method: 'GET',
-          url: CHANNEL_URL + uuid
+          path: channel_path(uuid)
         )
         logger.info("Retrieved channel information for #{uuid}")
         response['body']['channel']
       end
+
+      def payload
+        {
+          'audience': audience,
+          'attributes': [
+            attributes
+          ]
+        }
+      end
+
+      def set_attributes
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          path: channel_path('attributes'),
+          content_type: 'application/json'
+        )
+        response
+      end
     end
 
     class ChannelList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = CHANNEL_URL
+        @next_page_path = channel_path
         @data_attribute = 'channels'
       end
     end
@@ -43,7 +64,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: DEVICE_TOKEN_URL + token
+          path: device_token_path(token)
         )
         logger.info("Looking up info on device token #{token}")
         resp
@@ -56,7 +77,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = DEVICE_TOKEN_URL
+        @next_page_path = device_token_path
         @data_attribute = 'device_tokens'
       end
     end
@@ -74,7 +95,7 @@ module Urbanairship
 
         resp = @client.send_request(
           method: 'GET',
-          url: APID_URL + apid
+          path: apid_path(apid)
         )
         logger.info("Retrieved info on apid #{apid}")
         resp
@@ -84,9 +105,9 @@ module Urbanairship
     class APIDList < Urbanairship::Common::PageIterator
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = APID_URL
+        @next_page_path = apid_path
         @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',
+          path: channel_path('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',
+          path: channel_path('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
+          path: channel_path('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,
+          path: channel_path('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'
+        @path = channel_path('email/tags')
       end
 
       def set_audience(email_address: required('email_address'))

data/lib/urbanairship/devices/named_user.rb

@@ -1,6 +1,5 @@
 require 'urbanairship'
 
-
 module Urbanairship
   module Devices
     class NamedUser
@@ -13,6 +12,17 @@ module Urbanairship
         @named_user_id =  nil
       end
 
+      def update_attributes(attributes: required('attributes'))
+        response = @client.send_request(
+          method: 'POST',
+          body: Urbanairship::Attributes.new(attributes).payload.to_json,
+          path: named_users_path("#{@named_user_id}/attributes"),
+          content_type: CONTENT_TYPE,
+        )
+        logger.info { "Updated attributes for named_user #{@named_user_id}" }
+        response
+      end
+
       def associate(channel_id: required('channel_id'), device_type: nil)
         fail ArgumentError,
              'named_user_id is required for association' if @named_user_id.nil?
@@ -20,13 +30,13 @@ module Urbanairship
         payload = {}
         payload['channel_id'] = channel_id
         payload['device_type'] = device_type unless device_type.nil?
-        payload['named_user_id'] = @named_user_id
+        payload['named_user_id'] = @named_user_id.to_s
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/associate',
-          content_type: 'application/json'
+          path: named_users_path('associate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Associated channel_id #{channel_id} with named_user #{@named_user_id}" }
         response
@@ -40,8 +50,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/disassociate',
-          content_type: 'application/json'
+          path: named_users_path('disassociate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Dissociated channel_id #{channel_id}" }
         response
@@ -51,8 +61,8 @@ module Urbanairship
         fail ArgumentError,
            '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,
+          method: 'GET',
+          path: named_users_path('?id=' + @named_user_id),
         )
         logger.info { "Retrieved information on named_user_id #{@named_user_id}" }
         response
@@ -65,7 +75,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @url = NAMED_USER_URL + 'tags/'
+        @path = named_users_path('tags/')
       end
 
       def set_audience(user_ids: required('user_ids'))
@@ -79,7 +89,7 @@ module Urbanairship
 
       def initialize(client: required('client'))
         super(client: client)
-        @next_page = NAMED_USER_URL
+        @next_page_path = named_users_path
         @data_attribute = 'named_users'
       end
     end
@@ -101,8 +111,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: NAMED_USER_URL + '/uninstall',
-          content_type: 'application/json'
+          path: named_users_path('uninstall'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Uninstalled named_user_ids #{@named_user_ids} " }
         response