notifly 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92f6c588e4f3502444595b31560180669c637cd9
-  data.tar.gz: 302667266d98f457bd82e4e622daccb84ca0c62c
+  metadata.gz: 199c4354275abe7fdd5dfbc605a68a17205477ec
+  data.tar.gz: 83ab9a0f55faaba7ff98f6fbf6e68919fbf8d963
 SHA512:
-  metadata.gz: 6754215c7d59660b4b2e535b370776b2fc4a8b6431c234a42f8872e80bcb83c4d8e08ea2aff68d5716be2b4952c2857176482c42f43f8e07f4036c0845c50080
-  data.tar.gz: 4a1fcda0742faafb2d8b35f9296500ed90a7026d0f63cc5c7756d2884952d7a3eae1af5d56ca9279301fae9f775bfb7b080c8f3b1a655fb9aa6d8177e4608582
+  metadata.gz: e78062c032b1bab6bb4ca30983d91ce80564051deac0ba68dc044aa9d49012f8aa828684bedeb154e450abc1b348e46b3ed6bcd0747ac9cbfa93873181e97b8e
+  data.tar.gz: bbb624c480c39326c2fef39a1b5028223c08a7220ba4aec51241cd3bdea3b19b10cfdf84b40a7df5fe10d17eba3a8743a0bb6939ad81cfb8eef775544d451e30

data/README.md

@@ -187,6 +187,10 @@ You can access the notifications using the following methods:
   - unseen: used on `Notifly::Notifications` and `#notifly_notifications` to show **only** unseen notifications
   - not_only-mail: used on `Notifly::Notifications` and `#notifly_notifications` to remove notification that are **mail only**
 
