wupee 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af10fc3ae97b36dc7ac42eeb137b1efa44a6f7e3
+  data.tar.gz: e1b1f83375a63a78f51eb8da2ca172a3c4740e59
+SHA512:
+  metadata.gz: b5fc93a9d6c9441262c26f4780b0eea850dea8a101b6743fac2077fcd7960d48f06338a5fcaf8cfe1c8e3e993ddb9b3ade0c52d45e388c03e6149ed1ab32d526
+  data.tar.gz: a3c6b5d420d0b52ccaf0b2a554868d1bccdff120ab5f25282ed2bd0297b53e431fd5a90bbe37fdd454cbe47729d9a9ddc6aa8f3c3d23dcd65e2ede94fec49bc4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Peng DU
+
+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/Rakefile

@@ -0,0 +1,30 @@
+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    = 'Wupee'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/wupee/api/notifications_controller.rb

@@ -0,0 +1,33 @@
+module Wupee
+  class Api::NotificationsController < ApplicationController
+    before_action :set_notification, only: [:show, :update]
+
+    def index
+      if params[:is_read]
+        @notifications = current_user.notifications.where(is_read: params[:is_read] == "true")
+      else
+        @notifications = current_user.notifications
+      end
+    end
+
+    def show
+    end
+
+    def update
+      @notification.mark_as_read
+      render :show
+    end
+
+    def update_all
+      current_user.notifications.where(is_read: false).find_each do |n|
+        n.mark_as_read
+      end
+      head :no_content
+    end
+
+    private
+    def set_notification
+      @notification = current_user.notifications.find(params[:id])
+    end
+  end
+end

data/app/controllers/wupee/application_controller.rb

@@ -0,0 +1,4 @@
+module Wupee
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/mailers/wupee/notifications_mailer.rb

@@ -0,0 +1,30 @@
+module Wupee
+  class NotificationsMailer < ActionMailer::Base
+    after_action :mark_notification_as_sent
+
+    def send_mail_for(notification, subject_interpolations = {})
+      @notification = notification
+      @receiver = notification.receiver
+      @attached_object = notification.attached_object
+      @subject_interpolations = subject_interpolations
+
+      if !respond_to?(notification.notification_type.name)
+        class_eval %Q{
+          def #{notification.notification_type.name}
+            mail to: @receiver.email,
+                 subject: t('wupee.email_subjects.#{notification.notification_type.name}', @subject_interpolations),
+                 template_name: '#{notification.notification_type.name}',
+                 content_type: 'text/html'
+          end
+        }
+      end
+
+      send(notification.notification_type.name)
+    end
+
+    private
+      def mark_notification_as_sent
+        @notification.mark_as_sent unless @notification.is_sent
+      end
+  end
+end

data/app/models/concerns/wupee/attached_object.rb

@@ -0,0 +1,9 @@
+module Wupee
+  module AttachedObject
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :notifications_as_attached_object, as: :attached_object, dependent: :destroy, class_name: "Wupee::Notification"
+    end
+  end
+end

data/app/models/concerns/wupee/receiver.rb

@@ -0,0 +1,16 @@
+module Wupee
+  module Receiver
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :notifications, as: :receiver, dependent: :destroy, class_name: "Wupee::Notification"
+      has_many :notification_type_configurations, as: :receiver, dependent: :destroy, class_name: "Wupee::NotificationTypeConfiguration"
+
+      after_create do
+        Wupee::NotificationType.pluck(:id).each do |notification_type_id|
+          Wupee::NotificationTypeConfiguration.create!(notification_type_id: notification_type_id, receiver: self)
+        end
+      end
+    end
+  end
+end

data/app/models/wupee/notification.rb

@@ -0,0 +1,16 @@
+class Wupee::Notification < ActiveRecord::Base
+  belongs_to :receiver, polymorphic: true
+  belongs_to :attached_object, polymorphic: true
+  belongs_to :notification_type, class_name: "Wupee::NotificationType"
+
+  validates_presence_of :receiver,
+                        :notification_type
+
+  def mark_as_read
+    update_columns(is_read: true)
+  end
+
+  def mark_as_sent
+    update_columns(is_sent: true)
+  end
+end

data/app/models/wupee/notification_type.rb

