urbanairship 5.5.1 → 5.9.0

data/lib/urbanairship/automations/pipeline.rb

@@ -0,0 +1,52 @@
+require 'urbanairship'
+
+module Urbanairship
+  module Automations
+    class Pipeline
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :activation_time,
+                    :cancellation_trigger,
+                    :condition,
+                    :constraint,
+                    :creation_time,
+                    :deactivation_time,
+                    :historical_trigger,
+                    :immediate_trigger,
+                    :last_modified_time,
+                    :name,
+                    :status,
+                    :timing,
+                    :url,
+                    :enabled,
+                    :outcome
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def payload
+         fail ArgumentError, 'enabled must be set to create pipeline payload' if @enabled.nil?
+         fail ArgumentError, 'outcome must be set to create pipeline payload' if @outcome.nil?
+        {
+          activation_time: activation_time,
+          cancellation_trigger: cancellation_trigger,
+          condition: condition,
+          constraint: constraint,
+          creation_time: creation_time,
+          deactivation_time: deactivation_time,
+          enabled: enabled,
+          historical_trigger: historical_trigger,
+          immediate_trigger: immediate_trigger,
+          last_modified_time: last_modified_time,
+          name: name,
+          outcome: outcome,
+          status: status,
+          timing: timing,
+          url: url
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+      end
+      
+    end
+  end
+end

data/lib/urbanairship/client.rb

@@ -13,10 +13,12 @@ module Urbanairship
       #
       # @param [Object] key Application Key
       # @param [Object] secret Application Secret
+      # @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'), token: nil)
         @key = key
         @secret = secret
+        @token = token
       end
 
       # Send a request to Airship's API
@@ -25,10 +27,11 @@ module Urbanairship
       # @param [Object] body Request Body
       # @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)
+                       content_type: nil, encoding: nil, auth_type: :basic)
         req_type = case method
           when 'GET'
             :get
@@ -46,9 +49,14 @@ module Urbanairship
         headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
         headers['Content-type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
+        
+        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
 
-        debug = "Making #{method} request to #{url}.\n"+
-            "\tHeaders:\n"
+        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 +64,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

@@ -20,6 +20,7 @@ module Urbanairship
     FEEDS_URL = BASE_URL + '/feeds/'
     LOCATION_URL = BASE_URL + '/location/'
     CREATE_AND_SEND_URL = BASE_URL + '/create-and-send/'
+    EXPERIMENTS_URL = BASE_URL + '/experiments/'
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example

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

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

@@ -15,12 +15,6 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @addresses = nil
-        @device_types = nil
-        @notification = nil
-        @campaigns = nil
-        @name = nil
-        @scheduled_time = nil
       end
 
       def validate_address
@@ -40,17 +34,17 @@ module Urbanairship
 
         full_payload = {
           'audience': {
-            'create_and_send': @addresses
+            'create_and_send': addresses
           },
-          'device_types': @device_types,
-          'notification': @notification,
+          'device_types': device_types,
+          'notification': notification,
         }
 
-        if @campaigns
-          campaign_object = {'categories': @campaigns}
+        if campaigns
+          campaign_object = {'categories': campaigns}
           full_payload[:campaigns] = campaign_object
         end
-
+        
         full_payload
       end
 
@@ -81,9 +75,9 @@ module Urbanairship
 
         scheduled_payload = {
           "schedule": {
-            "scheduled_time": @scheduled_time
+            "scheduled_time": scheduled_time
           },
-          "name": @name,
+          "name": name,
           "push": payload
         }
 

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
@@ -20,6 +22,25 @@ module Urbanairship
         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),
+          url: CHANNEL_URL + 'attributes',
+          content_type: 'application/json'
+        )
+        response
+      end
     end
 
     class ChannelList < Urbanairship::Common::PageIterator

data/lib/urbanairship/devices/email.rb

@@ -19,16 +19,6 @@ module Urbanairship
 
       def initialize(client: required('client'))
         @client = client
-        @address = nil
-        @commercial_opted_in = nil
-        @commercial_opted_out = nil
-        @locale_country = nil
-        @locale_language = nil
-        @timezone = nil
-        @transactional_opted_in = nil
-        @transactional_opted_out = nil
-        @type = nil
-        @channel_id = nil
       end
 
       def register
@@ -36,15 +26,15 @@ module Urbanairship
 
         payload = {
           'channel': {
-            'address': @address,
-            'commercial_opted_in': @commercial_opted_in,
-            'commercial_opted_out': @commercial_opted_out,
-            'locale_country': @locale_country,
-            'locale_language': @locale_language,
-            'timezone': @timezone,
-            'transactional_opted_in': @transactional_opted_in,
-            'transactional_opted_out': @transactional_opted_out,
-            'type': @type
+            'address': address,
+            'commercial_opted_in': commercial_opted_in,
+            'commercial_opted_out': commercial_opted_out,
+            'locale_country': locale_country,
+            'locale_language': locale_language,
+            'timezone': timezone,
+            'transactional_opted_in': transactional_opted_in,
+            'transactional_opted_out': transactional_opted_out,
+            'type': type
           }
         }
 
@@ -54,7 +44,7 @@ module Urbanairship
           url: CHANNEL_URL + 'email',
           content_type: 'application/json'
         )
-        logger.info("Registering email channel with address #{@address}")
+        logger.info("Registering email channel with address #{address}")
         response
       end
 
