bakedweb-model_notifier 0.2.0

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+log/*
+db/*.sqlite3
+tmp
+*.sqlite3
+*.log
+schema.rb
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ivan Acosta-Rubio
+
+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,7 @@
+= model_notifier
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Ivan Acosta-Rubio. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "model_notifier"
+    gemspec.summary = "send an email when a watched model is created"
+    gemspec.email = "ivan@bakedweb.net"
+    gemspec.homepage = "http://github.com/bakedweb/model_notifier"
+    gemspec.description = "Notifies when a model is created"
+    gemspec.authors = ["Ivan Acosta-Rubio", "Corey Haines"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: features -r features
+focus: features -r features -t focus

data/features/model_notifier.feature

@@ -0,0 +1,24 @@
+Feature: Externalized Observer for notifying on model creation
+  In order to use the email notifier for model creation
+  As a developer of a webapp
+  I want to have the externalized notifier be configured and send me an email
+
+
+  Background:
+    And the following configuration
+    | recipient_email   | model_to_watch | subject      |
+    | corey@example.com | :contact_form  | test subject |
+
+
+  Scenario: Getting an email for a Contact Form
+    Given a new ContactForm with
+    | name | comment        |
+    | ivan | please help me |
+
+    When I save the contact form
+    Then I should receive an email
+    When I open the email
+    Then I should see "test subject" in the subject
+  
+  
+  

data/features/step_definitions/email_steps.rb

@@ -0,0 +1,74 @@
+#Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# reset_mailer 
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+
+module EmailHelpers
+  def current_email_address
+    "corey@example.com" # Replace with your a way to find your current_email. e.g current_user.email
+  end
+end
+World(EmailHelpers)
+
+# Use this step to reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+# Use this step to open the most recently sent e-mail. 
+When /^I open the email$/ do
+  open_email(current_email_address)
+end
+
+When %r{^I follow "([^"]*?)" in the email$} do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (an|\d+) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount.to_i
+end
+
+Then %r{^"([^"]*?)" should receive (\d+) emails?$} do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then %r{^"([^"]*?)" should not receive an email$} do |address|
+  find_email(address).should be_nil
+end
+
+Then %r{^I should see "([^"]*?)" in the subject$} do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then %r{^I should see "([^"]*?)" in the email$} do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^I click the first link in the email$/ do
+  click_first_link_in_email
+end
+

data/features/step_definitions/model_notifier_steps.rb

@@ -0,0 +1,18 @@
+Given /^the following configuration$/ do |table|
+  configuration = table.hashes[0]
+  ModelNotifier.configure do
+    recipients configuration[:recipient_email]
+    model configuration[:model_to_watch][1..-1].to_sym
+    subject configuration[:subject]
+  end
+end
+
+Given /^a new ContactForm with$/ do |form|
+  @contact_form = ContactForm.new(form.hashes[0])
+end
+
+When /^I save the contact form$/ do
+  @contact_form.save
+end
+
+

data/features/support/env.rb

@@ -0,0 +1,12 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../test_rails_app/config/environment')
+require 'cucumber/rails/world'
+require 'cucumber/formatter/unicode' # Comment out this line if you don't want Cucumber Unicode support
+Cucumber::Rails.use_transactional_fixtures
+Cucumber::Rails.bypass_rescue # Comment out this line if you want Rails own error handling 
+                              # (e.g. rescue_action_in_public / rescue_responses / rescue_from)
+
+require 'cucumber/rails/rspec'
+require 'email_spec/cucumber'
+require 'lib/model_notifier'

data/lib/model_notifier.rb

@@ -0,0 +1,61 @@
+class ModelNotifier < ActionMailer::Base
+  
+  def self.configure(&block)
+    @configurations ||= {}
+    configuration = configuration_from &block
+    configure_model configuration.watched_model
+    save_the configuration
+  end  
+  
+  def self.after_create(model)
+    model_name = model.class.name.underscore.to_sym
+    configuration = @configurations[model_name]
+    
+    ModelNotifier.deliver_notification_email configuration, model
+  end
+
+  def notification_email(configuration, model)
+    recipients configuration.deliver_to
+    body :model => model
+    subject configuration.subject_line
+    mailer_name "#{self.class.name.underscore}/#{model.class.name.underscore}"
+  end
+
+  
+  private
+  def self.save_the(configuration)
+    @configurations[configuration.watched_model] = configuration
+  end
+  def self.configure_model(model_name)
+    return if @configurations.has_key?(model_name)
+    observe_model model_name
+  end
+  
+  def self.configuration_from(&block)
+    configuration = Configuration.new
+    configuration.instance_eval &block
+    configuration
+  end
+  
+  def self.observe_model(model_name)
+    model = model_name.to_s.camelize.constantize
+    model.after_create ModelNotifier
+  end
+  
+  
+  class Configuration
+    attr_reader :deliver_to
+    attr_reader :watched_model
+    attr_reader :subject_line
+    
+    def model(model_name)
+      @watched_model = model_name
+    end
+    def recipients(recipient)
+      @deliver_to = recipient
+    end
+    def subject(subject)
+      @subject_line = subject
+    end
+  end
+end

data/spec/lib/model_notifier_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ModelNotifier do
+  context "when configuring" do
+    it "can be configured with model, recipients, subject" do
+      ModelNotifier.configure do
+        model :foo
+        recipients "corey@example.com"
+        subject "test email from corey"
+      end
+    end
+  end
+  
+  context "when saving the watched model" do
+    before(:each) do
+      expected_recipient = @expected_recipient = "corey@example.com"
+      expected_subject = @expected_subject = "this is a great email"
+      ModelNotifier.configure do
+        model :contact_form
+        recipients expected_recipient
+        subject expected_subject
+      end
+      @contact = ContactForm.new
+    end
+    
+    it "receives the newly-created model through the after_create hook" do
+      ModelNotifier.should_receive(:after_create).with(@contact)
+      @contact.save
+    end
+    it "calls deliver_notification_email" do
+      ModelNotifier.should_receive(:deliver_notification_email).with(anything, @contact)
+      @contact.save
+    end
+
+    context "when email is being created and delivered" do
+      include EmailSpec::Helpers
+      include EmailSpec::Matchers
+      before(:each) do
+        @configuration = mock("configuration", :deliver_to => @expected_recipient, :subject_line => @expected_subject)
+        @email = ModelNotifier.deliver_notification_email(@configuration, @contact)
+      end
+
+      it "delivers to the recipient on the configuration" do
+        @email.should deliver_to(@configuration.deliver_to)
+      end
+  
+      it "passes the contact object into the mail" do
+        @email.should have_text(/#{@contact}/)
+      end
+
+      it "sets the subject to what we have configured" do
+        @email.should have_subject(@expected_subject)
+      end
+
+      context "when rendering email according to model name" do
+        before(:each) do
+          expected_recipient = @expected_recipient
+          ModelNotifier.configure do
+            model :foo
+            recipients expected_recipient
+          end
+        end
+        it "renders contact_form/notification_email.rb for ContactForm" do
+          contact = ContactForm.new
+          @email = ModelNotifier.deliver_notification_email(@configuration, contact)
+          @email.should have_text(/Contact Email/)
+        end
+        it "renders foo/notification_email.rb for Foo" do
+          foo = Foo.new
+          @email = ModelNotifier.deliver_notification_email(@configuration, foo)
+          @email.should have_text(/Foo Template/)
+        end
+      end
+    end
+
+
+
+  end
+
+
+
+end

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*" 
+--rails

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.dirname(__FILE__) + "/../test_rails_app/config/environment" unless defined?(RAILS_ROOT)
+require 'spec/autorun'
+require 'spec/rails'
+
+require "email_spec/helpers"
+require "email_spec/matchers"
+
+require 'lib/model_notifier'
+
+Spec::Runner.configure do |config|
+  # If you're not using ActiveRecord you should remove these
+  # lines, delete config/database.yml and disable :active_record
+  # in your config/boot.rb
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+  config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+
+  # == Fixtures
+  #
+  # You can declare fixtures for each example_group like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so right here. Just uncomment the next line and replace the fixture
+  # names with your fixtures.
+  #
+  # config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+  #
+  # You can also declare which fixtures to use (for example fixtures for test/fixtures):
+  #
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+  #
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  #
+  # == Notes
+  # 
+  # For more information take a look at Spec::Runner::Configuration and Spec::Runner
+end

data/test_rails_app/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Apache .htaccess example
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.