me_exceptional 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,5 +1,4 @@
 
-
 = MeExceptional 
 
 The Gem notifies you of application exceptions by email and adds some
@@ -14,7 +13,7 @@ Install the gem in your Rails 3 App as usual:
 
     gem install me_exceptional
 
-Add installation run the generator 
+After you have installed MeExceptional and added it to your Gemfile, run the generator.
 
     rails generate me_exceptional:install
 
@@ -22,16 +21,44 @@ The generator will create an initializer which you MUST take a look at
 and configure.
 
 
-Support for Rails 2.x is not provided so far.
+NOTE: Support for Rails 2.x is not provided so far.
 
 
 == Getting Started
 
-So far there's nothing much more to it. In your production environment you
-will get emails for controller exceptions.
+Being an engine MeExceptional has mailer and views already set up for
+you to get started; if your app raises an exception production mode you
+will get notified by email (note: doesn't work for routing errors so far
+because of a bug in rails). You may, however change view and mailer to
+suit you better.
 
 === Configuring views
 
-Coming Soon. 
+If you want to change the email, you just need to invoke the generator 
+that copies it over to your application:
+
+     rails generate me_exceptional:views
+
+This copies the mailer views to "/app/views/me_exceptional". 
+
+
+=== Configuring mailer
+
+In case you also want to customize the mailer, invoke the mailer generator:
+
+     rails generate me_exceptional:mailer
+
+This creates the directory "/app/mailers/me_exceptional" with the mailer contained.
+
+
+== Outlook
+
+* more gem side configuration options
+* asynchronous mailing options
+* routing errors and other errors 
+
+
+
+
 
 

data/lib/generators/me_exceptional/mailers_generator.rb

@@ -0,0 +1,16 @@
+module MeExceptional
+  module Generators
+
+    class MailersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/mailers", __FILE__)
+      desc "Copies all mailers to your applications"
+
+      def copy_mailers
+        directory "me_exceptional", "app/mailers/#{:me_exceptional}"
+      end
+
+    end
+  end
+end
+
+

data/lib/generators/me_exceptional/views_generator.rb

@@ -0,0 +1,18 @@
+module MeExceptional
+  module Generators
+
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views", __FILE__)
+
+      desc "Copies all views to your application"
+
+      def copy_views
+        directory "me_exceptional", "app/views/#{:me_exceptional}"
+      end
+
+    end
+
+  end
+end
+
+

data/lib/generators/templates/README

@@ -1,4 +1,16 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Be sure you have a working ActionMailer configuration
+
+  2. Ensure you have set up sender and receiver of the exception mails:
+
+       config.mailer_from = "please-change-me@example.com"
+       config.mailer_to   = "please-change-me@example.com"
+
+===============================================================================
+
 
-= README for MeExceptional
 
 

data/lib/me_exceptional/version.rb

@@ -1,3 +1,3 @@
 module MeExceptional
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: me_exceptional
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kai Rubarth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +02:00
+date: 2011-06-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,8 @@ files:
 - app/mailers/me_exceptional/mailer.rb
 - app/views/me_exceptional/mailer/exceptional.html.erb
 - lib/generators/me_exceptional/install_generator.rb
+- lib/generators/me_exceptional/mailers_generator.rb
+- lib/generators/me_exceptional/views_generator.rb
 - lib/generators/templates/README
 - lib/generators/templates/me_exceptional.rb
 - lib/me_exceptional.rb