postful 0.1.0

data/lib/postful/service.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+require "net/https"
+require File.join(File.dirname(__FILE__), 'order')
+require File.join(File.dirname(__FILE__), 'util')
+
+module Postful
+  class Service
+    include Util
+    
+    def initialize(email, password)
+      @email = email
+      @password = password
+    end
+    
+    def find_order_by_id(id)
+      response = get_request_on_path("/service/mail/#{id}", @email, @password)
+      case response.code
+        when "200" then
+          Postful::Order.build_from_response(response.body, @email, @password)
+        else
+          process_standard_responses(response)        
+      end            
+    end
+    
+    def cancel_order_by_id(id)
+      order = Postful::Order.new { @id = id }
+      order.cancel
+    end
+    
+    def find_all_orders
+      response = get_request_on_path("/service/mail", @email, @password)
+      case response.code
+        when "200" then
+          Postful::Order.build_all_from_response(response.body, @email, @password)
+        else
+          process_standard_responses(response)        
+      end            
+    end
+  end
+end

data/lib/postful/util.rb

@@ -0,0 +1,69 @@
+module Postful
+  module Util #:nodoc:
+    protected
+
+    def build_error_message_from_response(response)
+      document = REXML::Document.new response
+      errors = []
+      document.elements.each("errors/error") do |element|
+        errors << element.text
+      end
+      errors.join("\n")
+    end
+
+    def authorization_header(email, password)
+      'Basic ' + ["#{email}:#{password}"].pack('m').delete("\r\n")
+    end
+    
+    def process_standard_responses(response)
+      case response.code
+        when "500" then
+          raise Postful::InternalServerError
+        when "401" then
+          raise Postful::AuthorizationException
+        when "404" then
+          raise Postful::NotFoundException
+        else
+          raise Postful::UnknownResponseException, response.code
+      end      
+    end
+    
+    def delete_request_on_path(path, email, password)
+      http = Net::HTTP.new('www.postful.com', 443)
+      http.use_ssl = true
+      silence_warnings do
+        http.start() {|http|
+          request = Net::HTTP::Delete.new(path)
+          request.basic_auth email, password
+          http.request(request)
+        }      
+      end            
+    end
+
+    def get_request_on_path(path, email, password)
+      http = Net::HTTP.new('www.postful.com', 443)
+      http.use_ssl = true
+      silence_warnings do
+        http.start() {|http|
+          request = Net::HTTP::Get.new(path)
+          request.basic_auth email, password
+          http.request(request)
+        }      
+      end      
+    end
+    
+    def post_request_on_path(path, post, email, password, headers = {})
+      http = Net::HTTP.new('www.postful.com', 443)
+      http.use_ssl = true
+      headers.merge!({ 'Authorization' => authorization_header(email, password) })                    
+      silence_warnings { http.post(path, post, headers) }               
+    end    
+
+    def silence_warnings
+      old_verbose, $VERBOSE = $VERBOSE, nil
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end      
+  end  
+end

data/test/suite.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'test/test_base'
+require 'test/test_letter'
+require 'test/test_order'
+require 'test/test_service'

data/test/test_base.rb

