anotifier 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-10-08
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/anotifier.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+rails/init.rb
+app/models/anotifier/resource_mailer.rb
+app/models/anotifier/resource_observer.rb
+app/views/anotifier/resource_mailer/new_resource.text.html.erb

data/README.rdoc

@@ -0,0 +1,61 @@
+= notifier
+
+* http://github.com/cmdjohnson/anotifier
+
+== DESCRIPTION:
+
+This Rails gem will send you an email whenever a record is created. This way, you can keep a tight track of what your users are doing. When you want to stop monitoring, simply remove the gem from the Gemfile.
+
+== FEATURES/PROBLEMS:
+
+Sends emails. 'nuff said.
+
+== SYNOPSIS:
+
+Run your app. That's all there's up to it.
+
+== REQUIREMENTS:
+
+ - Rails (tested on 2.3.12)
+
+== INSTALL:
+
+ 1. Add the anotifier gem to your gemfile
+ 2. Create a file config/anotifier_config.rb like this:
+ 
+ # -*- encoding : utf-8 -*-
+ ################################################################################
+ # Config file for Anotifier.
+ ################################################################################
+ 
+ module Anotifier
+   CONFIG = { 
+     :notifications_email_address => "joe@blow.com",
+     :application_name => "app.super-roundhouse.net"
+   }
+ end
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Commander Johnson <commanderjohnson@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/anotifier'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'anotifier' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/app/models/anotifier/resource_mailer.rb

@@ -0,0 +1,12 @@
+module Anotifier
+  class ResourceMailer < ActionMailer::Base
+    def new_resource(resource, sent_at = Time.now)
+      subject       "[#{Anotifier::CONFIG[:application_name]}] New #{resource.class} was created"
+      recipients    Anotifier::CONFIG[:notifications_email_address]
+      from          Anotifier::CONFIG[:notifications_email_address]
+      sent_on       sent_at
+    
+      body          :resource => resource
+    end
+  end
+end

data/app/models/anotifier/resource_observer.rb

@@ -0,0 +1,12 @@
+module Anotifier
+  class ResourceObserver < ActiveRecord::Observer
+    observe ActiveRecord::Base
+
+    def after_create resource
+      ################################################################################
+      # generic notification service
+      ################################################################################
+      Anotifier::ResourceMailer.deliver_new_resource(resource)
+    end
+  end
+end

data/app/views/anotifier/resource_mailer/new_resource.text.html.erb

@@ -0,0 +1,12 @@
+<p class="note">Please note: nonexistent and nil attributes are not listed.</p>
+
+<table class="new_resource">
+  <th>Attribute</th>
+  <th>Value</th>
+  <%- for attribute in @resource.attributes.keys %>
+    <tr>
+      <td><%= h attribute.to_s %></td>
+      <td><%= h @resource.attributes[attribute].inspect %></td>
+    </tr>
+  <%- end %>
+</table>

data/lib/anotifier.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Anotifier
+  VERSION = '0.0.1'
+end

data/rails/init.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+################################################################################
+# init.rb
+################################################################################
+
+# Load the config file
+require 'config/anotifier_config'
+
+raise "anotifier: Please create a config file config/anotifier_config.rb" unless defined? Anotifier::CONFIG
+
+config.after_initialize do
+	ActiveRecord::Base.observers << Anotifier::ResourceObserver
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/notifier.rb'}"
+puts "Loading notifier gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/anotifier'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: anotifier
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id001
+description: This Rails gem will send you an email whenever a record is created. This way, you can keep a tight track of what your users are doing. When you want to stop monitoring, simply remove the gem from the Gemfile.
+email: 
+- commanderjohnson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/anotifier.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- rails/init.rb
+- app/models/anotifier/resource_mailer.rb
+- app/models/anotifier/resource_observer.rb
+- app/views/anotifier/resource_mailer/new_resource.text.html.erb
+- .gemtest
+homepage: http://github.com/cmdjohnson/anotifier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: anotifier
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This Rails gem will send you an email whenever a record is created
+test_files: 
+- test/test_helper.rb