voltron-notify 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dc5675852a76e757329016521d703d1d9c11c7a
+  data.tar.gz: 1aaa6e0a848e1cf5d8c1daa8a24312adf0980ca9
+SHA512:
+  metadata.gz: 9e5bee262edb8cc3d12ff3c084767b526b77a936a6a43bcfb90248c9194be5436d4b92beeedfca215e7533897c63e4ce56b75b0c9fc8bb6d05e3c70567c3a0f7
+  data.tar.gz: f5d7d06d1231ec5918f07519f634824a700c0725e8b0a64c7a04f181da617f294ef1dbf30259bf0346e9d4acb5b6fe241eeaaac067a6ee23d1d57a1d78a093ed

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/
+log/
+voltron-*.gem
+*.bak
+*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at eric.hainer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gem.minow.io'
+
+# Specify your gem's dependencies in voltron-notify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Hainer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+[![Build Status](https://travis-ci.org/ehainer/voltron-notify.svg?branch=master)](https://travis-ci.org/ehainer/voltron-notify)
+
+# Voltron::Notify
+
+Voltron Notify is an attempt to join Twilio's SMS api with Rails' default mailer functionality into one single method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voltron-notify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voltron-notify
+
+Then run the following to create the voltron.rb initializer (if not exists already) and add the notify config:
+
+    $ rails g voltron:notify:install
+
+## Usage
+
+Once installed and configured, add `notifyable` at the top of any model you wish to be able to send notifications, such as:
+
+```ruby
+class User < ActiveRecord::Base
+
+  notifyable
+
+end
+```
+
+`notifyable` will create a notifications association on whatever model it is called on. Once done, you can utilize Voltron Notify like so:
+
+```ruby
+@user = User.find(1)
+
+@user.notifications.create do |n|
+  # First argument is SMS message text, second argument is hash containing zero or more of: [:to, :from]
+  n.sms "This is my message", to: "1 (234) 567-8910"
+
+  # and/or ...
+
+  # First argument is email subject, remaining arguments can consist of [:to, :from] or any other param you'd like,
+  # they will all be converted to @variables for use in the mailer template
+  n.email "This is the mail subject", { to: "info@example.com" }, { param_one: "Hi there", param_two: "" }
+end
+```
+
+While you may specify the :to and :from as one of the arguments, by default the :from value of each notification type comes from `Voltron.config.notify.email_from` and `Voltron.config.notify.sms_from`. The value of :to by default will attempt to be retrieved by calling `.phone` or `.email` on the notifyable model itself. So given a User model with attributes (or methods) `email` and `phone`, the following will send notifications to those values:
+
+```ruby
+@user = User.find(1) #<User id: 1, phone: "1234567890", email: "info@example.com", created_at: "2016-09-23 16:49:20", updated_at: "2016-09-23 16:49:20">
+
+@user.notifications.create do |n|
+  n.sms "Hello from SMS" # Will send to +1 (123) 456-7890
+  n.email "Hello from Email" # Will send to info@example.com
+end
+
+# @user.notifications.build { |n| ... } ... followed by @user.save works the same way
+```
+
+Optionally, you may pass a block to the `sms` or `email` methods that allows for additional functionality, like including attachments or overriding the `email` method default mailer/method:
+
+```ruby
+@user.notifications.create do |n|
+  n.sms "Hello from SMS" do
+    attach "picture.jpg" # Attach an image using the rails asset pipeline by specifying just the filename
+    attach "http://www.someimagesite.com/example/demo/image.png" # Or just provide a url to a supported file beginning with "http"
+  end
+
+  n.email "Hello from Email" do
+    attach "picture.jpg" # Uses the asset pipeline like above
+    attach "http://www.example.com/picture.jpg" # This WILL NOT work, email attachments don't work that way
+
+    mailer SiteMailer # Default: Voltron::NotificationMailer
+    method :send_my_special_notification # Default: :notify
+    arguments @any, list, of.arguments, :you, would, @like # In this case, the arguments used by SiteMailer.send_my_special_notification()
+  end
+end
+```
+
+Note that both SMS and Email notifications have validations on the :to/:from fields, the email subject, and the SMS body text. Since `notifications` is an association, any errors in the actual notification content will bubble up, possibly preventing the `notifyable` model from saving. For that reason, it may be more logical to instead use a @notifyable.notifications.build / @notifyable.save syntax to properly handle errors that may occur.
+
+## Integration with ActiveJob
+
+Voltron Notify supports sending both email (via deliver_later) and SMS (via Voltron::SmsJob and perform_later). To have all notifications be handled by ActiveJob in conjunction with Sidekiq/Resque/whatever you need only set the config value `Voltron.config.notify.use_queue` to `true`. If ActiveJob is configured properly notifications will send that way instead. You may also optionally set the delay for each notification by setting the value of `Voltron.config.notify.delay` to any time value (i.e. 5.minutes, 3.months, 0.seconds)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ehainer/voltron-notify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/jobs/voltron/sms_job.rb

