mack-notifier 0.6.1.1 → 0.6.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. data/doc/classes/Mack/Errors/UnconvertedNotifier.html +111 -0
  2. data/doc/classes/Mack/Notifier.html +698 -0
  3. data/doc/classes/Mack/Notifier/Adapters/Base.html +134 -0
  4. data/doc/classes/Mack/Notifier/Adapters/Tmail.html +256 -0
  5. data/doc/classes/Mack/Notifier/Attachment.html +270 -0
  6. data/doc/classes/Mack/Notifier/DeliveryHandlers/SendMail.html +154 -0
  7. data/doc/classes/Mack/Notifier/DeliveryHandlers/Smtp.html +153 -0
  8. data/doc/classes/Mack/Notifier/DeliveryHandlers/Test.html +147 -0
  9. data/doc/classes/Mack/Notifier/Validatable.html +419 -0
  10. data/doc/classes/Mack/Paths.html +197 -0
  11. data/doc/classes/NotifierGenerator.html +133 -0
  12. data/doc/created.rid +1 -0
  13. data/doc/files/README.html +150 -0
  14. data/doc/files/lib/mack-notifier/adapters/base_rb.html +101 -0
  15. data/doc/files/lib/mack-notifier/adapters/tmail_rb.html +108 -0
  16. data/doc/files/lib/mack-notifier/attachment_rb.html +101 -0
  17. data/doc/files/lib/mack-notifier/delivery_handlers/sendmail_rb.html +101 -0
  18. data/doc/files/lib/mack-notifier/delivery_handlers/smtp_rb.html +108 -0
  19. data/doc/files/lib/mack-notifier/delivery_handlers/test_rb.html +101 -0
  20. data/doc/files/lib/mack-notifier/errors_rb.html +101 -0
  21. data/doc/files/lib/mack-notifier/loader_rb.html +107 -0
  22. data/doc/files/lib/mack-notifier/notifier_generator/notifier_generator_rb.html +123 -0
  23. data/doc/files/lib/mack-notifier/notifier_rb.html +101 -0
  24. data/doc/files/lib/mack-notifier/paths_rb.html +101 -0
  25. data/doc/files/lib/mack-notifier/rendering/type/mailer_rb.html +101 -0
  26. data/doc/files/lib/mack-notifier/settings_rb.html +101 -0
  27. data/doc/files/lib/mack-notifier/testing_rb.html +142 -0
  28. data/doc/files/lib/mack-notifier/validations_rb.html +101 -0
  29. data/doc/files/lib/mack-notifier_rb.html +110 -0
  30. data/doc/fr_class_index.html +37 -0
  31. data/doc/fr_file_index.html +43 -0
  32. data/doc/fr_method_index.html +61 -0
  33. data/doc/index.html +24 -0
  34. data/doc/rdoc-style.css +208 -0
  35. metadata +36 -2
