eventifier 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15920100b421b49950f3d1e3423514d8c2a8ecd8
+  data.tar.gz: 8b5c7df0a4c737676a07c8d00ff9a694070a872f
+SHA512:
+  metadata.gz: e96258ba280481331e93dfc861fc26e22b5525e19ac8890e71d71efde10a54e3e0018ed67b191668c8b63fef95f7cfb8938ade01e8036b9717460695aa36669e
+  data.tar.gz: 37e145a2626ebaf891cff51bf77be2846fca4a99b4d52a4ac19be066f5aaeb73285f1d90a64826b822cc32b83b0ca5352f7bcbf6f899b421171f3a76db803a6a

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
+Gemfile.lock
 tmp
 .idea/*

data/.travis.yml

@@ -1,14 +1,13 @@
 language: ruby
 rvm:
-  # - 1.8.7
   - 1.9.2
   - 1.9.3
-  # - jruby-18mode # JRuby in 1.8 mode
   # - jruby-19mode # JRuby in 1.9 mode
-
-env:
-  - ORM=active_record
-  - ORM=mongoid
-
 before_script:
-  - psql -c 'create database eventifier;' -U postgres
+  - psql -c 'create database eventifier;' -U postgres
+notifications:
+  campfire:
+    rooms:
+      - secure: "PZeuyuOFIPVzA6Lr4unFdatKz/hYlwk8LRBK1DMWl7lPWL4RSxoCVY/Lh5mK\nj+1bYtPM73WL38xNLDsXeD6YpS1CkB66PaUcmhP+EnyH+5L1NZ2hKJG1zY4x\njC2ux6hKSstmQheRlIBaWhHUpGqZkoDUPxAI4C1qz44FkfHtI40="
+    on_success: change
+    on_failure: change

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in eventifier.gemspec
-gemspec
+gemspec

data/README.textile

@@ -19,7 +19,6 @@ class EventTracking
     events_for Post do
       track_on [:create, :update, :destroy], :attributes => { :except => %w(updated_at) }
       notify :group => :members, :on => [:create, :update]
-      url -> post { [post.category, post] }
     end
 
     events_for Announcement do
@@ -36,13 +35,55 @@ h2. Installation
 
 <pre><code>
   rails generate eventifier:install
+  rake eventifier:install:migrations
+</code></pre>
+
+h4. Add required gems
+
+<pre><code>
+  # Gemfile
+  group :assets do
+    gem 'compass-rails'
+    gem 'haml_coffee_assets'
+    gem 'jbuilder'
+  end
+</code></pre>
+
+h4. Add stylesheets
+
+<pre><code>
+  # app/assets/stylesheets/application.scss
+  /*= require eventifier/notifications*/
+</code></pre>
+
+h4. Add javascript
+
+<pre><code>
+  # app/assets/javascripts/application.coffee
+  #= require eventifier/notifications
+
+  new NotificationDropdown el: $(".notifications")
+</code></pre>
+
+h4. Add the required routes
+
+<pre><code>
+  # config/routes.rb
+  mount Eventifier::Engine => '/'
+</code></pre>
+
+h2. Sending of emails
+
+You want to add a scheduled task to run the following task every x minutes
+
+<pre><code>
+  rake eventifier:email:deliver
 </code></pre>
 
 h2. Requirements
 
 * ActiveRecord
 
-
 h2. Testing
 
 Creating the database:
@@ -55,4 +96,4 @@ Spec
 
 h2. Contributors
 
-* PJ Murray
+* PJ Murray

data/app/assets/javascripts/eventifier/notifications.coffee

