postageapp 1.0.24 → 1.2.0

data/lib/postageapp/rails/rails.rb

@@ -1,15 +1,25 @@
 require 'postageapp'
-require 'postageapp/mailer' if defined?(ActionMailer)
 
-module PostageApp::Rails
-  
+if (defined?(ActionMailer))
+  require 'postageapp/mailer' 
+end
+
+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)
+      if (defined?(::Rails.version))
+        config.framework = "Rails #{::Rails.version}"
+      end
+
+      if (defined?(::Rails.root))
+        config.project_root = ::Rails.root
+      end
+
+      if (defined?(::Rails.env))
+        config.environment = ::Rails.env
+      end
     end
   end
 end
 
-PostageApp::Rails.initialize
+PostageApp::Rails.initialize

data/lib/postageapp/rails/railtie.rb

@@ -1,14 +1,29 @@
 require 'postageapp'
-require 'postageapp/mailer' if defined?(ActionMailer)
+
+if (defined?(ActionMailer))
+  require 'postageapp/mailer'
+
+  # Register as a delivery method with ActionMailer
+  ActionMailer::Base.add_delivery_method(
+    :postageapp,
+    PostageApp::Mail::DeliveryMethod
+  )
+end
 
 class PostageApp::Railtie < Rails::Railtie
-  
   config.after_initialize do
     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)
+      if (defined?(::Rails.version))
+        config.framework = "Rails #{::Rails.version}"
+      end
+
+      if (defined?(::Rails.root))
+        config.project_root = ::Rails.root
+      end
+
+      if (defined?(::Rails.env))
+        config.environment  = ::Rails.env
+      end
     end
   end
-  
-end
+end

data/lib/postageapp/request.rb

@@ -1,12 +1,12 @@
 class PostageApp::Request
   API_VERSION = '1.0'
   
-  HEADERS = {
-    'Content-type'  => 'application/json',
-    'Accept'        => 'text/json, application/json'
+  HEADERS_DEFAULT = {
+    'Content-type' => 'application/json',
+    'Accept' => 'text/json, application/json'
   }
   
-  # Unique ID of the request
+  # Unique ID (UID) for the request
   attr_accessor :uid
   
   # The API method being called (example: send_message)
@@ -16,38 +16,44 @@ class PostageApp::Request
   # A list of arguments in a Hash format passed along with the request
   attr_accessor :arguments
   
-  # Ability to set api_key with eash request
+  # Assigns the API key to be used for the request
   attr_accessor :api_key
+
+  # Returns a user-agent string used for identification when making API calls.
+  def self.user_agent
+    @user_agent ||=
+      "PostageApp (Gem %s, Ruby %s, %s)" % [
+        PostageApp::VERSION,
+        RUBY_VERSION,
+        PostageApp.configuration.framework
+      ]
+  end
   
-  def initialize(method, arguments = {})
-    @method     = method
-    @uid        = arguments.delete('uid')
-    @api_key    = arguments.delete('api_key') || PostageApp.configuration.api_key
-    @arguments  = arguments
+  # Creates a new Request with the given API call method and arguments.
+  def initialize(method, arguments = { })
+    @method = method
+    @arguments = arguments.dup
+
+    @uid = @arguments.delete('uid')
+    @api_key = @arguments.delete('api_key') || PostageApp.configuration.api_key
   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?
-    
+    http = PostageApp.configuration.http
+
     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})")
+        HEADERS_DEFAULT.merge(
+          'User-Agent' => self.class.user_agent
+        )
       )
+
     rescue TimeoutError, Errno::ECONNREFUSED
       nil
     end
@@ -56,10 +62,10 @@ class PostageApp::Request
     
     PostageApp.logger.info(response)
     
-    unless skip_failed_requests_processing
-      if response.fail?
+    unless (skip_failed_requests_processing)
+      if (response.fail?)
         PostageApp::FailedRequest.store(self)
-      elsif response.ok?
+      elsif (response.ok?)
         PostageApp::FailedRequest.resend_all
       end
     end
