urbanairship 5.9.0 → 8.0.1

data/lib/urbanairship/common.rb

@@ -4,23 +4,67 @@ 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/'
+    CONTENT_TYPE = 'application/json'
+
+    def apid_path(path='')
+      "/apids/#{path}"
+    end
+
+    def channel_path(path='')
+      "/channels/#{path}"
+    end
+
+    def create_and_send_path(path='')
+      "/create-and-send/#{path}"
+    end
+
+    def custom_events_path(path='')
+      "/custom-events/#{path}"
+    end
+
+    def device_token_path(path='')
+      "/device_tokens/#{path}"
+    end
+
+    def experiments_path(path='')
+      "/experiments/#{path}"
+    end
+
+    def lists_path(path='')
+      "/lists/#{path}"
+    end
+
+    def location_path(path='')
+      "/location/#{path}"
+    end
+
+    def named_users_path(path='')
+      "/named_users/#{path}"
+    end
+
+    def open_channel_path(path='')
+      "/open/#{path}"
+    end
+
+    def pipelines_path(path='')
+      "/pipelines/#{path}"
+    end
+
+    def push_path(path='')
+      "/push/#{path}"
+    end
+
+    def reports_path(path='')
+      "/reports/#{path}"
+    end
+
+    def schedules_path(path='')
+      "/schedules/#{path}"
+    end
+
+    def segments_path(path='')
+      "/segments/#{path}"
+    end
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example
@@ -115,36 +159,18 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @next_page = nil
-        @data_list = nil
-        @data_attribute = nil
         @count = 0
-      end
-
-      def load_page
-        return false unless @next_page
-        response = @client.send_request(
-            method: 'GET',
-            url: @next_page
-        )
-        logger.info("Retrieving data from: #{@next_page}")
-        check_next_page = response['body']['next_page']
-        if check_next_page != @next_page
-          @next_page = check_next_page
-        elsif check_next_page
-          # if check_page = next_page, we have repeats in the response.
-          # and we don't want to load them
-          return false
-        else
-          @next_page = nil
-        end
-        @data_list = response['body'][@data_attribute]
-        true
+        @data_attribute = nil
+        @data_list = nil
+        @next_page_path = nil
+        @next_page_url = nil
       end
 
       def each
-        while load_page
-          @data_list.each do | value |
+        while @next_page_path || @next_page_url
+          load_page
+
+          @data_list.each do |value|
             @count += 1
             yield value
           end
@@ -154,6 +180,47 @@ module Urbanairship
       def count
         @count
       end
+
+      private
+
+      def load_page
+        logger.info("Retrieving data from: #{@next_page_url || @next_page_path}")
+        params = {
+            method: 'GET',
+            path: @next_page_path,
+            url: @next_page_url
+          }.select { |k, v| !v.nil? }
+        response = @client.send_request(params)
+
+        @data_list = get_new_data(response)
+        @next_page_url = get_next_page_url(response)
+        @next_page_path = nil
+      end
+
+      def extract_next_page_url(response)
+        response['body']['next_page']
+      end
+
+      def get_new_data(response)
+        potential_next_page_url = extract_next_page_url(response)
+
+        # if potential_next_page_url is the same as the current page, we have
+        # repeats in the response and we don't want to load them
+        return [] if potential_next_page_url && get_next_page_url(response).nil?
+
+        response['body'][@data_attribute]
+      end
+
+      def get_next_page_url(response)
+        potential_next_page_url = extract_next_page_url(response)
+        return nil if potential_next_page_url.nil?
+
+        # if potential_next_page_url is the same as the current page, we have
+        # repeats in the response and we don't want to check the next pages
+        return potential_next_page_url if @next_page_url && potential_next_page_url != @next_page_url
+        return potential_next_page_url if @next_page_path && !potential_next_page_url.end_with?(@next_page_path)
+        nil
+      end
     end
   end
 end

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',
+          path: custom_events_path
+        )
+        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/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,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/',
+          path: open_channel_path('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,
+          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

@@ -17,7 +17,7 @@ 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']
@@ -36,7 +36,7 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          url: CHANNEL_URL + 'attributes',
+          path: channel_path('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_path = channel_path
         @data_attribute = 'channels'
       end
     end
@@ -64,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
@@ -77,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
@@ -95,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
@@ -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_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'))