@@ -0,0 +1,196 @@
+#= require hamlcoffee
+#= require ./templates/dropdown
+#= require ./templates/settings
+# Usage
+# window.notifications = new NotificationDropdown el: $('.notifications'), limit: 5
+
+class window.NotificationDropdown
+  template: JST['eventifier/templates/dropdown']
+  settingsTemplate: JST['eventifier/templates/settings']
+
+  constructor: (options) ->
+    {@el, @limit, @pollTime} = options
+    @limit =    @limit || 5
+    @pollTime = @pollTime || 15
+
+
+    [@notifications, @renderedNotifications, @unreadCount, @lastReadAt] = [[], [], 0, new Date()]
+
+    @render()
+    @loadMore(limit: 14)
+
+  render: =>
+    @el.html(@template(@)).attr('tabindex', 0)
+
+    @checkVisibility()
+    @setEvents()
+    @poll()
+
+  checkVisibility: =>
+    @el.addClass("notifications_active").find('#notification_dropdown').attr('opacity': 0)
+    @el.find('#notification_dropdown').offset (index, coords)=>
+      coords.left = 10 if coords.left < 0
+      if coords.left + @el.find('#notification_dropdown').width() > $(window).width()
+        coords.left = $(window).width() - @el.find('#notification_dropdown').width() - 5
+
+      @el.find('#notification_dropdown').offset coords
+
+      if @el.find('#notification_dropdown').position().left > -@el.find('#notification_dropdown').width()/2
+        @el.find('#notification_dropdown').addClass('left_nipple')
+
+    @el.removeClass("notifications_active").find('#notification_dropdown').attr('opacity': 1)
+
+  setEvents: =>
+    @el.on 'click', '.toggle_dropdown', @toggleDropdown
+    @el.on 'click', '.toggle_settings', @toggleSettings
+    @el.on 'click', '#email_settings_default',   @defaultSettings
+    @el.on 'click', '.save_settings',   @saveSettings
+    @el.on 'addNotifications', @renderNotifications
+    @el.on 'addNotifications', @setUnreadCount
+    @el.on 'poll', @poll
+    @el.on 'scroll', 'ol', @scrolling
+    $(window).on 'click', @blurNotifications
+
+    @
+
+  renderNotifications: =>
+    @el.find(".none").remove() if @notifications.length > 0
+    $.each @notifications, (index, notification)=>
+      unless $.inArray(notification.id, @renderedNotifications) >= 0
+        if new Date(notification.created_at) > @lastReadAt
+          @el
+            .find('ol')
+            .prepend $("<li />")
+            .addClass('unread')
+            .html(notification.html)
+        else
+          @el
+          .find('ol')
+          .append($("<li />").html(notification.html))
+        @renderedNotifications.push notification.id
+
+  isActive: =>
+    @el.hasClass('notifications_active')
+
+  isAlerting: =>
+    @unreadCount > 0
+
+  toggleDropdown: (event)=>
+    event.preventDefault() if event?
+
+    @el.toggleClass('notifications_active')
+    @setLastRead()
+
+  toggleSettings: (event)=>
+    event.preventDefault() if event?
+    $.ajax
+      url: "/preferences"
+      success: (data)=>
+        @el.find("#settings_pane").html(@settingsTemplate(data))
+        @defaultSettings() if @arrayFromObject($.makeArray(data)).default
+    @el.toggleClass('show_settings')
+
+  defaultSettings: =>
+    @el.find("#settings_pane").toggleClass("disabled")
+    @el.find("input:not([id='email_settings_default'])").each ->
+      $(@).attr(disabled: !$(@).attr('disabled')).prop('checked', true)
+
+  saveSettings: (event)=>
+    event.preventDefault() if event?
+
+    serializedSettings = {}
+    @el.find("input:checked").each ->
+      serializedSettings[@name] = @value
+
+    $.ajax
+      url: "/preferences"
+      type: "PUT"
+      data: preferences: serializedSettings
+      success: (data)=> @el.toggleClass('show_settings')
+      error: -> alert "There was a problem saving your settings"
+
+  hide: =>
+    @el.removeClass('notifications_active')
+    $(window).off 'click', @blurNotifications
+
+  blurNotifications: (event)=>
+    if @isActive() and $.inArray(@el[0], $(event.target).parents()) < 0
+      @toggleDropdown()
+
+  loadMore: (params = {})=>
+    $.ajax
+      url: "/notifications"
+      dataType: 'json'
+      data: params
+      success: @addNotifications
+      error: => @el.off 'poll', @poll
+
+  addNotifications: (data)=>
+    @lastReadAt = new Date(data.last_read_at)
+    new_notifications = $.grep(data.notifications, (notification)=>
+      $.inArray(notification.id, $.map(@notifications, (n)->n.id)) < 0
+    )
+    @notifications = @notifications.concat new_notifications
+    @el.off('scroll', 'ol', @scrolling) if data.notifications == []
+    @el.trigger 'addNotifications'
+
+  updateAlert: =>
+    if @unreadCount == 0
+      displayCount = null
+      @el.removeClass('alerting')
+    else
+      displayCount = @unreadCount
+      @el.addClass('alerting')
+
+    @el.find(".notification_alert").html(displayCount)
+
+  setUnreadCount: =>
+    @unreadCount = $.grep(@notifications, (notification)=>
+      new Date(notification.created_at) > @lastReadAt
+    ).length
+
+    @updateAlert()
+
+    @unreadCount
+
+  setLastRead: =>
+    if @isAlerting()
+      @lastReadAt = new Date()
+      @setUnreadCount()
+      $.post '/notifications/touch'
+
+  poll: =>
+    @loadMore(recent: true, since: @lastLookTime())
+
+    setTimeout =>
+      @el.trigger 'poll'
+    , @pollTime*1000
+
+  oldestNotificationTime: =>
+    Math.min.apply Math, $.map(@notifications, (notification)->
+      notification.created_at
+    )
+
+  newestNotificationTime: =>
+    if @notifications.length
+      Math.max.apply Math, $.map(@notifications, (notification)->
+        notification.created_at
+      )
+    else
+      0
+
+  lastLookTime: =>
+    Math.max(@lastReadAt.getTime()/1000, @newestNotificationTime())
+
+  scrolling: =>
+    scrollWindow = @$el.find('ol')
+
+    if (scrollWindow.scrollTop() + scrollWindow.innerHeight() >= scrollWindow[0].scrollHeight - 50)
+      @loadMore(after: @oldestNotificationTime())
+
+  arrayFromObject: (collection)->
+    serializedObject = {}
+    $.each collection, ->
+      serializedObject[@key] = @value
+
+    serializedObject

