tuktuk 0.5.1 → 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f62d4bf43a7a59fc76ce9fec973740c593a40914
+  data.tar.gz: dd1bc1790077737e8d9c7c7b05f838bf8e2f2fed
+SHA512:
+  metadata.gz: 067e0525fcf6209b3a7023c123a7d7972cf7587b46c73a2e7100dde5e7cba23175e0f5a9afc9cbf73cce6a6b7de5da6355be06e1bf6f9895b7b1c9a65304fc1b
+  data.tar.gz: 454def2bcb6549622b77bc7c1668240d87176c98efca5e178a2d3a6f8c7f8e6b64f65d487d999236aa49a767d669a6618200660fd832b18c54a0dc36778e0df0

data/README.md

@@ -1,8 +1,8 @@
 Tuktuk - SMTP client for Ruby
 =============================
 
-Unlike Pony (which is friggin' awesome by the way) Tuktuk does not rely on 
-`sendmail` or a separate SMTP server in order to send email. Tuktuk looks up the
+Unlike famous ol' Pony gem (which is friggin' awesome by the way), Tuktuk does not rely on 
+`sendmail` or a separate SMTP server in order to deliver email. Tuktuk looks up the
 MX servers of the destination address and connects directly using Net::SMTP. 
 This way you don't need to install Exim or Postfix and you can actually handle 
 response status codes -- like bounces, 5xx -- within your application. 
