notify_with 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3173ecd1a4779e09c8fbfcaca08042117de9b342
+  data.tar.gz: 7348cc427713287bf0b640590dd4523ab035e9dc
+SHA512:
+  metadata.gz: 076d6743c70272b6df0077e83c5ca887de3ce84d5f7a1f263a225792f87d38956063cfca9541519c77a50e6d82c40b0623fb6d7a5f41a2806c8764c075cf49c2
+  data.tar.gz: 1880410b455978697059f4c20d804f15008c75d37f1e58d3139043385c7acc5c4d8ccb3b4cdf1d7620857dbb2d012776efbb3aa16f1e64eec970fc37e73f2b83

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    = 'NotifyWith'
+  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/concerns/notify_with/notifications_api.rb

@@ -0,0 +1,38 @@
+module NotifyWith
+  module NotificationsApi
+    extend ActiveSupport::Concern
+
+    included do
+      respond_to :json
+      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
+end

data/app/mailers/notify_with/notifications_mailer.rb

@@ -0,0 +1,29 @@
+module NotifyWith
+  class NotificationsMailer < ActionMailer::Base
+    after_action :mark_notification_as_send
+
+    def send_mail_by(notification)
+      @notification = notification
+      @recipient = notification.receiver
+      @attached_object = notification.attached_object
+
+      if !respond_to?(notification.notification_type)
+        class_eval %Q{
+          def #{notification.notification_type}
+            mail to: @recipient.email,
+                 subject: t('.subject_#{notification.notification_type}'),
+                 template_name: '#{notification.notification_type}',
+                 content_type: 'text/html'
+          end
+        }
+      end
+
+      send(notification.notification_type)
+    end
+
+    private
+    def mark_notification_as_send
+      @notification.mark_as_send unless @notification.is_send
+    end
+  end
+end

data/app/models/concerns/notify_with/notification.rb

@@ -0,0 +1,47 @@
+module NotifyWith
+  module Notification
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :receiver, polymorphic: true
+      belongs_to :attached_object, polymorphic: true
+
+      validates_presence_of :receiver_id,
+                            :receiver_type,
+                            :attached_object_id,
+                            :attached_object_type,
+                            :notification_type_id
+
+      def send_notification(type: nil, attached_object: nil)
+        self.notification_type_id = ::NotificationType.find_by_name(type)
+        self.attached_object = attached_object
+        self
+      end
+
+      def to(receiver)
+        self.receiver = receiver
+        self
+      end
+
+      def notification_type
+        ::NotificationType.find(notification_type_id)
+      end
+
+      def mark_as_read
+        update_columns(is_read: true)
+      end
+
+      def mark_as_send
+        update_columns(is_send: true)
+      end
+
+      def deliver_now
+        NotifyWith.mailer.send_mail_by(self).deliver_now if save
+      end
+
+      def deliver_later
+        NotifyWith.mailer.send_mail_by(self).deliver_later if save
+      end
+    end
+  end
+end

data/app/models/concerns/notify_with/notification_receiver.rb

@@ -0,0 +1,9 @@
+module NotifyWith
+  module NotificationReceiver
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :notifications, as: :receiver, dependent: :destroy
+    end
+  end
+end

data/app/models/concerns/notify_with/notification_type.rb

@@ -0,0 +1,23 @@
+module NotifyWith
+  module NotificationType
+    extend ActiveSupport::Concern
+
+    included do
+      NAMES = []
+
+      def self.notification_type_names(names)
+        NAMES.concat names
+      end
+
+      def self.find(id)
+        return nil if id.nil?
+        NAMES[id-1]
+      end
+
+      def self.find_by_name(name)
+        return nil if name.nil? or NAMES.empty?
+        NAMES.index(name.to_s)+1
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+NotifyWith::Engine.routes.draw do
+end

data/lib/generators/notify_with/install/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generates model notification and notification_type, a mailer, an initializer
+
+Example:
+    rails generate notify_with: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/notify_with.rb
+
+    this will update:
+        config/locales/{local}.yml

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

