tuktuk 0.4.5 → 0.4.6

data/lib/tuktuk/tuktuk.rb

@@ -29,6 +29,7 @@ module Tuktuk
     end
 
     def deliver(message, opts = {})
+      raise 'Please pass a valid message object.' unless messages.is_a?(Hash)
       self.options = opts if opts.any?
       mail = Package.new(message)
       response = lookup_and_deliver(mail)
@@ -36,6 +37,7 @@ module Tuktuk
     end
 
     def deliver_many(messages, opts = {})
+      raise 'Please pass an array of messages.' unless messages.is_a?(Array) and messages.any?
       self.options = opts if opts.any?
       messages_by_domain = reorder_by_domain(messages)
       lookup_and_deliver_many(messages_by_domain)
@@ -150,6 +152,7 @@ module Tuktuk
       queue = WorkQueue.new(count)
       responses = []
 
+      logger.info("Delivering emails to #{by_domain.keys.count} domains...")
       by_domain.each do |domain, mails|
         queue.enqueue_b(domain, mails) do |domain, mails|
           # send emails and then assign responses to array according to mail index
@@ -167,6 +170,8 @@ module Tuktuk
 
     def lookup_and_deliver_many_sync(by_domain)
       responses = []
+
+      logger.info("Delivering emails to #{by_domain.keys.count} domains...")
       by_domain.each do |domain, mails|
         # send emails and then assign responses to array according to mail index
         rr = lookup_and_deliver_by_domain(domain, mails)
@@ -179,28 +184,26 @@ module Tuktuk
 
     def lookup_and_deliver_by_domain(domain, mails)
       responses = []
+      total = mails.count
 
       unless servers = smtp_servers_for_domain(domain)
         err = DNSError.new("No MX Records for domain #{domain}")
-        mails.each {|mail| responses.push [err, mail] }
+        mails.each { |mail| responses.push [err, mail] }
         return responses
       end
 
-      last_error = nil
       servers.each do |server|
-        begin
-          send_many_now(server, mails).each do |mail, resp|
-            responses.push [resp, mail]
-          end
-          break
-        rescue => e
-          # logger.error e.message
-          last_error = e
+        send_many_now(server, mails).each do |mail, resp|
+          responses.push [resp, mail]
+          mails.delete(mail) # remove it from list, to avoid duplicate delivery
         end
+        logger.info "#{responses.count}/#{total} mails processed on #{domain}."
+        break if responses.count == total
       end
 
-      if last_error # got error at server level, mark all messages with errors
-        mails.each {|mail| responses.push [last_error, mail] }
+      # if we still have emails in queue, mark them with the last error which prevented delivery
+      if mails.any? and @last_error 
+         mails.each { |m| responses.push [@last_error, m] }
       end
 
       responses
@@ -212,8 +215,8 @@ module Tuktuk
 
       response = nil
       server = 'localhost' if ENV['DEBUG']
-      smtp = init_connection(server)
-      smtp.start(get_helo_domain(from), nil, nil, nil) do |smtp|
+      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)
         logger.info "#{to} - [SENT] #{response.message.strip}"
       end
@@ -228,26 +231,26 @@ module Tuktuk
       timeout_error = nil
 
       server = 'localhost' if ENV['DEBUG']
-      smtp = init_connection(server)
-      smtp.start(get_helo_domain, nil, nil, nil) do |smtp|
+      socket = init_connection(server)
+      socket.start(get_helo_domain, nil, nil, nil) do |smtp|
         mails.each do |mail|
