eventifier 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b2058a8b8853d745b422702127a30d6f813782f
-  data.tar.gz: 15cc3e4c382f87e2fabb2e39c9491564125de1c1
+  metadata.gz: aaf9b70e8194f8a8d0b9bbb3c1f47a66ce567924
+  data.tar.gz: b5cfd42aac01fc16b8c3c6f1958c3f7000ccb61e
 SHA512:
-  metadata.gz: 1c97b31eafca299de510fac186d067513d7172110217bc989b9e65fc44af6a3907cc056f39a4bda8f6b8f3ec70ec076bb11d19d809a5e1d5659e1ef78ec52054
-  data.tar.gz: 09fe86cdb9b773bd3bbeeec95a575a20ec99b957d534e44474c2188b87a03c0fc491ee2e7cbe070bd7b7b451fd669ba93fc8b861fb072979ad7ec4e447e944be
+  metadata.gz: f33025942a2d0648a150905772630b8f5ffdf322529f3d03f4122c1d1799a6fcb159e3cedd83d9022dff49e92383db461647a33ca9719500572b22fb5781d56e
+  data.tar.gz: 2027a96019a98283036f41efa293c77140e1144c30c8bb41b05046e5786c851df26221c9fa0b98825ca16fba8bc6c4f8520cc17fff702adc8512b6620fba55f6

data/Gemfile

@@ -2,3 +2,8 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in eventifier.gemspec
 gemspec
+
+gem 'haml_coffee_assets',
+  git:    'git://github.com/netzpirat/haml_coffee_assets.git',
+  branch: 'master',
+  ref:    'a3c2951eca'

data/README.textile

@@ -138,6 +138,19 @@ h2. Requirements
 
 * ActiveRecord
 
+h2. Turbolinks
+
+Turbolinks removes the body of the page, which is where our dropdown notifications box sits.  We'll need to re-render it and point it at the holding element when the page changes.
+
+```
+$ ->
+  window.notifications = new NotificationDropdown el: $('.notifications'), pollTime: 60
+
+$(document).on "page:change", ->
+  notifications.el = $('.notifications')
+  notifications.render()
+```
+
 h2. Testing
 
 Creating the database:

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

@@ -1,6 +1,6 @@
 #= require hamlcoffee
-#= require ./templates/dropdown
-#= require ./templates/settings
+#= require eventifier/templates/dropdown
+#= require eventifier/templates/settings
 # Usage
 # window.notifications = new NotificationDropdown el: $('.notifications'), limit: 5
 
@@ -19,14 +19,18 @@ class window.NotificationDropdown
 
     @render()
     @loadMore(limit: 14)
+    setTimeout =>
+      @el.trigger 'poll'
+    , @pollTime*1000
 
   render: =>
+    @unsetEvents()
+    @renderedNotifications = []
     @el.html(@template(@)).attr('tabindex', 0)
-
+    @renderNotifications()
     # @checkVisibility()
 
     @setEvents()
-    @poll()
 
   checkVisibility: =>
     @el.addClass("notifications_active").find('#notification_dropdown').attr('opacity': 0)
@@ -57,6 +61,9 @@ class window.NotificationDropdown
 
     @
 
+  unsetEvents: =>
+    @el.off()
+
   pushUrl: (e)=>
     location = $(e.currentTarget).attr('href')
     location = $('<a />').attr(href: location).get(0).pathname if location.match /^https?\:\/\//
@@ -72,16 +79,16 @@ class window.NotificationDropdown
       unless $.inArray(notification.id, @renderedNotifications) >= 0
         if new Date(notification.created_at) > @lastReadAt
           if @lastInserted?
-            @lastInserted.after @lastInserted = $("<li />")
+            @lastInserted.after( @lastInserted = $("<li />")
               .addClass('unread')
               .html(notification.html)
+            )
           else
             @el
               .find('ol')
-              .prepend( @lastInserted = $("<li />")
+              .prepend(@lastInserted = $("<li />")
                 .addClass('unread')
-                .html(notification.html)
-            )
+                .html(notification.html))
         else
           @el
           .find('ol')
@@ -105,7 +112,7 @@ class window.NotificationDropdown
   toggleSettings: (event)=>
     event.preventDefault() if event?
     $.ajax