@@ -32,7 +32,7 @@ The `response` is either a Net::SMTP::Response object, or a Bounce exception (Ha
 
 response, email = Tuktuk.deliver(message)
 
-if response.is_a?(Bounce)
+if response.is_a?(Tuktuk::Bounce)
   puts 'Email bounced. Type: ' + response.class.name # => HardBounce or SoftBounce
 else
   puts 'Email delivered!'
@@ -55,7 +55,7 @@ result = Tuktuk.deliver_many(messages)
 
 result.each do |response, email|
 
-  if response.is_a?(Bounce)
+  if response.is_a?(Tuktuk::Bounce)
     puts 'Email bounced. Type: ' + response.class.name
   else
     puts 'Email delivered!'
@@ -87,18 +87,55 @@ response, email = Tuktuk.deliver(message)
 
 For DKIM to work, you need to set up a TXT record in your domain's DNS.
 
-Additional Tuktuk options:
+All available options, with their defaults:
 
 ``` ruby
 Tuktuk.options = {
-  :log_to => 'log/mailer.log',
-  :helo_domain => 'mydomain.com',
-  :max_workers => 'auto', # spawns a new thread for each domain 
+  :log_to       => nil,   # e.g. log/mailer.log
+  :helo_domain  => nil,   # your server's domain goes here
+  :max_workers  => 0,     # controls number of threads for delivering_many emails (read below)
+  :open_timeout => 20,    # max seconds to wait for opening a connection
+  :read_timeout => 20,    # 20 seconds to wait for a response, once connected
+  :verify_ssl   => true,  # whether to skip SSL keys verification or not
+  :debug        => false, # connects and delivers email to localhost, instead of real target server. CAUTION!
   :dkim => { ... }
 }
 ```
 
-That's all.
+You can set the `max_threads` option to `auto`, which will spawn the necessary threads to connect in paralell to all target MX servers when delivering multiple messages. When set to `0`, these batches will be delivered sequentially.
+
+In other words, if you have three emails targeted to Gmail users and two for Hotmail users, using `auto` Tuktuk will spawn two threads and connect to both servers at once. Using `0` will have email deliveried to one host and then the other.
+
+Using with Rails
+----------------
+
+Tuktuk comes with ActionMailer support out of the box. In your environment.rb or environments/{env}.rb:
+
+``` ruby
+require 'tuktuk/rails'
+
+[...]
+
+config.action_mailer.delivery_method = :tuktuk
+```
+
+Since Tuktuk delivers email directly to the user's MX servers, it's probably a good idea to set `config.action_mailer.raise_delivery_errors` to true. That way you can actually know if an email couldn't make it to its destination.
+
+When used with ActionMailer, you can pass options using ActionMailer's interface, like this:
+
+``` ruby
+
+config.action_mailer.delivery_method = :tuktuk
+
+config.action_mailer.tuktuk_settings = {
+  :log_to => 'log/mailer.log', # when not set, Tuktuk will use Rails.logger
+  :dkim => {
+    :domain => 'yoursite.com',
+    :selector => 'mailer',
+    :private_key => IO.read('ssl/yoursite.com.key')
+  }
+}
+```
 
 --
 

data/lib/tuktuk/package.rb

@@ -9,22 +9,33 @@ module Tuktuk
 module Package
 
   class << self
+	
+    def build(message, index = nil)
+      mail = message.is_a?(Hash) ? new(message) : message.is_a?(Mail) ? message : Mail.read_from_string(message.to_s)
+      mail.array_index = index if index
+      mail
+    end
 
-    def new(message, index = nil)
+    def new(message)
       mail = message[:html_body] ? mixed(message) : plain(message)
-      mail.array_index = index if index
       mail.charset = 'UTF-8'
 
-      mail['In-Reply-To'] = message[:in_reply_to] if message[:in_reply_to]
-      mail['List-Archive'] = message[:list_archive] if message[:list_archive]
-      mail['List-Id'] = message[:list_id] if message[:list_id]
-      mail['X-Mailer'] = "Tuktuk SMTP v#{Tuktuk::VERSION}"
+      mail['In-Reply-To']   = message[:in_reply_to] if message[:in_reply_to]
+      mail['List-Archive']  = message[:list_archive] if message[:list_archive]
+      mail['List-Id']       = message[:list_id] if message[:list_id]
+      mail['X-Mailer']      = "Tuktuk SMTP v#{Tuktuk::VERSION}"
 
       if message[:return_path]
         mail['Return-Path'] = message[:return_path]
         mail['Bounces-To']  = message[:return_path]
         mail['Errors-To']   = message[:return_path]
       end
+      
+      if message[:attachments].any?
+        message[:attachments].each do |file|
+          mail.add_file(file)
+        end
+      end
 
       mail
     end

data/lib/tuktuk/rails.rb

@@ -0,0 +1,30 @@
+if ActionMailer::Base.respond_to?(:add_delivery_method)
+  
+  ActionMailer::Base.add_delivery_method :tuktuk, Tuktuk
+
+  module Tuktuk
+
+    def self.new(options)
+      self.options = options
+      self
+    end
+
+  end
+
+else
+  
+  require 'tuktuk'
+
+  class ActionMailer::Base
+
+    def self.tuktuk_settings=(opts)
+      Tuktuk.options = opts
+    end
+
+    def perform_delivery_tuktuk(mail)
+      Tuktuk.deliver!(mail)
+    end
+
+  end
+  
+end

data/lib/tuktuk/tuktuk.rb

@@ -14,6 +14,7 @@ DEFAULTS = {
   :read_timeout => 20,
   :open_timeout => 20,
   :verify_ssl   => true,
+  :debug        => false, 
   :log_to       => nil # $stdout,
 }
 
@@ -26,13 +27,20 @@ module Tuktuk
     end
 
     def deliver(message, opts = {})
-      raise 'Please pass a valid message object.' unless messages[:to]
+      # raise 'Please pass a valid message object.' unless message[:to]
       self.options = opts if opts.any?
-      mail = Package.new(message)
+      mail = Package.build(message)
       response = lookup_and_deliver(mail)
       return response, mail
     end
 
+    # same as deliver but raises error. used by ActionMailer
+    def deliver!(mail)
+      @logger = Rails.logger if defined?(Rails) and !config[:log_to]
+      resp, email = deliver(mail)
+      raise resp if resp.is_a?(Exception)
+    end
+
     def deliver_many(messages, opts = {})
       raise 'Please pass an array of messages.' unless messages.any?
       self.options = opts if opts.any?
@@ -74,7 +82,7 @@ module Tuktuk
     def reorder_by_domain(array)
       hash = {}
       array.each_with_index do |message, i|
-        mail = Package.new(message, i)
+        mail = Package.build(message, i)
         raise "Invalid destination count: #{mail.destinations.count}" if mail.destinations.count != 1
 
         if to = mail.destinations.first and domain = get_domain(to)
@@ -199,7 +207,6 @@ module Tuktuk
       from = get_from(mail)
 
       response = nil
-      server = 'localhost' if ENV['DEBUG']
       socket = init_connection(server)
       socket.start(get_helo_domain(from), nil, nil, nil) do |smtp|
         response = smtp.send_message(get_raw_mail(mail), from, to)
@@ -213,7 +220,6 @@ module Tuktuk
       logger.info "Delivering #{mails.count} mails at #{server}..."
       responses = {}
 
-      server = 'localhost' if ENV['DEBUG']
       socket = init_connection(server)
       socket.start(get_helo_domain, nil, nil, nil) do |smtp|
         mails.each do |mail|
@@ -230,8 +236,8 @@ module Tuktuk
 
       responses
     rescue => e # SMTPServerBusy, SMTPSyntaxError, SMTPUnsupportedCommand, SMTPUnknownError (unexpected reply code)
-	    logger.error "[SERVER ERROR: #{server}] #{e.message}"
-	    @last_error = e
+      logger.error "[SERVER ERROR: #{server}] #{e.message}"
+      @last_error = e
       responses
     end
 
@@ -252,6 +258,10 @@ module Tuktuk
       context.verify_mode = config[:verify_ssl] ?
         OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
 
+      if config[:debug]
+        logger.warn "Debug option enabled. Connecting to localhost!"
+        server = 'localhost'
+      end
       smtp = Net::SMTP.new(server, nil)
       smtp.enable_starttls_auto(context)
       smtp.read_timeout = config[:read_timeout] if config[:read_timeout]

data/lib/tuktuk/version.rb

@@ -1,7 +1,7 @@
 module Tuktuk
   MAJOR = 0
   MINOR = 5
-  PATCH = 1
+  PATCH = 2
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: tuktuk
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.5.2
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: net-dns
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: dkim
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: work_queue
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -107,32 +96,32 @@ files:
 - lib/tuktuk/cache.rb
 - lib/tuktuk/dns.rb
 - lib/tuktuk/package.rb
+- lib/tuktuk/rails.rb
 - lib/tuktuk/tuktuk.rb
 - lib/tuktuk/version.rb
 - spec/deliver_spec.rb
 - tuktuk.gemspec
 homepage: https://github.com/tomas/tuktuk
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: tuktuk
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SMTP client for Ruby with DKIM support.
 test_files: []