@@ -0,0 +1,131 @@
+require 'test/unit'
+require 'fake_web'
+require 'lib/postful/base'
+require 'rexml/document'
+
+class TestBase < Test::Unit::TestCase
+  def setup
+    @base = Postful::Base.new('email', 'password')
+  end
+  
+  def test_tags
+    @base.tag1 = 'tag 1'
+    @base.tag2 = 'tag 2'
+    @base.tag3 = 'tag 3'
+    @request = @base.send :build_request
+    assert_equal 'tag 1', fetch_tag('mail/tag1')
+    assert_equal 'tag 2', fetch_tag('mail/tag2')
+    assert_equal 'tag 3', fetch_tag('mail/tag3')
+  end
+  
+  def test_return_address
+    @base.return_address = ['Address 1', 'Address 2', 'Address 3']
+    @request = @base.send :build_request
+    assert_equal 'Address 1', fetch_tag('mail/return_address/line1')        
+    assert_equal 'Address 2', fetch_tag('mail/return_address/line2')
+    assert_equal 'Address 3', fetch_tag('mail/return_address/line3')
+  end
+
+  def test_creates_order
+    FakeWeb.register_uri('https://www.postful.com/service/mail', :string => fixture('201.xml'), :status => '201')
+    FakeWeb.register_uri('http://www.postful.com/', :string => 'Test Response')
+    order = @base.send :send_request, nil
+    assert order
+    assert_equal 'Received', order.status
+    assert_equal 999999, order.id
+    assert_equal 'web_service', order.source
+    assert_equal 1, order.pages
+    assert_equal 'http://www.postful.com', order.preview_url
+    assert_equal 'Test Response', order.preview    
+    assert_equal '$0.99', order.price    
+    assert_equal 'first', order.tag1
+    assert_equal 'second', order.tag2
+    assert_equal 'third', order.tag3
+    assert_equal [[Time.utc(2008, 'aug', 5, 17, 44, 2), 'Received'], [Time.utc(2008, 'aug', 6, 17, 44, 2), 'Prepared']], 
+      order.history
+    assert_equal ['Warning 1!', 'Warning 2!'], order.warnings
+    assert_equal ['Error 1!', 'Error 2!'], order.errors
+    assert_equal [
+      ['The Queen', 'Buckingham Palace', 'London SW1A 1AA', 'United Kingdom'],
+      ['Sherlock Holmes', '221B Baker Street', 'London NW1', 'United Kingdom']], 
+      order.addressees
+    assert_equal ['Postful, Inc', '123 Postful St', 'Postful, CA 10000'], order.return_address    
+  end
+
+  def test_unprocessable_entity
+    FakeWeb.register_uri('https://www.postful.com/service/mail', :string => fixture('422.xml'), :status => '422')
+    exception = assert_raises Postful::ValidationException do
+      @base.send :send_request, nil
+    end
+    assert_equal "Some error\nAnother error", exception.message
+  end
+  
+  def test_unauthorized
+    FakeWeb.register_uri('https://www.postful.com/service/mail', :status => '401')
+    assert_raises Postful::AuthorizationException do
+      @base.send :send_request, nil
+    end
+  end
+
+  def test_server_error
+    FakeWeb.register_uri('https://www.postful.com/service/mail', :status => '500')
+    assert_raises Postful::InternalServerError do
+      @base.send :send_request, nil
+    end
+  end
+
+  def test_add_international_address
+    address = @base.add_international_address ['The Queen', 'Buckingham Palace', 'London SW1A 1AA'], 'ENGLAND'
+    assert_equal 'ENGLAND', address.country
+    assert_equal ['The Queen', 'Buckingham Palace', 'London SW1A 1AA'], address.lines
+  end
+
+  def test_build_request_international_addressee
+    @base.add_international_address ['Buckingham Palace', 'London SW1A 1AA'], 'ENGLAND'
+    xml = @base.send(:build_request)    
+    assert_equal %(<mail><documents></documents><addressees><addressee><line1>Buckingham Palace</line1><line2>London SW1A 1AA</line2><country>ENGLAND</country></addressee></addressees></mail>), xml    
+  end
+  
+  def test_build_request_domestic_addressee
+    @base.add_address :name => 'John Doe', :address => '123 Main St', :city => 'Anytown', :state => 'AZ', :postal_code => '10000'
+    xml = @base.send(:build_request)    
+    assert_equal %(<mail><documents></documents><addressees><addressee><name>John Doe</name><address>123 Main St</address><city>Anytown</city><state>AZ</state><postal_code>10000</postal_code></addressee></addressees></mail>), xml        
+  end
+
+  def test_add_address
+    address = @base.add_address :name => 'John Doe',
+      :company => 'Postful, Inc',
+      :address => '123 Main St',
+      :address2 => 'Suite A',
+      :city => 'Anytown',
+      :state => 'AZ',
+      :postal_code => '10000'
+    assert_equal 'John Doe', address.name
+    assert_equal 'Postful, Inc', address.company
+    assert_equal 'Suite A', address.address2
+    assert_equal 'Anytown', address.city
+    assert_equal 'AZ', address.state
+    assert_equal '10000', address.postal_code
+  end
+  
+  def test_requires_address
+    assert !@base.valid?
+    assert_equal 'Requires at least one addressee', @base.errors.first
+  end
+  
+  private
+  
+  def fixture(filename)
+    f = File.join(File.dirname(__FILE__), 'responses', filename)
+    open(f, "rb") do |io| 
+      io.read
+    end         
+  end
+
+  def fetch_tag(tag)
+    @document ||= begin
+      REXML::Document.new @request
+    end
+    @document.elements[tag] && @document.elements[tag].text
+  end
+end

