notifun 1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c88df68caf7a8299ad9ff4926c6708c889fcaa52462a55210c14fa193a91e3d
+  data.tar.gz: 0c4befb2ee25fdc56a5bbb7af87edccd995227663969221aef82a5fe06ca88c1
+SHA512:
+  metadata.gz: fb39dca98588e16e36db112920e3ecd7d2babfa68c8339c728b247f6bced42bb7c4efb5aa9eb548223b02cdc06c1765648c0efc1c54b3e310a61498a7d282662
+  data.tar.gz: c8ebebaf962f0c7ee2ec01544cfe887ff3ff6d388c5378f48c946927967a991342200e2b499050aab7b6944f61c99cce2f9d8d3f28393177954b9cb8afff5f37

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.ruby-gemset

@@ -0,0 +1 @@
+notifun

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in notifun.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    notifun (1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.7.0)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  notifun!
+  pry
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,16 @@
+# Notifun
+
+To install run: `rails g notifun:install`
+
+This will generate three things:
+The config initializer at `config/initializers/notifun.rb`.
+The migration to create the notifun tables.
+The json file for loading message templates at `config/notifun_templates.json`.
+
+
+Once installed, edit `config/notifun_templates.json` to add your message templates.
+You can edit them at `/notifun/message_templates`.
+You can see the generated messages at `/notifun/messages`.
+Users can edit their preferences at `/notifun/preferences`.
+
+`rails g notifun:install` can also be used to install missing fields after updates.

data/app/assets/stylesheets/notifun.sass

@@ -0,0 +1,62 @@
+.notifun-code, .notifun-code-block
+  font-family: courier, monospace
+
+.notifun-code-block
+  padding: 20px
+  background-color: #eee
+  margin-bottom: 10px
+
+.notifun-preview
+  border: 1px solid #ccc
+  padding: 10px
+
+table.notifun-table
+  width: 100%
+  &.space-below
+    margin-bottom: 50px
+
+  tr
+    border-bottom: 1px solid black
+
+  td, th
+    text-align: center
+
+  td
+    color: black
+    padding: 5px 25px 5px 10px
+    text-align: left
+    &.notifun-category
+      font-weight: bold
+    &.notifun-indent
+      padding-left: 20px
+
+  th
+    background-color: #666666
+    border: 1px solid black
+    color: white
+    padding: 5px 10px
+    text-align: left
+    text-transform: uppercase
+    a:link, a:visited
+      color: white
+      text-decoration: underline
+    a:hover
+      text-decoration: none
+
+  tbody
+    tr:nth-child(even)
+      background: #dddddd
+
+.notifun-center
+  text-align: center !important
+
+form.notifun-form
+  width: 100%
+  max-width: 100%
+
+.notifun-detail
+  padding-bottom: 10px
+  .notifun-detail-title
+    font-size: 18px
+  .notifun-detail-value
+    padding-left: 20px

data/app/controllers/notifun/message_templates_controller.rb

@@ -0,0 +1,31 @@
+class Notifun::MessageTemplatesController < Notifun.configuration.admin_parent_controller.constantize
+  def index
+    @message_templates = Notifun::MessageTemplate.all
+  end
+
+  def edit
+    @message_template = Notifun::MessageTemplate.find_by_key(params[:key])
+  end
+
+  def update
+    @message_template = Notifun::MessageTemplate.find_by_key(params[:key])
+    if @message_template.update(message_template_attributes)
+      redirect_to edit_notifun_message_template_path(@message_template), notice: "Message Template updated."
+    else
+      render :edit
+    end
+  end
+
+  def preview
+    @message_template = Notifun::MessageTemplate.find_by_key(params[:key])
+    @notifun_models = @message_template.models
+
+    render html: @message_template.preview_email_html.html_safe, layout: "mailer"
+  end
+
+  private
+
+  def message_template_attributes
+    params.require(:notifun_message_template).permit(:push_title, :push_body, :email_subject, :email_html, :email_text)
+  end
+end

data/app/controllers/notifun/messages_controller.rb

