postageapp 0.0.0 → 1.0.0

data/lib/postageapp/rails.rb

@@ -0,0 +1,14 @@
+require 'postageapp'
+
+module PostageApp::Rails
+  
+  def self.initialize
+    PostageApp.configure do |config|
+      config.framework    = "Rails #{::Rails.version}"  if defined?(::Rails.version)
+      config.project_root = ::Rails.root                if defined?(::Rails.root)
+      config.environment  = ::Rails.env                 if defined?(::Rails.env)
+    end
+  end
+end
+
+PostageApp::Rails.initialize

data/lib/postageapp/request.rb

@@ -0,0 +1,87 @@
+class PostageApp::Request
+  
+  API_VERSION = '1.0'
+  
+  HEADERS = {
+    'Content-type'  => 'application/json',
+    'Accept'        => 'text/json, application/json'
+  }
+  
+  # Unique ID of the request
+  attr_accessor :uid
+  
+  # The API method being called (example: send_message)
+  # This controls the url of the request (example: https://api.postageapp.com/v.1.0/send_message.json)
+  attr_accessor :method
+  
+  # A list of arguments in a Hash format passed along with the request
+  attr_accessor :arguments
+  
+  def initialize(method, arguments = {})
+    @method     = method
+    @uid        = arguments.delete(:uid)
+    @arguments  = arguments
+  end
+  
+  # Skipping resend doesn't trigger PostageApp::FailedRequest.resend_all
+  # it's needed so the request being resend doesn't create duplicate queue
+  def send(skip_failed_requests_processing = false)
+    http = Net::HTTP::Proxy(
+      PostageApp.configuration.proxy_host,
+      PostageApp.configuration.proxy_port,
+      PostageApp.configuration.proxy_user,
+      PostageApp.configuration.proxy_pass
+    ).new(url.host, url.port)
+    
+    http.read_timeout = PostageApp.configuration.http_read_timeout
+    http.open_timeout = PostageApp.configuration.http_open_timeout
+    http.use_ssl      = PostageApp.configuration.secure?
+    
+    PostageApp.logger.info(self)
+    
+    http_response = begin
+      http.post(
+        url.path, 
+        self.arguments_to_send.to_json, 
+        HEADERS.merge('User-Agent' => "PostageApp-RubyGem #{PostageApp::VERSION} (Ruby #{RUBY_VERSION}, #{PostageApp.configuration.framework})")
+      )
+    rescue TimeoutError
+      nil
+    end
+    
+    response = PostageApp::Response.new(http_response)
+    
+    PostageApp.logger.info(response)
+    
+    unless skip_failed_requests_processing
+      response.fail?? PostageApp::FailedRequest.store(self) : PostageApp::FailedRequest.resend_all
+    end
+    
+    response
+  end
+  
+  # URL of the where PostageApp::Request will be directed at
+  def url
+    URI.parse("#{PostageApp.configuration.url}/v.#{API_VERSION}/#{self.method}.json")
+  end
+  
+  # Unique ID of the request
+  def uid(reload = false)
+    @uid = nil if reload
+    @uid ||= Digest::SHA1.hexdigest("#{Time.now.to_f}#{self.arguments}")
+  end
+  
+  # Arguments need to be appended with some some stuff before it's ready to be send out
+  def arguments_to_send
+    hash = { 'uid' => self.uid, 'api_key'  => PostageApp.configuration.api_key }
+    
+    if !self.arguments.nil? && !self.arguments.empty?
+      if !PostageApp.configuration.recipient_override.nil? && self.method.to_sym == :send_message
+        self.arguments.merge!('recipient_override' => PostageApp.configuration.recipient_override)
+      end
+      hash.merge!('arguments' => self.arguments.stringify_keys!) 
+    end
+    hash
+  end
+  
+end

data/lib/postageapp/response.rb

@@ -0,0 +1,39 @@
+class PostageApp::Response
+  
+  # The UID should match the Request's UID. If Request didn't provide with one
+  # PostageApp service should generate it for the Response
+  attr_reader :uid
+  
+  # The status of the response in string format (like: ok, bad_request)
+  # Will be set to +fail+ if Request times out
+  attr_reader :status
+  
+  # The message of the response. Could be used as an error explanation.
+  attr_reader :message
+  
+  # The data payload of the response. This is usually the return value of the
+  # request we're looking for
+  attr_reader :data
+  
+  # Takes in Net::HTTPResponse object as the attribute.
+  # If something goes wrong Response will be thought of as failed
+  def initialize(http_response)
+    hash = JSON::parse(http_response.body)
+    @status   = hash['response']['status']
+    @uid      = hash['response']['uid']
+    @message  = hash['response']['message']
+    @data     = hash['data']
+  rescue
+    @status   = 'fail'
+  end
+  
+  # Little helper that checks for the Response status
+  #   => @response.ok?
+  #   >> true
+  #   => @response.fail?
+  #   >> false
+  def method_missing(method)
+    /.*?\?$/.match(method.to_s) ? "#{self.status}?" == method.to_s : super(method)
+  end
+  
+end

