simple_notification 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3da0d1777ac57828b42209ff9c547d53e3434942
+  data.tar.gz: 75169ab04af06a1c0bd1f7120cc1c9b987ccbc83
+SHA512:
+  metadata.gz: a88d7348f157926aebf3a2a57a699699fd6146b61d1f2b328cbf4f29506b9a979f890816a0a2845e758ce01d40c4590de746b8636e480d8feefc6e8d1ced251b
+  data.tar.gz: 5ec6d6c2dd426ce4308ed125b047ae259a705d0a8179b58c8e6bb8f7dccc4ee09bbaa9a6fc65fa74c3e626043ce563d7f71afc8f1dde05976491bdb0854ee5d1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_notification.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cong Wang
+
+MIT License
+
+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,86 @@
+# SimpleNotification
+
+SimpleNotification is a user notification system using tracked events. Event has a owner, recipient, trackable source, and a message.
+
+## Assumptions
+
+SimpleNotification assumes a user systems is in place which uses the User model and has the current_user helper.
+
+SimpleNotification also assumes that the Notification model is not taken.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_notification'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_notification
+
+## Usage
+
+SimpleNotification generates the files in the /app folder, feel free to tweak it to fit specific needs.
+
+First generate the necessary files:
+
+    $ rails g simple_notification
+
+Add the routes for the view in /config/routes.rb:
+
+    resources :notifications
+
+Add the following to /app/models/user.rb:
+
+    has_notifications
+
+Add the following to any models that needs to be tracked:
+
+    can_be_tracked
+
+And finally, add the following to /app/controllers/application_controller.rb:
+
+    include SimpleNotification::Methods
+
+Now the setup is complete, the following are available:
+
+Notifications generated by a user's activities:
+
+    @user.own_notifications
+
+Notifications meant for a user:
+
+    @user.received_notifications
+
+one can add .where(read: false) to obtain unread notifications
+
+Method to **notify** a user of a tracked event:
+
+    notify(recipient, trackable, message)
+
+which will generate a notification from current_user (guest if undefined) to the recipient with the message and trackable source.
+
+Notifications are now working and can be displayed however desired, sample usages are:
+
+    render "notifications/show", notification_id: notification.id, read: false
+    render "notifications/show", notification_id: notification.id, read: true
+
+Will will generate the following by default:
+
+    **Owner** message **Trackable** | This notification was sent to **Recipient** | Destroy
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/simple_notification/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/simple_notification/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate simple_notification Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/simple_notification/simple_notification_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class SimpleNotificationGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  include Rails::Generators::Migration
+
+  def generate_migration
+    migration_template "create_notifications.rb.erb", "db/migrate/create_notifications.rb"
+  end
+
+  def generate_model
+    copy_file "notification.rb", "app/models/notification.rb"
+  end
+
+  def generate_controller
+    copy_file "notifications_controller.rb", "app/controllers/notifications_controller.rb"
+  end
+
+  def generate_view
+    empty_directory "app/views/notifications"
+    copy_file "notifications_index.html.haml", "app/views/notifications/index.html.haml"
+    copy_file "notifications_partial.html.haml", "app/views/notifications/_show.html.haml"
+    copy_file "notifications_css.css.scss", "app/assets/stylesheets/notifications.css.scss"
+  end
+
+  private
+
+  def self.next_migration_number( dirname )
+    next_migration_number = current_migration_number(dirname) + 1
+    if ActiveRecord::Base.timestamped_migrations
+      [Time.now.utc.strftime("%Y%m%d%H%M%S%6N"), "%.20d" % next_migration_number].max
+    else
+      "%.3d" % next_migration_number
+    end
+  end
+end
+

data/lib/generators/simple_notification/templates/create_notifications.rb.erb

@@ -0,0 +1,14 @@
+class CreateNotifications < ActiveRecord::Migration
+  def change
+    create_table :notifications do |t|
+      t.integer :owner_id
+      t.integer :recipient_id
+      t.integer :trackable_id
+      t.string :trackable_type
+      t.string :message
+      t.boolean :read, default: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/simple_notification/templates/notification.rb

@@ -0,0 +1,6 @@
+class Notification < ActiveRecord::Base
+  belongs_to :owner, class_name: "User"
+  belongs_to :recipient, class_name: "User"
+  belongs_to :trackable, polymorphic: :true
+
+end

data/lib/generators/simple_notification/templates/notifications_controller.rb

