notifly 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77982bba3899b260f37bc98c4a95a56658bef69c
+  data.tar.gz: 8645e6bae431b62fa69743e026687984da53528a
+SHA512:
+  metadata.gz: 6b416b97f187382029ea72e5121a4d980872a50b6c3b1a1fb505904efdcb135e74e0231f2f9b99a49da15f4ff314cd779bdd3a766cf508b26a0f02ce5ecf8e56
+  data.tar.gz: eac2d4e0026728c73b91e74a05c7bb9bdd49f89d8c10466acf27b65194425d98283b92d50f7756d51a55450e3998d1a2e06e6e1b7d6c78b0a66b262efe0fe084

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,197 @@
+# Notifly
+
+This project intend to offer a full notification system, back and front-end.
+In actual version, notifications are composed by:
+
+  - Receiver (**required**): the object that will receive the notification
+  - Sender: who sent the notification
+  - Target: object that you will be the subject between the sender and receiver
+  - Data: hash where you can store more info about the notification
+  - Template (**required**): html template used by notification
+  - Read: flag that records if the receiver read the notification
+  - Seen: flag that records if the receiver seen the notification
+  - If and Unless: used to create notifications conditionally
+
+
+# Install
+
+First we need to add the gem to `Gemfile`
+
+```ruby
+  gem 'notifly'
+```
+
+Run the bundle command to install it. After that, you need to run the initializer
+
+```shell
+  $ rails generate notifly:install
+```
+
+You can choose to change the namespace for Notifly routes, but the default is `notifly`.
+It will creates `config/initializers/notifly.rb` too. Also, in this file you can
+see/change the default configs
+
+Notifly **need** to storage the notifications and to do it you need to run the migrations
+
+```shell
+  $ rake db:migrate
+```
+
+# Usage
+
+## Back-end
+
+We have two ways to create notifications: 
+
+#### 1. Using `#notifly` method in your classes (as callback)
+
+If you want to create notifications after (or before) **any** method call.
+
+```ruby
+class TicketOrder < ActiveRecord::Base
+  belongs_to :ticket
+  belongs_to :buyer
+  belongs_to :owner
+
+  notifly default_values: { receiver: :owner }
+
+  notifly before: :destroy, template: :destroy, sender: :buyer, data: :attributes
+  notifly after: :send_gift!, template: :ticket_gift, sender: :buyer,
+    target: :ticket, if: -> { completed? }
+  notifly after: :accept_gift, sender: :owner, receiver: :buyer, target: :ticket
+
+  def send_gift!
+    # code here
+  end
+
+  def accept_gift
+    # code here
+  end
+end
+```
+Value explanation about each parameter:
+
+| Parameter           | Value         |
+| ------------------- | ------------- |
+| `before` or `after` | The method which will create notification before or after its call |
+| `receiver`          | The method which returns the notification receiver object          |
+| `sender`            | The method which returns the notification sender object            |
+| `template`          | The symbol or string that indicates which partial will be rendered at views. The partial must be inside `app/views/notifly/templates/`. Default is `:default`. |
+| `target`            | The method which returns the notification target object. It's a third actor of the notification. Example: In "Max sent you a ticket" notification, Max is the sender, you are the receiver and the **ticket is the target**. |
+| `data`              | A method which returns a hash with usefull values to be persisted, like ticket price or whatever you want to persist. |
+
+Note that you can use the `default_values` parameter, it is specific to DRY your
+notiflies and set the values to all notiflies. If you need to overwrite some 
+default value, just declare it again like the `:accept_gift` notifly above.
+
+
+#### Using `#notifly!` method on your receiver object
+
+If you need to create notifications without callbacks, even in the 
+controller scope.
+
+```ruby
+class TicketOrder < ActiveRecord::Base
+  belongs_to :ticket
+  belongs_to :buyer
+  belongs_to :owner
+
+  before_destroy do
+    owner.notifly! template: :destroy, sender: :buyer, data: :attributes
+  end
+
+  def send_gift!
+    # code here
+
+    if completed?
+      owner.notifly! template: :ticket_gift, sender: :buyer, target: :ticket
+    end
+  end
+
+  def accept_gift
+    # code here
+
+    buyer.notifly! sender: :owner, target: :ticket
+  end
+end
+```
+
+The receiver will be always the object which you call `#notifly!`
+
+You can access the notifications using the following methods:
+
+  - `object.notiflies` (**TODO**)
+  - Querying `Notifly::Notifications`
+  - Using our front-end helpers
+
+## Front-end
+
+First, you need to have a `current_user` in `ApplicationController`, if you use
+[Devise](https://github.com/plataformatec/devise) it is already there.
+
+After that you need our assets, add them to your `application.js`
+
+```javascript
+//= require notifly
+```
+
+```css
+/*
+*= require notifly
+*/
+```
+
+Now finally you can see the notifications view adding code bellow to your view
+
+```html
+<%= notiflies %>
+```
+
+This will inject our views and it will be like that
+
+![image](http://upl.io/i/4i26o3.png)
+
+As you can see, notifications are rendered with their templates. It uses a simple
+default template but if you want to change it or create new ones run the code below
+or create them in `app/views/notifly/templates/_your_template.html.erb`
+
+```shell
+  $ rails generate notifly:views
+```
+
+Now if you want to customize the layout, just generate it adding the option `--layout`
+to the code above and change it as you want. But if you already have a layout and just
+want add our features to it, take a look at [Adapting your layout](#adapting).
+
+### <a name='adapting'></a> Adapting your layout
+
+All partials that we insert in your layout are in the gem or if you generated them,
+they will be in `app/views/notifly/layouts/`
+
+Above are the elements that will loading the Notifly in your layout
+
+  - **Counter**: this element will show how many notifications are not seen. It
+    should have the id `#notifly-counter`, and the html rendered in will be
+    the `_counter.html.erb`
+  - **Notifications icon**: this element is the trigger to load the notifications
+    and you should have an icon to show when the user "have notifications" and
+    "do not have notifications" this element should have the id `#notifly-icon`. The
+    html icon is defined in our view helper `notifly_icon` you can overwrite it,
+    just remember that this method should have the argument `have_notifications=false`
+    and is this method that tell us which icon will be in the view.
+  - **Notifications**: they will be inserted in `#notifly-notifications-container`,
+    this element will contain all notifications (`_notification.html.erb`) rendered
+    by `_index.html.erb`
+  - **Next page link**: this link will append the next notifications page to the
+    `#notifly-notifications-container`, this is rendered by `_footer.html.erb` and
+    will be injected in `#notifly-notifications-footer`
+  - **Loading**: html element that will be showing while the notifications request
+    isn't completed. It should be in `#notifly-notifications-container` and should
+    have the class `loading`
+  - **Mark as read**: this link will mark all notifications in the page as read,
+    it will be rendered in `#notifly-header-actions`
+  - **Toggle read**: this link will be rendered by `_actions.html.erb' in
+    `_notification.html.erb`
+
+
+

data/Rakefile

@@ -0,0 +1,23 @@
+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    = 'Notifly'
+  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
+

data/app/assets/javascripts/notifly.js

@@ -0,0 +1,5 @@
+//= require 'jquery'
+//= require 'jquery_ujs'
+//= require 'notifly/counter'
+//= require 'notifly/get_notifications'
+//= require 'twitter/bootstrap'

data/app/assets/javascripts/notifly/counter.js.erb

@@ -0,0 +1,23 @@
+<% notifly = Notifly::Engine.routes.url_helpers %>
+var notiflyCounterRequested;
+
+var _notiflyGetCounter = function (notiflyPath) {
+  var $counter = $('#notifly-counter');
+
+  if (!notiflyCounterRequested) {
+    $.ajax({
+      url: '<%= notifly.counter_notifications_path %>',
+      type: 'GET',
+      error: _notiflyHandleCounterError
+    });
+  }
+};
+
+
+var _notiflyHandleCounterError = function () {
+  notiflyCounterRequested = false;
+};
+
+$(document).ready(function() {
+  _notiflyGetCounter();
+});

data/app/assets/javascripts/notifly/get_notifications.js.erb

@@ -0,0 +1,26 @@
+<% notifly = Notifly::Engine.routes.url_helpers %>
+var notiflyNotificationsRequested;
+
+var _notiflyGetNotifications = function () {
+  var $notifly = $('#notifly-icon');
+
+  $notifly.click(function () {
+    if (!notiflyNotificationsRequested) {
+      notiflyNotificationsRequested = true;
+
+      $.ajax({
+        url: '<%= notifly.notifications_path %>',
+        type: 'GET',
+        error: _notiflyHandleNotificationsError
+      });
+    }
+  });
+};
+
+var _notiflyHandleNotificationsError = function () {
+  notiflyNotificationsRequested = false;
+};
+
+$(document).ready(function() {
+  _notiflyGetNotifications();
+});

data/app/assets/stylesheets/notifly.css

@@ -0,0 +1,5 @@
+/*
+*= require notifly/layout
+*= require twitter/bootstrap
+*= require font-awesome
+*/

data/app/assets/stylesheets/notifly/layout.css

@@ -0,0 +1,50 @@
+.notifly-counter-label {
+  padding: 3px 7px 3px 7px;
+  background: #cc0000;
+  color: #ffffff;
+  font-weight: bold;
+  border-radius: 9px;
+  -moz-border-radius: 9px;
+  -webkit-border-radius: 9px;
+  position: absolute;
+  margin-top: -8px;
+  margin-left: 12px;
+  font-size: 11px;
+}
+
+#notifly-notifications-panel {
+  padding: 0px !important;
+  border: 0px !important;
+}
+
+#notifly-notifications-header {
+  padding: 9px;
+  font-weight: bold;
+  font-size: 13px;
+  border-bottom: 1px solid #dddddd;
+}
+
+#notifly-notifications-footer {
+  padding: 9px;
+  text-align: center;
+  font-weight: bold;
+  font-size: 12px;
+  border-top: 1px solid #dddddd;
+}
+
+.notifly-notification-not-read {
+  background-color: #e9eaed;
+}
+
+.notifly-notification {
+  padding: 9px;
+}
+
+#notifly-notifications-panel {
+  width: 430px;
+}
+
+#notifly-notifications-content {
+  overflow-y: scroll;
+  max-height: 300px;
+}

data/app/controllers/notifly/application_controller.rb

@@ -0,0 +1,4 @@
+module Notifly
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/notifly/notifications_controller.rb

@@ -0,0 +1,36 @@
+require_dependency "notifly/application_controller"
+
+module Notifly
+  class NotificationsController < ApplicationController
+    def counter
+      @counter = count_unseen
+    end
+
+    def index
+      @notifications = current_user_notifications.page(params[:page]).per(Notifly.per_page)
+      Notifly::Notification.where(id: @notifications.map(&:id)).update_all(seen: true)
+      @counter = count_unseen
+    end
+
+
+    def read_specific
+      size = params[:pages].to_i * Notifly.per_page
+      @notifications = current_user_notifications.limit(size)
+      @notifications.update_all read: true
+    end
+
+    def toggle_read
+      @notification = Notifly::Notification.find(params[:notification_id])
+      @notification.update(read: !@notification.read)
+    end
+
+    private
+      def current_user_notifications
+        Notifly::Notification.all_from(current_user).order('created_at DESC')
+      end
+
+      def count_unseen
+        Notifly::Notification.unseen_from(current_user).count
+      end
+  end
+end

data/app/helpers/notifly/view_helper.rb

@@ -0,0 +1,17 @@
+module Notifly
+  module ViewHelper
+    def notiflies
+      notiflies_for current_user
+    end
+
+    def notiflies_for(receiver)
+      render partial: 'notifly/layouts/notifly', locals: { receiver: receiver }
+    end
+
+    def notifly_icon(have_notifications=false)
+      icon = have_notifications ? Notifly.icon : Notifly.icon_empty
+      size = Notifly.icon_size
+      fa_icon "#{icon} #{size}"
+    end
+  end
+end

data/app/models/notifly/notification.rb

@@ -0,0 +1,27 @@
+module Notifly
+  class Notification < ActiveRecord::Base
+    belongs_to :target, polymorphic: true
+    belongs_to :sender, polymorphic: true
+    belongs_to :receiver, polymorphic: true
+
+    before_validation :convert_data, :set_template
+
+    scope :all_from,    ->(receiver) { where(receiver: receiver) }
+    scope :unseen_from, ->(receiver) { where(receiver: receiver, seen: false) }
+
+    validates :receiver, :template, presence: true
+
+    def data
+      YAML.load(read_attribute(:data))
+    end
+
+    private
+      def convert_data
+        self.data = read_attribute(:data).to_json
+      end
+
+      def set_template
+        self.template ||= :default
+      end
+  end
+end

data/app/views/notifly/layouts/_actions.html.erb

@@ -0,0 +1,4 @@
+<!-- This partial requires the locals: notification -->
+
+<% link_text = notification.read ? 'unread' : 'read' %>
+<%= link_to link_text, notification_toggle_read_path(notification), method: :put, remote: true %>

data/app/views/notifly/layouts/_counter.html.erb

@@ -0,0 +1,4 @@
+<!-- This partial requires the locals: counter -->
+<span class="notifly-counter-label <%= counter > 0 ? '' : 'hide' %>">
+  <%= counter %>
+</span>

data/app/views/notifly/layouts/_footer.html.erb

@@ -0,0 +1,3 @@
+<!-- This partial requires the locals: notifications -->
+
+<%= link_to_next_page notifications, 'More', remote: true, id: 'notifly-next-page' %>

data/app/views/notifly/layouts/_index.html.erb

@@ -0,0 +1,6 @@
+<!-- This partial requires the locals: notifications -->
+
+<% notifications.each do |notification| %>
+  <%= render partial: 'notifly/layouts/notification',
+    locals: { notification: notification } %>
+<% end %>

data/app/views/notifly/layouts/_notification.html.erb

@@ -0,0 +1,12 @@
+<!-- This partial requires the locals: notification -->
+
+<% read = notification.read ? '' : 'notifly-notification-not-read' %>
+
+<div id='<%= "notifly-notification-#{notification.id}" %>' class="notifly-notification <%= read %>">
+  <%= render partial: "notifly/templates/#{notification.template}",
+    locals: { notification: notification } %>
+
+  <span class="notifly-notification-actions">
+    <%= render partial: 'notifly/layouts/actions', locals: { notification: notification }  %>
+  </span>
+</div>

data/app/views/notifly/layouts/_notifly.html.erb

@@ -0,0 +1,25 @@
+<!-- This partial requires the locals: receiver -->
+
+<div id="notifly" class="dropdown">
+
+  <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+    <span id="notifly-counter"></span>
+    <span id="notifly-icon"><%= notifly_icon %></span>
+  </a>
+
+
+  <div id="notifly-notifications-panel" class="dropdown-menu">
+    <div id="notifly-notifications-header">
+      Notifications
+
+      <span id="notifly-header-actions" class="pull-right">
+      </span>
+    </div>
+
+    <div id="notifly-notifications-content">
+       <div class="loading">Loading notifications...</div>
+    </div>
+
+    <div id="notifly-notifications-footer"></div>
+  </div>
+</div>

data/app/views/notifly/notifications/counter.js.erb

@@ -0,0 +1,2 @@
+$('#notifly-counter').html("<%= escape_javascript(render 'notifly/layouts/counter', counter: @counter)%>");
+$('#notifly-icon').html("<%= escape_javascript notifly_icon(@counter > 0) %>")

data/app/views/notifly/notifications/index.js.erb

@@ -0,0 +1,20 @@
+<%
+  rendered_notifications = render partial: 'notifly/layouts/index',
+    locals: { notifications: @notifications }
+
+  notifications_pages = { pages: @notifications.current_page }
+  rendered_header_actions = link_to 'Mark as read', read_specific_notifications_path(notifications_pages),
+    remote: true, method: :put
+
+  rendered_footer = render partial: 'notifly/layouts/footer',
+    locals: { notifications: @notifications }
+%>
+
+$('#notifly-header-actions').html("<%= escape_javascript rendered_header_actions %>");
+
+$('#notifly-notifications-content .loading').remove();
+$('#notifly-notifications-content').append("<%= escape_javascript rendered_notifications %>");
+$('#notifly-notifications-footer').html("<%= escape_javascript rendered_footer %>");
+
+$('#notifly-counter').html("<%= escape_javascript(render 'notifly/layouts/counter', counter: @counter)%>");
+$('#notifly-icon').html("<%= escape_javascript notifly_icon(@counter > 0) %>")

data/app/views/notifly/notifications/read_specific.js.erb

@@ -0,0 +1,4 @@
+<% rendered_index = render partial: 'notifly/layouts/index',
+  locals: { notifications: @notifications } %>
+
+$('#notifly-notifications-content').html("<%= escape_javascript rendered_index %>");

data/app/views/notifly/notifications/toggle_read.js.erb

@@ -0,0 +1,5 @@
+<% rendered_notification = render partial: 'notifly/layouts/notification',
+  locals: { notification: @notification } %>
+
+$('<%= "#notifly-notification-#{@notification.id}" %>')
+  .replaceWith('<%= escape_javascript rendered_notification %>')

data/app/views/notifly/templates/_default.html.erb

@@ -0,0 +1,3 @@
+<!-- This partial requires the locals: notification -->
+
+<%= notification.receiver.name %>, you receive a new notification at <%= notification.created_at %>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Notifly::Engine.routes.draw do
+  resources :notifications, only: [:index] do
+    put :toggle_read
+
+    collection do
+      get :counter
+      put :update_counter
+      put :read_specific
+    end
+  end
+end

data/db/migrate/20141103170528_create_notifly_notifications.rb

@@ -0,0 +1,13 @@
+class CreateNotiflyNotifications < ActiveRecord::Migration
+  def change
+    create_table :notifly_notifications do |t|
+      t.string :template
+      t.boolean :read, default: false
+      t.references :target, index: true, polymorphic: true
+      t.references :sender, index: true, polymorphic: true
+      t.references :receiver, index: true, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141104150224_add_data_to_notification.rb

@@ -0,0 +1,5 @@
+class AddDataToNotification < ActiveRecord::Migration
+  def change
+    add_column :notifly_notifications, :data, :text
+  end
+end

data/db/migrate/20141117193436_add_seen_to_notifly_notification.rb

@@ -0,0 +1,5 @@
+class AddSeenToNotiflyNotification < ActiveRecord::Migration
+  def change
+    add_column :notifly_notifications, :seen, :boolean, default: false
+  end
+end

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

@@ -0,0 +1,22 @@
+require File.expand_path('../utils', __FILE__)
+
+module Notifly
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Generators::Utils::InstanceMethods
+      source_root File.expand_path('../templates', __FILE__)
+      argument :namespace, type: :string, required: false, desc: 'Notifly url namespace'
+
+      desc 'Notifly installation generator'
+
+      def mount_engine
+        namespace = ask_for('Where do you want to mount Notifly?', 'notifly', namespace)
+        route("mount Notifly::Engine => '/#{namespace}', as: 'notifly'")
+      end
+
+      def copy_config
+        template "config/initializers/notifly.rb"
+      end
+    end
+  end
+end

data/lib/generators/notifly/install/templates/config/initializers/notifly.rb

@@ -0,0 +1,4 @@
+Notifly.setup do |config|
+  # Define how many notifications per page.
+  config.per_page = 10
+end

data/lib/generators/notifly/install/utils.rb

@@ -0,0 +1,21 @@
+# github.com/sferik/rails_admin/blob/master/lib/generators/rails_admin/utils.rb
+
+module Notifly
+  module Generators
+    module Utils
+      module InstanceMethods
+        def display(output, color = :green)
+          say("           -  #{output}", color)
+        end
+
+        def ask_for(wording, default_value = nil, override_if_present_value = nil)
+          if override_if_present_value.present?
+            display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value
+          else
+            ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/notifly/views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create Notifly views in your application
+
+Example:
+    rails generate notifly:views:templates
+
+    This will create:
+        app/views/notifly/templates/default.html.erb

data/lib/generators/notifly/views/views_generator.rb

@@ -0,0 +1,22 @@
+module Notifly
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../../app/views/notifly', __FILE__)
+      class_option :layout, type: :boolean, default: false, desc: 'Include layout files.'
+
+      def copy_views
+        copy_file 'templates/_default.html.erb', "#{main_app_path}/templates/_default.html.erb"
+        layout_files if options.layout?
+      end
+
+      private
+        def main_app_path
+          'app/views/notifly'
+        end
+
+        def layout_files
+          directory 'layouts', "#{main_app_path}/layouts"
+        end
+    end
+  end
+end

data/lib/notifly.rb

@@ -0,0 +1,24 @@
+require 'notifly/engine'
+require 'notifly/railtie'
+require 'font-awesome-rails'
+
+module Notifly
+  # How many notifications per page.
+  mattr_accessor :per_page
+  @@per_page = 10
+
+  mattr_accessor :icon_size
+  @@icon_size = '2x'
+
+  mattr_accessor :icon
+  @@icon = 'bell'
+
+  mattr_accessor :icon_empty
+  @@icon_empty = 'bell-o'
+
+  # Default way to setup Notifly. Run rails generate notifly:install to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+end

data/lib/notifly/engine.rb

@@ -0,0 +1,22 @@
+require 'jquery-rails'
+require 'kaminari'
+
+module Notifly
+  class Engine < ::Rails::Engine
+    isolate_namespace Notifly
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    # http://pivotallabs.com/leave-your-migrations-in-your-rails-engines/
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/notifly/models/base.rb

@@ -0,0 +1,13 @@
+require_relative 'notifiable'
+require_relative 'flyable'
+
+module Notifly
+  module Models
+    module Base
+      extend ActiveSupport::Concern
+
+      include Notifly::Models::Notifiable
+      include Notifly::Models::Flyable
+    end
+  end
+end

data/lib/notifly/models/flyable.rb

@@ -0,0 +1,127 @@
+require_relative 'options/fly'
+
+module Notifly
+  module Models
+    module Flyable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        attr_reader :flies, :default_fly, :flyable_callbacks
+
+        def notifly(options = {})
+          @flies ||= []
+          @flyable_callbacks ||= []
+
+          fly = Notifly::Models::Options::Fly.new options
+
+          if options[:default_values]
+            @default_fly = fly
+          else
+            @flies << fly
+
+            if [:create, :save, :update, :destroy].include? fly.method_name
+              _create_callback_for_active_record_from fly
+            end
+          end
+        end
+
+        def method_added(method_name)
+          _create_callbacks_for method_name
+          super
+        end
+
+        private
+          def _create_callbacks_for(method_name)
+            method_flies = _flies_for method_name
+
+            method_flies.each do |fly|
+              _create_callback_for_instance_method_from(fly)
+            end
+          end
+
+          def _flies_for(method_name)
+            if flies.present?
+              flies.select { |fly| fly.method_name == method_name }
+            else
+              []
+            end
+          end
+
+          def _create_callback_for_active_record_from(fly)
+            callback_name = "#{fly.hook}_#{fly.method_name}"
+            flyable_callbacks << "#{callback_name}_#{fly.object_id}"
+
+            send(callback_name, if: fly.if, unless: fly.unless) do |record|
+              _create_notification_for(fly)
+            end
+          end
+
+          def _create_callback_for_instance_method_from(fly)
+            notifly_callback_name = _format_callback_name_for(fly)
+
+            if not flyable_callbacks.include? notifly_callback_name
+              flyable_callbacks << notifly_callback_name
+
+              define_callbacks notifly_callback_name
+              set_callback notifly_callback_name, fly.hook, if: fly.if, unless: fly.unless do |record|
+                _create_notification_for(fly)
+              end
+
+              old_method = instance_method(fly.method_name)
+
+              define_method(fly.method_name) do |*args|
+                run_callbacks(notifly_callback_name) do
+                  old_method.bind(self).call(*args)
+                end
+              end
+            end
+          end
+
+          def _format_callback_name_for(fly)
+            ending_chars = {
+              '!' => :_dangerous,
+              '?' => :_question
+            }
+
+            method_name = fly.method_name.to_s.gsub(/(?<char>[\?|\!])/, ending_chars)
+
+            "notifly_#{fly.hook}_#{method_name}_#{fly.object_id}"
+          end
+      end
+
+      def _create_notification_for(fly)
+        new_fly = _default_fly.merge(fly)
+        Notifly::Notification.create! _get_attributes_from(new_fly)
+      end
+
+      def notifly_notifications(options={})
+        Notifly::Notification.where(receiver: self)
+      end
+
+      private
+        def _default_fly
+          self.class.default_fly || Notifly::Models::Options::Fly.new
+        end
+
+        def _get_attributes_from(fly)
+          evaluated_attributes = {}
+
+          fly.attributes.each do |key, value|
+            evaluated_attributes[key] = _eval_for(key, value)
+          end
+
+          evaluated_attributes
+        end
+
+        def _eval_for(key, value)
+          if key.to_sym == :template
+            value
+          elsif value == :self
+            self
+          else
+            send(value)
+          end
+        end
+    end
+  end
+end

data/lib/notifly/models/notifiable.rb

@@ -0,0 +1,11 @@
+module Notifly
+  module Models
+    module Notifiable
+      extend ActiveSupport::Concern
+
+      def notifly!(args={})
+        Notifly::Notification.create! args.merge(receiver: self)
+      end
+    end
+  end
+end

data/lib/notifly/models/options/fly.rb

@@ -0,0 +1,37 @@
+module Notifly
+  module Models
+    module Options
+      class Fly
+        attr_accessor :before, :after, :template, :sender, :receiver, :target,
+          :if, :unless, :data
+
+        def initialize(options={})
+          options = options.fetch(:default_values, options)
+          options.each { |key, value| try "#{key}=", value }
+        end
+
+        def hook
+          if @before.nil?
+            :after
+          else
+            :before
+          end
+        end
+
+        def method_name
+          self.send(hook)
+        end
+
+        def attributes
+          instance_values.reject { |key| [hook, :if, :unless].include? key.to_sym  }
+        end
+
+        def merge(fly)
+          raise TypeError, "#{fly} is not a Fly" unless fly.is_a? self.class
+
+          Notifly::Models::Options::Fly.new attributes.merge(fly.attributes)
+        end
+      end
+    end
+  end
+end

data/lib/notifly/railtie.rb

@@ -0,0 +1,14 @@
+require_relative '../../app/helpers/notifly/view_helper'
+require_relative 'models/base'
+
+module Notifly
+  class Railtie < Rails::Railtie
+    initializer 'Notifly.view_helpers' do
+      ActionView::Base.send :include, ViewHelper
+    end
+
+    initializer 'Notifly.active_model_helpers' do
+      ActiveRecord::Base.send :include, Notifly::Models::Base
+    end
+  end
+end

data/lib/notifly/version.rb

@@ -0,0 +1,3 @@
+module Notifly
+  VERSION = '0.0.3'
+end

data/lib/tasks/notifly_tasks.rake

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

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: notifly
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Pedro Passalini
+- Rafael Carvalho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: This project intend to offer a full notification system, back and front-end.
+email:
+- henrique.passalini@gmail.com
+- rafael@algorich.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/notifly.js
+- app/assets/javascripts/notifly/counter.js.erb
+- app/assets/javascripts/notifly/get_notifications.js.erb
+- app/assets/stylesheets/notifly.css
+- app/assets/stylesheets/notifly/layout.css
+- app/controllers/notifly/application_controller.rb
+- app/controllers/notifly/notifications_controller.rb
+- app/helpers/notifly/view_helper.rb
+- app/models/notifly/notification.rb
+- app/views/notifly/layouts/_actions.html.erb
+- app/views/notifly/layouts/_counter.html.erb
+- app/views/notifly/layouts/_footer.html.erb
+- app/views/notifly/layouts/_index.html.erb
+- app/views/notifly/layouts/_notification.html.erb
+- app/views/notifly/layouts/_notifly.html.erb
+- app/views/notifly/notifications/counter.js.erb
+- app/views/notifly/notifications/index.js.erb
+- app/views/notifly/notifications/read_specific.js.erb
+- app/views/notifly/notifications/toggle_read.js.erb
+- app/views/notifly/templates/_default.html.erb
+- config/routes.rb
+- db/migrate/20141103170528_create_notifly_notifications.rb
+- db/migrate/20141104150224_add_data_to_notification.rb
+- db/migrate/20141117193436_add_seen_to_notifly_notification.rb
+- lib/generators/notifly/install/install_generator.rb
+- lib/generators/notifly/install/templates/config/initializers/notifly.rb
+- lib/generators/notifly/install/utils.rb
+- lib/generators/notifly/views/USAGE
+- lib/generators/notifly/views/views_generator.rb
+- lib/notifly.rb
+- lib/notifly/engine.rb
+- lib/notifly/models/base.rb
+- lib/notifly/models/flyable.rb
+- lib/notifly/models/notifiable.rb
+- lib/notifly/models/options/fly.rb
+- lib/notifly/railtie.rb
+- lib/notifly/version.rb
+- lib/tasks/notifly_tasks.rake
+homepage: https://github.com/algorich/notifly
+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.2
+signing_key: 
+specification_version: 4
+summary: A full notification system
+test_files: []