data/app/assets/javascripts/eventifier/templates/dropdown.hamlc

@@ -0,0 +1,10 @@
+%a.toggle_dropdown{ href: "#" }
+  View Notifications
+  %span.notification_alert
+#notification_dropdown
+  %header
+    %a.toggle_settings{ href: '#' } Settings
+    %h4 Notifications
+  %ol
+    %li.none You have no notifications
+  #settings_pane

data/app/assets/javascripts/eventifier/templates/settings.hamlc

@@ -0,0 +1,11 @@
+%form#email_notification_settings
+
+  %strong Receive emails for:
+
+  - for i, setting of @
+    %label{ for: "email_settings_#{setting.key}" }
+      %input{ type: 'checkbox', checked: setting.value, id: "email_settings_#{setting.key}", name: setting.key, value: setting.value }
+      = setting.label
+
+  .buttons
+    %button.save_settings Save

data/app/assets/stylesheets/eventifier/notifications.scss

@@ -0,0 +1,167 @@
+@import "compass/css3/images";
+@import "compass/css3/box-shadow";
+@import "compass/css3/transition";
+@import "compass/css3/transform";
+
+@mixin respond-to($media) {
+  @if $media == iphone {
+    @media only screen and (max-width: 320px) { @content }
+  }
+  @else if $media == iphone-landscape {
+    @media only screen and (max-width: 480px) { @content }
+  }
+  @else if $media == ipad {
+    @media only screen and (max-width: 980px) { @content }
+  }
+  @else if $media == ipad-landscape {
+    @media only screen and (max-width: 1024px) { @content }
+  }
+}
+
+.notifications {
+  display: inline-block;
+  float: none;
+  position: relative;
+  width: 30px;
+  height: 30px;
+  text-align: left;
+  &:focus { outline: 0 }
+  @include respond-to(iphone-landscape) {
+    float: none;
+    display: inline-block;
+    margin-bottom: 10px;
+    top: 0px;
+  }
+  > a {
+    display: block;
+    background: image-url('eventifier/notifications-tower.png') no-repeat;
+    text-indent: -9999em;
+    width: 100%;
+    height: 100%;
+    opacity: 0.5;
+    &:hover { opacity: 1; }
+    .notification_alert {
+      display: none;
+      border-radius: 8px;
+      position: absolute;
+      top: -5px;
+      right: -5px;
+      padding: 3px 6px;
+      background: red;
+      color: white;
+      border: 1px solid black;
+      box-shadow: 0 1px 1px rgba(black, 0.4);
+      text-shadow: 0 1px 1px rgba(black, 0.4);
+      font-size: 11px;
+      text-indent: 0;
+      line-height: 1;
+    }
+  }
+  &.alerting > a, &.notifications_active > a { opacity: 1; }
+  &.alerting > a .notification_alert { display: block; }
+  #settings_pane {
+    display: none;
+    margin: 0;
+    padding: 0;
+    width: 100%;
+    height: 100%;
+    max-height:380px;
+    background-color: #f2f2f2;
+    strong {
+      display: block;
+      font-size: 13px;
+      padding: 5px 5px 10px;
+    }
+    label {
+      display: block;
+      margin-bottom: 15px;
+      font-size: 12px;
+      line-height: 1.2;
+      padding-left: 35px;
+      input {
+        float: left;
+        margin-left: -25px;
+      }
+    }
+    &.disabled label:not([for='email_settings_default']) { opacity: 0.5; }
+    .buttons { text-align: center; }
+  }
+  &.show_settings {
+    #notification_dropdown ol { display: none; }
+    #settings_pane { display: block; }
+  }
+  #notification_dropdown {
+    position: absolute;
+    display: none;
+    width: 290px;
+    outline: none;
+    z-index: 100;
+    top: 44px;
+    right: -50px;
+    border: 2px solid #d9d9d9;
+    border-radius: 2px;
+    @include box-shadow(inset 0px 1px 0px #475560, 0px 0px 15px rgba(0,0,0,.23));
+    @include transition(all .1s ease-out);
+    &:before {
+      content: '';
+      position: absolute;
+      top: -8px;
+      right: 60px;
+      background: #fff;
+      width: 14px;
+      height: 14px;
+      @include transform(rotate(45deg));
+      box-shadow: -1px -1px 1px rgba(black, .2);
+      @include respond-to(iphone-landscape) { display: none }
+    }
+    &.left_nipple:before { left: 30px; right: auto; }
+    header {
+      margin: 0;
+      padding: 5px;
+      background: white;
+      h4 {
+        margin: 0;
+        font-weight: bold;
+        font-size: 12px;
+        line-height: 1.3;
+      }
+      a.toggle_settings {
+        float: right;
+        font-size: 11px;
+      }
+    }
+    ol {
+      display: block;
+      margin: 0;
+      padding: 0;
+      width: 100%;
+      max-height:380px;
+      overflow: auto;
+      list-style: none;
+      background-color: #f2f2f2;
+      li {
+        display: block;
+        margin: 0;
+        padding: 5px;
+        font-size: 11px;
+        border-top: 1px solid white;
+        border-bottom: 1px solid #e5e5e5;
+        &.unread { background-color: #d3d3d3; }
+        a {
+          display: block;
+          overflow: auto;
+          padding-left: 38px;
+        }
+        img.avatar {
+          float: left;
+          margin-left: -35px;
+          width: 28px;
+          height: 28px;
+        }
+      }
+    }
+  }
+  &.notifications_active #notification_dropdown {
+    display: block;
+  }
+}

