mail_spy 0.0.2 → 0.0.3

data/README.rdoc

@@ -12,57 +12,63 @@ Add gem "mailspy" to your Gemfile
  gem "mailspy"
 
 
+If you haven't already create a mongoid.yml file for the mongodb connection
+ rails generate mongoid:config
+
 Create the mongoid configuration for the mongo db
 
- rails g mailspy:initialize
+ rails g mail_spy:initializer
 
-Fill out the generated mailspy_mongoid.yml with the mongodb configuration settings
+Fill out the generated mailspy.rb with your esp settings (file has example)
 
 Then mount the engine in the routes.rb file
   Rails.application.routes.draw do
-    mount MailSpy::Engine => "/mailspy"
+    mount MailSpy::Engine => "/mail_spy"
   end
 
 == Usage
 
-To start using the viral tool simply enable it by
+Mailspy is centered around email templates and instances of those templates
+(aka emails).
 
-Adding the Virality module to Application Controller
-  class ApplicationController < ActionController::Base
-    include Virality
-    before_filter :track_virality
+To create a template:
 
-  end
+MailSpy.add_template(template_name, html_erb, text_erb, template_values_definition)
 
-This will give you access to the following methods in lib/virality.rb these
-methods are the complete client interface for the tool.
+ * Template name must be unique to all templates
+ * html, and text are the contents for a multipart email
+ * template_values_definition is a array of keys that should be present in the
+   template values of each hash
 
-You will want to get started by instrumenting you code with the record_* methods
-and using the message_for_conceit to populate your channel messages
 
+To create a instance:
 
+MailSpy.add_instance(options)
 
-== packaging into a application
+required options include:
+
+ * :template_name
+ * :campaign :top level grouping
+ * :stream : mid level grouping
+ * :component : bottom level grouping
+ * :schedule_at
+ * :subject
+ * :template_values
+ * :from
+ * :reply_to
+ * one of [:to, :cc, :bcc]
 
-If you don't have a private gem server you can package the gem into your
-application since its not open source...
 
-1) gem build viral.gemspec
-2) rvm 1.9.2@global gem install viral-0.7.3.gem
-3) gem unpack viral -v '0.7.3' --target vendor/gems/
-4) Add the gemspec file to the vendored unpacked gem.
-5) bundle install
 
 == Testing
 
-You will need to add your own database.yml to the dummy app, rake db:create, and
+You will need to add your own mongoid.yml to the dummy app, rake db:create, and
 rake db:migrate and rake db:test:prepare to get the dummy app setup.
 
 Then you can simply run rake from the plugins test directory
 
+TODO explain the test_email_credentials.yml file in /test
 
 
 == License
-This project is property of Ooga Labs and not open source software
-
 This project rocks and uses MIT-LICENSE.

data/lib/mail_spy/version.rb

@@ -1,3 +1,3 @@
 module MailSpy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -2,7 +2,7 @@
 name: mail_spy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Timothy Cardenas
@@ -193,7 +193,7 @@ files:
 - app/models/mail_spy/stream_report.rb
 - app/views/layouts/mail_spy/application.html.erb
 - config/routes.rb
-- lib/generators/mail_spy/initialize_generator.rb
+- lib/generators/mail_spy/initializer_generator.rb
 - lib/generators/mail_spy/templates/mail_spy.rb
 - lib/mail_spy/engine.rb
 - lib/mail_spy/manager.rb