urbanairship 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f260b6f4cd6af338f251cc34c473eeb49063c7eb0daa5ad3a569f0d90a3584d
-  data.tar.gz: 160fcdd2a23b6dea6008b09b03f22a65d601555590810b3d951394aa24d8f51e
+  metadata.gz: 473e83567cb51164c9ed471d2e5ecbd73902624f231fd6463a07d2626d6233a6
+  data.tar.gz: dd676b778158ed24687223009942bdff1ec105bfc485987767c27f10c6de0344
 SHA512:
-  metadata.gz: 4103a2061061355627af7cfee8879fd231a8eccda95a1f5ad1a4af3be9471d8177844e8de8b9a5ba832607249cbf67928df77951da03317d8e9a6c9df209ec0b
-  data.tar.gz: 4c0e50e54f17166a734c929f33b912b9afcdb593edadf7549bf2a55b548e10b21cbcca69d687fa58dfcae2fa31579a28f355485a6034055933cd6229fdf85e49
+  metadata.gz: e0ca4c22e57d83a0d89fa0e32ecb19db0f3ffa3b3ff5913b6f4df38df3dd73dc862b5d526cbb9654ff9fa92535dbad29b50cb516a8772ccdcbc50f416cca6068
+  data.tar.gz: 1ce0f4984b438dd40df90ccc29eeb0e4f10c99ef8a9e2f85a5af601f6ad241aa47586f78c4c2b089e989b0e01f5a595414faae82c1b6643271daf213a7b9a92a

data/.gitignore

@@ -9,6 +9,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/csv_file
 
 # App
 urbanairship.log

data/CHANGELOG

@@ -1,3 +1,11 @@
+--------------------
+5.5.0
+--------------------
+- Add Create and Send Functionality for Email
+- Add endpoints for Create and Send Validation and Scheduling
+- Add Create and Send Functionality for SMS
+- Update Rake version from 10.0 to 12.3.3
+
 --------------------
 5.4.0
 --------------------

data/docs/create_and_send.rst