@@ -0,0 +1,15 @@
+class Notifun::MessagesController < Notifun.configuration.admin_parent_controller.constantize
+  def index
+    limit = 100
+
+    @page = (params[:page].presence || 1).to_i
+    offset = limit * (@page - 1)
+    @messages = Notifun::Message.order(created_at: :desc)
+    @pages = (@messages.count / limit.to_f).ceil
+    @messages = @messages.limit(limit).offset(offset)
+  end
+
+  def show
+    @message = Notifun::Message.find(params[:id])
+  end
+end

data/app/controllers/notifun/preferences_controller.rb

@@ -0,0 +1,26 @@
+class Notifun::PreferencesController < Notifun.configuration.user_parent_controller.constantize
+  def index
+    begin
+      @models = self.send(Notifun.configuration.controller_method)
+    rescue
+      render text: "Notifun.configuration.controller_method is not set or not defined." and return
+    end
+    @models = [@models].flatten.compact
+    if @models.empty?
+      render text: "#{Notifun.configuration.controller_method} returned no models."
+    end
+
+    @notification_methods = Notifun.configuration.notification_methods.sort
+  end
+
+  def save
+    params[:preferences].each do |index, preference_params|
+      permitted_params = preference_params.slice(:preferable_type, :preferable_id, :category, :message_template_key, :email, :push, :text).permit!
+      preference = Notifun::Preference.where(permitted_params.slice(:preferable_type, :preferable_id, preference_params[:preference_type])).first_or_initialize
+      preference.attributes = permitted_params
+      preference.save!
+    end
+
+    redirect_to notifun_preferences_path, notice: "Notification preferences saved."
+  end
+end

data/app/mailers/notifun/message_mailer.rb

@@ -0,0 +1,49 @@
+class Notifun::MessageMailer < Notifun.configuration.parent_mailer.constantize
+  if Notifun.configuration.premailer_html_to_text && defined?(Premailer)
+    include Premailer::HtmlToPlainText
+  end
+
+  def send_message(email, subject, html, text, message_template, options={})
+    @notifun_models = message_template.models
+
+    if options[:attachments].present?
+      options[:attachments].each do |key, value|
+        attachments[key] = value
+      end
+    end
+
+    if options[:instance_variables].present?
+      options[:instance_variables].each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    settings = {
+      to: email,
+      subject: subject
+    }
+
+    if options[:from].present?
+      settings[:from] = options[:from]
+    end
+    if options[:reply_to].present?
+      settings[:reply_to] = options[:reply_to]
+    end
+
+    if Rails.version[0].to_i > 4
+      hack_layout = _layout(["text"])
+    else
+      hack_layout = _layout
+    end
+
+    if Notifun.configuration.premailer_html_to_text && defined?(Premailer)
+      text = text.dup
+      text = convert_to_text(text)
+    end
+
+    mail(settings) do |format|
+      format.text { render plain: text, layout: hack_layout }
+      format.html { render html: html.html_safe, layout: hack_layout }
+    end
+  end
+end

data/app/models/notifun/message.rb

@@ -0,0 +1,7 @@
+class Notifun::Message < ActiveRecord::Base
+  self.table_name = 'notifun_messages'
+
+  def message_template
+    Notifun::MessageTemplate.where(key: message_template_key).first
+  end
+end

data/app/models/notifun/message_template.rb

