postful 0.2.0 → 0.3.1

data/doc/files/lib/postful/util_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Aug 11 20:16:49 -0700 2008</td>
+      <td>Fri Nov 21 15:40:51 -0800 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/postful_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Aug 11 14:14:29 -0700 2008</td>
+      <td>Mon Aug 11 13:14:29 -0700 2008</td>
     </tr>
     </table>
   </div>

data/doc/fr_class_index.html

@@ -22,12 +22,16 @@
   <div id="index-entries">
     <a href="classes/Postful/AuthorizationException.html">Postful::AuthorizationException</a><br />
     <a href="classes/Postful/Base.html">Postful::Base</a><br />
+    <a href="classes/Postful/Document.html">Postful::Document</a><br />
     <a href="classes/Postful/InternalServerError.html">Postful::InternalServerError</a><br />
     <a href="classes/Postful/Letter.html">Postful::Letter</a><br />
     <a href="classes/Postful/NotFoundException.html">Postful::NotFoundException</a><br />
     <a href="classes/Postful/Order.html">Postful::Order</a><br />
     <a href="classes/Postful/Postcard.html">Postful::Postcard</a><br />
+    <a href="classes/Postful/Section.html">Postful::Section</a><br />
     <a href="classes/Postful/Service.html">Postful::Service</a><br />
+    <a href="classes/Postful/SimpleDocument.html">Postful::SimpleDocument</a><br />
+    <a href="classes/Postful/TemplateDocument.html">Postful::TemplateDocument</a><br />
     <a href="classes/Postful/UnknownResponseException.html">Postful::UnknownResponseException</a><br />
     <a href="classes/Postful/ValidationException.html">Postful::ValidationException</a><br />
   </div>

data/doc/fr_file_index.html

@@ -24,11 +24,15 @@
     <a href="files/README.html">README</a><br />
     <a href="files/lib/postful_rb.html">lib/postful.rb</a><br />
     <a href="files/lib/postful/base_rb.html">lib/postful/base.rb</a><br />
+    <a href="files/lib/postful/document_rb.html">lib/postful/document.rb</a><br />
     <a href="files/lib/postful/instance_exec_module_rb.html">lib/postful/instance_exec_module.rb</a><br />
     <a href="files/lib/postful/letter_rb.html">lib/postful/letter.rb</a><br />
     <a href="files/lib/postful/order_rb.html">lib/postful/order.rb</a><br />
     <a href="files/lib/postful/postcard_rb.html">lib/postful/postcard.rb</a><br />
+    <a href="files/lib/postful/section_rb.html">lib/postful/section.rb</a><br />
     <a href="files/lib/postful/service_rb.html">lib/postful/service.rb</a><br />
+    <a href="files/lib/postful/simple_document_rb.html">lib/postful/simple_document.rb</a><br />
+    <a href="files/lib/postful/template_document_rb.html">lib/postful/template_document.rb</a><br />
     <a href="files/lib/postful/util_rb.html">lib/postful/util.rb</a><br />
   </div>
 </div>

data/doc/fr_method_index.html