@@ -0,0 +1,62 @@
+class NotifyWith::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number path
+    unless @prev_migration_nr
+    @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+    else
+    @prev_migration_nr += 1
+    end
+    @prev_migration_nr.to_s
+  end
+
+  def copy_notification_migration
+    migration_template "create_notification.rb", "db/migrate/create_notification.rb"
+  end
+
+  def copy_notification_model
+    template "notification.rb", "app/models/notification.rb"
+  end
+
+  def copy_notification_type_model
+    template "notification_type.rb", "app/models/notification_type.rb"
+  end
+
+  def copy_notifications_mailer
+    template "notifications_mailer.rb", "app/mailers/notifications_mailer.rb"
+  end
+
+  def copy_api_notifications_controller
+    template "notifications_controller.rb", "app/controllers/api/notifications_controller.rb"
+  end
+
+  def copy_api_notifications_views
+    template "index.json.jbuilder", "app/views/api/notifications/index.json.jbuilder"
+    template "show.json.jbuilder", "app/views/api/notifications/show.json.jbuilder"
+  end
+
+  def add_notifications_route
+    route \
+<<-CODE
+namespace :api, defaults: { format: :json } do
+    resources :notifications, only: [:index, :show, :update] do
+      match :update_all, path: '/', via: [:put, :patch], on: :collection
+    end
+  end
+CODE
+  end
+
+  def copy_initializer
+    template "notify_with.rb", "config/initializers/notify_with.rb"
+  end
+
+  def add_subject_locale
+    append_file "config/locales/#{I18n.locale.to_s}.yml" do
+<<-CODE
+  notifications_mailer:
+    send_mail_by:
+CODE
+    end
+  end
+end

data/lib/generators/notify_with/install/templates/create_notification.rb

@@ -0,0 +1,13 @@
+class CreateNotification < ActiveRecord::Migration
+  def change
+    create_table :notify_with_notifications do |t|
+      t.references :receiver, polymorphic: true
+      t.references :attached_object, polymorphic: true
+      t.integer :notification_type_id
+      t.boolean :is_read, default: false
+      t.boolean :is_send, default: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/notify_with/install/templates/index.json.jbuilder

@@ -0,0 +1,9 @@
+json.array!(@notifications) do |notification|
+  if notification.attached_object
+    json.extract! notification, :id, :notification_type_id, :notification_type, :created_at, :is_read
+    json.attached_object notification.attached_object
+    json.message do
+      json.partial! "/api/notifications/#{notification.notification_type}", notification: notification
+    end
+  end
+end.delete_if {|n| n['id'] == nil }

data/lib/generators/notify_with/install/templates/notification.rb

@@ -0,0 +1,3 @@
+class Notification < ActiveRecord::Base
+  include NotifyWith::Notification
+end

data/lib/generators/notify_with/install/templates/notification_type.rb

@@ -0,0 +1,6 @@
+class NotificationType
+  include NotifyWith::NotificationType
+
+  notification_type_names %w(
+  )
+end

data/lib/generators/notify_with/install/templates/notifications_controller.rb

@@ -0,0 +1,3 @@
+class API::NotificationsController < ApplicationController
+  include NotifyWith::NotificationsApi
+end

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

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

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

@@ -0,0 +1 @@
+NotifyWith.mailer = NotificationsMailer

data/lib/generators/notify_with/install/templates/show.json.jbuilder

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

data/lib/generators/notify_with/notification/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/notify_with/notification/notification_generator.rb

@@ -0,0 +1,33 @@
+class NotifyWith::NotificationGenerator < Rails::Generators::NamedBase
+  def add_notification_type
+    inject_into_file 'app/models/notification_type.rb', before: /  \)/ do
+<<-CODE
+    #{file_name}
+CODE
+    end
+  end
+
+  def create_notification_mail_template_file
+    create_file "app/views/notifications_mailer/#{file_name}.html.erb", <<-FILE
+<%# this is a mail template of notifcation #{file_name} %>
+<p><%= @recipient.name %></p>
+<p><%= @attached_object.body %></p>
+    FILE
+  end
+
+  def add_notification_subject
+    inject_into_file "config/locales/#{I18n.locale.to_s}.yml", after: /send_mail_by:\n/ do
+<<-CODE
+      subject_#{file_name}: "#{file_name}"
+CODE
+    end
+  end
+
+  def create_notification_json_template_file
+    create_file "app/views/api/notifications/_#{file_name}.json.jbuilder", <<-FILE
+json.title notification.notification_type
+json.description 'a notification description'
+json.url 'a url for redirect to attached_object'
+    FILE
+  end
+end