@@ -0,0 +1,98 @@
+class Notifun::MessageTemplate < ActiveRecord::Base
+  self.table_name = 'notifun_message_templates'
+
+  validates :key, uniqueness: true
+
+  def to_param
+    key
+  end
+
+  [:push_title, :push_body, :email_html, :email_text, :email_subject, :text_body].each do |method|
+    define_method("merged_#{method}") do |merge_hash|
+      merge(self.send(method), merge_hash)
+    end
+
+    define_method("preview_#{method}") do
+      merge(self.send(method), merge_fields_preview)
+    end
+  end
+
+  def messages
+    Notifun::Message.where(message_template_key: key)
+  end
+
+  def default_notification_methods
+    notification_methods = self[:default_notification_methods] & Notifun.configuration.notification_methods
+    if notification_methods.empty?
+      notification_methods = self[:backup_notification_methods] & Notifun.configuration.notification_methods
+    end
+
+    notification_methods
+  end
+
+  def backup_notification_methods
+    (self[:backup_notification_methods] & Notifun.configuration.notification_methods) - default_notification_methods
+  end
+
+  def notification_methods
+    default_notification_methods + backup_notification_methods
+  end
+
+  def possible_notification_methods
+    array = []
+    array << "push" if push_body.present?
+    array << "email" if email_subject.present?
+    array << "text" if text_body.present?
+
+    if array.empty?
+      notification_methods
+    else
+      array
+    end
+  end
+
+  def push?
+    notification_methods.include?("push")
+  end
+
+  def email?
+    notification_methods.include?("email")
+  end
+
+  def sent_via
+    text = default_notification_methods.join(' and ')
+    if backup_notification_methods.any?
+      text += " or "
+      text += backup_notification_methods.join(', ')
+    end
+
+    text
+  end
+
+  def merge_fields_preview
+    merge_fields.reduce({}){|hash, (k,v)| hash[k] = v["preview"].presence || v["description"] || v; hash}
+  end
+
+  def merge_fields_description
+    merge_fields.reduce({}){|hash, (k,v)| hash[k] = v["description"] || v; hash}
+  end
+
+  def merge_fields_display
+    text = []
+    merge_fields_description.each do |key, description|
+      text << "{#{key}} => #{description}"
+    end
+    text.join('<br>').html_safe
+  end
+
+  private
+
+  def merge(text, merge_hash)
+    text ||= ""
+    merge_hash.each do |key, value|
+      text.gsub!(/\{#{key}\}/, value)
+    end
+
+    text
+  end
+end

data/app/models/notifun/preference.rb

@@ -0,0 +1,13 @@
+class Notifun::Preference < ActiveRecord::Base
+  self.table_name = 'notifun_preferences'
+
+  belongs_to :preferable, polymorphic: true
+
+  def notification_methods
+    array = []
+    array << Notifun::NotificationMethods::EMAIL if email
+    array << Notifun::NotificationMethods::PUSH if push
+    array << Notifun::NotificationMethods::TEXT if text
+    array & Notifun.configuration.notification_methods
+  end
+end

data/app/views/notifun/message_templates/edit.html.haml

@@ -0,0 +1,53 @@
+- if Notifun.configuration.wysiwyg == "tinymce"
+  = tinymce_assets
+%h1 Edit #{@message_template.key.humanize} Message Template
+
+= simple_form_for @message_template, html: { class: "two-columns" } do |f|
+  .form-inputs
+    = f.error_notification
+
+    %p= @message_template.description
+    %p Models: #{@message_template.models.join(', ')}
+    %p Sent Via: #{@message_template.sent_via}
+    %p Text surrounded by curly brackets "{example}" is replaced with info from the database when sent. The following are the keys you have available for replacement.
+    .notifun-code-block= @message_template.merge_fields_display
+    - if @message_template.push?
+      = f.input :push_title, input_html: { class: 'notifun-code' }
+      .input
+        %label Push Title Preview
+        .notifun-preview= @message_template.preview_push_title
+      %br
+      %br
+      = f.input :push_body, input_html: { class: 'notifun-code' }
+      .input
+        %label Push Body Preview
+        .notifun-preview= @message_template.preview_push_body
+      %br
+      %br
+    - if @message_template.email?
+      = f.input :email_subject, input_html: { class: 'notifun-code' }
+      .input
+        %label Email Subject Preview
+        .notifun-preview= @message_template.preview_email_subject
+      %br
+      %br
+      - if Notifun.configuration.wysiwyg == "tinymce"
+        = f.input :email_html, input_html: { rows: 5, class: 'notifun-code tinymce', style: "height: 300px" }
+        = tinymce
+      - elsif Notifun.configuration.wysiwyg == "froala"
+        = f.input :email_html, input_html: { rows: 5, class: 'notifun-code froala-editor', data: { froalaoptions: { heightMin: 300 }} }
+      - else
+        = f.input :email_html, input_html: { rows: 5, class: 'notifun-code' }
+      .input
+        %label Email HTML Preview
+        .notifun-preview
+          %iframe{height: "300px", width: "100%", src: preview_notifun_message_template_path(@message_template)}
+      %br
+      %br
+      = f.input :email_text, input_html: { rows: 5, class: 'notifun-code' }
+      .input
+        %label Email Text Preview
+        .notifun-preview= @message_template.preview_email_text
+
+  .form-actions
+    = f.button :submit