data/app/controllers/eventifier/application_controller.rb

@@ -0,0 +1,4 @@
+class Eventifier::ApplicationController < ApplicationController
+  before_filter :authenticate_user!
+  layout false
+end

data/app/controllers/eventifier/notifications_controller.rb

@@ -0,0 +1,36 @@
+class Eventifier::NotificationsController < Eventifier::ApplicationController
+  def index
+    @notifications = notifications
+  end
+
+  def touch
+    current_user.update_attribute :notifications_last_read_at, Time.zone.now
+
+    render :json => {'status' => 'OK'}
+  end
+
+  private
+
+  def notifications
+    scope = current_user.notifications.limit(per_page)
+    scope = scope.where("notifications.created_at < ?", after) if params[:after]
+    scope = scope.where("notifications.created_at > ?", since) if params[:since]
+    scope = scope.where(
+      "notifications.created_at > ?", current_user.notifications_last_read_at
+    ) if params[:recent]
+
+    scope
+  end
+
+  def after
+    Time.zone.at params[:after].to_i
+  end
+
+  def per_page
+    (params[:limit] || 5).to_i
+  end
+
+  def since
+    Time.zone.at params[:since].to_i
+  end
+end

data/app/controllers/eventifier/preferences_controller.rb

@@ -0,0 +1,19 @@
+class Eventifier::PreferencesController < Eventifier::ApplicationController
+  def show
+    render :json => Eventifier::Preferences.new(current_user).to_hashes
+  end
+
+  def update
+    settings = Eventifier::NotificationSetting.for_user current_user
+    settings.preferences['email'] ||= {}
+    params[:preferences]          ||= {}
+
+    Eventifier::Preferences.new(current_user).to_hashes.each do |hash|
+      settings.preferences['email'][hash[:key]] = !params[:preferences][hash[:key]].nil?
+    end
+
+    settings.save
+
+    render :json => {'status' => 'OK'}
+  end
+end