@@ -0,0 +1,18 @@
+class Wupee::NotificationType < ActiveRecord::Base
+  validates :name, presence: true
+  validates :name, uniqueness: true
+
+  has_many :notification_type_configurations, foreign_key: :notification_type_id, dependent: :destroy
+
+  def self.create_configurations_for(*receivers)
+    class_eval do
+      receivers.each do |receiver|
+        after_create do
+          receiver.to_s.constantize.pluck(:id).each do |receiver_id|
+            Wupee::NotificationTypeConfiguration.create!(notification_type: self, receiver_type: receiver, receiver_id: receiver_id)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/wupee/notification_type_configuration.rb

@@ -0,0 +1,17 @@
+class Wupee::NotificationTypeConfiguration < ActiveRecord::Base
+  belongs_to :receiver, polymorphic: true
+  belongs_to :notification_type, class_name: "Wupee::NotificationType"
+
+  validates :notification_type, uniqueness: { scope: [:receiver] }
+  validates :receiver, :notification_type, presence: true
+
+  enum value: { both: 0, nothing: 1, email: 2, notification: 3 }
+
+  def wants_email?
+    ['both', 'email'].include?(value)
+  end
+
+  def wants_notification?
+    ['both', 'notification'].include?(value)
+  end
+end

data/app/models/wupee/notifier.rb

@@ -0,0 +1,73 @@
+module Wupee
+  class Notifier
+    attr_reader :deliver_when, :attached_object, :receiver_s, :notification_type, :subject_vars
+
+    def initialize(opts = {})
+      @attached_object = opts[:attached_object]
+      @receiver_s = opts[:receiver] || opts[:receivers] || []
+      @subject_vars = opts[:subject_vars] || {}
+      @deliver_when = opts[:deliver]
+      notif_type(opts[:notif_type]) if opts[:notif_type]
+    end
+
+    def notif_type(notif_type)
+      if notif_type.is_a?(Wupee::NotificationType)
+        @notification_type = notif_type
+      else
+        @notification_type = Wupee::NotificationType.find_by!(name: notif_type)
+      end
+    end
+
+    def attached_object(attached_object)
+      @attached_object = attached_object
+    end
+
+    def receiver(receiver)
+      @receiver_s = receiver
+    end
+
+    def receivers(receivers)
+      @receiver_s = receivers
+    end
+
+    def deliver(deliver_method)
+      @deliver_when = deliver_method
+    end
+
+    def subject_vars(subject_vars = {})
+      @subject_vars = subject_vars
+    end
+
+    def execute
+      notif_type_configs = Wupee::NotificationTypeConfiguration.includes(:receiver).where(receiver: @receiver_s, notification_type: @notification_type)
+
+      notif_type_configs.each do |notif_type_config|
+        notification = Wupee::Notification.new(receiver: notif_type_config.receiver, notification_type: @notification_type, attached_object: @attached_object)
+        notification.is_read = true unless notif_type_config.wants_notification?
+        notification.save!
+
+        subject_interpolations = interpolate_subject_vars(notification)
+        send_email(notification, subject_interpolations) if notif_type_config.wants_notification?
+      end
+    end
+
+    private
+      def send_email(notification, subject_interpolations)
+        deliver_method = "deliver_#{@deliver_when || Wupee.deliver_when}"
+        Wupee.mailer.send_mail_for(notification, subject_interpolations).send(deliver_method)
+      end
+
+      def interpolate_subject_vars(notification)
+        subject_vars_interpolated = {}
+        @subject_vars.each do |key, value|
+          subject_vars_interpolated[key] = if value.kind_of?(Proc)
+            notification.instance_eval(&value)
+          else
+            value.to_s
+          end
+        end
+
+        subject_vars_interpolated
+      end
+  end
+end

data/app/views/wupee/api/notifications/_notification.json.jbuilder

@@ -0,0 +1,5 @@
+json.extract! notification, :id, :notification_type_id, :created_at, :is_read
+json.attached_object notification.attached_object
+json.message do
+  json.partial! "wupee/api/notifications/#{notification.notification_type.name}", notification: notification
+end

data/app/views/wupee/api/notifications/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @notifications, partial: 'wupee/api/notifications/notification', as: :notification

data/app/views/wupee/api/notifications/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'wupee/api/notifications/notification', notification: @notification

data/db/migrate/20151029113101_create_wupee_notification_type_configurations.rb

