notify_on 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 522b65290d13dbc3fcde080221b2e3ab63dd8567
+  data.tar.gz: c88fa1da0714593511218f5159679ccf9e223421
+SHA512:
+  metadata.gz: 9f50b96b159f20bbe1165013bc1337ec409078adaf2ba1081cd79f86d7a09036f7fb123698f1671a0bd566b736507f350721d5d9d0dd9258e985da423dd57e85
+  data.tar.gz: 309847d668e04e6d0485228be4a39d738030d30e36ff6996cde96c043b1e45390018682f8d49490b7adf85f0b834a747f41760144373acc3a483cc598bdbc1b3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mile Wille, Sean C Davis
+
+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,29 @@
+NotifyOn
+==========
+
+![](https://api.travis-ci.org/BrilliantChemistry/NotifyOn.svg?branch=overhaul)
+
+NotifyOn generates automatic notifications as a result of state changes on a
+particular model in a Rails application. It supports email messages, along with
+third-party real-time delivery, while also storing each notification in your
+database so you can use, adjust, and display as you'd wish.
+
+Documentation can be found in [the wiki
+library](https://github.com/digerata/NotifyOn/wiki). A good place to start is
+[this article](https://github.com/BrilliantChemistry/NotifyOn/wiki/Getting-Started).
+
+If you have questions, comments, ideas, or bug reports, please [create an
+issue](https://github.com/BrilliantChemistry/NotifyOn/issues/new).
+
+Contributors
+----------
+
+This project was built and is maintained by [Mike
+Wille](https://github.com/digerata) and [Sean C
+Davis](https://github.com/seancdavis), and was made possible by [Brilliant
+Chemistry](http://www.brilliantchemistry.com/).
+
+License
+----------
+
+See [MIT-LICENSE](https://github.com/BrilliantChemistry/NotifyOn/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NotifyOn'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/notify_on_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/notify_on .js
+//= link_directory ../stylesheets/notify_on .css

data/app/assets/javascripts/notify_on/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/notify_on/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/notify_on/application_controller.rb

@@ -0,0 +1,5 @@
+module NotifyOn
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/notify_on/application_helper.rb

@@ -0,0 +1,4 @@
+module NotifyOn
+  module ApplicationHelper
+  end
+end

data/app/helpers/notify_on/mailer_helper.rb

@@ -0,0 +1,9 @@
+module NotifyOn::MailerHelper
+
+  def method_missing(method, *args, &block)
+    m = method.to_s
+    super unless m.ends_with?('_path') || m.ends_with?('_url')
+    main_app.send(m, *args)
+  end
+
+end

data/app/jobs/notify_on/application_job.rb

@@ -0,0 +1,4 @@
+module NotifyOn
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/notify_on/application_mailer.rb

@@ -0,0 +1,6 @@
+module NotifyOn
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/mailers/notify_on/notification_mailer.rb

@@ -0,0 +1,26 @@
+module NotifyOn
+  class NotificationMailer < ApplicationMailer
+
+    helper 'notify_on/mailer'
+
+    def notify(notification_id, template = 'notify', files = [])
+      @notification = NotifyOn::Notification.find_by_id(notification_id)
+      @recipient = @notification.recipient
+      @sender = @notification.sender
+      @trigger = @notification.trigger
+      # Add attachments.
+      files.each { |attr| attachments[attr[:name]] = attr[:file] }
+      # Save a reference to the message if requested.
+      if @notification.should_save_email_id?
+        headers['message-id'] = (message_id = SecureRandom.uuid)
+        @trigger.update_columns(:message_id => message_id)
+      end
+      mail :to => @recipient.email,
+           :from => @notification.email_from,
+           :subject => @notification.email_subject,
+           :template_path => 'notifications',
+           :template_name => template
+    end
+
+  end
+end

data/app/models/concerns/notify_on/email_support.rb

@@ -0,0 +1,97 @@
+module NotifyOn
+  module EmailSupport
+
+    def send_email!
+      return false unless can_send_email?
+      NotifyOn.configuration.mailer_class.constantize
+              .notify(id, email_template, email_attachments)
+              .send("deliver_#{email_delivery_timing}")
+    end
+
+    def email_template
+      return nil unless email_config?
+      email_config.template || 'notify'
+    end
+
+    def email_from
+      convert_string(email_from_raw)
+    end
+
+    def email_subject
+      return email_config.subject if email_config? && email_config.subject?
+      description
+    end
+
+    def should_save_email_id?
+      email_config? && email_config.save_id?
+    end
+
+    def email_attachments
+      attachments = []
+      return attachments unless email_config? && email_config.attachments?
+      email_config.attachments.each do |name, renderer|
+        next unless trigger.send(renderer.if) if renderer.try(:if?)
+        filename = begin
+          trigger.send(name)
+        rescue => e
+          name
+        end
+        begin
+          file = if renderer.is_a?(Symbol)
+            trigger.send(renderer)
+          else
+            trigger.send(renderer.file)
+          end
+        rescue => e
+          raise "Could not create file: #{filename}\n#{e}"
+        end
+        attachments << { :name => filename, :file => file }
+      end
+      attachments
+    end
+
+    private
+
+      def email_delivery_timing
+        return email_config.deliver if email_config? && email_config.deliver?
+        NotifyOn.configuration.deliver_mail.to_s
+      end
+
+      def email_config
+        return nil unless opts.email
+        opts.email.is_a?(Hashie::Mash) ? opts.email : Hashie::Mash.new
+      end
+
+      def email_enabled?
+        opts.email?
+      end
+
+      def email_disabled?
+        !email_enabled?
+      end
+
+      def email_config?
+        email_enabled? && email_config.respond_to?(:[])
+      end
+
+      def can_send_email?
+        return false if email_disabled?
+        return true unless email_config.unless?
+        begin
+          !trigger.send(email_config.unless)
+        rescue
+          !send(email_config.unless)
+        end
+      end
+
+      def use_default_email?
+        email_disabled? || !email_config.from?
+      end
+
+      def email_from_raw
+        return NotifyOn.configuration.default_email if use_default_email?
+        email_config.from
+      end
+
+  end
+end

data/app/models/concerns/notify_on/pusher_support.rb

@@ -0,0 +1,66 @@
+module NotifyOn
+  module PusherSupport
+    extend ActiveSupport::Concern
+
+    def push!
+      return false unless can_push?
+
+      pusher_config
+
+      msg  = "Pusher Event: #{pusher_event_name} | "
+      msg += "To Channel: #{pusher_channel_name}\n#{pusher_attrs}"
+      Rails.logger.debug(msg)
+
+      Pusher.trigger_async(pusher_channel_name, pusher_event_name, pusher_attrs)
+    end
+
+    def pusher_sender_active?
+      ids = Pusher.channel_users(pusher_channel_name)[:users]
+                  .collect { |u| u["id"].to_i }
+      ids.include?(sender_id)
+    end
+
+    def pusher_recipient_active?
+      ids = Pusher.channel_users(pusher_channel_name)[:users]
+                  .collect { |u| u["id"].to_i }
+      ids.include?(recipient_id)
+    end
+
+    def pusher_channel_name
+      return nil unless can_push?
+      channel = options[:pusher][:channel] if options[:pusher].respond_to?(:[])
+      channel = NotifyOn.configuration.default_pusher_channel if channel.blank?
+      @pusher_channel_name ||= convert_string(channel)
+    end
+
+    def pusher_event_name
+      return nil unless can_push?
+      event = options[:pusher][:event] if options[:pusher].respond_to?(:[])
+      event = NotifyOn.configuration.default_pusher_event if event.blank?
+      @pusher_event_name ||= convert_string(event)
+    end
+
+    def pusher_attrs
+      return nil unless can_push?
+      {
+        :notification => self.to_json,
+        :trigger => trigger.to_json,
+        :data => (options[:pusher][:data] if options[:pusher].respond_to?(:[]))
+      }
+    end
+
+    private
+
+      def pusher_config
+        Pusher.app_id = NotifyOn.configuration.pusher_app_id
+        Pusher.key    = NotifyOn.configuration.pusher_key
+        Pusher.secret = NotifyOn.configuration.pusher_secret
+      end
+
+      def can_push?
+        options[:pusher].present? ||
+        (options[:pusher].nil? && NotifyOn.configuration.use_pusher_by_default)
+      end
+
+  end
+end

data/app/models/concerns/notify_on/string_interpolation.rb

@@ -0,0 +1,39 @@
+module NotifyOn
+  module StringInterpolation
+    extend ActiveSupport::Concern
+
+    private
+
+      def convert_string(input)
+        return nil if input.blank?
+        (output = input.to_s).scan(/{[\w\_\.\?]+}/).each do |match|
+          result = begin
+            match.gsub(/[^\w\_\.\?]/, '').split('.').inject(trigger, :send)
+          rescue NoMethodError => e
+            match.gsub(/[^\w\_\.\?]/, '').split('.').inject(self, :send)
+          end
+          output = output.gsub(/#{match}/, result.to_s)
+        end
+        output.gsub(/\{:env}/, Rails.env.downcase)
+              .gsub(/\{:recipient_id}/, recipient_id.to_s)
+      end
+
+      def convert_link(input)
+        return nil if input.blank?
+        input = input.split(/\(|\)|,/).map(&:strip)
+        if %w(_path _url).select { |r| input[0].end_with?(r) }.blank?
+          return convert_string(input[0])
+        end
+        args = []
+        input[1..-1].each do |arg|
+          args << if %w(self :self).include?(arg)
+            trigger
+          else
+            (arg[0] == ':') ? trigger.send(arg[1..-1]) : arg
+          end
+        end
+        Rails.application.routes.url_helpers.send(input[0], *args)
+      end
+
+  end
+end

data/app/models/notify_on/application_record.rb

@@ -0,0 +1,5 @@
+module NotifyOn
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/notify_on/notification.rb

@@ -0,0 +1,86 @@
+module NotifyOn
+  class Notification < ApplicationRecord
+
+    # ---------------------------------------- Plugins
+
+    include NotifyOn::StringInterpolation,
+            NotifyOn::PusherSupport,
+            NotifyOn::EmailSupport
+
+    # ---------------------------------------- Attributes
+
+    serialize :options, Hash
+
+    # ---------------------------------------- Associations
+
+    belongs_to :recipient, :polymorphic => true
+    belongs_to :sender, :polymorphic => true
+    belongs_to :trigger, :polymorphic => true
+
+    def recipient_type=(sType)
+      super(sType.to_s.classify.constantize.base_class.to_s)
+    end
+
+    def sender_type=(sType)
+      super(sType.to_s.classify.constantize.base_class.to_s)
+    end
+
+    def trigger_type=(sType)
+      super(sType.to_s.classify.constantize.base_class.to_s)
+    end
+
+    # ---------------------------------------- Scopes
+
+    scope :preloaded, -> { includes(:recipient, :sender, :trigger) }
+    scope :unread, -> { where(:unread => true) }
+    scope :recent, -> { order(:updated_at => :desc) }
+
+    scope :from_with_type, ->(from, type) {
+      where(:sender => from, :trigger_type => type)
+    }
+
+    # ---------------------------------------- Callbacks
+
+    after_save :convert_attrs
+
+    # ---------------------------------------- Class Methods
+
+    def self.mark_read_for(recipient, trigger)
+      where(:recipient => recipient, :trigger => trigger)
+        .update_all(:unread => false)
+    end
+
+    # ---------------------------------------- Instance Methods
+
+    def read!
+      update_columns(:unread => false)
+    end
+
+    def read?
+      !unread?
+    end
+
+    def link
+      link_cached || convert_link(link_raw)
+    end
+
+    def description
+      description_cached || convert_string(description_raw)
+    end
+
+    def method_missing(method_name, *args, &blk)
+      return Hashie::Mash.new(options) if method_name.to_s == 'opts'
+      super
+    end
+
+    # ---------------------------------------- Private Methods
+
+    private
+
+      def convert_attrs
+        update_columns(:description_cached => convert_string(description_raw),
+                       :link_cached => convert_link(link_raw))
+      end
+
+  end
+end