data/lib/postageapp/utils.rb

@@ -0,0 +1,30 @@
+class Hash
+  
+  # Example usage:
+  #   @hash.dig(:k1)          # same as @hash[:k1]
+  #   @hash.dig(:k1, :k2)     # same as @hash[:k1] && @hash[:k1][:k2]
+  #   @hash.dig(:k1, :k2, k3) # same as @hash[:k1] && @hash[:k1][:k2] && @hash[:k1][:k2][:k3]
+  def dig(*path)
+    path.inject(self) do |location, key|
+      location.respond_to?(:keys) ? location[key] : nil
+    end
+  end
+  
+  # Destructively convert all keys to strings.
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+end
+
+class Net::HTTP
+  # Getting rid of the 'warning: peer certificate won't be verified in this SSL session'
+  alias_method :old_initialize, :initialize
+  def initialize(*args)
+    old_initialize(*args)
+    @ssl_context = OpenSSL::SSL::SSLContext.new
+    @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+end

data/lib/postageapp/version.rb

@@ -0,0 +1,7 @@
+module PostageApp
+  VERSION = begin 
+    IO.read(File.join(File.dirname(__FILE__), '/../../VERSION')).chomp
+  rescue
+    'UNKNOWN'
+  end
+end

data/postageapp.gemspec

@@ -5,28 +5,65 @@
 
 Gem::Specification.new do |s|
   s.name = %q{postageapp}
-  s.version = "0.0.0"
+  s.version = "1.0.0"
 
   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-06-10}
+  s.date = %q{2010-07-23}
   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 = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.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"
   ]
   s.homepage = %q{http://github.com/theworkinggroup/postageapp-gem}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -34,8 +71,19 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Easier way to send email from web apps}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_postageapp.rb"
+    "test/configuration_test.rb",
+     "test/failed_request_test.rb",
+     "test/helper.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"
   ]
 
   if s.respond_to? :specification_version then
