disclosure 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2013 Josh McArthur
+
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Disclosure
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/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    = 'Disclosure'
+  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/disclosure/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * 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/disclosure/application_controller.rb

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

data/app/helpers/disclosure/application_helper.rb

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

data/app/mailers/disclosure/email_reactor.rb

@@ -0,0 +1,18 @@
+module Disclosure
+  class EmailReactor < ActionMailer::Base
+    default Disclosure.configuration.email_reactor_defaults
+
+    def react!(model, action, rule)
+      self.notification(model, action, rule).deliver
+    end
+
+    def notification(model, action, rule)
+      mail(
+        :to => rule.owner.email,
+        :subject => t("disclosure.email_reactor.#{rule.notifier_class}.#{action}.subject"),
+        :template_path => "disclosure/email/#{rule.notifier_class}",
+        :template_name => "action"
+      )
+    end
+  end
+end

data/app/models/disclosure/rule.rb

@@ -0,0 +1,74 @@
+module Disclosure
+  class Rule < ActiveRecord::Base
+    belongs_to :owner, :class_name => Disclosure.configuration.owner_class
+
+    validates :notifier_class, :inclusion => {
+      :in => proc { Disclosure.configuration.notifier_classes.map(&:name) }
+    }
+
+    validates :reactor_class, :inclusion => {
+      :in => proc { Disclosure.configuration.reactor_classes.map(&:name) }
+    }
+
+    validates :action, :uniqueness => {
+      :scope => [:owner_id, :notifier_class]
+    }
+
+    validate :action_in_notifier_actions
+
+    # Public: Find the notifier class instance from the
+    # class name (string) that is saved in the model table.
+    #
+    # Returns the notifier class or nil
+    def notifier
+      Disclosure.configuration.notifier_classes.select do |nc|
+        nc.name == self.notifier_class
+      end.first
+    end
+
+    # Public: Find the reactor class instance from the
+    # class name (string) that is saved in the model table.
+    #
+    # Returns the reactor class or nil   
+    def reactor
+      Disclosure.configuration.reactor_classes.select do |rc|
+        rc.name == self.reactor_class
+      end.first
+    end
+
+    # Public: Tell the reactor for this rule that it should now react to a change.
+    #
+    # Passes along the instance of the model that changed, the action that occurred, 
+    # and the owner of the rule
+    #
+    # model - The model instance that changed
+    #
+    # Returns truthy value if the reactor returned successfully, and false if not.
+    # Depending on the reactor, may raise exceptions - for example, Net::SMTP errors
+    # if sending email.
+    def react!(model)
+      reactor.react!(model, action, owner)
+    end
+
+    private
+
+    # Private: Ensure that the configured action is within the 
+    # actions recorded against the notifier.
+    #
+    # For example, an Issue may notify actions such as:
+    # * created
+    # * closed
+    #
+    # While a Project may only notify creating and updating actions
+    #
+    # Returns true if the action is valid, or false if not
+    def action_in_notifier_actions
+      unless notifier && notifier.notifiable_actions.include?(self.action)
+        errors.add(:action, :not_in_notifiable_actions)
+        return false
+      end
+
+      return true
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Disclosure</title>
+  <%= stylesheet_link_tag    "disclosure/application", :media => "all" %>
+  <%= javascript_include_tag "disclosure/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Disclosure::Engine.routes.draw do
+  # This engine has no routes, as it is more of a backend system for you to use
+  # in your own application as you need.
+  #
+  # If you would like to make your notification rules content-editable, that's really easy!
+  # Just add your own controller where you need it, and have it manage all the 
+  # Disclosure::Rule models in your database!
+  
+end

data/db/migrate/20130331060054_create_disclosure_rules.rb

@@ -0,0 +1,13 @@
+class CreateDisclosureRules < ActiveRecord::Migration
+  def change
+    create_table :disclosure_rules do |t|
+      t.belongs_to :owner
+      t.string :notifier_class
+      t.string :reactor_class
+      t.string :action
+
+      t.timestamps
+    end
+    add_index :disclosure_rules, :owner_id
+  end
+end