data/doc/classes/NotifierGenerator.html ADDED
@@ -0,0 +1,133 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: NotifierGenerator</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">NotifierGenerator</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/mack-notifier/notifier_generator/notifier_generator_rb.html">
59
+ lib/mack-notifier/notifier_generator/notifier_generator.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Genosaurus
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ Generates the necessary files for a basic notifier.
84
+ </p>
85
+ <p>
86
+ Example:
87
+ </p>
88
+ <pre>
89
+ rake generate:notifier name=welcome_email
90
+ </pre>
91
+ <p>
92
+ generates the following files:
93
+ </p>
94
+ <pre>
95
+ app/notifiers/welcome_email.rb
96
+ app/notifiers/templates/welcome_email/text.erb
97
+ app/notifiers/templates/welcome_email/html.erb
98
+ test/unit/welcome_email_spec.rb # =&gt; if using RSpec
99
+ test/unit/welcome_email_test.rb # =&gt; if using Test::Unit::TestCase
100
+ </pre>
101
+
102
+ </div>
103
+
104
+
105
+ </div>
106
+
107
+
108
+ </div>
109
+
110
+
111
+ <!-- if includes -->
112
+
113
+ <div id="section">
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ <!-- if method_list -->
123
+
124
+
125
+ </div>
126
+
127
+
128
+ <div id="validator-badges">
129
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
130
+ </div>
131
+
132
+ </body>
133
+ </html>
data/doc/created.rid ADDED
@@ -0,0 +1 @@
1
+ Fri, 29 Aug 2008 11:20:18 -0400
data/doc/files/README.html ADDED
@@ -0,0 +1,150 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>File: README</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="fileHeader">
50
+ <h1>README</h1>
51
+ <table class="header-table">
52
+ <tr class="top-aligned-row">
53
+ <td><strong>Path:</strong></td>
54
+ <td>README
55
+ </td>
56
+ </tr>
57
+ <tr class="top-aligned-row">
58
+ <td><strong>Last Update:</strong></td>
59
+ <td>Mon Aug 25 10:11:30 -0400 2008</td>
60
+ </tr>
61
+ </table>
62
+ </div>
63
+ <!-- banner header -->
64
+
65
+ <div id="bodyContent">
66
+
67
+
68
+
69
+ <div id="contextContent">
70
+
71
+ <div id="description">
72
+ <p>
73
+ This gem provides a simple API for creating emails within a Mack
74
+ application.
75
+ </p>
76
+ <p>
77
+ A simple <a href="../classes/Mack/Notifier.html">Mack::Notifier</a> model
78
+ would look like this:
79
+ </p>
80
+ <pre>
81
+ class WelcomeEmail
82
+ include Mack::Notifier
83
+ end
84
+ </pre>
85
+ <p>
86
+ To use this in your application you would do something like the following:
87
+ </p>
88
+ <pre>
89
+ mail = WelcomeEmail.new
90
+ mail.to = &quot;foo@example.com&quot;
91
+ mail.from = &quot;me@example.com&quot;
92
+ mail.subject = &quot;Hello&quot;
93
+ mail.body(:plain, &quot;This is my plain text body&quot;)
94
+ mail.body(:html, &quot;This is my &lt;b&gt;HTML&lt;/b&gt; body&quot;)
95
+ mail.attach(Mack::Notifier::Attachment.new(&quot;/path/to/my/image_file.png&quot;))
96
+ mail.attach(Mack::Notifier::Attachment.new(&quot;/path/to/my/pdf_file.pdf&quot;))
97
+ mail.deliver
98
+ </pre>
99
+ <p>
100
+ This gem currently has an adapter for TMail, but it can support any mailing
101
+ framework under the covers with the creation of a simple adapter class.
102
+ </p>
103
+ <p>
104
+ Currently implemented delivery handlers are: SMTP (default), sendmail, and
105
+ test.
106
+ </p>
107
+ <h2>Testing</h2>
108
+ <p>
109
+ When testing you can get access to delivered emails with the
110
+ delivered_emails method. After each tests these emails will be flushed our
111
+ of the test handler.
112
+ </p>
113
+ <h2>Rake tasks</h2>
114
+ <pre>
115
+ # Generates a notifier model, a test, and text and html template files.
116
+ rake generate:notifier
117
+ </pre>
118
+
119
+ </div>
120
+
121
+
122
+ </div>
123
+
124
+
125
+ </div>
126
+
127
+
128
+ <!-- if includes -->
129
+
130
+ <div id="section">
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <!-- if method_list -->
140
+
141
+
142
+ </div>
143
+
144
+
145
+ <div id="validator-badges">
146
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
147
+ </div>
148
+
149
+ </body>
150
+ </html>
data/doc/files/lib/mack-notifier/adapters/base_rb.html ADDED
@@ -0,0 +1,101 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>File: base.rb</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="fileHeader">
50
+ <h1>base.rb</h1>
51
+ <table class="header-table">
52
+ <tr class="top-aligned-row">
53
+ <td><strong>Path:</strong></td>
54
+ <td>lib/mack-notifier/adapters/base.rb
55
+ </td>
56
+ </tr>
57
+ <tr class="top-aligned-row">
58
+ <td><strong>Last Update:</strong></td>
59
+ <td>Mon Aug 25 10:11:30 -0400 2008</td>
60
+ </tr>
61
+ </table>
62
+ </div>
63
+ <!-- banner header -->
64
+
65
+ <div id="bodyContent">
66
+
67
+
68
+
69
+ <div id="contextContent">
70
+
71
+
72
+
73
+ </div>
74
+
75
+
76
+ </div>
77
+
78
+
79
+ <!-- if includes -->
80
+
81
+ <div id="section">
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+ <!-- if method_list -->
91
+
92
+
93
+ </div>
94
+
95
+
96
+ <div id="validator-badges">
97
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
98
+ </div>
99
+
100
+ </body>
101
+ </html>
data/doc/files/lib/mack-notifier/adapters/tmail_rb.html ADDED
@@ -0,0 +1,108 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>File: tmail.rb</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="fileHeader">
50
+ <h1>tmail.rb</h1>
51
+ <table class="header-table">
52
+ <tr class="top-aligned-row">
53
+ <td><strong>Path:</strong></td>
54
+ <td>lib/mack-notifier/adapters/tmail.rb
55
+ </td>
56
+ </tr>
57
+ <tr class="top-aligned-row">
58
+ <td><strong>Last Update:</strong></td>
59
+ <td>Mon Aug 25 10:11:30 -0400 2008</td>
60
+ </tr>
61
+ </table>
62
+ </div>
63
+ <!-- banner header -->
64
+
65
+ <div id="bodyContent">
66
+
67
+
68
+
69
+ <div id="contextContent">
70
+
71
+
72
+ <div id="requires-list">
73
+ <h3 class="section-bar">Required files</h3>
74
+
75
+ <div class="name-list">
76
+ base64&nbsp;&nbsp;
77
+ </div>
78
+ </div>
79
+
80
+ </div>
81
+
82
+
83
+ </div>
84
+
85
+
86
+ <!-- if includes -->
87
+
88
+ <div id="section">
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <!-- if method_list -->
98
+
99
+
100
+ </div>
101
+
102
+
103
+ <div id="validator-badges">
104
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
105
+ </div>
106
+
107
+ </body>
108
+ </html>