@@ -0,0 +1,7 @@
+class Voltron::SmsJob < ActiveJob::Base
+
+  def perform(sms)
+    sms.deliver_now
+  end
+
+end

data/app/mailers/voltron/notification_mailer.rb

@@ -0,0 +1,13 @@
+class Voltron::NotificationMailer < ApplicationMailer
+  default from: Voltron.config.notify.email_from
+
+  def notify(mail_args, var_args = {}, attachment_args = {})
+    # Make all passed in variables instance variables so they can be used in the template
+    var_args.each { |name, value| instance_variable_set "@#{name}", value }
+
+    # Add all of the attachments
+    attachment_args.each { |name, file| attachments[name] = File.read(file) }
+
+    mail mail_args
+  end
+end

data/app/models/voltron/notification/email_notification.rb

@@ -0,0 +1,102 @@
+class Voltron::Notification::EmailNotification < ActiveRecord::Base
+
+  belongs_to :notification
+
+  after_initialize :setup
+
+  before_create :deliver_now, unless: :use_queue?
+
+  after_create :deliver_later, if: :use_queue?
+
+  attr_accessor :vars, :attachments
+
+  def setup
+    @request = []
+    @response = []
+    @vars ||= {}
+    @attachments ||= {}
+    @mailer_arguments = nil
+    self.mailer_class ||= "Voltron::NotificationMailer"
+    self.mailer_method ||= "notify"
+  end
+
+  def request
+    # Wrap entire request in container hash so that we can call deep_symbolize_keys on it (in case it's an array)
+    # Wrap entire request in array and flatten so we can be sure the result is an array
+    [{ request: (JSON.parse(request_json) rescue Hash.new) }.deep_symbolize_keys[:request]].flatten
+  end
+
+  def response
+    # Wrap entire response in container hash so that we can call deep_symbolize_keys on it (in case it's an array)
+    # Wrap entire response in array and flatten so we can be sure the result is an array
+    [{ response: (JSON.parse(response_json) rescue Hash.new) }.deep_symbolize_keys[:response]].flatten
+  end
+
+  def after_deliver
+    self.request_json = @request.to_json
+    self.response_json = @response.to_json
+  end
+
+  def deliver_now
+    mail.deliver_now
+    @response << ActionMailer::Base.deliveries.last
+    after_deliver
+  end
+
+  def deliver_later
+    @response << mail.deliver_later(wait: Voltron.config.notify.delay)
+    after_deliver
+  end
+
+  def attach(file, name = nil)
+    name = File.basename(file) if name.blank?
+    path = file
+
+    if file.is_a?(File)
+      path = file.path
+      file.close
+    elsif !File.exists?(path)
+      path = Voltron.asset.find(path)
+    end
+
+    attachments[name] = path
+  end
+
+  def mailer(klass = nil)
+    self.mailer_class = (klass || mailer_class).to_s.classify.constantize
+  end
+
+  def method(meth = nil)
+    self.mailer_method = meth || mailer_method
+  end
+
+  def arguments(*args)
+    @mailer_arguments = *args
+  end
+
+  # TODO: Move this to actual validates_* methods
+  def error_messages
+    output = []
+    output << "recipient cannot be blank" if to.blank?
+    output << "subject cannot be blank" if subject.blank?
+    output
+  end
+
+  private
+
+    def use_queue?
+      Voltron.config.notify.use_queue
+    end
+
+    def mail
+      # If no mailer arguments, use default order of arguments as defined in Voltron::NotificationMailer.notify
+      if @mailer_arguments.blank?
+        @request << { to: to, from: from, subject: subject }.compact.merge(vars: vars, attachments: attachments)
+        mailer.send method, { to: to, from: from, subject: subject }.compact, vars, attachments
+      else
+        @request << @mailer_arguments.compact
+        mailer.send method, *@mailer_arguments.compact
+      end
+    end
+
+end