data/lib/disclosure/configuration.rb

@@ -0,0 +1,11 @@
+class Disclosure::Configuration 
+  attr_accessor :owner_class, :notifier_classes, :reactor_classes, :email_reactor_defaults
+
+  def initialize
+    self.owner_class = "User"
+    self.reactor_classes = []
+    self.notifier_classes = []
+    self.email_reactor_defaults = {:from => "please-change-me@localhost"}
+  end
+
+end

data/lib/disclosure/engine.rb

@@ -0,0 +1,15 @@
+module Disclosure
+  class Engine < ::Rails::Engine
+    isolate_namespace Disclosure
+
+    initializer 'disclosure.subscribe_to_model_events' do
+      ActiveSupport::Notifications.subscribe "disclosure.model_saved" do |name, start, finish, id, payload|
+        Disclosure.react_to!(payload[:model])
+      end
+    end
+
+    initializer 'disclosure.extend_model_classes' do
+      Disclosure.bootstrap!
+    end
+  end
+end

data/lib/disclosure/exceptions.rb

@@ -0,0 +1,5 @@
+class Disclosure::NotifiableActionsNotDefined < RuntimeError
+end
+
+class Disclosure::ActionMethodNotDefined < RuntimeError
+end

data/lib/disclosure/version.rb

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

data/lib/disclosure.rb

@@ -0,0 +1,58 @@
+require "disclosure/engine"
+require 'disclosure/exceptions'
+require "disclosure/configuration"
+
+module Disclosure
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.bootstrap!
+    Disclosure.configuration.notifier_classes.each do |klass|
+      if !klass.methods.include?(:notifiable_actions)
+        klass.class_eval do
+          class << self
+            def notifiable_actions
+              raise Disclosure::NotifiableActionsNotDefined.new("Notifiable actions must be defined in #{self.name}.")
+            end
+          end
+        end
+      end
+
+      # We don't use an else here, because we may have *just* added
+      # the method - it's not a if this, else that - we may need to do both
+      if klass.methods.include?(:notifiable_actions) 
+        # If notifiable actions has just been defined, it will raise an exception
+        (klass.notifiable_actions rescue []).each do |action|
+          unless klass.instance_methods.include?(:"#{action}?")
+            klass.define_method(:"#{action}?") do
+              raise Disclosure::ActionMethodNotDefined.new("#{action}? must be defined in #{klass}.")
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.react_to!(model)
+    unless Disclosure.configuration.notifier_classes.include?(model.class) 
+      return nil
+    end
+
+    Disclosure::Rule.where(
+      :notifier_class => model.class.name,
+      :owner_id => model.send("#{Disclosure.configuration.owner_class.underscore}_id")
+    ).each do |rule|
+      next if !model.send("#{rule.action}?")
+      rule.react!(model)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/tasks/disclosure_tasks.rake

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

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: disclosure
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine to allow you to easily set up rules and events for when
+  each user should receive notifications - great for adding configurable notifications.
+email:
+- joshua.mcarthur+disclosure@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/disclosure/application.js
+- app/assets/stylesheets/disclosure/application.css
+- app/controllers/disclosure/application_controller.rb
+- app/helpers/disclosure/application_helper.rb
+- app/mailers/disclosure/email_reactor.rb
+- app/models/disclosure/rule.rb
+- app/views/layouts/disclosure/application.html.erb
+- config/routes.rb
+- db/migrate/20130331060054_create_disclosure_rules.rb
+- lib/disclosure/configuration.rb
+- lib/disclosure/engine.rb
+- lib/disclosure/exceptions.rb
+- lib/disclosure/version.rb
+- lib/disclosure.rb
+- lib/tasks/disclosure_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/joshmcarthur/disclosure
+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: -1278575994465868298
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1278575994465868298
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Rails engine to allow you to easily set up rules and events for notificaitons.
+test_files: []