data/test/test_letter.rb

@@ -0,0 +1,115 @@
+require 'test/unit'
+require 'fake_web'
+require 'lib/postful/letter'
+
+class TestLetter < Test::Unit::TestCase
+  def setup
+    @letter = Postful::Letter.new('email', 'password')
+  end
+  
+  def test_build_request_document
+    document = @letter.add_html_document '<b>Hello, world!</b>'
+    document.attachment_name = 'porcupine'
+    xml = @letter.send(:build_request)    
+    assert_equal %(<mail><documents><document><type>html</type><attachment>porcupine</attachment></document></documents><addressees></addressees></mail>), xml
+  end
+  
+  def test_upload
+    FakeWeb.register_uri('https://www.postful.com/service/upload', :string => %(
+      <?xml version="1.0" encoding="UTF-8"?><upload><id>290797321.waltershandy.2</id></upload>))
+    document = @letter.add_html_document '<b>Hello, world!</b>'
+    document.upload
+    assert_equal '290797321.waltershandy.2', document.attachment_name
+  end
+  
+  def test_add_html_document
+    document = @letter.add_html_document '<b>Hello, world!</b>'
+    assert_equal 'html', document.format
+    assert_equal '<b>Hello, world!</b>', document.content
+  end
+  
+  def test_add_html_document_from_file
+    document = @letter.add_html_document_from_file fixture('sample.txt')
+    assert_equal 'html', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+  
+  def test_add_word_document
+    document = @letter.add_word_document 'Example Word Document'
+    assert_equal 'doc', document.format
+    assert_equal 'Example Word Document', document.content
+  end
+
+  def test_add_word_document_from_file
+    document = @letter.add_word_document_from_file fixture('sample.txt')
+    assert_equal 'doc', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+
+  def test_add_rtf_document
+    document = @letter.add_rtf_document 'Example RTF Document'
+    assert_equal 'rtf', document.format
+    assert_equal 'Example RTF Document', document.content
+  end
+
+  def test_add_rtf_document_from_file
+    document = @letter.add_rtf_document_from_file fixture('sample.txt')
+    assert_equal 'rtf', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+
+  def test_add_odt_document
+    document = @letter.add_open_office_document 'Example Open Office Document'
+    assert_equal 'odt', document.format
+    assert_equal 'Example Open Office Document', document.content
+  end
+
+  def test_add_odt_document_from_file
+    document = @letter.add_open_office_document_from_file fixture('sample.txt')
+    assert_equal 'odt', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+
+  def test_add_text_document
+    document = @letter.add_text_document 'Example text Document'
+    assert_equal 'txt', document.format
+    assert_equal 'Example text Document', document.content
+  end
+
+  def test_add_text_document_from_file
+    document = @letter.add_text_document_from_file fixture('sample.txt')
+    assert_equal 'txt', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+
+  def test_add_pdf_document
+    document = @letter.add_pdf_document 'Example PDF Document'
+    assert_equal 'pdf', document.format
+    assert_equal 'Example PDF Document', document.content
+  end
+
+  def test_add_pdf_document_from_file
+    document = @letter.add_pdf_document_from_file fixture('sample.txt')
+    assert_equal 'pdf', document.format
+    assert_equal 'Hello, world!', document.content
+  end
+  
+  def test_requires_document
+    @letter.add_international_address ['Buckingham Palace', 'London SW1A 1AA'], 'ENGLAND'
+    assert !@letter.valid?
+    assert_equal 'Requires at least one document', @letter.errors.first
+  end
+  
+  def test_valid_with_letter_and_document
+    @letter.add_international_address ['Buckingham Palace', 'London SW1A 1AA'], 'ENGLAND'
+    @letter.add_pdf_document 'Example PDF Document'
+    assert @letter.send(:valid?)
+  end  
+  
+  private
+  
+  def fixture(filename)
+    File.join(File.dirname(__FILE__), 'fixtures', filename)
+  end
+  
+end