-          unless timeout_error
-            begin
-              resp = smtp.send_message(get_raw_mail(mail), get_from(mail), mail.to)
-              smtp.send(:getok, 'RSET') if server['hotmail'] # fix for '503 Sender already specified'
-            rescue Net::SMTPError, EOFError, Timeout::Error => e # may be Net::SMTPFatalError (550 Mailbox not found)
-              # logger.error e.inspect
-              timeout_error = e if e.is_a?(Timeout::Error)
-              resp = e
-            end
+          begin
+            resp = smtp.send_message(get_raw_mail(mail), get_from(mail), mail.to)
+            smtp.send(:getok, 'RSET') if server['hotmail'] # fix for '503 Sender already specified'
+          rescue Net::SMTPFatalError => e # error code 5xx, except for 500, like: 550 Mailbox not found
+            resp = e
           end
-          responses[mail] = timeout_error || resp
+          responses[mail] = resp
           status = resp.is_a?(Net::SMTP::Response) ? 'SENT' : 'ERROR'
           logger.info "#{mail.to} [#{status}] #{responses[mail].message.strip}" # both error and response have this method
         end
       end
 
       responses
+    rescue => e # SMTPServerBusy, SMTPSyntaxError, SMTPUnsupportedCommand, SMTPUnknownError (unexpected reply code)
+	    logger.error "[SERVER ERROR: #{server}] #{e.message}"
+	    @last_error = e
+      responses
     end
 
     def get_raw_mail(mail)

data/lib/tuktuk/version.rb

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

data/spec/deliver_spec.rb