@@ -67,16 +73,6 @@ class PostageApp::Request
     response
   end
 
-  # Emulates Mail::Message#html_part
-  def html_part
-    self.arguments && self.arguments['content'] && self.arguments['content']['text/html']
-  end
-  
-  # Emulates Mail::Message#text_part
-  def text_part
-    self.arguments && self.arguments['content'] && self.arguments['content']['text/plain']
-  end
-
   # URL of the where PostageApp::Request will be directed at
   def url
     URI.parse("#{PostageApp.configuration.url}/v.#{API_VERSION}/#{self.method}.json")
@@ -84,20 +80,48 @@ class PostageApp::Request
   
   # Unique ID of the request
   def uid(reload = false)
-    @uid = nil if reload
+    @uid = nil if (reload)
+
     @uid ||= Digest::SHA1.hexdigest("#{rand}#{Time.now.to_f}#{self.arguments}")
   end
   
-  # Arguments need to be appended with some some stuff before it's ready to be send out
+  # Returns the arguments that will be used to send this request.
   def arguments_to_send
-    hash = { 'uid' => self.uid, 'api_key' => self.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)
+    hash = {
+      'uid' => self.uid,
+      'api_key' => self.api_key
+    }
+
+    if (self.arguments && !self.arguments.empty?)
+      case (self.method.to_sym)
+      when :send_message
+        if (PostageApp.configuration.recipient_override)
+          self.arguments.merge!(
+            'recipient_override' => PostageApp.configuration.recipient_override
+          )
+        end
       end
-      hash.merge!('arguments' => self.arguments.recursive_stringify_keys!) 
+
+      hash.merge!(
+        'arguments' => self.arguments.recursive_stringify_keys!
+      )
     end
+    
     hash
   end
+
+  # Emulation of Mail::Message interface
+  def body
+    self.arguments and self.arguments['content'] and (self.arguments['content']['text/html'] or self.arguments['content']['text/plain'])
+  end
+
+  # Emulates Mail::Message#html_part
+  def html_part
+    self.arguments and self.arguments['content'] and self.arguments['content']['text/html']
+  end
+  
+  # Emulates Mail::Message#text_part
+  def text_part
+    self.arguments and self.arguments['content'] and self.arguments['content']['text/plain']
+  end
 end

data/lib/postageapp/response.rb

@@ -1,5 +1,4 @@
 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
@@ -19,12 +18,17 @@ class PostageApp::Response
   # 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']
+
+    _response = hash['response']
+
+    @status = _response['status']
+    @uid = _response['uid']
+    @message = _response['message']
+
+    @data = hash['data']
+
   rescue
-    @status   = 'fail'
+    @status = 'fail'
   end
   
   # Little helper that checks for the Response status
@@ -35,5 +39,4 @@ class PostageApp::Response
   def method_missing(method)
     /.*?\?$/.match(method.to_s) ? "#{self.status}?" == method.to_s : super(method)
   end
-  
-end
+end

data/lib/postageapp/utils.rb

@@ -1,5 +1,4 @@
 class Hash
-  
   # Example usage:
   #   @hash.dig(:k1)          # same as @hash[:k1]
   #   @hash.dig(:k1, :k2)     # same as @hash[:k1] && @hash[:k1][:k2]
@@ -14,8 +13,16 @@ class Hash
   def recursive_stringify_keys!
     keys.each do |key|
       value = delete(key)
-      self[key.to_s] = value.is_a?(Hash) ? value.recursive_stringify_keys! : value
+
+      self[key.to_s] =
+        case (value)
+        when Hash
+          value.recursive_stringify_keys!
+        else
+          value
+        end
     end
+
     self
   end
 end
@@ -25,7 +32,8 @@ class Net::HTTP
   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
+end

data/lib/postageapp/version.rb

@@ -1,3 +1,3 @@
 module PostageApp
-  VERSION = "1.0.24"
-end
+  VERSION = "1.2.0"
+end

data/postageapp.gemspec

