postageapp 0.0.0 → 1.0.0

data/test/request_integration_test.rb

@@ -0,0 +1,78 @@
+require File.expand_path('../helper', __FILE__)
+
+class RequestIntegrationTest < Test::Unit::TestCase
+  
+  # Note: Need access to a live PostageApp.com account
+  # See helper.rb to set host / api key
+  unless false # set to +true+ to run tests
+    puts "\e[0m\e[31mSkipping #{File.basename(__FILE__)}\e[0m"
+    def test_nothing ; end
+  else
+    
+    def setup
+      super
+      PostageApp.configure do |config|
+        config.secure   = false
+        config.host     = 'api.postageapp.local'
+        config.api_key  = 'PROJECT_API_KEY'
+      end
+    end
+    
+    def test_request_get_method_list
+      request = PostageApp::Request.new(:get_method_list)
+      response = request.send
+      assert_equal 'PostageApp::Response', response.class.name
+      assert_equal 'ok', response.status
+      assert_match /^\w{40}$/, response.uid
+      assert_equal nil, response.message
+      assert_equal ({
+        'methods' => 'get_account_info, get_message_receipt, get_method_list, get_project_info, send_message'
+      }), response.data
+    end
+    
+    def test_request_send_message
+      request = PostageApp::Request.new(:send_message, {
+        :headers    => { 'from'     => 'sender@test.test',
+                         'subject'  => 'Test Message'},
+        :recipients => 'test@test.test',
+        :content    => {
+          'text/plain'  => 'text content',
+          'text/html'   => 'html content'
+        }
+      })
+      response = request.send
+      assert_equal 'PostageApp::Response', response.class.name
+      assert_equal 'ok', response.status
+      assert_match /^\w{40}$/, response.uid
+      assert_equal nil, response.message
+      assert_match /\d+/, response.data['message']['id'].to_s
+      
+      receipt = PostageApp::Request.new(:get_message_receipt, :uid => response.uid).send
+      assert receipt.ok?
+      
+      receipt = PostageApp::Request.new(:get_message_receipt, :uid => 'bogus').send
+      assert receipt.not_found?
+    end
+    
+    def test_request_non_existant_method
+      request = PostageApp::Request.new(:non_existant)
+      response = request.send
+      assert_equal 'PostageApp::Response', response.class.name
+      assert_equal 'internal_server_error', response.status
+      assert_match /^\w{40}$/, response.uid
+      assert_equal 'No action responded to non_existant. Actions: get_account_info, get_message_receipt, get_method_list, get_project_info, and send_message', response.message
+      assert_equal nil, response.data
+    end
+    
+    # Testable under ruby 1.9.2 Probably OK in production too... Probably
+    # Lunchtime reading: http://ph7spot.com/musings/system-timer
+    def test_request_timeout
+      PostageApp.configuration.host = 'dead.postageapp.local'
+      request = PostageApp::Request.new(:get_method_list)
+      response = request.send
+      assert_equal 'PostageApp::Response', response.class.name
+      assert_equal 'fail', response.status
+    end
+    
+  end
+end

data/test/request_test.rb

@@ -0,0 +1,81 @@
+require File.expand_path('../helper', __FILE__)
+
+class RequestTest < Test::Unit::TestCase
+  
+  def test_method_uid
+    request = PostageApp::Request.new(:test_method)
+    uid = request.uid
+    assert_match /^\w{40}$/, uid
+    assert_equal uid, request.uid
+    assert_not_equal uid, request.uid(true)
+  end
+  
+  def test_method_url
+    request = PostageApp::Request.new(:test_method)
+    assert_equal 'api.postageapp.com',      request.url.host
+    assert_equal 443,                       request.url.port
+    assert_equal '/v.1.0/test_method.json', request.url.path
+  end
+  
+  def test_method_arguments_to_send
+    request = PostageApp::Request.new(:test_method)
+    args = request.arguments_to_send
+    assert_equal '1234567890abcdef', args['api_key']
+    assert_match /^\w{40}$/, args['uid']
+    
+    request.arguments = { 'data' => 'content' }
+    args = request.arguments_to_send
+    assert_equal '1234567890abcdef', args['api_key']
+    assert_match /^\w{40}$/, args['uid']
+    assert_equal 'content', args['arguments']['data']
+  end
+  
+  def test_uid_is_enforceable
+    request = PostageApp::Request.new(:test_method)
+    assert_match /^\w{40}$/, request.arguments_to_send['uid']
+    
+    request.uid = 'my_uid'
+    assert_equal 'my_uid', request.arguments_to_send['uid']
+    
+    request = PostageApp::Request.new(:test_method, :uid => 'new_uid', :data => 'value')
+    assert_equal 'new_uid', request.uid
+    assert_equal ({:data => 'value'}), request.arguments
+  end
+  
+  def test_send
+    mock_successful_send
+    
+    request = PostageApp::Request.new(:send_message, {
+      :headers    => { 'from'     => 'sender@test.test',
+                       'subject'  => 'Test Message'},
+      :recipients => 'test@test.test',
+      :content    => {
+        'text/plain'  => 'text content',
+        'text/html'   => 'html content'
+      }
+    })
+    response = request.send
+    assert_equal 'ok', response.status
+    assert_equal 'sha1hashuid23456789012345678901234567890', response.uid
+    assert_equal ({'message' => { 'id' => 999 }}), response.data
+  end
+  
+  def test_send_failure
+    mock_failed_send
+    
+    request = PostageApp::Request.new(:send_message, {
+      :headers    => { 'from'     => 'sender@test.test',
+                       'subject'  => 'Test Message'},
+      :recipients => 'test@test.test',
+      :content    => {
+        'text/plain'  => 'text content',
+        'text/html'   => 'html content'
+      }
+    })
+    response = request.send
+    assert_equal 'fail', response.status
+    assert_equal nil, response.uid
+    assert_equal nil, response.data
+  end
+  
+end