-      url: "/preferences"
+      url: "/eventifier/preferences"
       success: (data)=>
         @el.find("#settings_pane").html(@settingsTemplate(data))
         @defaultSettings() if @arrayFromObject($.makeArray(data)).default
@@ -124,7 +131,7 @@ class window.NotificationDropdown
       serializedSettings[@name] = @value
 
     $.ajax
-      url: "/preferences"
+      url: "/eventifier/preferences"
       type: "PUT"
       data: preferences: serializedSettings
       success: (data)=> @el.toggleClass('show_settings')
@@ -140,7 +147,7 @@ class window.NotificationDropdown
 
   loadMore: (params = {})=>
     $.ajax
-      url: "/notifications"
+      url: "/eventifier/notifications"
       dataType: 'json'
       data: params
       success: @addNotifications
@@ -189,7 +196,7 @@ class window.NotificationDropdown
     if @isAlerting()
       @lastReadAt = new Date()
       @setUnreadCount()
-      $.post '/notifications/touch'
+      $.post '/eventifier/notifications/touch'
 
   poll: =>
     @loadMore(recent: true, since: @lastLookTime())

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

@@ -151,6 +151,7 @@
           display: block;
           overflow: visible;
           padding-left: 38px;
+          word-break: break-all;
         }
         img.avatar {
           float: left;

data/app/views/eventifier/notifications/index.jbuilder

@@ -1,6 +1,6 @@
-json.last_read_at current_user.notifications_last_read_at.to_i*1000
-json.notifications @notifications do |notification|
+json.last_read_at user.notifications_last_read_at.to_i*1000
+json.notifications notifications do |notification|
   json.(notification, :id)
   json.created_at notification.created_at.to_i*1000
   json.html render_partial_view(notification, :dropdown)
-end
+end

data/config/routes.rb

@@ -1,7 +1,3 @@
 Eventifier::Engine.routes.draw do
-  resources :notifications, module: 'eventifier' do
-    collection { post :touch }
-  end
-
-  resource :preferences, module: 'eventifier'
+  mount Eventifier::API.new => '/eventifier'
 end

data/eventifier.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "eventifier"
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   s.authors     = ["Nathan Sampimon", "Peter Murray", "Pat Allan"]
   s.email       = ["nathan@inspire9.com"]
   s.homepage    = "http://github.com/inspire9/eventifier"
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'rails',           '~> 4.0.3'
+  s.add_runtime_dependency 'rails',           '>= 4.0.3'
   s.add_runtime_dependency "bson_ext"
   s.add_runtime_dependency 'haml-rails',      '~> 0.4'
   s.add_runtime_dependency 'haml_coffee_assets'
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'multi_json',      '>= 1.7.4'
   s.add_runtime_dependency 'jbuilder',        '>= 2.0.4'
   s.add_runtime_dependency 'rails-observers', '~> 0.1.2'
+  s.add_runtime_dependency 'sliver',          '~> 0.0.3'
 
   s.add_development_dependency 'combustion',  '~> 0.5.0'
   s.add_development_dependency 'fabrication', '~> 2.11.0'

data/lib/eventifier.rb

@@ -18,6 +18,7 @@ require 'compass-rails'
 require 'haml-rails'
 require 'haml_coffee_assets'
 require 'jbuilder'
+require 'sliver'
 
 module Eventifier
   mattr_accessor :mailer_sender
@@ -60,7 +61,7 @@ module Eventifier
   end
 end
 
-
+require 'eventifier/api'
 require 'eventifier/delivery'
 require 'eventifier/event_tracking'
 require 'eventifier/event_builder'

data/lib/eventifier/api.rb

@@ -0,0 +1,19 @@
+class Eventifier::API < Sliver::API
+  def initialize
+    super do |api|
+      api.connect :get,  '/notifications', Eventifier::API::GetNotifications
+      api.connect :post, '/notifications/touch',
+        Eventifier::API::TouchNotifications
+
+      api.connect :get, '/preferences', Eventifier::API::GetPreferences
+      api.connect :put, '/preferences', Eventifier::API::PutPreferences
+    end
+  end
+end
+
+require 'eventifier/api/base'
+require 'eventifier/api/view'
+require 'eventifier/api/get_notifications'
+require 'eventifier/api/touch_notifications'
+require 'eventifier/api/get_preferences'
+require 'eventifier/api/put_preferences'

data/lib/eventifier/api/base.rb

@@ -0,0 +1,36 @@
+class Eventifier::API::Base
+  include Sliver::Action
+
+  def skip?
+    return false if user
+
+    response.status = 403
+    response.body   = ['Forbidden']
+
+    true
+  end
+
+  def call
+    response.status ||= 200
+    response.body   ||= {}
+    response.headers['Content-Type'] ||= 'application/json'
+
+    if response.body.is_a?(String)
+      response.body = [response.body]
+    else
+      response.body = [JSON.generate(response.body)]
+    end
+  end
+
+  private
+
+  def user
+    return nil unless warden && warden.authenticated?(:user)
+
+    warden.user(:user)
+  end
+
+  def warden
+    environment['warden']
+  end
+end

data/lib/eventifier/api/get_notifications.rb

@@ -0,0 +1,37 @@
+class Eventifier::API::GetNotifications < Eventifier::API::Base
+  include Eventifier::API::View
+
+  def call
+    render 'eventifier/notifications/index',
+      notifications: notifications, user: user
+
+    super
+  end
+
+  private
+
+  delegate :params, to: :request
+
+  def notifications
+    scope = user.notifications.order("eventifier_notifications.created_at DESC").limit(per_page)
+    scope = scope.where("eventifier_notifications.created_at < ?", after) if params['after']
+    scope = scope.where("eventifier_notifications.created_at > ?", since) if params['since']
+    scope = scope.where(
+      "eventifier_notifications.created_at > ?", 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/lib/eventifier/api/get_preferences.rb

@@ -0,0 +1,7 @@
+class Eventifier::API::GetPreferences < Eventifier::API::Base
+  def call
+    response.body = Eventifier::Preferences.new(user).to_hashes
+
+    super
+  end
+end

data/lib/eventifier/api/put_preferences.rb

@@ -0,0 +1,9 @@
+class Eventifier::API::PutPreferences < Eventifier::API::Base
+  def call
+    Eventifier::Preferences.new(user).update request.params['preferences'] || {}
+
+    response.body = {'status' => 'OK'}
+
+    super
+  end
+end

data/lib/eventifier/api/touch_notifications.rb

@@ -0,0 +1,9 @@
+class Eventifier::API::TouchNotifications < Eventifier::API::Base
+  def call
+    user.update_attribute :notifications_last_read_at, Time.zone.now
+
+    response.body = {'status' => 'OK'}
+
+    super
+  end
+end

data/lib/eventifier/api/view.rb

@@ -0,0 +1,13 @@
+module Eventifier::API::View
+  private
+
+  def render(template, locals = {})
+    response.body = renderer.render template: template, locals: locals
+  end
+
+  def renderer
+    ApplicationController.view_context_class.new(
+      ApplicationController.view_paths
+    )
+  end
+end

data/spec/eventifier/api_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Eventifier::API do
+  include Rack::Test::Methods
+
+  let(:app)    { Eventifier::API.new }
+  let(:user)   { double 'User' }
+  let(:warden) { double 'Warden', authenticated?: true, user: user }
+
+  describe 'GET /notifications' do
+    let(:event)         { double 'Event', eventable_type: 'User', eventable: double, user: User.create!(name: 'Pat'), verb: :create }
+    let(:notifications) { [double('Notification', id: 84, created_at: created_at, event: event)] }
+    let(:created_at)    { 1.minute.ago }
+
+    before :each do
+      Rails.application.default_url_options = {host: 'eventifier.dev'}
+
+      allow(user).to receive(:notifications_last_read_at).and_return(1)
+      allow(notifications).to receive(:order).and_return(notifications)
+      allow(notifications).to receive(:limit).and_return(notifications)
+    end
+
+    it 'returns 403 if there is no authenticated user' do
+      allow(warden).to receive(:authenticated?).and_return(false)
+      allow(warden).to receive(:user).and_return(nil)
+
+      get '/notifications', {}, {'warden' => warden}
+
+      expect(last_response.status).to eq(403)
+    end
+
+    it 'returns notifications as JSON' do
+      allow(user).to receive(:notifications).and_return(notifications)
+
+      get '/notifications', {}, {'warden' => warden}
+
+      json = JSON.parse(last_response.body)
+      expect(json['last_read_at']).to eq(1000)
+      expect(json['notifications'].first['id']).to eq(84)
+    end
+  end
+
+  describe 'POST /notifications/touch' do
+    before :each do
+      allow(user).to receive(:update_attribute).and_return(true)
+    end
+
+    it "updates the current user's notifications last read at" do
+      expect(user).to receive(:update_attribute).
+        with(:notifications_last_read_at, anything)
+
+      post '/notifications/touch', {}, {'warden' => warden}
+    end
+
+    it "responds with JSON OK status" do
+      post '/notifications/touch', {}, {'warden' => warden}
+
+      expect(last_response.body).to eq ({'status' => 'OK'}.to_json)
+    end
+  end
+
+  describe 'GET /preferences' do
+    let(:preferences) { double :to_hashes => [{'foo' => 'bar'}] }
+
+    before :each do
+      allow(Eventifier::Preferences).to receive(:new).and_return(preferences)
+    end
+
+    it 'initializes the preferences with the logged in user' do
+      expect(Eventifier::Preferences).to receive(:new).with(user).
+        and_return(preferences)
+
+      get '/preferences', {}, {'warden' => warden}
+    end
+
+    it "returns the settings hashes" do
+      get '/preferences', {}, {'warden' => warden}
+
+      expect(last_response.body).to eq ([{'foo' => 'bar'}].to_json)
+    end
+  end
+
+  describe 'PUT /preferences' do
+    let(:preferences) { double update: true }
+
+    before :each do
+      allow(Eventifier::Preferences).to receive(:new).and_return(preferences)
+    end
+
+    it 'initializes the preferences with the logged in user' do
+      expect(Eventifier::Preferences).to receive(:new).with(user).
+        and_return(preferences)
+
+      put '/preferences', {preferences: {'foo' => ''}}, {'warden' => warden}
+    end
+
+    it 'saves the settings changes' do
+      expect(preferences).to receive(:update).with('foo' => '')
+
+      put '/preferences', {preferences: {'foo' => ''}}, {'warden' => warden}
+    end
+
+    it "renders a JSON OK status" do
+      put '/preferences', {preferences: {'foo' => ''}}, {'warden' => warden}
+
+      expect(last_response.body).to eq ({'status' => 'OK'}.to_json)
+    end
+  end
+end

data/spec/internal/config/locales/events.en.yml

@@ -18,3 +18,5 @@ en:
       update:
         single: "{{user.name}} updated a {{object_type}}"
         multiple: "{{user.name}} made some changes to a {{object_type}}"
+test:
+  placeholder: true

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ Bundler.setup :default, :development
 require 'fabrication'
 require 'combustion'
 require 'active_record'
+require 'action_view'
+require 'haml'
 require 'eventifier'
 
 Fabrication.configure do |config|
@@ -12,7 +14,8 @@ Fabrication.configure do |config|
   config.path_prefix     = '.'
 end
 
-Combustion.initialize! :action_controller, :active_record, :action_mailer
+Combustion.initialize! :action_controller, :action_view, :active_record,
+  :action_mailer
 
 require 'rspec/rails'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventifier
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nathan Sampimon
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.3
 - !ruby/object:Gem::Dependency
@@ -138,6 +138,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: sliver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -213,9 +227,6 @@ files:
 - app/assets/javascripts/eventifier/templates/dropdown.hamlc
 - app/assets/javascripts/eventifier/templates/settings.hamlc
 - app/assets/stylesheets/eventifier/notifications.scss
-- app/controllers/eventifier/application_controller.rb
-- app/controllers/eventifier/notifications_controller.rb
-- app/controllers/eventifier/preferences_controller.rb
 - app/helpers/eventifier/notification_helper.rb
 - app/helpers/eventifier/path_helper.rb
 - app/mailers/eventifier/mailer.rb
@@ -238,6 +249,13 @@ files:
 - db/migrate/5_system_events.rb
 - eventifier.gemspec
 - lib/eventifier.rb
+- lib/eventifier/api.rb
+- lib/eventifier/api/base.rb
+- lib/eventifier/api/get_notifications.rb
+- lib/eventifier/api/get_preferences.rb
+- lib/eventifier/api/put_preferences.rb
+- lib/eventifier/api/touch_notifications.rb
+- lib/eventifier/api/view.rb
 - lib/eventifier/delivery.rb
 - lib/eventifier/engine.rb
 - lib/eventifier/event_builder.rb
@@ -258,9 +276,8 @@ files:
 - lib/generators/eventifier/install/templates/event_tracking.rb
 - lib/generators/eventifier/install/templates/events.en.yml
 - lib/tasks/email.rake
-- spec/controllers/eventifier/notifications_controller_spec.rb
-- spec/controllers/eventifier/preferences_controller_spec.rb
 - spec/event_tracking_spec.rb
+- spec/eventifier/api_spec.rb
 - spec/eventifier/delivery_spec.rb
 - spec/eventifier/event_translator_spec.rb
 - spec/eventifier/notification_translator_spec.rb
@@ -321,9 +338,8 @@ signing_key:
 specification_version: 4
 summary: Event tracking and notifying for active record models
 test_files:
-- spec/controllers/eventifier/notifications_controller_spec.rb
-- spec/controllers/eventifier/preferences_controller_spec.rb
 - spec/event_tracking_spec.rb
+- spec/eventifier/api_spec.rb
 - spec/eventifier/delivery_spec.rb
 - spec/eventifier/event_translator_spec.rb
 - spec/eventifier/notification_translator_spec.rb

data/app/controllers/eventifier/application_controller.rb

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

data/app/controllers/eventifier/notifications_controller.rb

@@ -1,36 +0,0 @@
-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.order("eventifier_notifications.created_at DESC").limit(per_page)
-    scope = scope.where("eventifier_notifications.created_at < ?", after) if params[:after]
-    scope = scope.where("eventifier_notifications.created_at > ?", since) if params[:since]
-    scope = scope.where(
-      "eventifier_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

@@ -1,17 +0,0 @@
-class Eventifier::PreferencesController < Eventifier::ApplicationController
-  def show
-    render :json => preferences.to_hashes
-  end
-
-  def update
-    preferences.update params[:preferences] || {}
-
-    render :json => {'status' => 'OK'}
-  end
-
-  private
-
-  def preferences
-    Eventifier::Preferences.new(current_user)
-  end
-end

data/spec/controllers/eventifier/notifications_controller_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe Eventifier::NotificationsController do
-  routes     { Eventifier::Engine.routes }
-
-  describe '#touch' do
-    let(:user) { double 'User', :update_attribute => true }
-
-    before :each do
-      sign_in user
-    end
-
-    it "updates the current user's notifications last read at" do
-      user.should_receive(:update_attribute).
-        with(:notifications_last_read_at, anything)
-
-      post :touch
-    end
-
-    it "responds with JSON OK status" do
-      post :touch
-
-      expect(response.body).to eq ({'status' => 'OK'}.to_json)
-    end
-  end
-end

data/spec/controllers/eventifier/preferences_controller_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-describe Eventifier::PreferencesController do
-  routes     { Eventifier::Engine.routes }
-  let(:user) { double 'User' }
-
-  before :each do
-    sign_in user
-
-    Eventifier::Preferences.stub :new => preferences
-  end
-
-  describe '#show' do
-    let(:preferences) { double :to_hashes => [{'foo' => 'bar'}] }
-
-    it "returns the settings hashes" do
-      get :show
-
-      expect(response.body).to eq ([{'foo' => 'bar'}].to_json)
-    end
-  end
-
-  describe '#update' do
-    let(:preferences) { double update: true }
-
-    it 'saves the settings changes' do
-      preferences.should_receive(:update).with('foo' => '')
-
-      put :update, :preferences => {'foo' => ''}
-    end
-
-    it "renders a JSON OK status" do
-      put :update, :preferences => {'foo' => ''}
-
-      expect(response.body).to eq ({'status' => 'OK'}.to_json)
-    end
-  end
-end