windbag 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 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.markdown

@@ -0,0 +1,50 @@
+# Windbag
+### Notification Engine for Rails 3.1+
+
+Windbag is an event notification system for Rails. Using Windbag with model observers, you can notify users about changes they're interested in over a variety of transports (WebSockets, email, SMS, Twitter, etc).
+
+At present, the implementation of Transports is left up to you.
+
+Windbag consists of Channels, Subscriptions and Notifications. A user subscribes to the Global Channel, his own Private Channel, and any number of other channels belonging to models in your application.
+
+A Windbag notification is given a list of transport classes, which are triggered through an ActionMailer-like API upon creation.
+
+## Installation
+
+Add windbag to your Gemfile:
+
+    gem 'windbag'
+
+Then run `bundle install`, and migrate up:
+
+    rake windbag:install:migrations
+    rake db:migrate
+
+In your **User** model, `include Windbag::UserClass`.
+
+## Users and Channels
+
+When a User is created, he is automatically subscribed to two channels; Windbag.global_channel, and a private one created just for him. To sub/unsub other channels:
+
+    @user.subscribe(foo_channel).unsubscribe(bar_channel)
+
+You can query `@user.notifications` for a list of notifications on all subscribed channels.
+
+## Creating Notifications
+
+    Windbag::Notification.create({
+      :event => :rsvp
+      :title => 'Someone has RSVP'd to the party!',
+      :description => 'I will be there!'
+      :url => party_url(party),
+      :icon => 'party_hat.png',
+      :sticky => false,
+      :transports => [ Windbag::Transports::Mailer, Windbag::Transports::SMS, Windbag::Transports::Pusher ],
+      :channel => party.windbag_channel
+    })
+
+When the notification is created, the **deliver** method will be called on each transport class provided.
+
+### TODO
+
+* User-selected transport preferences for specific events.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Windbag'
+  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
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/assets/javascripts/windbag/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/windbag/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/app/controllers/windbag/application_controller.rb

@@ -0,0 +1,4 @@
+module Windbag
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/windbag/application_helper.rb

@@ -0,0 +1,4 @@
+module Windbag
+  module ApplicationHelper
+  end
+end

data/app/models/windbag/channel.rb

@@ -0,0 +1,12 @@
+module Windbag
+  class Channel < ActiveRecord::Base
+    has_many :notifications, :class_name => 'Windbag::Notification'
+
+    belongs_to :owner, :polymorphic => true, :foreign_key => :owner_id
+
+    has_many :subscriptions, :class_name => 'Windbag::Subscription'
+    has_many :subscribers, :through => :subscriptions, :source => :user
+
+    validates_uniqueness_of :name
+  end
+end

data/app/models/windbag/notification.rb

@@ -0,0 +1,28 @@
+module Windbag
+  class Notification < ActiveRecord::Base
+
+    belongs_to :channel, :class_name => 'Windbag::Channel'
+    serialize :transports, Array
+
+    validates_presence_of :event, :title
+
+    before_validation :convert_transports
+
+    after_create :deliver
+
+    def deliver
+      self.transports.each do |transport|
+        transport.constantize.with(self.id).deliver
+      end
+    end
+
+    def convert_transports
+      self.transports = self.transports.map {|t| t.to_s}
+    end
+
+    def channel_name
+      self.channel.name if self.channel
+    end
+
+  end
+end

data/app/models/windbag/subscription.rb

@@ -0,0 +1,6 @@
+module Windbag
+  class Subscription < ActiveRecord::Base
+    belongs_to :user
+    belongs_to :channel, :class_name => 'Windbag::Channel'
+  end
+end

data/app/views/layouts/windbag/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Windbag</title>
+  <%= stylesheet_link_tag    "windbag/application" %>
+  <%= javascript_include_tag "windbag/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Windbag::Engine.routes.draw do
+end

data/db/migrate/20111230191249_create_windbag_notifications.rb

@@ -0,0 +1,18 @@
+class CreateWindbagNotifications < ActiveRecord::Migration
+  def change
+    create_table :windbag_notifications do |t|
+      t.string   "event"
+      t.string   "title"
+      t.text     "description"
+      t.string   "url"
+      t.string   "icon"
+      t.boolean  "sticky",                  :default => false
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "transports"
+      t.integer  "channel_id"
+    end
+
+    add_index "windbag_notifications", ["channel_id"], :name => "index_windbag_notifications_on_channel_id"
+  end
+end