data/app/models/voltron/notification/sms_notification/attachment.rb

@@ -0,0 +1,5 @@
+class Voltron::Notification::SmsNotification::Attachment < ActiveRecord::Base
+
+  belongs_to :sms_notification
+
+end

data/app/models/voltron/notification/sms_notification.rb

@@ -0,0 +1,132 @@
+require "twilio-ruby"
+
+class Voltron::Notification::SmsNotification < ActiveRecord::Base
+
+  has_many :attachments
+
+  belongs_to :notification
+
+  after_initialize :setup
+
+  before_create :deliver_now, unless: :use_queue?
+
+  after_create :deliver_later, if: :use_queue?
+
+  include Rails.application.routes.url_helpers
+
+  def setup
+    @request = []
+    @response = []
+  end
+
+  def request
+    # Wrap entire request in container hash so that we can call deep_symbolize_keys on it (in case it's an array)
+    # Wrap entire request in array and flatten so we can be sure the result is an array
+    [{ request: (JSON.parse(request_json) rescue nil) }.deep_symbolize_keys[:request]].flatten.compact
+  end
+
+  def response
+    # Wrap entire response in container hash so that we can call deep_symbolize_keys on it (in case it's an array)
+    # Wrap entire response in array and flatten so we can be sure the result is an array
+    [{ response: (JSON.parse(response_json) rescue nil) }.deep_symbolize_keys[:response]].flatten.compact
+  end
+
+  def after_deliver
+    if use_queue?
+      # if use_queue?, meaning if this was sent via ActiveJob, we need to update ourself
+      # since we got to here within after_create, meaning setting the attributes alone won't cut it
+      self.update(request_json: @request.to_json, response_json: @response.to_json, sid: @response.first[:sid], status: @response.first[:status])
+    else
+      # We are before_create so we can just set the attribute values, it will be saved after this
+      self.request_json = @request.to_json
+      self.response_json = @response.to_json
+      self.sid = @response.first[:sid]
+      self.status = @response.first[:status]
+    end
+  end
+
+  def deliver_now
+    all_attachments = attachments.map(&:attachment)
+
+    # If sending more than 1 attachment, iterate through all but one attachment and send each without a body...
+    if all_attachments.count > 1
+      begin
+        client.messages.create({ from: from_formatted, to: to_formatted, media_url: all_attachments.shift }.compact)
+        @request << Rack::Utils.parse_nested_query(client.last_request.body)
+        @response << JSON.parse(client.last_response.body)
+      end until all_attachments.count == 1
+    end
+
+    # ... Then send the last attachment (if any) with the actual text body. This way we're not sending multiple SMS's with same body
+    client.messages.create({ from: from_formatted, to: to_formatted, body: message, media_url: all_attachments.shift }.compact)
+    @request << Rack::Utils.parse_nested_query(client.last_request.body)
+    @response << JSON.parse(client.last_response.body)
+    after_deliver
+  end
+
+  def deliver_later
+    job = Voltron::SmsJob.set(wait: Voltron.config.notify.delay).perform_later self
+    @request << job.to_json
+    @response << { sid: nil, status: "enqueued" }
+    after_deliver
+  end
+
+  def attach(url)
+    if url.starts_with? "http"
+      attachments.build attachment: url
+    else
+      attachments.build attachment: Voltron.config.base_url + ActionController::Base.helpers.asset_url(url)
+    end
+  end
+
+  def valid_phone?
+    begin
+      return true if to.blank? # Handle a blank `to` separately in the errors method below
+      to_formatted
+      true
+    rescue => e
+      Voltron.log e.message, "Notify", :light_red
+      false
+    end
+  end
+
+  # TODO: Move this to actual validates_* methods
+  def error_messages
+    output = []
+    output << "recipient cannot be blank" if to.blank?
+    output << "recipient is not a valid phone number" unless valid_phone?
+    output << "sender cannot be blank" if from.blank?
+    output << "message cannot be blank" if message.blank?
+    output
+  end
+
+  private
+
+    def use_queue?
+      Voltron.config.notify.use_queue
+    end
+
+    def to_formatted
+      format to
+    end
+
+    def from_formatted
+      format from
+    end
+
+    def format(input)
+      # Try to format the number via Twilio's api
+      # raises an exception if the input was invalid
+      number = lookup.phone_numbers.get input
+      number.phone_number
+    end
+
+    def client
+      @client ||= ::Twilio::REST::Client.new Voltron.config.notify.sms_account_sid, Voltron.config.notify.sms_auth_token
+    end
+
+    def lookup
+      @lookup ||= ::Twilio::REST::LookupsClient.new Voltron.config.notify.sms_account_sid, Voltron.config.notify.sms_auth_token
+    end
+
+end