data/lib/notify_with/engine.rb

@@ -0,0 +1,12 @@
+module NotifyWith
+  class Engine < ::Rails::Engine
+    isolate_namespace NotifyWith
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/notify_with/version.rb

@@ -0,0 +1,3 @@
+module NotifyWith
+  VERSION = "0.0.1"
+end

data/lib/notify_with.rb

@@ -0,0 +1,5 @@
+require "notify_with/engine"
+
+module NotifyWith
+  mattr_accessor :mailer
+end

data/lib/tasks/notify_with_tasks.rake

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

data/spec/controllers/notifications_controller_spec.rb

@@ -0,0 +1,57 @@
+require 'rails_helper'
+
+RSpec.describe API::NotificationsController, type: :controller do
+  let(:notification) { create :notification }
+
+  before :each do
+    allow_any_instance_of(API::NotificationsController).to receive(:current_user).and_return(notification.receiver)
+  end
+
+  it 'should get current user' do
+    expect(subject).to receive(:current_user).and_return(notification.receiver)
+    get :index, format: :json
+  end
+
+  describe 'GET index json' do
+    render_views
+
+    it "should returns a notification from a rendered template" do
+      get :index, format: :json
+      expect(json.size).to eq 1
+      expect(json[0]['id']).to eq notification.id
+      expect(json[0]['message']['title']).to eq notification.notification_type
+    end
+  end
+
+  describe 'GET show json' do
+    render_views
+
+    it "should returns a notification from a rendered template" do
+      get :show, format: :json, id: notification.id
+      expect(json['id']).to eq notification.id
+      expect(json['message']['title']).to eq notification.notification_type
+    end
+  end
+
+  describe 'PUT update' do
+    render_views
+
+    it "should mark as read" do
+      put :update, format: :json, id: notification.id
+      expect(json['is_read']).to eq true
+    end
+  end
+
+  describe 'PUT update_all' do
+    render_views
+
+    it "should all notification of user mark as read" do
+      put :update_all, format: :json
+      expect(notification.reload.is_read).to eq true
+    end
+  end
+
+  def json
+    ActiveSupport::JSON.decode(response.body)
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/api/notifications_controller.rb

@@ -0,0 +1,6 @@
+class API::NotificationsController < ApplicationController
+  include NotifyWith::NotificationsApi
+
+  def current_user
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/mailers/notifications_mailer.rb

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

data/spec/dummy/app/models/message.rb

@@ -0,0 +1,2 @@
+class Message < ActiveRecord::Base
+end

data/spec/dummy/app/models/notification.rb

@@ -0,0 +1,3 @@
+class Notification < ActiveRecord::Base
+  include NotifyWith::Notification
+end

data/spec/dummy/app/models/notification_type.rb

@@ -0,0 +1,7 @@
+class NotificationType
+  include NotifyWith::NotificationType
+
+  notification_type_names %w(
+    notify_new_message
+  )
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include NotifyWith::NotificationReceiver
+end

data/spec/dummy/app/views/api/notifications/_notify_new_message.json.jbuilder

@@ -0,0 +1,3 @@
+json.title notification.notification_type
+json.description "description"
+json.url 'url'

data/spec/dummy/app/views/api/notifications/index.json.jbuilder

@@ -0,0 +1,9 @@
+json.array!(@notifications) do |notification|
+  if notification.attached_object
+    json.extract! notification, :id, :notification_type_id, :notification_type, :created_at, :is_read
+    json.attached_object notification.attached_object
+    json.message do
+      json.partial! "/api/notifications/#{notification.notification_type}", notification: notification
+    end
+  end
+end.delete_if {|n| n['id'] == nil }

data/spec/dummy/app/views/api/notifications/show.json.jbuilder

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

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/notifications_mailer/notify_new_message.html.erb

@@ -0,0 +1,2 @@
+<p><%= @recipient.name %></p>
+<p><%= @attached_object.body %></p>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')