data/db/migrate/20111230191630_create_windbag_channels.rb

@@ -0,0 +1,15 @@
+class CreateWindbagChannels < ActiveRecord::Migration
+  def change
+
+    create_table :windbag_channels do |t|
+      t.string   "name"
+      t.integer  "owner_id"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "owner_type"
+    end
+
+    add_index "windbag_channels", ["owner_id", "owner_type"], :name => "index_windbag_channels_on_owner_id_and_owner_type"
+
+  end
+end

data/db/migrate/20111230191822_create_windbag_subscriptions.rb

@@ -0,0 +1,14 @@
+class CreateWindbagSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :windbag_subscriptions do |t|
+      t.integer  "user_id"
+      t.integer  "channel_id"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.timestamps
+    end
+
+    add_index "windbag_subscriptions", ["channel_id"], :name => "windbag_subs_on_chan_id"
+    add_index "windbag_subscriptions", ["user_id"], :name => "index_windbag_subscriptions_on_user_id"
+  end
+end

data/lib/tasks/windbag_tasks.rake

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

data/lib/windbag.rb

@@ -0,0 +1,8 @@
+require "windbag/engine"
+require "windbag/user_class"
+
+module Windbag
+  def self.global_channel
+    Channel.find_or_create_by_name('global-notifications')
+  end
+end

data/lib/windbag/engine.rb

@@ -0,0 +1,9 @@
+module Windbag
+  class Engine < Rails::Engine
+    isolate_namespace Windbag
+
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+  end
+end

data/lib/windbag/user_class.rb

@@ -0,0 +1,46 @@
+module Windbag
+  module UserClass
+    def self.included(base)
+      base.class_eval do
+        has_one  :windbag_channel, :as => :owner, :dependent => :destroy, :class_name => 'Windbag::Channel'
+        has_many :windbag_subscriptions, :class_name => 'Windbag::Subscription'
+        has_many :windbag_channels, :through => :windbag_subscriptions, :class_name => 'Windbag::Channel', :source => :channel
+
+        after_create :subscribe_to_global_channel
+        after_create :create_private_channel
+      end
+    end
+
+  public
+    def subscribe(channel)
+      Subscription.find_or_create_by_user_id_and_channel_id(self.id, channel.id)
+      self
+    end
+
+    def unsubscribe(channel)
+      Subscription.destroy_all(:user_id => self.id, :channel_id => channel.id)
+      self
+    end
+
+    def notifications
+       notifications = []
+       windbag_channels.each do |channel|
+         notifications << channel.notifications
+       end
+       notifications.flatten
+    end
+
+  protected
+    def subscribe_to_global_channel
+      subscribe Windbag.global_channel
+    end
+
+    def create_private_channel
+      self.windbag_channel = Channel.find_or_create_by_name(
+        "private-user-#{self.id}-notifications"
+      )
+      subscribe self.windbag_channel
+    end
+
+  end
+end

data/lib/windbag/version.rb

@@ -0,0 +1,3 @@
+module Windbag
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: windbag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &14877840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *14877840
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &14876240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14876240
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &14875280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14875280
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &14872340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14872340
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &14906820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14906820
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &14905200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14905200
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &14904360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14904360
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &14903740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14903740
+description: Windbag is the event notification system extracted from MLG Starcraft
+  Arena
+email:
+- lkoester@majorleaguegaming.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/windbag/application_controller.rb
+- app/helpers/windbag/application_helper.rb
+- app/models/windbag/subscription.rb
+- app/models/windbag/notification.rb
+- app/models/windbag/channel.rb
+- app/assets/stylesheets/windbag/application.css
+- app/assets/javascripts/windbag/application.js
+- app/views/layouts/windbag/application.html.erb
+- config/routes.rb
+- db/migrate/20111230191630_create_windbag_channels.rb
+- db/migrate/20111230191249_create_windbag_notifications.rb
+- db/migrate/20111230191822_create_windbag_subscriptions.rb
+- lib/windbag/engine.rb
+- lib/windbag/version.rb
+- lib/windbag/user_class.rb
+- lib/tasks/windbag_tasks.rake
+- lib/windbag.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: http://github.com/agoragames/windbag
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2181554666769158353
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2181554666769158353
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Notification System for Rails 3.1+
+test_files: []