postful 0.2.0 → 0.3.1

data/doc/classes/Postful/Base.html

@@ -86,12 +86,15 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000002">add_address</a>&nbsp;&nbsp;
-      <a href="#M000003">add_international_address</a>&nbsp;&nbsp;
-      <a href="#M000006">errors</a>&nbsp;&nbsp;
-      <a href="#M000004">mail!</a>&nbsp;&nbsp;
-      <a href="#M000001">new</a>&nbsp;&nbsp;
-      <a href="#M000005">valid?</a>&nbsp;&nbsp;
+      <a href="#M000007">add_address</a>&nbsp;&nbsp;
+      <a href="#M000005">add_document</a>&nbsp;&nbsp;
+      <a href="#M000008">add_international_address</a>&nbsp;&nbsp;
+      <a href="#M000006">document</a>&nbsp;&nbsp;
+      <a href="#M000011">errors</a>&nbsp;&nbsp;
+      <a href="#M000009">mail!</a>&nbsp;&nbsp;
+      <a href="#M000004">new</a>&nbsp;&nbsp;
+      <a href="#M000012">upload_assets</a>&nbsp;&nbsp;
+      <a href="#M000010">valid?</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -123,6 +126,11 @@
           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
           <td class="context-item-desc"></td>
         </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">sections</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">tag1</td>
           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
@@ -148,12 +156,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000001" class="method-detail">
-        <a name="M000001"></a>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000001.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000001.html');return false;">
+          <a href="Base.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000004.html');return false;">
           <span class="method-name">new</span><span class="method-args">(email, password)</span>
           </a>
         </div>
@@ -164,12 +172,12 @@
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000002.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000002.html');return false;">
+          <a href="Base.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000007.html');return false;">
           <span class="method-name">add_address</span><span class="method-args">(attributes = {})</span>
           </a>
         </div>
@@ -181,12 +189,31 @@ Add a domestic recipient to a mailing
         </div>
       </div>
 
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000005.html');return false;">
+          <span class="method-name">add_document</span><span class="method-args">(name, options = {}, &amp;block)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Adds a <a href="Base.html#M000004">new</a> <a
+href="Base.html#M000006">document</a> to the request that should be
+customized by setting section properties
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000003.html');return false;">
+          <a href="Base.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000008.html');return false;">
           <span class="method-name">add_international_address</span><span class="method-args">(lines, country)</span>
           </a>
         </div>
@@ -202,8 +229,22 @@ Add an international recipient to a mailing
         <a name="M000006"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000006.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000006.html');return false;">
+          <span class="method-name">document</span><span class="method-args">(name, options = {}, &amp;block)</span>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Alias for <a href="Base.html#M000005">add_document</a>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000011.html');return false;">
           <span class="method-name">errors</span><span class="method-args">()</span>
           </a>
         </div>
@@ -212,12 +253,12 @@ Add an international recipient to a mailing
         </div>
       </div>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000004.html');return false;">
+          <a href="Base.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000009.html');return false;">
           <span class="method-name">mail!</span><span class="method-args">()</span>
           </a>
         </div>
@@ -226,12 +267,12 @@ Add an international recipient to a mailing
         </div>
       </div>
 
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
 
         <div class="method-heading">
-          <a href="Base.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000005.html');return false;">
+          <a href="Base.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000010.html');return false;">
           <span class="method-name">valid?</span><span class="method-args">()</span>
           </a>
         </div>
@@ -240,6 +281,22 @@ Add an international recipient to a mailing
         </div>
       </div>
 
+      <h3 class="section-bar">Protected Instance methods</h3>
+
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+
+        <div class="method-heading">
+          <a href="Base.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('Base.src/M000012.html');return false;">
+          <span class="method-name">upload_assets</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
 
     </div>
 

data/doc/classes/Postful/Base.src/M000004.html

@@ -5,18 +5,18 @@
 
 <html>
 <head>