@@ -62,7 +52,7 @@ module Urbanairship
         fail ArgumentError, 'address must be set to register email channel' if @address.nil?
 
         payload = {
-          'email_address': @address
+          'email_address': address
         }
 
         response = @client.send_request(
@@ -71,7 +61,7 @@ module Urbanairship
           url: CHANNEL_URL + 'email/uninstall',
           content_type: 'application/json'
         )
-        logger.info("Uninstalling email channel with address #{@address}")
+        logger.info("Uninstalling email channel with address #{address}")
         response
       end
 
@@ -80,32 +70,32 @@ 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}")
+        logger.info("Looking up email channel with address #{address}")
         response
       end
 
       def update
-        fail ArgumentError, 'address must be set to update email channel' if @channel_id.nil?
-
-        channel_data =  {}
-
-        channel_data['address'] = @address if @address
-        channel_data['commercial_opted_in'] = @commercial_opted_in if @commercial_opted_in
-        channel_data['commercial_opted_out'] = @commercial_opted_out if @commercial_opted_out
-        channel_data['locale_country'] = @locale_country if @locale_country
-        channel_data['locale_language'] = @locale_language if @locale_language
-        channel_data['timezone'] = @timezone if @timezone
-        channel_data['transactional_opted_in'] = @transactional_opted_in if @transactional_opted_in
-        channel_data['transactional_opted_out'] = @transactional_opted_out if @transactional_opted_out
-        channel_data['type'] = @type if @type
-
-        payload = {channel: channel_data}
+        fail ArgumentError, 'address must be set to update email channel' if channel_id.nil?
+
+        channel_data =  {
+          'address': address,
+          'commercial_opted_in': commercial_opted_in,
+          'commercial_opted_out': commercial_opted_out,
+          'localte_country': locale_country,
+          'locale_language': locale_language,
+          'timezone': timezone,
+          'transactional_opted_in': transactional_opted_in,
+          'transactional_opted_out': transactional_opted_out,
+          'type': type
+      }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        payload = {'channel': channel_data}
 
         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'
         )

data/lib/urbanairship/devices/email_notification.rb

@@ -16,21 +16,12 @@ module Urbanairship
                     :sender_name,
                     :subject,
                     :template_id,
-                    :variable_details
+                    :variable_details,
+                    :click_tracking,
+                    :open_tracking
 
       def initialize(client: required('client'))
         @client = client
-        @bcc = nil
-        @bypass_opt_in_level = nil
-        @html_body = nil
-        @message_type = nil
-        @plaintext_body = nil
-        @reply_to = nil
-        @sender_address = nil
-        @sender_name = nil
-        @subject = nil
-        @template_id = nil
-        @variable_details = nil
       end
 
       def email_override
@@ -41,22 +32,21 @@ module Urbanairship
         fail ArgumentError, 'sender_name is needed for email override' if @sender_name.nil?
         fail ArgumentError, 'subject is needed for email override' if @subject.nil?
 
-        override = {'email': {
-          'bypass_opt_in_level': @bypass_opt_in_level,
-          'html_body': @html_body,
-          'message_type': @message_type,
-          'plaintext_body': @plaintext_body,
-          'reply_to': @reply_to,
-          'sender_address': @sender_address,
-          'sender_name': @sender_name,
-          'subject': @subject
-        }}
+        override = {
+          bcc: bcc,
+          bypass_opt_in_level: bypass_opt_in_level,
+          click_tracking: click_tracking,
+          html_body: html_body,
+          message_type: message_type,
+          open_tracking: open_tracking, 
+          plaintext_body: plaintext_body,
+          reply_to: reply_to,
+          sender_address: sender_address,
+          sender_name: sender_name,
+          subject: subject
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
 
-        if @bcc
-          override[:email][:bcc] = @bcc
-        end
-
-        override
+        {'email': override}
       end
 
       def email_with_inline_template
@@ -65,33 +55,36 @@ module Urbanairship
         fail ArgumentError, 'sender_address is needed for email with inline template' if @sender_address.nil?
         fail ArgumentError, 'sender_name is needed for email with inline template' if @sender_name.nil?
 
-        inline_template = {'email': {
-          'message_type': @message_type,
-          'reply_to': @reply_to,
-          'sender_address': @sender_address,
-          'sender_name': @sender_name,
-          'template': {}
-          }
-        }
-
-        if @subject and @plaintext_body
-          fields_object = {'plaintext_body': @plaintext_body, 'subject': @subject}
-          inline_template[:email][:template][:fields] = fields_object
-        end
+        inline_template = {
+          bcc: bcc,
+          click_tracking: click_tracking,
+          message_type: message_type,
+          open_tracking: open_tracking,
+          reply_to: reply_to,
+          sender_address: sender_address,
+          sender_name: sender_name,
+          template: define_template_object
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs      
 
-        if @bcc
-          inline_template[:email][:bcc] = @bcc
-        end
+        {'email': inline_template}
+      end
 
-        if @variable_details
-          inline_template[:email][:template][:variable_details] = @variable_details
-        end
+      def define_template_object
+        fail ArgumentError, 'Must choose between template_id or fields object' if template_id && plaintext_body && subject
+        template_portion = {
+          template_id: template_id,
+          fields: define_fields,
+          variable_details: variable_details
+        }.delete_if {|key, value| value.nil?}
+      end
 
-        if @template_id
-          inline_template[:email][:template][:template_id] = @template_id
+      def define_fields
+        if subject && plaintext_body
+          {
+            subject: subject,
+            plaintext_body: plaintext_body
+          }
         end
-
-        inline_template
       end
 
     end