@@ -0,0 +1,13 @@
+class CreateWupeeNotificationTypeConfigurations < ActiveRecord::Migration
+  def change
+    create_table :wupee_notification_type_configurations do |t|
+      t.belongs_to :notification_type, foreign_key: true
+      t.belongs_to :receiver, polymorphic: true
+      t.integer :value, default: 0
+      t.timestamps null: false
+    end
+
+    add_index :wupee_notification_type_configurations, [:notification_type_id], name: "idx_wupee_notif_type_config_on_notification_type_id"
+    add_index :wupee_notification_type_configurations, [:receiver_type, :receiver_id], name: "idx_wupee_notif_typ_config_on_receiver_type_and_receiver_id"
+  end
+end

data/db/migrate/20151029113107_create_wupee_notifications.rb

@@ -0,0 +1,14 @@
+class CreateWupeeNotifications < ActiveRecord::Migration
+  def change
+    create_table :wupee_notifications do |t|
+      t.references :receiver, polymorphic: true
+      t.references :attached_object, polymorphic: true
+      t.belongs_to :notification_type, foreign_key: true
+      t.integer :notification_type_id
+      t.boolean :is_read, default: false
+      t.boolean :is_sent, default: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151029113122_create_wupee_notification_types.rb

@@ -0,0 +1,10 @@
+class CreateWupeeNotificationTypes < ActiveRecord::Migration
+  def change
+    create_table :wupee_notification_types do |t|
+      t.string :name
+      t.timestamps null: false
+    end
+
+    add_index :wupee_notification_types, :name, unique: true
+  end
+end

data/lib/generators/wupee/install/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generates model notification and notification_type, a mailer, an initializer
+
+Example:
+    rails generate wupee:install
+
+    This will create:
+        db/migrate/created_notifcation.rb
+        app/models/notification.rb
+        app/models/notification_type.rb
+        app/mailers/notifications_mailer.rb
+        config/initializers/wupee.rb
+
+    this will update:
+        config/locales/{local}.yml

data/lib/generators/wupee/install/install_generator.rb

@@ -0,0 +1,24 @@
+class Wupee::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_notifications_mailer
+    template "notifications_mailer.rb", "app/mailers/notifications_mailer.rb"
+  end
+
+  def add_wupee_routes
+    route 'mount Wupee::Engine, at: "/wupee"'
+  end
+
+  def copy_initializer
+    template "wupee.rb", "config/initializers/wupee.rb"
+  end
+
+  def add_subject_locale
+    append_file "config/locales/#{I18n.locale.to_s}.yml" do
+      <<-CODE
+  wupee:
+    email_subjects:
+      CODE
+    end
+  end
+end

data/lib/generators/wupee/install/templates/notifications_mailer.rb

@@ -0,0 +1,4 @@
+class NotificationsMailer < Wupee::NotificationsMailer
+  default from: 'contact@sleede.com'
+  layout false
+end

data/lib/generators/wupee/install/templates/wupee.rb

@@ -0,0 +1,6 @@
+Wupee.mailer = NotificationsMailer
+Wupee.deliver_when = :now
+
+Wupee::NotificationType.class_eval do
+  create_configurations_for 'User'
+end

data/lib/generators/wupee/notification_type/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Add a notification by name
+
+Example:
+    rails generate notification name
+
+    This will create or modify:
+      insert  app/models/notification_type.rb
+      create  app/views/notifications_mailer/name.html.erb
+      insert  app/mailers/notifications_mailer.rb
+      insert  config/locales/en.yml

data/lib/generators/wupee/notification_type/notification_type_generator.rb

@@ -0,0 +1,26 @@
+class Wupee::NotificationTypeGenerator < Rails::Generators::NamedBase
+  def add_notification_subject
+    inject_into_file "config/locales/#{I18n.locale.to_s}.yml", after: /email_subjects:\n/ do
+<<-CODE
+      #{file_name}: "#{file_name}"
+CODE
+    end
+  end
+
+  def create_notification_json_template_file
+    create_file "app/views/wupee/api/notifications/_#{file_name}.json.jbuilder", <<-FILE
+json.subject "subject"
+json.body "body"
+json.url "url"
+    FILE
+  end
+
+  def create_notification_html_template_file
+    create_file "app/views/wupee/notifications/_#{file_name}.html.erb", <<-FILE
+    FILE
+  end
+
+  def create_notification_type_object
+    Wupee::NotificationType.create!(name: file_name)
+  end
+end

data/lib/tasks/wupee_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :wupee do
+#   # Task goes here
+# end