urbanairship 5.3.0 → 5.6.1

data/docs/examples.rst

@@ -37,12 +37,12 @@ Complex audience with platform specifics
     )
     push.notification = UA.notification(
         ios: UA.ios(
-            alert: "Kim Jong-Un wins U.S. Open",
+            alert: "Serena Williams wins U.S. Open",
             badge: "+1",
             extra: {"articleid" => "123456"}
         ),
         android: UA.android(
-            alert: "Breaking Android News! Glorious Leader Kim Jong-Un wins U.S. Open!",
+            alert: "Breaking Android News! Serena Williams wins U.S. Open!",
             extra: {"articleid" => "http://m.example.com/123456"}
         ),
         amazon: UA.amazon(
@@ -64,7 +64,7 @@ Single iOS push
     push = airship.create_push
     push.audience = UA.ios_channel('channel-id')
     push.notification = UA.notification(
-       ios: UA.ios(alert="Kim Jong-Un is following you on Twitter")
+       ios: UA.ios(alert="Your package is on its way!")
     )
     push.device_types = UA.device_types(['ios'])
     push.send_push
@@ -78,10 +78,10 @@ Single iOS Rich Push with notification
     push = airship.create_push
     push.audience = UA.ios_channel('channel-id')
     push.notification = UA.notification(
-       ios: UA.ios(alert="Kim Jong-Un is following you on Twitter")
+       ios: UA.ios(alert="Your package is on its way!")
     )
     push.device_types = UA.device_types(['ios'])
-    push.message = UA.message(title: "New follower", body: "<h1>OMG It's Kim Jong-Un</h1>")
+    push.message = UA.message(title: "Your package is on the way!", body: "<h1>Please complete our survey</h1>")
     push.send_push
 
 
@@ -94,8 +94,8 @@ Rich Push with extra and without notification
     push.audience = UA.all
     push.device_types = UA.all
     push.message = UA.message(
-      title: "New follower",
-      body: "<h1>OMG It's Kim Jong-Un</h1>",
+      title: "Your package is on its way!",
+      body: "<h1>Would you please complete our customer survey?</h1>",
       extra: {"articleid" => "http://m.example.com/123456"}
     )
     push.send_push
@@ -112,7 +112,7 @@ Scheduled iOS Push
     sched.push = airship.create_push
     sched.push.audience = UA.ios_channel('channel-id')
     sched.push.notification = UA.notification(
-       ios: UA.ios(alert: "Kim Jong-Un is following you on Twitter"))
+       ios: UA.ios(alert: "Your package is on its way!"))
     sched.push.device_types = UA.device_types(['ios'])
 
     sched.send_push

data/docs/index.rst

@@ -69,6 +69,10 @@ Contents:
    location.rst
    exceptions.rst
    examples.rst
+   create_and_send.rst
+   email.rst
+   open_channels.rst
+   sms.rst
 
 
 Indices and tables

data/lib/urbanairship.rb

@@ -6,6 +6,10 @@ require 'urbanairship/devices/segment'
 require 'urbanairship/devices/channel_uninstall'
 require 'urbanairship/devices/sms'
 require 'urbanairship/devices/email'
+require 'urbanairship/devices/email_notification'
+require 'urbanairship/devices/sms_notification'
+require 'urbanairship/devices/mms_notification'
+require 'urbanairship/devices/create_and_send'
 require 'urbanairship/client'
 require 'urbanairship/common'
 require 'urbanairship/configuration'

data/lib/urbanairship/common.rb

@@ -4,8 +4,8 @@ require 'urbanairship/loggable'
 module Urbanairship
   # Features mixed in to all classes
   module Common
-    SERVER = 'go.airship.com'
-    BASE_URL = 'https://go.airship.com/api'
+    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/'
@@ -19,6 +19,7 @@ module Urbanairship
     PIPELINES_URL = BASE_URL + '/pipelines/'
     FEEDS_URL = BASE_URL + '/feeds/'
     LOCATION_URL = BASE_URL + '/location/'
+    CREATE_AND_SEND_URL = BASE_URL + '/create-and-send/'
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example

data/lib/urbanairship/devices/create_and_send.rb

@@ -0,0 +1,96 @@
+require 'urbanairship'
+require 'urbanairship/devices/email_notification'
+
+module Urbanairship
+  module Devices
+    class CreateAndSend
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :addresses,
+                    :device_types,
+                    :notification,
+                    :campaigns,
+                    :name,
+                    :scheduled_time
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def validate_address
+        @addresses.each do |address|
+          unless address.include?(:ua_address) or address.include?(:ua_msisdn && :ua_opted_in && :ua_sender)
+            fail ArgumentError, 'Missing a component in address portion of the object'
+          end
+        end
+      end
+
+      def payload
+        fail ArgumentError, 'addresses must be set for defining payload' if @addresses.nil?
+        fail ArgumentError, 'device type array must be set for defining payload' if @device_types.nil?
+        fail ArgumentError, 'notification object must be set for defining payload' if @notification.nil?
+
+        validate_address
+
+        full_payload = {
+          'audience': {
+            'create_and_send': addresses
+          },
+          'device_types': device_types,
+          'notification': notification,
+        }
+
+        if campaigns
+          campaign_object = {'categories': campaigns}
+          full_payload[:campaigns] = campaign_object
+        end
+        
+        full_payload
+      end
+
+      def create_and_send
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: CREATE_AND_SEND_URL,
+          content_type: 'application/json'
+        )
+        logger.info("Running create and send for addresses #{@addresses}")
+        response
+      end
+
+      def validate
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: CREATE_AND_SEND_URL + 'validate',
+          content_type: 'application/json'
+        )
+        logger.info("Validating payload for create and send")
+        response
+      end
+
+      def schedule
+        fail ArgumentError, 'scheduled time must be set to run an operation' if @scheduled_time.nil?
+
+        scheduled_payload = {
+          "schedule": {
+            "scheduled_time": scheduled_time
+          },
+          "name": name,
+          "push": payload
+        }
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(scheduled_payload),
+          url: SCHEDULES_URL + 'create-and-send',
+          content_type: 'application/json'
+        )
+        logger.info("Scheduling create and send operation with name #{@name}")
+        response
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class EmailNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :bcc,
+                    :bypass_opt_in_level,
+                    :html_body,
+                    :message_type,
+                    :plaintext_body,
+                    :reply_to,
+                    :sender_address,
+                    :sender_name,
+                    :subject,
+                    :template_id,
+                    :variable_details,
+                    :click_tracking,
+                    :open_tracking
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def email_override
+        fail ArgumentError, 'message_type is needed for email override' if @message_type.nil?
+        fail ArgumentError, 'plaintext_body is needed for email override' if @plaintext_body.nil?
+        fail ArgumentError, 'reply_to is needed for email override' if @reply_to.nil?
+        fail ArgumentError, 'sender_address is needed for email override' if @sender_address.nil?
+        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 = {
+          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
+
+        {'email': override}
+      end
+
+      def email_with_inline_template
+        fail ArgumentError, 'message_type is needed for email with inline template' if @message_type.nil?
+        fail ArgumentError, 'reply_to is needed for email with inline template' if @reply_to.nil?
+        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 = {
+          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      
+
+        {'email': inline_template}
+      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
+
+      def define_fields
+        if subject && plaintext_body
+          {
+            subject: subject,
+            plaintext_body: plaintext_body
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/urbanairship/devices/mms_notification.rb

@@ -0,0 +1,107 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class MmsNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :fallback_text,
+                    :shorten_links,
+                    :content_length,
+                    :content_type,
+                    :url,
+                    :text,
+                    :subject,
+                    :template_id,
+                    :slide_1_text
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def validate_url
+        unless ['.jpg', '.gif', '.png', 'jpeg'].include?(@url[-4..-1])
+          fail ArgumentError, 'url must end in .gif, .jpg, .png, or .jpeg'
+        end
+      end
+
+      def mms_override
+        fail ArgumentError, 'fallback_text is needed for MMS override' if fallback_text.nil?
+        fail ArgumentError, 'content_length is needed for MMS override' if content_length.nil?
+        fail ArgumentError, 'content_type is needed for MMS override' if content_type.nil?
+        fail ArgumentError, 'url is needed for MMS override' if url.nil?
+
+        validate_url
+
+        override = {"mms": {
+                "subject": subject,
+                "fallback_text": fallback_text,
+                "shorten_links": shorten_links,
+                "slides": [
+                      {
+                         "text": text,
+                         "media": {
+                            "url": url,
+                            "content_type": content_type,
+                            "content_length": content_length
+                         }
+                      }
+                    ]
+                 }
+              }
+        override
+      end
+
+      def mms_template_with_id
+        fail ArgumentError, 'content_length is needed for MMS Inline Template with ID' if content_length.nil?
+        fail ArgumentError, 'content_type is needed for MMS Inline Template with ID' if content_type.nil?
+        fail ArgumentError, 'url is needed for MMS Inline Template with ID' if url.nil?
+        fail ArgumentError, 'template_id is needed for MMS Inline Template with ID' if template_id.nil?
+
+        {"mms": {
+            "template": {
+              "template_id": template_id
+            },
+            "shorten_links": true,
+            "slides": [
+                {
+                    "media": {
+                        "url": url,
+                        "content_type": content_type,
+                        "content_length": content_length
+                    }
+                }
+            ]
+          }
+        }
+      end
+
+      def mms_inline_template
+        fail ArgumentError, 'slide_1_text text is needed for MMS with inline template' if text.nil?
+
+          {"mms": {
+            "template": {
+              "fields": {
+                "subject": subject,
+                "fallback_text": fallback_text,
+                "slide_1_text": text
+              }
+            },
+            "slides": [
+              {
+                "media": {
+                    "url": url,
+                    "content_type": content_type,
+                    "content_length": content_length
+                }
+              }
+            ]
+          }
+        }
+      end
+
+    end
+  end
+end