+### Websocket
+
+If you want to use websocket just install the gem [websocket-rails](https://github.com/websocket-rails/websocket-rails/wiki/Installation-and-Setup) and change the notifly's configuration
+at `config/initializers/notifly.rb`
 
 ## Front-end
 
@@ -249,7 +253,8 @@ Notifications and Mails are rendered with their templates. They use a simple def
 template but if you want to change or create new ones run the generate above
 with the option that you want or create them in `app/views/notifly/templates/`.
 Remember that notifications templates should be in `notifications` folder and
-mails templates in `mails` folder.
+mails templates in `mails` folder and with **both** you need to use the `main_app`
+to render links.
 
 If you already have a layout and just want add our features to it, take a look
 at [Adapting your layout](#adapting).

data/app/assets/javascripts/{notifly.js → notifly.js.erb}

@@ -5,6 +5,7 @@
 //= require 'notifly/seen_notifications'
 //= require 'notifly/read_notifications'
 //= require 'notifly/more_notifications'
+<% require_asset 'notifly/real_time' if Notifly.websocket %>
 
 $(document).ready(function() {
   $(document).on('click', '#notifly-notifications-panel.dropdown-menu', function (e) {

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

@@ -1,6 +1,10 @@
 <% notifly = Notifly::Engine.routes.url_helpers %>
 var notiflyLastNotification, notiflyFirstNotification;
 
+$(document).ready(function() {
+  _notiflyGetNotifications();
+});
+
 var _notiflyGetNotifications = function () {
   var $notifly = $('#notifly');
 
@@ -19,9 +23,7 @@ var _notiflyGetNotifications = function () {
 };
 
 var _notiflyRepeatRequest = function () {
-  setTimeout(_notiflyGetNotifications, <%= Notifly.timeout %>);
+  <% if not Notifly.websocket %>
+    setTimeout(_notiflyGetNotifications, <%= Notifly.timeout %>);
+  <% end %>
 };
-
-$(document).ready(function() {
-  _notiflyGetNotifications();
-});

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

@@ -1,5 +1,10 @@
 <% notifly = Notifly::Engine.routes.url_helpers %>
 
+$(document).ready(function() {
+  _notiflyReadNotifications();
+  _notiflyReadNotificationWithLink();
+});
+
 var _notiflyReadNotifications = function () {
   var $notifly = $('#notifly-mark-as-read-link');
 
@@ -17,6 +22,19 @@ var _notiflyReadNotifications = function () {
   }
 };
 
-$(document).ready(function() {
-  _notiflyReadNotifications();
-});
+var _notiflyReadNotificationWithLink = function () {
+  if ($('#notifly').length > 0) {
+    $('#notifly').on('click', '.notifly-notification-message a', function () {
+      var notificationId =  $(this).closest('div.notifly-notification').data('id');
+
+      $.ajax({
+        url: '<%= notifly.notification_toggle_read_path %>',
+        data: {
+          notification_id: notificationId,
+          read: true
+        },
+        type: 'PUT'
+      });
+    });
+  }
+};

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

@@ -0,0 +1,26 @@
+window.dispatcher = new WebSocketRails(location.host + '/websocket');
+var notiflyFirstNotification;
+
+$(function () {
+  var $notifly = $('#notifly');
+
+  if ($notifly !== undefined) {
+    dispatcher.bind('notifly.notifications.new', _injectNotificationFrom);
+  }
+});
+
+var _injectNotificationFrom = function (data) {
+  if (data.message) {
+    $('#notifly-notifications-content .notifly-empty').remove();
+    notiflyFirstNotification = data.id;
+
+    if (!$('#notifly').hasClass('open')) {
+      $counter = $('#notifly-counter');
+      $counter.html(eval($counter.html()) + 1);
+      $counter.removeClass('hide');
+    }
+
+    return $('#notifly').find('#notifly-notifications-content')
+      .prepend(data.message)
+  }
+};

data/app/controllers/notifly/notifications_controller.rb

@@ -19,7 +19,7 @@ module Notifly
 
     def toggle_read
       @notification = Notifly::Notification.find(params[:notification_id])
-      @notification.update(read: !@notification.read)
+      @notification.update(read: params[:read] || !@notification.read)
     end
 
     def seen

data/app/models/notifly/notification.rb

@@ -5,23 +5,24 @@ module Notifly
     belongs_to :receiver, polymorphic: true
 
     before_validation :set_defaults
+    after_create :send_to_receiver, if: -> { Notifly.websocket }
 
     scope :all_from,      -> (receiver) { where(receiver: receiver) }
     scope :unseen,        -> { where(seen: false) }
     scope :not_only_mail, -> { where.not(mail: 'only') }
     scope :limited,       -> { limit(Notifly.per_page) }
-    scope :ordered,       -> { order('created_at DESC') }
+    scope :ordered,       -> { order('notifly_notifications.created_at DESC') }
     scope :newer,         ->(than: nil) do
       return ordered if than.blank?
 
       reference = find_by(id: than)
-      ordered.where('created_at > ?', reference.created_at).where.not(id: reference)
+      ordered.where('notifly_notifications.created_at > ?', reference.created_at).where.not(id: reference)
     end
     scope :older,         ->(than: nil) do
       reference = find_by(id: than)
 
       ordered.
-      where('created_at < ?', reference.created_at).
+      where('notifly_notifications.created_at < ?', reference.created_at).
       where.not(id: reference)
     end
     scope :between,       ->(first, last) do
@@ -39,5 +40,9 @@ module Notifly
         self.kind     ||= :notification
         self.template ||= :default
       end
+
+      def send_to_receiver
+        Notifly::NotificationChannel.new(self.receiver_id).trigger(self)
+      end
   end
 end

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

@@ -2,9 +2,11 @@
 
 <% read = notification.read ? '' : 'notifly-notification-not-read' %>
 
-<div id='<%= "notifly-notification-#{notification.id}" %>' class="notifly-notification <%= read %>">
-  <%= render partial: "notifly/templates/notifications/#{notification.template}",
-    locals: { notification: notification } %>
+<div id='<%= "notifly-notification-#{notification.id}" %>' class="notifly-notification <%= read %>" data-id="<%= notification.id %>">
+  <div class="notifly-notification-message">
+    <%= render partial: "notifly/templates/notifications/#{notification.template}",
+      locals: { notification: notification } %>
+  </div>
 
   <span class="notifly-notification-actions">
     <%= render partial: 'notifly/layouts/actions', locals: { notification: notification }  %>

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

@@ -1,4 +1,4 @@
-<div id="notifly" class="dropdown keep_open">
+<div id="notifly" class="dropdown keep_open" data-user-id="<%= current_user.id %>">
 
   <a id="notifly-trigger" href="#" class="dropdown-toggle" data-toggle="dropdown">
     <span id="notifly-counter"></span>

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

@@ -1,17 +1,17 @@
-<% rendered_notifications = render partial: 'notifly/layouts/index',
-  locals: { notifications: @notifications } %>
-<% last_notification = @notifications.last.try(:id) %>
-<% first_notification = @notifications.first.try(:id) %>
-
 $('#notifly-notifications-content .notifly-loading').remove();
 $('#notifly-notifications-content .notifly-empty').remove();
 
 <% if @notifications.any? %>
+  <% rendered_notifications = render partial: 'notifly/layouts/index',
+    locals: { notifications: @notifications } %>
+  <% last_notification = @notifications.last.try(:id) %>
+  <% first_notification = @notifications.first.try(:id) %>
 
   <% if @scope_param == 'older' %>
-    $('#notifly-notifications-content').append("<%= j rendered_notifications %>");
+     $('#notifly-notifications-content').append("<%= j rendered_notifications %>");
     notiflyLastNotification = <%= last_notification %>;
 
+    $('#notifly-notifications-content').scrollTop($('<%= "#notifly-notification-#{first_notification}" %>').offset().top);
   <% else %>
     $('#notifly-notifications-content').prepend("<%= j rendered_notifications %>");
     notiflyFirstNotification = <%= first_notification %>;

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

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

data/config/routes.rb

@@ -1,7 +1,7 @@
 Notifly::Engine.routes.draw do
-  resources :notifications, only: [:index] do
-    put :toggle_read
+  put '/notifications/(:notification_id)/toggle_read', to: 'notifications#toggle_read', as: :notification_toggle_read
 
+  resources :notifications, only: [:index] do
     collection do
       put :read
       put :seen

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

@@ -13,4 +13,7 @@ Notifly.setup do |config|
 
   # Define your mailer sender
   config.mailer_sender = 'change-me-at-config-initializers-notifly@exemple.com'
+
+  # Active websocket
+  config.websocket = false
 end

data/lib/notifly.rb

@@ -1,6 +1,9 @@
 require 'notifly/engine'
 require 'notifly/railtie'
+require 'services/notification_channel'
+require 'services/action_view_helper'
 require 'font-awesome-rails'
+require 'websocket-rails'
 
 module Notifly
   # How many notifications per page.
@@ -19,9 +22,14 @@ module Notifly
   mattr_accessor :mailer_sender
   @@mailer_sender = 'change-me-at-config-initializers-notifly@exemple.com'
 
+  # Timeout used when notifly get new notifications per request
   mattr_accessor :timeout
   @@timeout = 10000
 
+  # Active websocket
+  mattr_accessor :websocket
+  @@websocket = false
+
   # Default way to setup Notifly. Run rails generate notifly:install to create
   # a fresh initializer with all configuration values.
   def self.setup

data/lib/services/action_view_helper.rb

@@ -0,0 +1,19 @@
+class ActionViewHelper
+  attr_reader :action_view
+  delegate *ActionView::Base.instance_methods, to: :action_view
+
+  def initialize
+    notifly_path = File.expand_path(File.dirname(File.dirname(__FILE__))) + '../../app/views/notifly'
+    ActionController::Base.prepend_view_path(notifly_path)
+    @action_view = ActionView::Base.new(ActionController::Base.view_paths)
+    @action_view.extend ApplicationHelper
+
+    @action_view.class_eval do
+      include Notifly::Engine.routes.url_helpers
+
+      def protect_against_forgery?
+        false
+      end
+    end
+  end
+end

data/lib/services/notification_channel.rb

@@ -0,0 +1,19 @@
+module Notifly
+  class NotificationChannel
+    def initialize(user_id)
+      @user_id = user_id
+      @channel = WebsocketRails.users[@user_id.to_s]
+      @action_view = ActionViewHelper.new
+    end
+
+    def trigger(notification)
+      @channel.send_message 'notifly.notifications.new',
+        { message: render(notification), id: notification.id }
+    end
+
+    def render(notification)
+      @action_view.render partial: 'layouts/notification',
+        locals: { notification: notification }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifly
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Pedro Passalini
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: better_errors
   requirement: !ruby/object:Gem::Requirement
@@ -170,10 +212,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/notifly.js
+- app/assets/javascripts/notifly.js.erb
 - app/assets/javascripts/notifly/get_notifications.js.erb
 - app/assets/javascripts/notifly/more_notifications.js.erb
 - app/assets/javascripts/notifly/read_notifications.js.erb
+- app/assets/javascripts/notifly/real_time.js.erb
 - app/assets/javascripts/notifly/seen_notifications.js.erb
 - app/assets/javascripts/notifly_dropdown.js
 - app/assets/stylesheets/notifly.css
@@ -215,6 +258,8 @@ files:
 - lib/notifly/models/notifiable.rb
 - lib/notifly/models/options/fly.rb
 - lib/notifly/railtie.rb
+- lib/services/action_view_helper.rb
+- lib/services/notification_channel.rb
 - lib/tasks/notifly_tasks.rake
 - vendor/assets/javascripts/tinycon.js
 - vendor/assets/javascripts/twitter/bootstrap/dropdown.js