data/app/models/voltron/notification.rb

@@ -0,0 +1,79 @@
+module Voltron
+  class Notification < ActiveRecord::Base
+
+    belongs_to :notifyable, polymorphic: true
+
+    has_many :sms_notifications
+
+    has_many :email_notifications
+
+    before_validation :prepare
+
+    before_validation :validate
+
+    PERMITTED_ATTRIBUTES = [:to, :from]
+
+    def email(subject, **args, &block)
+      # Get the remaining args as params, that will eventually become assigns in the mailer template
+      params = { subject: subject }.merge(**args)
+
+      # Build the options hash from the provided arguments
+      options = { subject: subject }.merge(**args.select { |k,v| PERMITTED_ATTRIBUTES.include?(k.to_sym) })
+
+      # Build a new SMS notification object
+      notification_email = email_notifications.build(options)
+
+      # Set the email vars (assigns)
+      notification_email.vars = params
+
+      # If a block is provided, allow calls to methods like `attach`
+      notification_email.instance_exec &block if block_given?
+    end
+
+    def sms(message, **args, &block)
+      # Build the options hash from the provided arguments
+      options = { message: message, from: Voltron.config.notify.sms_from }.merge(**args)
+
+      # Build a new SMS notification object
+      notification_sms = sms_notifications.build(options)
+
+      # If a block is provided, allow calls to methods like `attach`
+      notification_sms.instance_exec &block if block_given?
+    end
+
+    # Called from the before_validation callback within `notifyable`
+    # makes one final pass to set the email and phone as the to attribute
+    # If already set however, this does nothing. We do this because simply calling
+    # `notifyable` here returns nil until it's actually saved
+    def to(email, phone)
+      email_notifications.each { |n| n.to ||= email }
+      sms_notifications.each { |n| n.to ||= phone }
+    end
+
+    private
+
+      def validate
+        # Add SMS related errors to self
+        sms_notifications.each do |n|
+          n.error_messages.each do |error|
+            self.errors.add :sms, error
+          end
+        end
+
+        # Add Email related errors to self
+        email_notifications.each do |n|
+          n.error_messages.each do |error|
+            self.errors.add :email, error
+          end
+        end
+      end
+
+      def prepare
+        # Set the to value for both the email and phone, if any on this model
+        # This method is also called from the before_validation block in the notify module
+        # but we do it here in case the notification was created using resource.create
+        # instead of resource.build -> resource.save
+        to notifyable.try(:email), notifyable.try(:phone)
+      end
+  end
+end

data/app/views/voltron/notification_mailer/notify.html.erb

@@ -0,0 +1 @@
+<%= @body %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "voltron/notify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/templates/db/migrate/create_voltron_notification_email_notifications.rb

@@ -0,0 +1,14 @@
+class CreateVoltronNotificationEmailNotifications < ActiveRecord::Migration
+  def change
+    create_table :voltron_notification_email_notifications do |t|
+      t.string :to
+      t.string :from
+      t.string :subject
+      t.string :mailer_class
+      t.string :mailer_method
+      t.text :request_json
+      t.text :response_json
+      t.integer :notification_id
+    end
+  end
+end

data/lib/generators/templates/db/migrate/create_voltron_notification_sms_notification_attachments.rb

@@ -0,0 +1,10 @@
+class CreateVoltronNotificationSmsNotificationAttachments < ActiveRecord::Migration
+  def change
+    create_table :voltron_notification_sms_notification_attachments do |t|
+      t.integer :sms_notification_id
+      t.string :attachment
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/templates/db/migrate/create_voltron_notification_sms_notifications.rb