data/test/test_order.rb

@@ -0,0 +1,49 @@
+require 'test/unit'
+require 'fake_web'
+require 'lib/postful/service'
+
+class TestOrder < Test::Unit::TestCase
+  def setup
+    @service = Postful::Service.new('email', 'password')
+  end
+  
+  def test_cancel
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :status => '200', :string => fixture('delete.xml'))
+    order = Postful::Order.new { @id = 999999 }
+    assert order.status.nil?
+    order.cancel
+    assert_equal 'Canceled', order.status
+  end
+
+  def test_cannot_cancel
+    FakeWeb.register_uri('https://www.postful.com/service/mail/1', :status => '422', :string => fixture('422.xml'))
+    order = Postful::Order.new { @id = 1 }
+    assert_raises Postful::ValidationException do
+      order.cancel
+    end
+  end
+  
+  def test_refresh
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :string => fixture('get.xml'))
+    service = Postful::Service.new('email', 'password')
+    order = service.find_order_by_id(999999)
+    assert_equal 'Error', order.status
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :string => fixture('modified_get.xml'))
+    order.refresh
+    assert_equal 'Prepared', order.status    
+  end
+
+  def test_find_all
+    
+  end
+  
+  private
+  
+  def fixture(filename)
+    f = File.join(File.dirname(__FILE__), 'responses', filename)
+    open(f, "rb") do |io| 
+      io.read
+    end         
+  end
+
+end

data/test/test_postcard.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'fake_web'
+
+class TestPostcard < Test::Unit::TestCase
+  def setup
+    # @postcard = Postful::Postcard.new('email', 'password')
+  end  
+  
+  def test_request_raises_authorization_exception
+    
+  end
+end

data/test/test_service.rb

@@ -0,0 +1,52 @@
+require 'test/unit'
+require 'fake_web'
+require 'lib/postful/service'
+
+class TestService < Test::Unit::TestCase
+  def setup
+    @service = Postful::Service.new('email', 'password')
+  end
+
+  def test_cancel_order_by_id
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :status => '200', :string => fixture('delete.xml'))
+    order = @service.cancel_order_by_id(999999)
+    assert_equal 'Canceled', order.status
+  end
+
+  def test_cancel_order_not_found
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :status => '404', :string => 'Junk response')
+    assert_raises Postful::NotFoundException do
+      @service.cancel_order_by_id(999999)
+    end
+  end
+
+  def test_find_order_by_id
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :string => fixture('get.xml'))
+    order = @service.find_order_by_id(999999)
+    assert_equal 999999, order.id
+  end
+
+  def test_find_order_not_found
+    FakeWeb.register_uri('https://www.postful.com/service/mail/999999', :status => '404', :string => 'Junk response')    
+    assert_raises Postful::NotFoundException do
+      @service.find_order_by_id(999999)
+    end
+  end
+
+  def test_find_all_orders
+    FakeWeb.register_uri('https://www.postful.com/service/mail', :string => fixture('get_all.xml'))
+    orders = @service.find_all_orders
+    assert_equal 2, orders.size
+    assert_equal 'Canceled', orders.first.status
+    assert_equal 'Mailed', orders.last.status    
+  end
+  
+  private
+  
+  def fixture(filename)
+    f = File.join(File.dirname(__FILE__), 'responses', filename)
+    open(f, "rb") do |io| 
+      io.read
+    end         
+  end
+end