@@ -20,35 +20,64 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Postful/Base.html#M000002">add_address (Postful::Base)</a><br />
-    <a href="classes/Postful/Postcard.html#M000013">add_border (Postful::Postcard)</a><br />
-    <a href="classes/Postful/Letter.html#M000018">add_html_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000019">add_html_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Base.html#M000003">add_international_address (Postful::Base)</a><br />
-    <a href="classes/Postful/Letter.html#M000024">add_open_office_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000025">add_open_office_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000028">add_pdf_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000029">add_pdf_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000022">add_rtf_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000023">add_rtf_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000026">add_text_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000027">add_text_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000020">add_word_document (Postful::Letter)</a><br />
-    <a href="classes/Postful/Letter.html#M000021">add_word_document_from_file (Postful::Letter)</a><br />
-    <a href="classes/Postful/Postcard.html#M000012">back_image_from_file= (Postful::Postcard)</a><br />
-    <a href="classes/Postful/Order.html#M000009">cancel (Postful::Order)</a><br />
-    <a href="classes/Postful/Service.html#M000016">cancel_order_by_id (Postful::Service)</a><br />
-    <a href="classes/Postful/Base.html#M000006">errors (Postful::Base)</a><br />
-    <a href="classes/Postful/Service.html#M000017">find_all_orders (Postful::Service)</a><br />
-    <a href="classes/Postful/Service.html#M000015">find_order_by_id (Postful::Service)</a><br />
-    <a href="classes/Postful/Postcard.html#M000011">front_image_from_file= (Postful::Postcard)</a><br />
-    <a href="classes/Postful/Base.html#M000004">mail! (Postful::Base)</a><br />
-    <a href="classes/Postful/Order.html#M000010">new (Postful::Order)</a><br />
-    <a href="classes/Postful/Service.html#M000014">new (Postful::Service)</a><br />
-    <a href="classes/Postful/Base.html#M000001">new (Postful::Base)</a><br />
-    <a href="classes/Postful/Order.html#M000007">preview (Postful::Order)</a><br />
-    <a href="classes/Postful/Order.html#M000008">refresh (Postful::Order)</a><br />
-    <a href="classes/Postful/Base.html#M000005">valid? (Postful::Base)</a><br />
+    <a href="classes/Postful/Base.html#M000007">add_address (Postful::Base)</a><br />
+    <a href="classes/Postful/Postcard.html#M000025">add_border (Postful::Postcard)</a><br />
+    <a href="classes/Postful/Base.html#M000005">add_document (Postful::Base)</a><br />
+    <a href="classes/Postful/Letter.html#M000041">add_html_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000042">add_html_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000043">add_html_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/Base.html#M000008">add_international_address (Postful::Base)</a><br />
+    <a href="classes/Postful/Letter.html#M000050">add_open_office_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000051">add_open_office_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000052">add_open_office_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000056">add_pdf_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000057">add_pdf_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000058">add_pdf_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000031">add_property (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Letter.html#M000047">add_rtf_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000048">add_rtf_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000049">add_rtf_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000033">add_section (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Letter.html#M000053">add_text_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000054">add_text_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000055">add_text_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000044">add_word_document (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000045">add_word_document_from_file (Postful::Letter)</a><br />
+    <a href="classes/Postful/Letter.html#M000046">add_word_document_from_url (Postful::Letter)</a><br />
+    <a href="classes/Postful/Postcard.html#M000024">back_image_from_file= (Postful::Postcard)</a><br />
+    <a href="classes/Postful/Section.html#M000022">build_request (Postful::Section)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000029">build_request (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/SimpleDocument.html#M000001">build_request (Postful::SimpleDocument)</a><br />
+    <a href="classes/Postful/Order.html#M000015">cancel (Postful::Order)</a><br />
+    <a href="classes/Postful/Service.html#M000039">cancel_order_by_id (Postful::Service)</a><br />
+    <a href="classes/Postful/Document.html#M000028">do_upload (Postful::Document)</a><br />
+    <a href="classes/Postful/Section.html#M000021">do_upload (Postful::Section)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000036">do_upload (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Base.html#M000006">document (Postful::Base)</a><br />
+    <a href="classes/Postful/Base.html#M000011">errors (Postful::Base)</a><br />
+    <a href="classes/Postful/Section.html#M000019">filename (Postful::Section)</a><br />
+    <a href="classes/Postful/Service.html#M000040">find_all_orders (Postful::Service)</a><br />
+    <a href="classes/Postful/Service.html#M000038">find_order_by_id (Postful::Service)</a><br />
+    <a href="classes/Postful/Postcard.html#M000023">front_image_from_file= (Postful::Postcard)</a><br />
+    <a href="classes/Postful/Base.html#M000009">mail! (Postful::Base)</a><br />
+    <a href="classes/Postful/Service.html#M000037">new (Postful::Service)</a><br />
+    <a href="classes/Postful/Document.html#M000026">new (Postful::Document)</a><br />
+    <a href="classes/Postful/Base.html#M000004">new (Postful::Base)</a><br />
+    <a href="classes/Postful/Order.html#M000016">new (Postful::Order)</a><br />
+    <a href="classes/Postful/Section.html#M000017">new (Postful::Section)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000030">new (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Order.html#M000013">preview (Postful::Order)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000032">property (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Order.html#M000014">refresh (Postful::Order)</a><br />
+    <a href="classes/Postful/SimpleDocument.html#M000002">requires_upload? (Postful::SimpleDocument)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000035">requires_upload? (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Document.html#M000027">requires_upload? (Postful::Document)</a><br />
+    <a href="classes/Postful/Section.html#M000020">requires_upload? (Postful::Section)</a><br />
+    <a href="classes/Postful/TemplateDocument.html#M000034">section (Postful::TemplateDocument)</a><br />
+    <a href="classes/Postful/Section.html#M000018">text (Postful::Section)</a><br />
+    <a href="classes/Postful/SimpleDocument.html#M000003">upload (Postful::SimpleDocument)</a><br />
+    <a href="classes/Postful/Base.html#M000012">upload_assets (Postful::Base)</a><br />
+    <a href="classes/Postful/Base.html#M000010">valid? (Postful::Base)</a><br />
   </div>
 </div>
 </body>

data/lib/postful/base.rb

@@ -1,6 +1,7 @@
 require 'builder'
 require File.join(File.dirname(__FILE__), 'order')
 require File.join(File.dirname(__FILE__), 'util')
+require File.join(File.dirname(__FILE__), 'template_document')
 
 module Postful #:nodoc:
   class AuthorizationException < StandardError; end
@@ -17,6 +18,7 @@ module Postful #:nodoc:
     attr_accessor :tag2
     attr_accessor :tag3
     attr_accessor :return_address
+    attr_accessor :sections
     
     include Util
     
@@ -25,8 +27,19 @@ module Postful #:nodoc:
       @password = password
       @documents = []      
       @addressees = []
+      @sections = []
     end
 
+    # Adds a new document to the request that should be customized by setting section properties
+    def add_document(name, options = {}, &block)
+      returning TemplateDocument.new(name, @email, @password) do |document|
+        document.instance_exec(&block) if block
+        document.source = options[:source] if options[:source]
+        @documents << document
+      end
+    end
+    alias_method :document, :add_document
+
     # Add a domestic recipient to a mailing      
     def add_address(attributes = {})
       returning DomesticAddress.new do |address|
@@ -97,8 +110,15 @@ module Postful #:nodoc:
     def validate #:nodoc:
       errors << 'Requires at least one addressee' if @addressees.empty?
     end
+    
+    def upload_assets
+      @documents.each do |document|
+        document.do_upload if document.requires_upload?
+      end      
+    end
 
     def mail_without_validation! #:nodoc:
+      upload_assets
       xml = build_request
       send_request(xml)
     end

data/lib/postful/document.rb

@@ -0,0 +1,18 @@
+module Postful
+  class Document
+    include Util
+
+    def initialize(email, password)
+      @email = email
+      @password = password
+    end      
+
+    def requires_upload?
+      false
+    end
+    
+    def do_upload
+      
+    end
+  end
+end

data/lib/postful/letter.rb

@@ -2,6 +2,7 @@ require 'net/https'
 require 'builder'
 require File.join(File.dirname(__FILE__), 'base')
 require File.join(File.dirname(__FILE__), 'util')
+require File.join(File.dirname(__FILE__), 'simple_document')
 
 module Postful
   # Builder for mailing letters with the Postful Web Service.
@@ -9,62 +10,92 @@ module Postful
   class Letter < Base    
     # Add an HTML document to the request
     def add_html_document(text)
-      add_document('html', text)
+      add_simple_document('html', text)
     end
     
     # Add an HTML document to the request
     def add_html_document_from_file(filename)
-      add_document_from_file('html', filename)
+      add_simple_document_from_file('html', filename)
+    end    
+
+    # Add an HTML document to the request
+    def add_html_document_from_url(url)
+      add_simple_document_from_url('html', url)
     end    
 
     # Add a Microsoft Word document to the request
     def add_word_document(text)
-      add_document('doc', text)
+      add_simple_document('doc', text)
     end
 
     # Add a Microsoft Word document to the request
     def add_word_document_from_file(filename)
-      add_document_from_file('doc', filename)
+      add_simple_document_from_file('doc', filename)
+    end
+
+    # Add a Microsoft Word document to the request
+    def add_word_document_from_url(url)
+      add_simple_document_from_url('doc', url)
     end
 
     # Add a Rich Text Format document to the request
     def add_rtf_document(text)
-      add_document('rtf', text)
+      add_simple_document('rtf', text)
     end
 
     # Add a Rich Text Format document to the request
     def add_rtf_document_from_file(filename)
-      add_document_from_file('rtf', filename)
+      add_simple_document_from_file('rtf', filename)
+    end
+
+    # Add a Rich Text Format document to the request
+    def add_rtf_document_from_url(url)
+      add_simple_document_from_url('rtf', url)
     end
 
     # Add an Open Office document to the request
     def add_open_office_document(text)
-      add_document('odt', text)
+      add_simple_document('odt', text)
     end
 
     # Add an Open Office document to the request
     def add_open_office_document_from_file(filename)
-      add_document_from_file('odt', filename)
+      add_simple_document_from_file('odt', filename)
+    end
+
+    # Add an Open Office document to the request
+    def add_open_office_document_from_url(url)
+      add_simple_document_from_file('odt', url)
     end
 
     # Add a text document to the request
     def add_text_document(text)
-      add_document('txt', text)
+      add_simple_document('txt', text)
     end
 
     # Add a text document to the request
     def add_text_document_from_file(filename)
-      add_document_from_file('txt', filename)
+      add_simple_document_from_file('txt', filename)
+    end
+
+    # Add a text document to the request
+    def add_text_document_from_url(url)
+      add_simple_document_from_url('txt', url)
     end
 
     # Add a PDF document to the request
     def add_pdf_document(text)
-      add_document('pdf', text)
+      add_simple_document('pdf', text)
     end
 
     # Add a PDF document to the request
     def add_pdf_document_from_file(filename)
-      add_document_from_file('pdf', filename)
+      add_simple_document_from_file('pdf', filename)
+    end
+
+    # Add a PDF document to the request
+    def add_pdf_document_from_url(url)
+      add_simple_document_from_url('pdf', url)
     end
 
     protected
@@ -87,52 +118,28 @@ module Postful
       end
     end
 
-    def add_document(format, content)
-      returning Document.new(@email, @password) do |document|
+    def add_simple_document_from_url(format, url)
+      returning SimpleDocument.new(@email, @password) do |document|
+        document.format = format
+        document.url = url
+        @documents << document
+      end      
+    end
+
+    def add_simple_document(format, content)
+      returning SimpleDocument.new(@email, @password) do |document|
         document.format = format
         document.content = content
         @documents << document
       end      
     end
 
-    def add_document_from_file(format, filename)    
+    def add_simple_document_from_file(format, filename)    
       content = open(filename, "rb") do |io| 
         io.read
       end         
-      add_document(format, content)
+      add_simple_document(format, content)
     end       
     
-    class Document #:nodoc:
-      include Util
-  
-      attr_accessor :format
-      attr_accessor :content
-      attr_accessor :attachment_name
-  
-      def initialize(email, password)
-        @email = email
-        @password = password
-      end      
-      
-      def build_request(builder)
-        builder.document do
-          builder.type format
-          builder.attachment attachment_name
-        end
-      end
-      
-      def upload
-        headers = { 
-          'Content-Type' => 'application/octet-stream',
-          'Content-Length' => content.size.to_s
-          }              
-        response = post_request_on_path('/service/upload', content, @email, @password, headers)
-        if response.is_a?(Net::HTTPOK) && response.body =~ /<id>(.*)<\/id>/        
-          self.attachment_name = $1 
-        else
-          # raise stuff
-        end
-      end     
-    end
   end
 end

data/lib/postful/postcard.rb

@@ -105,6 +105,10 @@ module Postful
         @sections = []
       end
       
+      def requires_upload?
+        false
+      end
+      
       def build_request(builder)
         builder.document do
           builder.template do 

data/lib/postful/section.rb

@@ -0,0 +1,46 @@
+module Postful
+  class Section
+    include Util
+
+    def initialize(name, email, password)
+      @name = name
+      @email = email
+      @password = password
+      @requires_upload = false
+    end      
+    
+    def text(text)
+      @text = text
+    end
+    
+    def filename(filename)
+      raise "File '#{filename}' not found" unless File.exist? filename
+      @requires_upload = true
+      @filename = filename
+    end
+
+    def requires_upload?
+      @requires_upload
+    end
+    
+    def do_upload
+      content = open(@filename, "rb") { |io| io.read }
+      headers = {  'Content-Type' => 'application/octet-stream', 'Content-Length' => content.size.to_s }              
+      response = post_request_on_path('/service/upload', content, @email, @password, headers)
+      if response.is_a?(Net::HTTPOK) && response.body =~ /<id>(.*)<\/id>/        
+        @attachment = $1 
+      else
+        raise 'Attachment name not found in response'
+      end      
+    end
+    
+    def build_request(builder)
+      builder.section do 
+        builder.name @name
+        builder.text @text if @text
+        builder.attachment @attachment if @attachment
+      end
+    end
+    
+  end
+end