postageapp 1.0.4 → 1.0.5

data/README.md

@@ -87,6 +87,8 @@ ActionMailer Integration
 ------------------------
 You can quickly convert your existing mailers to use PostageApp service by simply changing `class MyMailer < ActionMailer::Base` to `class MyMailer < PostageApp::Mailer`.  If you using ActionMailer from outside of Rails make sure you have this line somewhere: `require 'postageapp/mailer'`
 
+There are custom methods that allow setting of `template` and `variables` parts of the API call. They are `postageapp_template` and `postageapp_variables`. Examples how they are used are below. For details what they do please see [documentation](http://help.postageapp.com/faqs)
+
 ### Rails 3.x
 
 Here's an example of a mailer in Rails 3 environment:
@@ -102,8 +104,8 @@ Here's an example of a mailer in Rails 3 environment:
         headers['Special-Header'] = 'SpecialValue'
         
         # PostageApp specific elements:
-        postage_template 'example_template'
-        postage_variables 'global_variable' => 'value'
+        postageapp_template 'example_template'
+        postageapp_variables 'global_variable' => 'value'
         
         mail(
           :from     => 'test@test.test',
@@ -154,8 +156,8 @@ Here's an example of a mailer you'd set in in a Rails 2 environment:
                     :body         => File.read('/path/to/example.zip')
         
         # PostageApp specific elements:
-        postage_template 'example_template'
-        postage_variables 'global_variable' => 'value'
+        postageapp_template 'example_template'
+        postageapp_variables 'global_variable' => 'value'
         
       end
     end

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/lib/postageapp/mailer/mailer_2.rb

@@ -16,8 +16,8 @@
 #
 # Postage::Mailer introduces a few mailer methods specific to Postage:
 #
-# * postage_template  - template name that is defined in your PostageApp project
-# * postage_variables - extra variables you want to send along with the message
+# * template  - template name that is defined in your PostageApp project
+# * variables - extra variables you want to send along with the message
 #
 # Sending email
 #
@@ -29,8 +29,8 @@ class PostageApp::Mailer < ActionMailer::Base
   # Using :test as a delivery method if set somewhere else
   self.delivery_method = :postage unless (self.delivery_method == :test)
   
-  adv_attr_accessor :postage_template
-  adv_attr_accessor :postage_variables
+  adv_attr_accessor :postageapp_template
+  adv_attr_accessor :postageapp_variables
   
   def perform_delivery_postage(mail)
     mail.send
@@ -71,8 +71,8 @@ class PostageApp::Mailer < ActionMailer::Base
       end
     end
     
-    params['template'] = self.postage_template unless self.postage_template.blank?
-    params['variables'] = self.postage_variables unless self.postage_variables.blank?
+    params['template'] = self.postageapp_template unless self.postageapp_template.blank?
+    params['variables'] = self.postageapp_variables unless self.postageapp_variables.blank?
     
     params.delete('headers')     if params['headers'].blank?
     params.delete('content')     if params['content'].blank?

data/lib/postageapp/mailer/mailer_3.rb

@@ -18,8 +18,8 @@
 #
 # Postage::Mailer introduces a few mailer methods specific to Postage:
 #
-# * postage_template  - template name that is defined in your PostageApp project
-# * postage_variables - extra variables you want to send along with the message
+# * postageapp_template  - template name that is defined in your PostageApp project
+# * postageapp_variables - extra variables you want to send along with the message
 #
 # Sending email
 #
@@ -57,25 +57,21 @@ class PostageApp::Mailer < ActionMailer::Base
     end
   end
   
-  # In API call we can specify PostageApp template that will be used
-  # to generate content of the message
-  attr_accessor :postage_template
-  
-  # Hash of variables that will be used to inject into the content
-  attr_accessor :postage_variables
-  
   # Instead of initializing Mail object, we prepare PostageApp::Request
   def initialize(method_name = nil, *args)
     @_message = PostageApp::Request.new(:send_message)
     process(method_name, *args) if method_name
   end
   
-  def postage_template(value)
-    @_message.arguments['template'] = value
+  # In API call we can specify PostageApp template that will be used
+  # to generate content of the message
+  def postageapp_template(value = nil)
+    value ? @_message.arguments['template'] = value : @_message.arguments['template']
   end
   
-  def postage_variables(variables = {})
-    @_message.arguments['variables'] = variables
+  # Hash of variables that will be used to inject into the content
+  def postageapp_variables(value = nil)
+    value ? @_message.arguments['variables'] = value : @_message.arguments['variables']
   end
   
   def attachments

data/postageapp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{postageapp}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov, The Working Group Inc"]
-  s.date = %q{2010-07-27}
+  s.date = %q{2010-07-30}
   s.description = %q{Gem that interfaces with PostageApp.com service to send emails from web apps}
   s.email = %q{oleg@twg.ca}
   s.extra_rdoc_files = [
@@ -45,13 +45,18 @@ Gem::Specification.new do |s|
      "test/configuration_test.rb",
      "test/failed_request_test.rb",
      "test/helper.rb",
+     "test/live_test.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_custom_postage_variables.text.html.erb",
+     "test/mailer/action_mailer_2/notifier/with_custom_postage_variables.text.plain.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_custom_postage_variables.html.erb",
+     "test/mailer/action_mailer_3/notifier/with_custom_postage_variables.text.erb",
      "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",
@@ -63,19 +68,19 @@ Gem::Specification.new do |s|
      "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"
   ]
   s.homepage = %q{http://github.com/theworkinggroup/postageapp-gem}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Easier way to send email from web apps}
   s.test_files = [
     "test/configuration_test.rb",
      "test/failed_request_test.rb",
      "test/helper.rb",
+     "test/live_test.rb",
      "test/mailer/action_mailer_2/notifier.rb",
      "test/mailer/action_mailer_3/notifier.rb",
      "test/mailer_2_test.rb",
@@ -83,7 +88,6 @@ Gem::Specification.new do |s|
      "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"
   ]
@@ -92,7 +96,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, ["= 1.2.4"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
     else

data/test/{request_integration_test.rb → live_test.rb}

@@ -1,6 +1,6 @@
 require File.expand_path('../helper', __FILE__)
 
-class RequestIntegrationTest < Test::Unit::TestCase
+class LiveTest < Test::Unit::TestCase
   
   # Note: Need access to a live PostageApp.com account
   # See helper.rb to set host / api key
@@ -74,5 +74,16 @@ class RequestIntegrationTest < Test::Unit::TestCase
       assert_equal 'fail', response.status
     end
     
+    def test_deliver_with_custom_postage_variables
+      response = if ActionMailer::VERSION::MAJOR < 3
+        require File.expand_path('../mailer/action_mailer_2/notifier', __FILE__)
+        Notifier.deliver_with_custom_postage_variables
+      else
+        require File.expand_path('../mailer/action_mailer_3/notifier', __FILE__)
+        Notifier.with_custom_postage_variables.deliver
+      end
+      assert response.ok?
+    end
+    
   end
 end

data/test/mailer/action_mailer_2/notifier.rb

@@ -49,8 +49,8 @@ class Notifier < PostageApp::Mailer
       'test1@test.text' => { 'name' => 'Test 1' },
       'test2@test.text' => { 'name' => 'Test 2' }
     })
-    postage_template 'test_template'
-    postage_variables 'variable' => 'value'
+    postageapp_template 'test-template'
+    postageapp_variables 'variable' => 'value'
   end
   
 private

data/test/mailer/action_mailer_2/notifier/with_custom_postage_variables.text.html.erb

@@ -0,0 +1 @@
+html content

data/test/mailer/action_mailer_2/notifier/with_custom_postage_variables.text.plain.erb

@@ -0,0 +1 @@
+text content

data/test/mailer/action_mailer_3/notifier.rb

@@ -47,8 +47,8 @@ class Notifier < PostageApp::Mailer
     headers['CustomHeader1'] = 'CustomValue1'
     headers 'CustomHeader2' => 'CustomValue2'
     
-    postage_template 'test_template'
-    postage_variables 'variable' => 'value'
+    postageapp_template 'test-template'
+    postageapp_variables 'variable' => 'value'
     
     mail(
       :from     => 'test@test.test',
@@ -85,8 +85,8 @@ class Notifier < PostageApp::Mailer
                 :filename     => 'foo.jpg',
                 :body         => '123456789'
     
-    postage_template 'test_template'
-    postage_variables 'variable' => 'value'
+    postageapp_template 'test-template'
+    postageapp_variables 'variable' => 'value'
   end
   
 private

data/test/mailer/action_mailer_3/notifier/with_custom_postage_variables.html.erb

@@ -0,0 +1 @@
+html content

data/test/mailer/action_mailer_3/notifier/with_custom_postage_variables.text.erb

@@ -0,0 +1 @@
+text content

data/test/mailer_2_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../helper', __FILE__)
 
 # tests for ActionMailer bundled with Rails 2
-class Mailer3Test < Test::Unit::TestCase
+class Mailer2Test < Test::Unit::TestCase
   
   if ActionMailer::VERSION::MAJOR < 3
     
@@ -67,10 +67,12 @@ class Mailer3Test < Test::Unit::TestCase
     
     def test_create_with_custom_postage_variables
       assert mail = Notifier.create_with_custom_postage_variables
-      assert_equal 'test_template', mail.arguments['template']
+      assert_equal 'test-template', mail.arguments['template']
       assert_equal ({ 'variable' => 'value' }), mail.arguments['variables']
       assert_equal ({ 'test2@test.text' => { 'name' => 'Test 2'}, 
                       'test1@test.text' => { 'name' => 'Test 1'}}), mail.arguments['recipients']
+      assert_equal 'text content', mail.arguments['content']['text/plain']
+      assert_equal 'html content', mail.arguments['content']['text/html']
     end
     
     def test_create_with_recipient_override

data/test/mailer_3_test.rb

@@ -62,10 +62,12 @@ class Mailer3Test < Test::Unit::TestCase
         'test1@test.test' => { 'name' => 'Test 1'},
         'test2@test.test' => { 'name' => 'Test 2'}
       }), mail.arguments['recipients']
-      assert_equal 'test_template', mail.arguments['template']
+      assert_equal 'test-template', mail.arguments['template']
       assert_equal ({ 'variable' => 'value' }), mail.arguments['variables']
       assert_equal 'CustomValue1', mail.arguments['headers']['CustomHeader1']
       assert_equal 'CustomValue2', mail.arguments['headers']['CustomHeader2']
+      assert_equal 'text content', mail.arguments['content']['text/plain']
+      assert_equal 'html content', mail.arguments['content']['text/html']
     end
     
     def test_create_with_old_api

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: postageapp
 version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - Oleg Khabarov, The Working Group Inc
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 -04:00
+date: 2010-07-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
@@ -83,13 +88,18 @@ files:
 - test/configuration_test.rb
 - test/failed_request_test.rb
 - test/helper.rb
+- test/live_test.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_custom_postage_variables.text.html.erb
+- test/mailer/action_mailer_2/notifier/with_custom_postage_variables.text.plain.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_custom_postage_variables.html.erb
+- test/mailer/action_mailer_3/notifier/with_custom_postage_variables.text.erb
 - 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
@@ -101,7 +111,6 @@ files:
 - 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
@@ -114,23 +123,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Easier way to send email from web apps
@@ -138,6 +151,7 @@ test_files:
 - test/configuration_test.rb
 - test/failed_request_test.rb
 - test/helper.rb
+- test/live_test.rb
 - test/mailer/action_mailer_2/notifier.rb
 - test/mailer/action_mailer_3/notifier.rb
 - test/mailer_2_test.rb
@@ -145,6 +159,5 @@ test_files:
 - 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