@@ -0,0 +1,489 @@
+Create and Send
+===============
+
+The CreateAndSend class uses various notification classes as the portion of the notification
+part of the payload. Different channels that harness Create and Send will require slightly different
+implementation, and therefore, a different notification object.
+
+For more context see EmailNotification and SmsNotification to see how each class method
+operates, and how that is used to create the notification portion of the Create and Send payload.
+
+For background information visit out docs here: https://docs.airship.com/api/ua/#tag/create-and-send
+
+Create and Send Validation
+--------------------------
+
+Here, the payload that is being validated is one that would be used for email override.
+However, this validation method should work on any other create and send notification objects.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = email_notification.email_override
+    send_it.validate
+
+.. note::
+
+  Should return a 200 HTTP status code.
+
+Schedule Create and Send Operation
+----------------------------------
+
+Here, the payload that is being scheduled is one that would be used for email override.
+However, this operation method should schedule any other create and send notification objects.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = email_notification.email_override
+    send_it.name = 'Name for scheduled create and send'
+    send_it.scheduled_time =  "2019-13-29T10:34:22"
+    send_it.schedule
+
+.. note::
+
+  Should return a 201  HTTP status code.
+
+Create and Send to Email Channels
+=================================
+
+You will need to create an EmailNotification object before adding that to the notification
+field as the create and send object.
+
+Create and Send with Email Override
+-----------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to the object. The line of code here:
+`override = email_notification.email_override`
+is using a class method on EmailNotification specific for an email override in order
+to format the payload correctly for the notification portion of the CreateAndSend object.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = override
+    send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send with Email Inline Template/Template ID
+------------------------------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to the object. The line of code here:
+`inline_template = email_notification.email_with_inline_template`
+is using a class method on EmailNotification specific for an inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  email_notification = UA::EmailNotification.new(client: airship)
+  email_notification.message_type = 'transactional'
+  email_notification.reply_to = 'reply_to_this@email.com'
+  email_notification.sender_address = 'sends_from_this@email.com'
+  email_notification.sender_name = 'Sender Name'
+  email_notification.template_id = "<template_id>"
+  inline_template = email_notification.email_with_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "test@example.com",
+      "ua_commercial_opted_in": "2019-12-29T10:34:22"
+    }
+  ]
+  send_it.device_types = [ "email" ]
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.notification = inline_template
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send with Email Inline Template/Fields
+-------------------------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to that object. The line of code here:
+`inline_template = email_notification.email_with_inline_template`
+is using a class method on EmailNotification specific for an inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.message_type = 'transactional'
+    email_notification.reply_to = 'reply_to_this@email.com'
+    email_notification.sender_address = 'sends_from_this@email.com'
+    email_notification.sender_name = 'Sender Name''
+    email_notification.subject= "I'm sending some stuff"
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    inline_template = email_notification.email_with_inline_template
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "example@test.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = inline_template
+    send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS Channels
+================================
+
+Create and Send to SMS Override
+-------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`override = notification.sms_notification_override`
+is using a class method on SmsNotification specific for a sms override. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.sms_alert = "A shorter alert with a link for SMS users to click https://www.mysite.com/amazingly/long/url-that-takes-up-lots-of-characters"
+  notification.generic_alert = "A generic alert sent to all platforms without overrides in device_types"
+  notification.expiry = 172800
+  notification.shorten_links = true
+  override = notification.sms_notification_override
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_msisdn": "15558675309",
+      "ua_sender": "12345",
+      "ua_opted_in": "2018-11-11T18:45:30"
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = override
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS With Inline Template
+-------------------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`template = notification.sms_inline_template`
+is using a class method on SmsNotification specific for a sms inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.sms_alert = "Hi, {{customer.first_name}}, your {{#each cart}}{{this.name}}{{/each}} are ready to pickup at our {{customer.location}} location!"
+  notification.expiry = 172800
+  notification.shorten_links = true
+  template = notification.sms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+      "customer": {
+          "first_name": "Customer Name",
+          "last_name": "Last Name",
+          "location": "Location",
+      },
+      "cart": [
+        {
+          "name": "Robot Unicorn",
+          "qty": 1
+        },
+        {
+          "name": "Holy Hand Grenade of Antioch",
+          "qty": 1
+        }
+      ]
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = template
+  send_it.campaigns = [ "order-pickup" ]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS With Template ID
+---------------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`template = notification.sms_inline_template`
+is using a class method on SmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.template_id = <sms_template_id_for_app>
+  notification.expiry = 172800
+  notification.shorten_links = true
+  template = notification.sms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+      "customer": {
+          "first_name": "Customer Name",
+          "last_name": "Last Name",
+          "location": "Your Location",
+      },
+      "cart": [
+        {
+          "name": "Robot Unicorn",
+          "qty": 1
+        },
+        {
+          "name": "Holy Hand Grenade of Antioch",
+          "qty": 1
+        }
+      ]
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = template
+  send_it.campaigns = [ "order-pickup" ]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS Channels
+================================
+
+Create and Send to MMS Override
+-------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_override`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  override = UA::MmsNotification.new(client: airship)
+  override.fallback_text = "See https://urbanairship.com for double rainbows!"
+  override.shorten_links = true
+  override.content_length = 238686
+  override.content_type = "image/jpeg"
+  override.url = "https://www.metoffice.gov.uk/binaries/content/gallery/mohippo/images/learning/learn-about-the-weather/rainbows/full_featured_double_rainbow_at_savonlinna_1000px.jpg"
+  override.text = "A double rainbow is a wonderful sight where you get two spectacular natural displays for the price of one."
+  override.subject = "Double Rainbows"
+  mms_notification = override.mms_override
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS Template with ID
+---------------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_template_with_id`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  override = UA::MmsNotification.new(client: airship)
+  override.template_id = "<existing_template_id>"
+  override.shorten_links = true
+  override.content_length = 19309
+  override.content_type = "image/jpeg"
+  override.url = "https://images-na.ssl-images-amazon.com/images/I/71eUHxwlMKL._AC_SX425_.jpg"
+  mms_notification = override.mms_template_with_id
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "123456789",
+    "ua_sender": "12345",
+    "ua_opted_in": "2020-01-30T18:45:30",
+    "customer": {
+              "first_name": "Phil",
+              "last_name": "Leash",
+          }
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.create_and_send
+
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS with Inline Template
+---------------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_inline_template`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  override = UA::MmsNotification.new(client: airship)
+  override.subject = "Subject"
+  override.fallback_text = "Fallback text"
+  override.text = "Some slide text"
+  override.content_length = 123100
+  override.content_type = "image/jpeg"
+  override.url = 'image ending in allowed image types'
+  mms_notification = override.mms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "123456789",
+    "ua_sender": "12345",
+    "ua_opted_in": "2020-01-30T18:45:30"
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.

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

@@ -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,102 @@
+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
+        @addresses = nil
+        @device_types = nil
+        @notification = nil
+        @campaigns = nil
+        @name = nil
+        @scheduled_time = nil
+      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_notification.rb

@@ -0,0 +1,99 @@
+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
+
+      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
+        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 = {'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
+        }}
+
+        if @bcc
+          override[:email][:bcc] = @bcc
+        end
+
+        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 = {'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
+
+        if @bcc
+          inline_template[:email][:bcc] = @bcc
+        end
+
+        if @variable_details
+          inline_template[:email][:template][:variable_details] = @variable_details
+        end
+
+        if @template_id
+          inline_template[:email][:template][:template_id] = @template_id
+        end
+
+        inline_template
+      end
+
+    end
+  end
+end

data/lib/urbanairship/devices/mms_notification.rb

@@ -0,0 +1,115 @@
+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
+        @fallback_text = nil
+        @shorten_links = nil
+        @content_length = nil
+        @content_type = nil
+        @url = nil
+        @text = nil
+        @subject = nil
+        @template_id = nil
+      end
+
+      def validate_url
+        unless @url[-4..-1] == '.jpg' || '.gif' || '.png' || 'jpeg'
+          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

data/lib/urbanairship/devices/sms_notification.rb

@@ -0,0 +1,59 @@
+require 'urbanairship'
+require 'json'
+
+module Urbanairship
+  module Devices
+    class SmsNotification
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      attr_accessor :sms_alert,
+                    :generic_alert,
+                    :expiry,
+                    :shorten_links,
+                    :template_id
+
+      def initialize(client: required('client'))
+        @client = client
+        @alert = nil
+        @generic_alert = nil
+        @expiry = nil
+        @shorten_links = nil
+        @template_id = nil
+      end
+
+      def sms_notification_override
+        {
+           "alert": @generic_alert,
+           "sms": {
+              "alert": @sms_alert,
+              "expiry": @expiry,
+              "shorten_links": @shorten_links
+           }
+        }
+      end
+
+      def sms_inline_template
+        inline_template = {
+          "sms": {
+            "template": {}
+          }
+        }
+
+        if @template_id
+          inline_template[:sms][:template][:template_id] = @template_id
+        end
+
+        if @sms_alert
+          inline_fields= {
+            "fields": {"alert": @sms_alert}
+          }
+          inline_template[:sms][:template] = inline_fields
+        end
+        
+        inline_template
+      end
+
+    end
+  end
+end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.4.0'
+  VERSION = '5.5.0'
 end

data/urbanairship.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - docs/Makefile
 - docs/channel_uninstall.rst
 - docs/conf.py
+- docs/create_and_send.rst
 - docs/devices.rst
 - docs/email.rst
 - docs/examples.rst
@@ -161,12 +162,16 @@ files:
 - lib/urbanairship/configuration.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
+- lib/urbanairship/devices/create_and_send.rb
 - lib/urbanairship/devices/devicelist.rb
 - lib/urbanairship/devices/email.rb
+- lib/urbanairship/devices/email_notification.rb
+- lib/urbanairship/devices/mms_notification.rb
 - lib/urbanairship/devices/named_user.rb
 - lib/urbanairship/devices/open_channel.rb
 - lib/urbanairship/devices/segment.rb
 - lib/urbanairship/devices/sms.rb
+- lib/urbanairship/devices/sms_notification.rb
 - lib/urbanairship/devices/static_lists.rb
 - lib/urbanairship/loggable.rb
 - lib/urbanairship/push/audience.rb