@@ -0,0 +1,189 @@
+require './lib/tuktuk/tuktuk'
+require 'rspec/mocks'
+
+describe 'deliver' do
+	
+end
+
+describe 'deliver many' do
+	
+	before(:each) do
+		@mock_smtp = mock('Net::SMTP')
+		Net::SMTP.stub!(:new).and_return(@mock_smtp)
+	end
+	
+	describe 'when no emails are passed' do
+		
+		it 'raises' do
+			lambda do
+				Tuktuk.deliver_many []
+			end.should raise_error
+		end
+		
+	end
+	
+	describe 'when one email contains multiple addresses' do
+		
+		it 'raises' do
+			lambda do 
+				Tuktuk.deliver_many [ email, email(:to => 'one@user.com, two@user.com')]
+			end.should raise_error
+		end
+		
+	end
+	
+	describe 'when emails are valid' do
+		
+		it 'groups them by domain' do
+			
+		end
+		
+		describe 'and max_workers is 0' do
+			
+			it 'does not start any threads' do
+				
+			end
+			
+		end
+		
+		describe 'and max_workers is >0' do
+			
+			it 'does not spawn any more threads than the max allowed' do
+				
+			end
+			
+		end
+		
+		describe 'and max workers is auto' do
+			
+			it 'spawns a new thread for each domain' do
+				
+			end
+			
+		end
+		
+		describe 'when delivering to domain' do
+			
+			before do
+				@mock_smtp.stub!(:start).and_yield()
+				@emails = [email, email, email]
+
+				@success = mock('Net::SMTP::Response')
+				@soft_email_bounce = Net::SMTPFatalError.new('503 Sender already specified')
+				@hard_email_bounce = Net::SMTPFatalError.new('505 Mailbox not found')
+				@soft_server_bounce = Net::SMTPServerBusy.new('Be back in a sec')
+				@hard_server_bounce = Tuktuk::DNSError.new('No MX records found.')
+			end
+
+			describe 'when domain exists' do
+				
+				before do
+					@domain = 'domain.com'
+				end
+				
+				describe 'and has valid MX servers' do
+					
+					before do
+						@servers = ['mx1.domain.com', 'mx2.domain.com', 'mx3.domain.com']
+						Tuktuk.stub!(:smtp_servers_for_domain).and_return(@servers)
+					end
+					
+					it 'starts by delivering to first one' do
+						Tuktuk.should_receive(:send_many_now).once.with('mx1.domain.com', [1]).and_return([[1,'ok']])
+						Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', [1])
+					end
+					
+					describe 'and first server processes all our mail' do
+						
+						describe 'and all mail goes through' do
+
+							before do
+								@responses = []
+								@emails.each { |e| @responses.push [e, @success] }
+							end
+
+							it 'does not try to connect to second server' do
+								Tuktuk.should_receive(:send_many_now).once.with('mx1.domain.com', @emails).and_return(@responses)
+								Tuktuk.should_not_receive(:send_many_now).with('mx2.domain.com')
+								Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', @emails)
+							end
+							
+						end
+						
+						describe 'and all emails were hard failures (bounces)' do
+
+							before do
+								@responses = []
+								@emails.each { |e| @responses.push [e, @hard_email_bounce] }
+							end
+
+							it 'does not try to connect to second server' do
+								Tuktuk.should_receive(:send_many_now).once.with('mx1.domain.com', @emails).and_return(@responses)
+								Tuktuk.should_not_receive(:send_many_now).with('mx2.domain.com')
+								Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', @emails)
+							end
+
+						end
+
+					end
+
+					describe 'and first server is down' do
+
+						before do
+							Tuktuk.stub(:init_connection).and_return(@mock_smtp)
+							Tuktuk.stub(:init_connection).with('mx1.domain.com').and_raise('Unable to connect.')
+							@responses = []
+							@emails.each { |e| @responses.push [e, @success] }
+						end
+						
+						it 'does not raise error' do
+							lambda do
+								Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', @emails)
+							end.should_not raise_error(RuntimeError)
+						end
+
+						it 'tries to connect to second server' do
+							Tuktuk.should_receive(:send_many_now).once.with('mx1.domain.com', @emails).and_return([])
+							Tuktuk.should_receive(:send_many_now).once.with('mx2.domain.com', @emails).and_return(@responses)
+							Tuktuk.should_not_receive(:send_many_now).with('mx3.domain.com')
+							Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', @emails)
+						end
+						
+					end
+					
+					describe 'and first server receives only one email' do
+						
+						before do
+							@first = [@emails[0], @success]
+							@last_two = [[@emails[1], @success], [@emails[2], @soft_email_bounce]]
+						end
+						
+						it 'does not try to send that same email to second server' do
+							Tuktuk.should_receive(:send_many_now).once.with('mx1.domain.com', @emails).and_return([@first])
+							last_two_emails = @emails.last(2)
+							last_two_emails.include?(@emails.first).should be_false
+							Tuktuk.should_receive(:send_many_now).once.with('mx2.domain.com', last_two_emails).and_return(@last_two)
+							Tuktuk.should_not_receive(:send_many_now).with('mx3.domain.com')
+							Tuktuk.send(:lookup_and_deliver_by_domain, 'domain.com', @emails)
+						end
+							
+					end
+					
+				end
+				
+			end
+			
+		end
+		
+	end
+	
+	def email(attrs = {})
+		{
+			:to => "user#{rand(1000)}@domain.com",
+			:from => 'me@company.com',
+			:subject => 'Test email',
+			:body => 'Hello world.'
+		}.merge(attrs)
+	end
+	
+end

metadata

@@ -1,111 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tuktuk
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 0.4.6
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 5
-  version: 0.4.5
 platform: ruby
-authors: 
-- "Tom\xC3\xA1s Pollak"
+authors:
+- Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: net-dns
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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 
-        hash: 5
-        segments: 
-        - 0
-        - 6
-        - 1
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.6.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mail
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: dkim
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: dkim
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 0
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: work_queue
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: work_queue
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :runtime
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 description: Easy way of sending DKIM-signed emails from Ruby, no dependencies needed.
-email: 
+email:
 - tomas@forkhq.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -116,41 +108,30 @@ files:
 - lib/tuktuk/package.rb
 - lib/tuktuk/tuktuk.rb
 - lib/tuktuk/version.rb
+- spec/deliver_spec.rb
 - tuktuk.gemspec
 homepage: https://github.com/tomas/tuktuk
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: tuktuk
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: SMTP client for Ruby with DKIM support.
 test_files: []
-