@@ -43,9 +91,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= 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
+      s.add_dependency(%q<json>, ["= 1.2.4"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
     end
   else
+    s.add_dependency(%q<json>, ["= 1.2.4"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
   end
 end
 

data/test/configuration_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../helper', __FILE__)
+
+class ConfigurationTest < Test::Unit::TestCase
+  
+  def test_intitialization_defaults
+    config = PostageApp::Configuration.new
+    
+    assert_equal true,                      config.secure
+    assert_equal nil,                       config.api_key
+    assert_equal 'https',                   config.protocol
+    assert_equal 'api.postageapp.com',      config.host
+    assert_equal 443,                       config.port
+    assert_equal nil,                       config.proxy_host
+    assert_equal nil,                       config.proxy_port
+    assert_equal nil,                       config.proxy_user
+    assert_equal nil,                       config.proxy_pass
+    assert_equal 5,                         config.http_open_timeout
+    assert_equal 10,                        config.http_read_timeout
+    assert_equal nil,                       config.recipient_override
+    assert_equal %w( send_message ),        config.requests_to_resend
+    assert_equal nil,                       config.project_root
+    assert_equal 'production',              config.environment
+    assert_equal nil,                       config.logger
+    assert_equal 'undefined framework',     config.framework
+  end
+  
+  def test_initialization_overrides
+    config = PostageApp::Configuration.new
+    
+    config.protocol = 'http'
+    config.port     = 999
+    
+    assert_equal 'http',  config.protocol
+    assert_equal 999,     config.port
+  end
+  
+  def test_intitialization_for_secure
+    config = PostageApp::Configuration.new
+    
+    config.secure = true
+    assert_equal true,    config.secure
+    assert_equal 'https', config.protocol
+    assert_equal 443,     config.port
+    
+    assert config.secure?
+  end
+  
+  def test_intialization_for_insecure
+    config = PostageApp::Configuration.new
+    
+    config.secure = false
+    assert_equal false,   config.secure
+    assert_equal 'http',  config.protocol
+    assert_equal 80,      config.port
+    
+    assert !config.secure?
+  end
+  
+  def test_method_url
+    config = PostageApp::Configuration.new
+    
+    config.host = 'api.postageapp.com'
+    assert_equal 'https://api.postageapp.com:443', config.url
+  end
+  
+end

data/test/failed_request_test.rb

@@ -0,0 +1,79 @@
+require File.expand_path('../helper', __FILE__)
+
+class FailedRequestTest < Test::Unit::TestCase
+  
+  def setup
+    super
+    PostageApp.configuration.project_root = File.expand_path('../', __FILE__)
+  end
+  
+  def test_store_and_initialize
+    assert_match /.*?\/tmp\/postageapp_failed_requests/, PostageApp::FailedRequest.store_path
+    
+    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'
+      }
+    })
+    assert PostageApp::FailedRequest.store(request)
+    file_path = File.join(PostageApp::FailedRequest.store_path, request.uid)
+    assert File.exists?(file_path)
+    
+    stored_request = PostageApp::FailedRequest.initialize_request(request.uid)
+    assert stored_request.is_a?(PostageApp::Request)
+    assert_equal request.url, stored_request.url
+    assert_equal request.uid, stored_request.uid
+    assert_equal request.arguments_to_send, stored_request.arguments_to_send
+  end
+  
+  def test_initialize_request_when_not_found
+    assert !PostageApp::FailedRequest.initialize_request('not_there')
+  end
+  
+  def test_store_for_wrong_call_type
+    request = PostageApp::Request.new(:get_project_info)
+    assert !PostageApp::FailedRequest.store(request)
+  end
+  
+  def test_store_with_no_file_path_defined
+    PostageApp.configuration.project_root = nil
+    assert !PostageApp::FailedRequest.store_path
+    assert !PostageApp::FailedRequest.store('something')
+  end
+  
+  def test_resend_all
+    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 response.fail?
+    file_path = File.join(PostageApp::FailedRequest.store_path, request.uid)
+    assert File.exists?(file_path)
+    
+    mock_successful_send
+    
+    request = PostageApp::Request.new(:get_project_info)
+    
+    message_receipt_response = stub(:ok? => false, :not_found? => true)
+    message_receipt_request = stub(:send => message_receipt_response)
+    PostageApp::Request.stubs(:new).with{|a,b| a == :get_message_receipt}.returns(message_receipt_request)
+    
+    response = request.send
+    assert response.ok?
+    
+    assert !File.exists?(file_path)
+  end
+  
+end

data/test/helper.rb

@@ -3,7 +3,73 @@ require 'test/unit'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'postageapp'
+require 'postageapp/mailer'
+
+begin require 'redgreen' unless ENV['TM_FILEPATH']; rescue LoadError; end
+require 'mocha'
 
 class Test::Unit::TestCase
+  
+  def setup
+    # resetting to default configuration
+    PostageApp.configure do |config|
+      config.api_key            = '1234567890abcdef'
+      config.secure             = true
+      config.protocol           = 'https'
+      config.host               = 'api.postageapp.com'
+      config.port               = 443
+      config.proxy_host         = nil
+      config.proxy_port         = nil
+      config.proxy_user         = nil
+      config.proxy_pass         = nil
+      config.http_open_timeout  = 5
+      config.http_read_timeout  = 10
+      config.recipient_override = nil
+      config.requests_to_resend = %w( send_message )
+      config.project_root       = File.expand_path('../', __FILE__)
+      config.environment        = 'production'
+      config.logger             = nil
+      config.framework          = 'undefined framework'
+    end
+  end
+  
+  def mock_successful_send
+    Net::HTTP.any_instance.stubs(:post).returns(Net::HTTPResponse.new(nil, nil, nil))
+    Net::HTTPResponse.any_instance.stubs(:body).returns({
+      :response => { 
+        :uid    => 'sha1hashuid23456789012345678901234567890',
+        :status => 'ok'
+      },
+      :data => {
+        :message => { :id => 999 }
+      }
+    }.to_json)
+  end
+  
+  def mock_failed_send
+    Net::HTTP.any_instance.stubs(:post).returns(nil)
+  end
+  
+end
+
+# Setting up constants just for the duration of the test
+module ConstantDefinitions
+  
+  def setup
+    @defined_constants = []
+  end
+  
+  def teardown
+    @defined_constants.each do |constant|
+      Object.__send__(:remove_const, constant)
+    end
+  end
+  
+  def define_constant(name, value)
+    Object.const_set(name, value)
+    @defined_constants << name
+  end
+  
 end