tuktuk 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2537bbe4a21520034c1c224b03c8a1969d5ab5bc
-  data.tar.gz: b3c980a8467cfdecd7dd5c077c2466f89fec3669
+  metadata.gz: 7372b2bc0d09b1c9b88fe82f013528dc9997811e
+  data.tar.gz: 05db8f38889e63c22d6542bfcf04b966a71827ec
 SHA512:
-  metadata.gz: e926584a25e528c86808aa8ad6b70c4c5ae39a9bd38e902c39eecbb4e36e3c276471a7c022180fc17bb53001ab98e5696f54ef64e22d1af48a0ae1d34241e8fa
-  data.tar.gz: 47914f0eeb2bb7c9b5a6b117f9366cae4f5b0024f7d2c7772581be83aa36ec1ef98ce22177149c3cfe63f48adb87f096cab80dd47a80a443905927e64b2a9438
+  metadata.gz: 312b8cc15164b282191c4e519973a0c93afff143644a9b23aa1815d9a6d80a625b11a57a53350fbf7f38d0e8dba7e24522431d56d4b536742b10ebaa9863ed05
+  data.tar.gz: 5dc1afa0829e7c96d344455f01def4d401de8d1e3ea00dd6171f149e335087d1ff435d987b17846ec93f7c6400851a217f2c6712ca10075dd8a8d8ca84b698c4

data/README.md

@@ -25,6 +25,21 @@ message = {
 response, email = Tuktuk.deliver(message)
 ```
 
+HTML (multipart) emails are supported, of course. 
+
+``` ruby
+
+message = {
+  :from      => 'you@username.com',
+  :to        => 'user@yoursite.com',
+  :body      => 'Hello there',
+  :html_body => '<h1 style="color: red">Hello there</h1>',
+  :subject   => 'Hiya in colours'
+}
+
+response, email = Tuktuk.deliver(message)
+```
+
 The `response` is either a Net::SMTP::Response object, or a Bounce exception (HardBounce or SoftBounce, depending on the cause). `email` is a [mail](https://github.com/mikel/mail) object. So, to handle bounces you'd do:
 
 ``` ruby
@@ -39,7 +54,46 @@ else
 end
 ```
 
-You can also call `Tuktuk.deliver!` (with a trailing `!`), in which case it will automatically raise an exception if the response was either a HardBounce or SoftBounce. This is useful when running in the background via Resque or Sidekiq, because it makes you aware of which emails are not getting through, and you can requeue those jobs to have them redelivered.
+You can also call `Tuktuk.deliver!` (with a trailing `!`), in which case it will automatically raise an exception if the response was either a `HardBounce` or a `SoftBounce`. This is useful when running in the background via Resque or Sidekiq, because it makes you aware of which emails are not getting through, and you can requeue those jobs to have them redelivered.
+
+Email options
+-------------
+
+Attachments are supported, as you'd expect. 
+
+``` rb
+message = {
+  :from             => 'john@lennon.com',
+  :to               => 'paul@maccartney.com',
+  :subject          => 'Question for you',
+  :body             => 'How do you sleep?',
+  :reply_to         => '<haha@foobar.com>',
+  :return_path      => 'bounces@server.com',
+  :attachments      => [ '/home/john/walrus.png' ]
+}
+```
+
+Attachments can be either a path to a file or a hash containing the file's name and content, like this:
+
+``` rb
+  message = {
+    ...
+    :attachments => [ 
+      { :filename => 'walrus.png', :content => File.read('/home/john/walrus.png') } 
+    ]
+  }
+```
+
+These are the email headers Tuktuk is able to set for you. Just pass them as part of the hash and they'll be automatically set.
+
+```
+  :return_path      => '<return-path@host.com>', # will actually set three headers, Return-Path, Bounces-To and Errors-To
+  :reply_to         => '<reply@to.com>',
+  :in_reply_to      => '<inreply@to.com>',
+  :list_unsubscribe => '<http://server.com/path>, <mailto:somewhere@server.com>',
+  :list_archive     => '<http://server.com/list/archive>',
+  :list_id          => '<mail-list.foobar.com>'
+```
 
 Delivering multiple
 -------------------
@@ -69,7 +123,7 @@ end
 Options & DKIM
 --------------
 
-Now, if you want to enable DKIM (and you should):
+Now, if you want to enable DKIM (and you _should_):
 
 ``` ruby
 require 'tuktuk'
@@ -104,7 +158,7 @@ Tuktuk.options = {
 }
 ```
 
-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.
+You can set the `max_workers` 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.
 

data/bin/tuktuk

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/tuktuk'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/tuktuk'
 require 'optparse'
 
 def missing_keys?(opts)

data/lib/tuktuk/tuktuk.rb

@@ -5,8 +5,10 @@ require 'work_queue'
 
 module Tuktuk; end
 
-%w(package cache dns bounce).each { |lib| require_relative "./#{lib}" }
-require_relative './version' unless defined?(Tuktuk::VERSION)
+this_path = File.expand_path(File.dirname(__FILE__))
+
+%w(package cache dns bounce).each { |lib| require this_path + "/#{lib}" }
+require_relative this_path + '/version' unless defined?(Tuktuk::VERSION)
 
 DEFAULTS = {
   :helo_domain  => nil,
@@ -116,7 +118,7 @@ module Tuktuk
       mail.destinations.each do |to|
 
         domain = get_domain(to)
-        raise "Empty domain: #{domain}" if domain.blank?
+        raise "Empty domain: #{domain}" if domain.to_s.strip == ''
 
         unless servers = smtp_servers_for_domain(domain)
           return HardBounce.new("588 No MX records for domain #{domain}")

data/lib/tuktuk/version.rb

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

data/spec/deliver_spec.rb

@@ -169,7 +169,7 @@ describe 'deliver many' do
             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
+              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)

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: tuktuk
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -42,42 +42,42 @@ dependencies:
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: dkim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: work_queue
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
 description: Easy way of sending DKIM-signed emails from Ruby, no dependencies needed.
@@ -88,7 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
@@ -112,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: tuktuk
-rubygems_version: 2.0.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: SMTP client for Ruby with DKIM support.