urbanairship 5.6.1 → 7.0.0

data/lib/urbanairship/client.rb

@@ -13,22 +13,30 @@ module Urbanairship
       #
       # @param [Object] key Application Key
       # @param [Object] secret Application Secret
+      # @param [String] server Airship server to use ("go.airship.eu" or "go.urbanairship.com").
+      #                        Used only when the request is sent with a "path", not an "url".
+      # @param [String] token Application Auth Token (for custom events endpoint)
       # @return [Object] Client
-      def initialize(key: required('key'), secret: required('secret'))
+      def initialize(key: required('key'), secret: required('secret'),
+                     server: Urbanairship.configuration.server, token: nil)
         @key = key
         @secret = secret
+        @server = server
+        @token = token
       end
 
       # Send a request to Airship's API
       #
       # @param [Object] method HTTP Method
       # @param [Object] body Request Body
+      # @param [Object] path Request path
       # @param [Object] url Request URL
       # @param [Object] content_type Content-Type
-      # @param [Object] version API Version
+      # @param [Object] encoding Encoding
+      # @param [Symbol] auth_type (:basic|:bearer)
       # @return [Object] Push Response
-      def send_request(method: required('method'), url: required('url'), body: nil,
-                       content_type: nil, encoding: nil)
+      def send_request(method: required('method'), path: nil, url: nil, body: nil,
+                       content_type: nil, encoding: nil, auth_type: :basic)
         req_type = case method
           when 'GET'
             :get
@@ -42,13 +50,22 @@ module Urbanairship
             fail 'Method was not "GET" "POST" "PUT" or "DELETE"'
         end
 
+        raise ArgumentError.new("path and url can't be both nil") if path.nil? && url.nil?
+
         headers = {'User-agent' => 'UARubyLib/' + Urbanairship::VERSION}
         headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
         headers['Content-type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
 
-        debug = "Making #{method} request to #{url}.\n"+
-            "\tHeaders:\n"
+        if auth_type == :bearer
+          raise ArgumentError.new('token must be provided as argument if auth_type=bearer') if @token.nil?
+          headers['X-UA-Appkey'] = @key
+          headers['Authorization'] = "Bearer #{@token}"
+        end
+
+        url = "https://#{@server}/api#{path}" unless path.nil?
+
+        debug = "Making #{method} request to #{url}.\n"+ "\tHeaders:\n"
         debug += "\t\tcontent-type: #{content_type}\n" unless content_type.nil?
         debug += "\t\tcontent-encoding: gzip\n" unless encoding.nil?
         debug += "\t\taccept: application/vnd.urbanairship+json; version=3\n"
@@ -56,15 +73,20 @@ module Urbanairship
 
         logger.debug(debug)
 
-        response = RestClient::Request.execute(
+        params = {
           method: method,
           url: url,
           headers: headers,
-          user: @key,
-          password: @secret,
           payload: body,
           timeout: Urbanairship.configuration.timeout
-        )
+        }
+
+        if auth_type == :basic
+          params[:user] = @key
+          params[:password] = @secret
+        end
+
+        response = RestClient::Request.execute(params)
 
         logger.debug("Received #{response.code} response. Headers:\n\t#{response.headers}\nBody:\n\t#{response.body}")
         Response.check_code(response.code, response)

data/lib/urbanairship/common.rb

@@ -4,22 +4,65 @@ 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/'
+    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
@@ -114,36 +157,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
@@ -153,6 +178,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/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