data/app/helpers/eventifier/notification_helper.rb

@@ -0,0 +1,87 @@
+module Eventifier
+  module NotificationHelper
+    # A helper method for outputting a notification message.
+    #
+    # Uses I18n messages from config/locales/events.en.yml to generate these messages, or defaults to a standard.
+    #
+    # Example:
+    #
+    # %ul#recent_notifications
+    #   - current_user.notifications.each do |notification|
+    #     %li= notification_message notification.event
+
+    def notification_message event
+      default = "notifications.default.#{event.verb}".to_sym
+      if event.verb.to_sym == :update
+        if event.change_data.keys.count == 1
+          key = "notifications.#{event.eventable_type.downcase}.#{event.verb}.attributes.#{event.change_data.keys.first}"
+          default = ["notifications.#{event.eventable_type.downcase}.#{event.verb}.single".to_sym, default]
+        else
+          key = "notifications.#{event.eventable_type.downcase}.#{event.verb}.multiple"
+        end
+      else
+        key = "notifications.#{event.eventable_type.downcase}.#{event.verb}"
+      end
+      message = I18n.translate key, :default => default, :"user.name" => event.user.name, :"event.type" => event.eventable_type
+
+      replace_vars(message, event).html_safe
+    end
+
+    def event_message event
+      if event.verb.to_sym == :update
+        if event.change_data.keys.count == 1
+          key = "events.#{event.eventable_type.downcase}.#{event.verb}.single"
+        else
+          key = "events.#{event.eventable_type.downcase}.#{event.verb}.multiple"
+        end
+      else
+        key = "events.#{event.eventable_type.downcase}.#{event.verb}"
+      end
+      message = I18n.translate key, :default => :"events.default.#{event.verb}", "user.name" => event.user.name, :"event.type" => event.eventable_type
+
+      replace_vars(message, event).html_safe
+    end
+
+    # Used to replace {{variables}} in I18n messages
+    def replace_vars message, event
+      event = load_event_for_template event
+      message.scan(/{{[^}]*}}/) do |replaceable|
+        method = "event."+replaceable.to_s.gsub(/[{|}]/, '').to_s
+        replace_text = eval(method) rescue ""
+
+        case replaceable.to_s
+          when "{{object.name}}"
+            replace_text = "<strong class='target'>#{replace_text}</strong>"
+          when "{{object.title}}"
+            replace_text = "<strong class='target'>#{replace_text}</strong>"
+          when "{{user.name}}"
+            replace_text = "<strong class='user'>#{replace_text}</strong>"
+          else
+            replace_text = "<strong>#{replace_text}</strong>"
+        end
+
+        message = message.gsub(replaceable.to_s, replace_text.to_s.gsub("_", " "))
+      end
+      message
+    end
+
+    # Make is so you can include object in the I18n descriptions and it refers to the eventable object the event is referring to.
+    def load_event_for_template event
+      def event.object; eventable; end
+      def event.object_type; eventable_type; end
+
+      event
+    end
+
+    def pastize(verb)
+      case verb
+      when 'create'
+        "created"
+      when 'update'
+        "changed"
+      when 'destroy'
+        "deleted"
+      end
+    end
+  end
+end

data/app/helpers/eventifier/path_helper.rb

@@ -0,0 +1,15 @@
+module Eventifier
+  module PathHelper
+    def render_partial_view notification, context = nil
+      render(partial: partial_path(notification, context), object: notification.event, locals: { notification: notification, event: notification.event, object: notification.event.eventable })
+    end
+
+    def partial_path notification, context = nil
+      if lookup_context.exists?(notification.event.eventable_type.underscore, [:eventifier, context].compact.join("/"), true)
+        [:eventifier, context, notification.event.eventable_type.underscore].compact.join("/")
+      else
+        [:eventifier, context, 'notification'].compact.join("/")
+      end
+    end
+  end
+end

data/app/mailers/eventifier/mailer.rb

@@ -0,0 +1,12 @@
+class Eventifier::Mailer < ::ActionMailer::Base
+  include Eventifier::Mailers::Helpers
+
+  helper 'eventifier/notification'
+  helper 'eventifier/path'
+
+  default :from => Eventifier.mailer_sender
+
+  def notifications(user, records)
+    eventifier_mail(user, records, :notifications)
+  end
+end

data/app/models/event_tracking.rb

@@ -0,0 +1,3 @@
+class EventTracking
+  #
+end