@@ -0,0 +1,16 @@
+class CreateVoltronNotificationSmsNotifications < ActiveRecord::Migration
+  def change
+    create_table :voltron_notification_sms_notifications do |t|
+      t.string :to
+      t.string :from
+      t.text :message
+      t.text :request_json
+      t.text :response_json
+      t.integer :notification_id
+      t.string :status
+      t.string :sid
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/templates/db/migrate/create_voltron_notifications.rb

@@ -0,0 +1,10 @@
+class CreateVoltronNotifications < ActiveRecord::Migration
+  def change
+    create_table :voltron_notifications do |t|
+      t.string :notifyable_type
+      t.integer :notifyable_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/voltron/notify/install_generator.rb

@@ -0,0 +1,94 @@
+module Voltron
+  module Notify
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+
+        source_root File.expand_path("../../../templates", __FILE__)
+
+        desc "Add Voltron Notify initializer"
+
+        def inject_initializer
+
+          voltron_initialzer_path = Rails.root.join("config", "initializers", "voltron.rb")
+
+          unless File.exist? voltron_initialzer_path
+            unless system("cd #{Rails.root.to_s} && rails generate voltron:install")
+              puts "Voltron initializer does not exist. Please ensure you have the 'voltron' gem installed and run `rails g voltron:install` to create it"
+              return false
+            end
+          end
+
+          current_initiailzer = File.read voltron_initialzer_path
+
+          unless current_initiailzer.match(Regexp.new(/# === Voltron Notify Configuration ===/))
+            inject_into_file(voltron_initialzer_path, after: "Voltron.setup do |config|\n") do
+<<-CONTENT
+
+  # === Voltron Notify Configuration ===
+
+  # Whether or not to use the ActiveJob queue to handle sending email/sms messages
+  # A queue is still only used if configured via config.active_job.queue_adapter
+  # config.notify.use_queue = false
+
+  # How long to delay sending email/sms messages. Use this in conjunction with config.notify.use_queue
+  # config.notify.delay = 0.seconds
+
+  # Twilio account id number
+  # config.notify.sms_account_sid = ""
+
+  # Twilio authentication token
+  # config.notify.sms_auth_token = ""
+
+  # Default from phone number. Must be the number provided by Twilio.
+  # Avoid the overhead of pre-formatting the number by entering in the format "+1234567890"
+  # config.notify.sms_from = ""
+
+  # Default from email address. If not specified the default from in the mailer or the :from param on mail() is used
+  # config.notify.email_from = "no-reply@example.com"
+CONTENT
+            end
+          end
+        end
+
+        def copy_migrations
+          copy_migration "create_voltron_notifications"
+          copy_migration "create_voltron_notification_sms_notifications"
+          copy_migration "create_voltron_notification_email_notifications"
+          copy_migration "create_voltron_notification_sms_notification_attachments"
+        end
+
+        def copy_views
+          copy_file "../../../app/views/voltron/notification_mailer/notify.html.erb", Rails.root.join("app", "views", "voltron", "notification_mailer", "notify.html.erb")
+        end
+
+        protected
+
+          def copy_migration(filename)
+            if migration_exists?(Rails.root.join("db", "migrate"), filename)
+              say_status("skipped", "Migration #{filename}.rb already exists")
+            else
+              copy_file "db/migrate/#{filename}.rb", Rails.root.join("db", "migrate", "#{migration_number}_#{filename}.rb")
+            end
+          end
+
+          def migration_exists?(dirname, filename)
+            Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{filename}.rb$/).first
+          end
+
+          def migration_id_exists?(dirname, id)
+            Dir.glob("#{dirname}/#{id}*").length > 0
+          end
+
+          def migration_number
+            @migration_number ||= Time.now.strftime("%Y%m%d%H%M%S").to_i
+
+            while migration_id_exists?(Rails.root.join("db", "migrate"), @migration_number) do
+              @migration_number += 1
+            end
+
+            @migration_number
+          end
+      end
+    end
+  end
+end

data/lib/voltron/config/notify.rb

@@ -0,0 +1,26 @@
+module Voltron
+  class Config
+
+    def notify
+      @notify ||= Notify.new
+    end
+
+    class Notify
+
+      attr_accessor :use_queue, :delay
+
+      # SMS config settings
+      attr_accessor :sms_account_sid, :sms_auth_token, :sms_from
+
+      # Email config settings
+      attr_accessor :email_from
+
+      def initialize
+        @use_queue ||= false
+        @delay ||= 0.seconds
+        @email_from ||= "no-reply@example.com"
+      end
+
+    end
+  end
+end

data/lib/voltron/notify/engine.rb

@@ -0,0 +1,12 @@
+module Voltron
+  module Notify
+    class Engine < Rails::Engine
+
+      isolate_namespace Voltron
+
+      initializer "voltron.notify.initialize" do
+        ::ActiveRecord::Base.send :extend, ::Voltron::Notify
+      end
+    end
+  end
+end

data/lib/voltron/notify/version.rb

@@ -0,0 +1,5 @@
+module Voltron
+  module Notify
+    VERSION = "0.1.2".freeze
+  end
+end

data/lib/voltron/notify.rb

@@ -0,0 +1,47 @@
+require "voltron"
+require "voltron/notify/version"
+require "voltron/config/notify"
+
+module Voltron
+  module Notify
+
+    def notifyable
+      include InstanceMethods
+
+      before_validation :validate_notifications
+
+      after_validation :clean_notification_validation
+
+      has_many :notifications, as: :notifyable, class_name: "::Voltron::Notification"
+    end
+
+    module InstanceMethods
+
+      private
+
+        def validate_notifications
+          # Find all notification records that haven't been saved yet
+          self.notifications.select(&:new_record?).each do |notification|
+
+            # Set the to value for both the email and phone, if any on this model
+            notification.to self.try(:email), self.try(:phone)
+
+            # If not valid, populate the childs error messages in this models errors object
+            unless notification.valid?
+              notification.errors.messages.each do |k, errors|
+                errors.each { |error| self.errors.add k, error }
+              end
+            end
+          end
+        end
+
+        def clean_notification_validation
+          # Cleanup, remove the notifications key from the error messages,
+          # All of the actual errors are populated into "notifications.<type>" keys above
+          self.errors.delete :notifications
+        end
+    end
+  end
+end
+
+require "voltron/notify/engine" if defined?(Rails)

data/voltron-notify.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "voltron/notify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "voltron-notify"
+  spec.version       = Voltron::Notify::VERSION
+  spec.authors       = ["Eric Hainer"]
+  spec.email         = ["eric@commercekitchen.com"]
+
+  spec.summary       = %q{Send notifications easier}
+  spec.homepage      = "https://github.com/ehainer/voltron-notify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.2"
+  spec.add_dependency "twilio-ruby", "~> 4.11"
+  spec.add_dependency "rack", ">= 1.6"
+  spec.add_dependency "voltron", "~> 0.1.2", ">= 0.1.0"
+
+  spec.add_development_dependency "simplecov", "0.11.0"
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rspec-rails", ">= 3.4"
+  spec.add_development_dependency "sqlite3", ">= 1.2"
+  spec.add_development_dependency "factory_girl_rails", ">= 4.7"
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: voltron-notify
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Eric Hainer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: voltron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: 
+email:
+- eric@commercekitchen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/jobs/voltron/sms_job.rb
+- app/mailers/voltron/notification_mailer.rb
+- app/models/voltron/notification.rb
+- app/models/voltron/notification/email_notification.rb
+- app/models/voltron/notification/sms_notification.rb
+- app/models/voltron/notification/sms_notification/attachment.rb
+- app/views/voltron/notification_mailer/notify.html.erb
+- bin/console
+- bin/setup
+- lib/generators/templates/db/migrate/create_voltron_notification_email_notifications.rb
+- lib/generators/templates/db/migrate/create_voltron_notification_sms_notification_attachments.rb
+- lib/generators/templates/db/migrate/create_voltron_notification_sms_notifications.rb
+- lib/generators/templates/db/migrate/create_voltron_notifications.rb
+- lib/generators/voltron/notify/install_generator.rb
+- lib/voltron/config/notify.rb
+- lib/voltron/notify.rb
+- lib/voltron/notify/engine.rb
+- lib/voltron/notify/version.rb
+- voltron-notify.gemspec
+homepage: https://github.com/ehainer/voltron-notify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Send notifications easier
+test_files: []