-  <title>mail! (Postful::Base)</title>
+  <title>new (Postful::Base)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 49</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mail!</span>
-      <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">valid?</span>
-        <span class="ruby-identifier">raise</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
-      <span class="ruby-keyword kw">else</span>
-        <span class="ruby-identifier">mail_without_validation!</span>
-      <span class="ruby-keyword kw">end</span>
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 25</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">email</span>, <span class="ruby-identifier">password</span>)
+      <span class="ruby-ivar">@email</span> = <span class="ruby-identifier">email</span>
+      <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
+      <span class="ruby-ivar">@documents</span> = []      
+      <span class="ruby-ivar">@addressees</span> = []
+      <span class="ruby-ivar">@sections</span> = []
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Postful/Base.src/M000005.html

@@ -5,16 +5,18 @@
 
 <html>
 <head>
-  <title>valid? (Postful::Base)</title>
+  <title>add_document (Postful::Base)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 57</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
-      <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">clear</span>
-      <span class="ruby-identifier">validate</span>
-      <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">empty?</span>
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 34</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_document</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+      <span class="ruby-identifier">returning</span> <span class="ruby-constant">TemplateDocument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@email</span>, <span class="ruby-ivar">@password</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">document</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">document</span>.<span class="ruby-identifier">instance_exec</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block</span>
+        <span class="ruby-identifier">document</span>.<span class="ruby-identifier">source</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:source</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:source</span>]
+        <span class="ruby-ivar">@documents</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">document</span>
+      <span class="ruby-keyword kw">end</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Postful/Base.src/{M000002.html → M000007.html}

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 31</span>
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 44</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_address</span>(<span class="ruby-identifier">attributes</span> = {})
       <span class="ruby-identifier">returning</span> <span class="ruby-constant">DomesticAddress</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">address</span><span class="ruby-operator">|</span>
         [<span class="ruby-identifier">:name</span>, <span class="ruby-identifier">:company</span>, <span class="ruby-identifier">:address</span>, <span class="ruby-identifier">:address2</span>, <span class="ruby-identifier">:city</span>, <span class="ruby-identifier">:state</span>, <span class="ruby-identifier">:postal_code</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">field</span><span class="ruby-operator">|</span>

data/doc/classes/Postful/Base.src/{M000003.html → M000008.html}

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 41</span>
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 54</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_international_address</span>(<span class="ruby-identifier">lines</span>, <span class="ruby-identifier">country</span>)
       <span class="ruby-identifier">returning</span> <span class="ruby-constant">InternationalAddress</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">address</span><span class="ruby-operator">|</span>
         <span class="ruby-identifier">address</span>.<span class="ruby-identifier">lines</span> = <span class="ruby-identifier">lines</span>

data/doc/classes/Postful/Base.src/M000009.html

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>mail! (Postful::Base)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 62</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mail!</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">valid?</span>
+        <span class="ruby-identifier">raise</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-identifier">mail_without_validation!</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Postful/Base.src/M000010.html

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>valid? (Postful::Base)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 70</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
+      <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">clear</span>
+      <span class="ruby-identifier">validate</span>
+      <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">empty?</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Postful/Base.src/{M000006.html → M000011.html}

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 63</span>
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 76</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">errors</span>
       <span class="ruby-ivar">@errors</span> <span class="ruby-operator">||=</span> []
     <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/Postful/Base.src/M000012.html

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>upload_assets (Postful::Base)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/postful/base.rb, line 114</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">upload_assets</span>
+      <span class="ruby-ivar">@documents</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">document</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">document</span>.<span class="ruby-identifier">do_upload</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">document</span>.<span class="ruby-identifier">requires_upload?</span>
+      <span class="ruby-keyword kw">end</span>      
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Postful/Document.html

@@ -0,0 +1,176 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Postful::Document</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Postful::Document</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/postful/document_rb.html">
+                lib/postful/document.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000028">do_upload</a>&nbsp;&nbsp;
+      <a href="#M000026">new</a>&nbsp;&nbsp;
+      <a href="#M000027">requires_upload?</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name">Util</span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+
+        <div class="method-heading">
+          <a href="Document.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000026.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(email, password)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+
+        <div class="method-heading">
+          <a href="Document.src/M000028.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000028.html');return false;">
+          <span class="method-name">do_upload</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+
+        <div class="method-heading">
+          <a href="Document.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000027.html');return false;">
+          <span class="method-name">requires_upload?</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>