@@ -4,18 +4,20 @@ $:.unshift File.expand_path('../lib', __FILE__)
 require 'postageapp/version'
 
 Gem::Specification.new do |s|
-  s.name          = "postageapp"
-  s.version       = PostageApp::VERSION
-  s.authors       = ["Oleg Khabarov", "Scott Tadman", "The Working Group Inc."]
-  s.email         = ["oleg@khabarov.ca", "scott@twg.ca"]
-  s.homepage      = "http://github.com/postageapp/postageapp-ruby"
-  s.summary       = "Easier way to send email from web apps"
-  s.description   = "Gem that interfaces with PostageApp.com service to send emails from web apps"
-  s.license       = 'MIT'
+  s.name = "postageapp"
+  s.version = PostageApp::VERSION
+  s.authors = [ "Oleg Khabarov", "Scott Tadman", "The Working Group Inc." ]
+  s.email = [ "oleg@khabarov.ca", "tadman@postageapp.com" ]
+  s.homepage = "http://github.com/postageapp/postageapp-ruby"
+  s.summary = "Easier way to send email from web apps"
+  s.description = "Gem that interfaces with PostageApp.com service to send emails from web apps"
+  s.license = 'MIT'
   
-  s.files         = `git ls-files`.split("\n")
-  s.platform      = Gem::Platform::RUBY
-  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = [ 'lib' ]
+
+  s.required_ruby_version = '>= 1.9.3'
   
   s.add_dependency 'json'
 end

data/rails/init.rb

@@ -1,2 +1,2 @@
 # Loading for Rails 2
-require 'postageapp/rails/rails'
+require 'postageapp/rails/rails'

data/test/configuration_test.rb

@@ -1,27 +1,26 @@
-require File.expand_path('../helper', __FILE__)
+require File.expand_path('helper', File.dirname(__FILE__))
 
-class ConfigurationTest < Minitest::Test
-  
+class ConfigurationTest < MiniTest::Test
   def test_initialization_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
+    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
@@ -30,17 +29,17 @@ class ConfigurationTest < Minitest::Test
     config.protocol = 'http'
     config.port     = 999
     
-    assert_equal 'http',  config.protocol
-    assert_equal 999,     config.port
+    assert_equal 'http', config.protocol
+    assert_equal 999, config.port
   end
   
   def test_initialization_for_secure
     config = PostageApp::Configuration.new
     
     config.secure = true
-    assert_equal true,    config.secure
+    assert_equal true, config.secure
     assert_equal 'https', config.protocol
-    assert_equal 443,     config.port
+    assert_equal 443, config.port
     
     assert config.secure?
   end
@@ -49,23 +48,22 @@ class ConfigurationTest < Minitest::Test
     config = PostageApp::Configuration.new
     
     config.secure = false
-    assert_equal false,   config.secure
-    assert_equal 'http',  config.protocol
-    assert_equal 80,      config.port
+    assert_equal false, config.secure
+    assert_equal 'http', config.protocol
+    assert_equal 80, config.port
     
     assert !config.secure?
   end
   
   def test_initialization_with_env_api_key
-    ENV['POSTAGEAPP_API_KEY'] = 'env_api_key'
-    
-    config = PostageApp::Configuration.new
-    assert_equal 'env_api_key', config.api_key
-    
-    config.api_key = 'config_api_key'
-    assert_equal 'config_api_key', config.api_key
-    
-    ENV['POSTAGEAPP_API_KEY'] = nil # must unset for other methods to run properly
+    with_environment('POSTAGEAPP_API_KEY' => 'env_api_key') do
+      config = PostageApp::Configuration.new
+
+      assert_equal 'env_api_key', config.api_key
+      
+      config.api_key = 'config_api_key'
+      assert_equal 'config_api_key', config.api_key
+    end
   end
   
   def test_method_url
@@ -74,5 +72,4 @@ class ConfigurationTest < Minitest::Test
     config.host = 'api.postageapp.com'
     assert_equal 'https://api.postageapp.com:443', config.url
   end
-  
-end
+end