@@ -0,0 +1,38 @@
+class NotificationsController < ApplicationController
+  before_action :set_notification, only: [:show, :edit, :update, :destroy]
+
+  # GET /notifications
+  # GET /notifications.json
+  def index
+    @notifications = Notification.all
+  end
+
+  # POST /notifications
+  # POST /notifications.json
+  def create
+    @notification = Notification.new(notification_params)
+    @notification.save
+    redirect_to :back
+  end
+
+  # DELETE /notifications/1
+  # DELETE /notifications/1.json
+  def destroy
+    @notification.destroy
+    respond_to do |format|
+      format.html { redirect_to :back }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_notification
+      @notification = Notification.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def notification_params
+      params.require(:notification).permit(:owner_id, :recipient_id, :trackable_id, :trackable_type, :message, :read)
+    end
+end

data/lib/generators/simple_notification/templates/notifications_index.html.haml

@@ -0,0 +1,4 @@
+%h1 Listing All Notifications
+
+- @notifications.each do |notification|
+  = render "notifications/show", notification_id: notification.id, read: true

data/lib/generators/simple_notification/templates/notifications_partial.html.haml

@@ -0,0 +1,31 @@
+- @notification = Notification.find(notification_id)
+- if read
+  - @notification.read = true
+- @notification.save
+.notification
+  %p
+    - if @notification.owner == nil
+      %b Guest
+    - else
+      %b
+        = link_to @notification.owner do
+          = @notification.owner.username
+
+    = @notification.message
+
+    - if @notification.trackable == nil
+      %b which has since been deleted
+    - else
+      %b
+        = link_to @notification.trackable do
+          = @notification.trackable_type
+    \|
+    This notification was sent to
+    - if @notification.recipient == nil
+      %b Deleted User
+    - else
+      %b
+        = link_to @notification.recipient do
+          = @notification.recipient.username
+    \|
+    = link_to 'Destroy', @notification, :method => :delete, :data => { :confirm => 'Are you sure?' }

data/lib/simple_notification.rb

@@ -0,0 +1,6 @@
+require "simple_notification/version"
+require "simple_notification/has_notifications"
+require "simple_notification/can_be_tracked"
+
+module SimpleNotification
+end

data/lib/simple_notification/can_be_tracked.rb

@@ -0,0 +1,21 @@
+module SimpleNotification
+  module Methods
+    def notify(recipient, trackable, message)
+      owner = current_user
+      owner = User.new if owner == nil
+
+      if owner == recipient
+        return
+      end
+
+      notification = Notification.create(owner_id: owner.id, recipient_id: recipient.id, message: message)
+      trackable.notifications << notification
+    end
+  end
+end
+
+class << ActiveRecord::Base
+  def can_be_tracked
+    has_many :notifications, as: :trackable
+  end
+end

data/lib/simple_notification/has_notifications.rb

@@ -0,0 +1,6 @@
+class << ActiveRecord::Base
+  def has_notifications
+    has_many :own_notifications, class_name: "Notification", foreign_key: :owner_id
+    has_many :received_notifications, class_name: "Notification", foreign_key: :recipient_id
+  end
+end

data/lib/simple_notification/version.rb

@@ -0,0 +1,3 @@
+module SimpleNotification
+  VERSION = "0.0.4"
+end

data/simple_notification.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_notification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_notification"
+  spec.version       = SimpleNotification::VERSION
+  spec.authors       = ["Cong Wang"]
+  spec.email         = ["findcongwang@gmail.com"]
+  spec.summary       = %q{Simple user notification module.}
+  spec.description   = %q{User notification system assuming user systems is built using the User model and has current_user helper. This gem uses the Notification model so must not be taken.}
+  spec.homepage      = "https://github.com/findcongwang"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: simple_notification
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Cong Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: User notification system assuming user systems is built using the User
+  model and has current_user helper. This gem uses the Notification model so must
+  not be taken.
+email:
+- findcongwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_notification/USAGE
+- lib/generators/simple_notification/simple_notification_generator.rb
+- lib/generators/simple_notification/templates/create_notifications.rb.erb
+- lib/generators/simple_notification/templates/notification.rb
+- lib/generators/simple_notification/templates/notifications_controller.rb
+- lib/generators/simple_notification/templates/notifications_css.css.scss
+- lib/generators/simple_notification/templates/notifications_index.html.haml
+- lib/generators/simple_notification/templates/notifications_partial.html.haml
+- lib/simple_notification.rb
+- lib/simple_notification/can_be_tracked.rb
+- lib/simple_notification/has_notifications.rb
+- lib/simple_notification/version.rb
+- simple_notification.gemspec
+homepage: https://github.com/findcongwang
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Simple user notification module.
+test_files: []