data/test/response_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../helper', __FILE__)
+
+class ResponseTest < Test::Unit::TestCase
+  
+  def test_initialization
+    object = stub(:body => {
+      'response' => {
+        'uid'     => 'md5_hash_uid',
+        'status'  => 'ok',
+        'message' => 'api reply message'
+      },
+      'data' => {
+        'key' => 'value'
+      }
+    }.to_json)
+    
+    response = PostageApp::Response.new(object)
+    assert_equal 'md5_hash_uid',        response.uid
+    assert_equal 'ok',                  response.status
+    assert_equal 'api reply message',   response.message
+    assert_equal ({'key' => 'value'}),  response.data
+    assert response.ok?
+  end
+  
+  def test_status_check
+    response = PostageApp::Response.new(nil)
+    assert_equal 'fail', response.status
+    assert response.fail?
+    assert !response.ok?
+    assert !response.really?
+    
+    begin
+      response.bad_method 
+      assert false
+    rescue NoMethodError 
+      assert true
+    end
+  end
+  
+end

metadata

@@ -3,10 +3,10 @@ name: postageapp
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Oleg Khabarov, The Working Group Inc
@@ -14,10 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-10 00:00:00 -04:00
+date: 2010-07-23 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id002
 description: Gem that interfaces with PostageApp.com service to send emails from web apps
 email: oleg@twg.ca
 executables: []
@@ -26,18 +53,55 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
+- generators/postageapp/postageapp_generator.rb
+- generators/postageapp/templates/initializer.rb
+- generators/postageapp/templates/postageapp_tasks.rake
+- lib/generators/postageapp/postageapp_generator.rb
 - lib/postageapp.rb
+- lib/postageapp/configuration.rb
+- lib/postageapp/failed_request.rb
+- lib/postageapp/logger.rb
+- lib/postageapp/mailer.rb
+- lib/postageapp/mailer/mailer_2.rb
+- lib/postageapp/mailer/mailer_3.rb
+- lib/postageapp/rails.rb
+- lib/postageapp/request.rb
+- lib/postageapp/response.rb
+- lib/postageapp/utils.rb
+- lib/postageapp/version.rb
 - postageapp.gemspec
+- test/configuration_test.rb
+- test/failed_request_test.rb
 - test/helper.rb
-- test/test_postageapp.rb
+- test/mailer/action_mailer_2/notifier.rb
+- test/mailer/action_mailer_2/notifier/with_body_and_attachment.erb
+- test/mailer/action_mailer_2/notifier/with_html_and_text_views.text.html.erb
+- test/mailer/action_mailer_2/notifier/with_html_and_text_views.text.plain.erb
+- test/mailer/action_mailer_2/notifier/with_simple_view.erb
+- test/mailer/action_mailer_2/notifier/with_text_only_view.text.plain.erb
+- test/mailer/action_mailer_3/notifier.rb
+- test/mailer/action_mailer_3/notifier/with_html_and_text_views.html.erb
+- test/mailer/action_mailer_3/notifier/with_html_and_text_views.text.erb
+- test/mailer/action_mailer_3/notifier/with_old_api.html.erb
+- test/mailer/action_mailer_3/notifier/with_old_api.text.erb
+- test/mailer/action_mailer_3/notifier/with_simple_view.erb
+- test/mailer/action_mailer_3/notifier/with_text_only_view.text.erb
+- test/mailer_2_test.rb
+- test/mailer_3_test.rb
+- test/mailer_helper_methods_test.rb
+- test/postageapp_test.rb
+- test/rails_initialization_test.rb
+- test/request_integration_test.rb
+- test/request_test.rb
+- test/response_test.rb
 has_rdoc: true
 homepage: http://github.com/theworkinggroup/postageapp-gem
 licenses: []
@@ -69,5 +133,16 @@ signing_key:
 specification_version: 3
 summary: Easier way to send email from web apps
 test_files: 
+- test/configuration_test.rb
+- test/failed_request_test.rb
 - test/helper.rb
-- test/test_postageapp.rb
+- test/mailer/action_mailer_2/notifier.rb
+- test/mailer/action_mailer_3/notifier.rb
+- test/mailer_2_test.rb
+- test/mailer_3_test.rb
+- test/mailer_helper_methods_test.rb
+- test/postageapp_test.rb
+- test/rails_initialization_test.rb
+- test/request_integration_test.rb
+- test/request_test.rb
+- test/response_test.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= postageapp
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Oleg. See LICENSE for details.

data/test/test_postageapp.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestPostageapp < Test::Unit::TestCase
-  def test_something_for_real
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end