simple-notifier 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "shoulda", ">= 0"
+  gem "shoulda-matchers"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "actionmailer", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.11)
+      actionpack (= 2.3.11)
+    actionpack (2.3.11)
+      activesupport (= 2.3.11)
+      rack (~> 1.1.0)
+    activesupport (2.3.11)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    shoulda-matchers (1.0.0.beta1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (~> 2.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda
+  shoulda-matchers

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alex Agranov
+
+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,43 @@
+==simple-notifier - simple type-based notification
+
+   gem install simple-notifier
+
+simple-notifier offers a simple type-based notification facility modeled much after ActionMailer.  You can create Notifier implementations that offer a method for each type of object/class that you would like to notify on via the 'notify!' method.
+
+For instance:
+
+    class FooNotifier < Notifier::Base
+
+          def bar(somebar, opts={})
+              puts "I just got Foo'd"
+          end
+
+    end
+
+    class Bar
+    end
+
+    FooNotifier.notify!(Bar.new)
+
+    I just got Foo'd
+    => nil
+
+==Examples
+
+You can find more examples in the /example directory along with corresponding unit tests in /test.
+
+==Contributing to simple-notifier
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Alex Agranov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple-notifier"
+  gem.homepage = "http://github.com/alexagranov/simple-notifier"
+  gem.license = "MIT"
+  gem.summary = %Q{Allows one to create notification handlers for any type of object.}
+  gem.description = %Q{Inspired by ActionMailer, Notifier offers Notifier::Base, a base class for creating notification handlers on any class or instance of a class.  Simply define a method in your handler named after the type of object you would like to create notification events for, substituting any namespace "::" delineation with "_", along with a signature that allows for the object as the first parameter and an optional params hash.  Then notify on that object or class by simply calling MyHandler.notify!(myclass, params).}
+  gem.email = "alex@morphogenic.net"
+  gem.authors = ["Alex Agranov"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_dependency 'actionmailer', '~> 2.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/example/error.rb

@@ -0,0 +1,69 @@
+=begin rdoc
+  This is an Error notifier.
+
+  Create a <object_type> method for each object type you would like to handle notification via the 'notify!(<object>, <params>...)' method.
+=end
+module Notifier
+  class Error < Notifier::Base
+
+=begin rdoc
+  A method to configure the Error Notifier.
+
+  :recipients => <array of email addresses to receive email notifications>
+  :from => <email address to be used for the From: field of email notification>
+=end
+    def self.configure(opts={})
+      @@recipients = opts[:recipients]
+      @@from = opts[:from]
+    end
+
+    def self.recipients
+      @@recipients
+    end
+
+    def self.from
+      @@from
+    end
+
+=begin rdoc
+  Notification handler for Exception.  Called via Notifier::Error.notify!(exception).
+
+  Currently, use an internal ActionMailer class to send out an email to the error recipients list about potential problems.
+=end
+    def exception(exception, opts={})
+      opts[:body] = exception.message + "\n"
+      opts[:body] += exception.backtrace.join("\n") unless exception.backtrace.nil?
+      Emailer.deliver_error_notification(exception.message, opts)
+    end
+
+=begin rdoc
+  Notification handler for String.  Called via Notifier::Error.notify!("some error msg").
+
+  Currently, use an internal ActionMailer class to send out an email to the error recipients list about potential problems.
+=end
+    def string(msg, opts={})
+      opts[:body] = msg
+      Emailer.deliver_error_notification(msg, opts)
+    end
+
+    private
+
+    class ConfigurationError < StandardError
+    end
+
+    class Emailer < ActionMailer::Base
+      self.template_root = File.dirname(__FILE__)
+      self.delivery_method = :test
+
+      def error_notification(error_msg, opts={})
+        raise ConfigurationError.new("Failed to call Notifier::Error.configure with :recipients and/or :from") if Notifier::Error.recipients.nil? or Notifier::Error.from.nil?
+        recipients Notifier::Error.recipients.join(",")
+        from       Notifier::Error.from
+        subject    error_msg
+        body       :body => opts[:body]
+      end
+    end
+
+  end
+end
+

data/example/notifier/error/emailer/error_notification.erb

@@ -0,0 +1,2 @@
+<%# We can get rid of this blank template after moving to Rails 3.0 as then you are not forced to use template files. %>
+<%= @body %>

data/lib/notifier/base.rb

@@ -0,0 +1,76 @@
+=begin rdoc
+  The notifier gem offers a simple framework for type-based notification events.
+
+  Working much like ActionMailer, this base class simply adds a method_missing implementation to child classes that allows delegation of calls to
+  'notify!(object_or_class, params...)' to a method in the child class named after the class type of the first parameter.  
+
+  Concrete sub-classes should implement a method named after the class type of the document being notified on - with the convention that the method 
+  name is all downcase with '::' replaced with '_'.
+
+  For an example, see Notifier::Error in the /example directory and the corresponding unit test /test/test_error_notifier.rb.
+=end
+module Notifier
+  class Base
+
+    private_class_method :new
+
+    class << self
+
+      # allow child class to only respond_to the dynamic method names that we will add/support below...
+      def respond_to?(method_symbol, include_private = false) #:nodoc:
+        matches_dynamic_method?(method_symbol) || super
+      end
+
+      # override method_missing for child classes so that our list of dynamically added method names are recognized.  if a particular
+      # dynamically added method name is called, do the appropriate action.  For instance, if calling 'notify!', delegate to a method named
+      # after the type of the first passed parameter...
+      def method_missing(method_symbol, *parameters) #:nodoc:
+        if match = matches_dynamic_method?(method_symbol)
+          case match[1]
+            when 'notify!':
+              # support for notifying on Class types rather than just instances...
+              if parameters[0].class == Class
+                method_to_call = parameters[0].to_s.downcase.gsub(/::/,"_")
+              else
+                method_to_call = parameters[0].class.to_s.downcase.gsub(/::/,"_")
+              end
+              new(method_to_call).send!(*parameters)
+            when 'new'     then nil
+            else super
+          end
+        else
+          super
+        end
+      end
+
+      private
+
+      # our list of supported dynamic method names on child classes...(note these are to be called at class-level)
+      def matches_dynamic_method?(method_name) #:nodoc:
+        method_name = method_name.to_s
+        /^(notify!)$/.match(method_name) || /^(new)$/.match(method_name)
+      end
+
+    end
+
+    def initialize(method_name=nil, *parameters)
+      create!(method_name) if method_name
+    end
+
+    def create!(method_name)
+      initialize_defaults(method_name)
+    end
+
+    def send!(*parameters)
+      __send__(@type_method, *parameters)
+    end
+
+    private
+      # Set up any default values
+      def initialize_defaults(method_name)
+        @type_method ||= method_name
+      end
+
+  end
+end
+

data/lib/notifier.rb

@@ -0,0 +1,39 @@
+#
+# Copyright (c) 2010-2011 MorphoGenic Corp.
+#
+# 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.
+#
+
+require 'rubygems'
+require 'action_mailer'
+
+$:.unshift(File.dirname(__FILE__))
+require 'notifier/base'
+
+module Notifier #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0 unless defined?(MAJOR)
+    MINOR = 1 unless defined?(MINOR)
+    PATCH = 0 unless defined?(PATCH)
+
+    STRING = [MAJOR, MINOR, PATCH].join('.') unless defined?(STRING)
+  end
+end
+

data/simple-notifier.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple-notifier}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Agranov"]
+  s.date = %q{2011-02-11}
+  s.description = %q{Inspired by ActionMailer, Notifier offers Notifier::Base, a base class for creating notification handlers on any class or instance of a class.  Simply define a method in your handler named after the type of object you would like to create notification events for, substituting any namespace "::" delineation with "_", along with a signature that allows for the object as the first parameter and an optional params hash.  Then notify on that object or class by simply calling MyHandler.notify!(myclass, params).}
+  s.email = %q{alex@morphogenic.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "example/error.rb",
+    "example/notifier/error/emailer/error_notification.erb",
+    "lib/notifier.rb",
+    "lib/notifier/base.rb",
+    "simple-notifier.gemspec",
+    "test/helper.rb",
+    "test/test_error_notifier.rb"
+  ]
+  s.homepage = %q{http://github.com/alexagranov/simple-notifier}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Allows one to create notification handlers for any type of object.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_error_notifier.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<actionmailer>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<actionmailer>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<actionmailer>, ["~> 2.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'notifier'
+
+class Test::Unit::TestCase
+end

data/test/test_error_notifier.rb

@@ -0,0 +1,25 @@
+require 'helper'
+require 'example/error'
+require 'shoulda'
+require 'shoulda-matchers'
+
+class TestErrorNotifier < Test::Unit::TestCase
+  context "the test error notifier" do
+    subject { "TestErrorNotifier" }
+
+    setup do
+      Notifier::Error.configure(:recipients=>["alex@morphogenic.net"], :from=>"notifier@morphogenic.net")
+    end
+
+    should "1 send an email when ErrorNotifier notifies on a String message" do
+      Notifier::Error.notify!("Please read this important message!")
+    end
+    
+    should "2 send an email when ErrorNotifier notifies on an Exception" do
+      Notifier::Error.notify!(Exception.new("Notifying on Exception!"))
+    end
+    
+    should have_sent_email.with_body(/Please read/)
+    should have_sent_email.with_subject(/Notifying on Exception!/)
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: simple-notifier
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Agranov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  name: actionmailer
+  version_requirements: *id005
+  prerelease: false
+description: Inspired by ActionMailer, Notifier offers Notifier::Base, a base class for creating notification handlers on any class or instance of a class.  Simply define a method in your handler named after the type of object you would like to create notification events for, substituting any namespace "::" delineation with "_", along with a signature that allows for the object as the first parameter and an optional params hash.  Then notify on that object or class by simply calling MyHandler.notify!(myclass, params).
+email: alex@morphogenic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- example/error.rb
+- example/notifier/error/emailer/error_notification.erb
+- lib/notifier.rb
+- lib/notifier/base.rb
+- simple-notifier.gemspec
+- test/helper.rb
+- test/test_error_notifier.rb
+has_rdoc: true
+homepage: http://github.com/alexagranov/simple-notifier
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Allows one to create notification handlers for any type of object.
+test_files: 
+- test/helper.rb
+- test/test_error_notifier.rb