witch 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a844251fad9136572ae168e4ccec604679651caf
-  data.tar.gz: 51f9b573a0bfcb8b59885ed2d88e5c518455d7b4
+  metadata.gz: 64a969de8320e9adb6c72c13be3ae3d13c51eaeb
+  data.tar.gz: 403a58d810b091e25dfa7c43d5e9382daa8707b9
 SHA512:
-  metadata.gz: 47e2ab33086fa1b4bc303dd5fddd3fdb3abca21d43dd263a4ba7db1990bf23bd2236d61eb37552febae197018277c674f8a8490391ffa11fa41e824e36ae4f5f
-  data.tar.gz: 015e88a9dbb40aaa85f321bb086a3d809c249811252429d0803f7a7a60d26101ed3147f6cc0ce98c173ebe155ef5d426ff3b3683041bd39c526f868e2ebd3638
+  metadata.gz: 4e6497fbdc894c06800f665af7cf50c6fad172ad116219c9e3b9c9e26794b7f38f3e95ff24b1d7105dfbf1c6560396d19a37c3948c8166fde2ac56c3128518e0
+  data.tar.gz: 70895fc62110b11c42c350d357a19c3babf3c5c05d4d2a5bd2c5fa2a68a8457411761cbd3deb3d1160d8b9821bec3b2de8bf2f51e5506296ce0e338384c30ac2

data/README.md

@@ -1,140 +1,37 @@
-Tuktuk - SMTP client for Ruby
-=============================
-
-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. 
-
-Plus, it supports DKIM out of the box.
-
-Delivering mail
----------------
+Witch
+=====
 
 ``` ruby
-require 'tuktuk'
 
-message = {
-  :from    => 'you@username.com',
-  :to      => 'user@yoursite.com',
-  :body    => 'Hello there',
-  :subject => 'Hiya'
-}
+# foo.rb
+require 'witch'
 
-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:
+Witch.init(:queue => 'events')
 
-``` ruby
-[...]
-
-response, email = Tuktuk.deliver(message)
-
-if response.is_a?(Tuktuk::Bounce)
-  puts 'Email bounced. Type: ' + response.class.name # => HardBounce or SoftBounce
-else
-  puts 'Email delivered!'
+Witch.once 'hello', do |name|
+  Witch.publish('message', "Well hello there #{name}")
 end
-```
-
-Delivering multiple
--------------------
-
-With Tuktuk, you can also deliver multiple messages at once. Depending on the `max_workers` config parameter, Tuktuk will either connect sequentially to the target domain's MX servers, or do it in parallel by spawning threads. 
-
-Tuktuk will try to send all emails targeted for a specific domain on the same SMTP session. If a MX server is not responding -- or times out in the middle --, Tuktuk will try to deliver the remaining messages to next MX server, and so on.
-
-To #deliver_many, you need to pass an array of messages, and you'll receive an array of [response, email] elements, just as above.
-
-``` ruby
-messages = [ { ... }, { ... }, { ... }, { ... } ] # array of messages
-
-result = Tuktuk.deliver_many(messages)
-
-result.each do |response, email|
-
-  if response.is_a?(Tuktuk::Bounce)
-    puts 'Email bounced. Type: ' + response.class.name
-  else
-    puts 'Email delivered!'
-  end
 
+Witch.on 'message', do |msg|
+  puts "Got message: #{msg}"
 end
-```
-
-Options & DKIM
---------------
 
-Now, if you want to enable DKIM (and you should):
-
-``` ruby
-require 'tuktuk'
+Witch.publish('hello', 'foo')
 
-Tuktuk.options = {
-  :dkim => {
-    :domain      => 'yoursite.com',
-    :selector    => 'mailer',
-    :private_key => IO.read('ssl/yoursite.com.key')
-  }
-}
+# bar.rb
+require 'witch'
 
-message = { ... }
+Witch.init(:queue => 'events')
 
-response, email = Tuktuk.deliver(message)
-```
-
-For DKIM to work, you need to set up some TXT records in your domain's DNS. You can use [this tool](http://www.socketlabs.com/domainkey-dkim-generation-wizard/) to generate the key. You should also create [SPF records](http://www.spfwizard.net/) if you haven't.
-
-All available options, with their defaults:
-
-``` ruby
-Tuktuk.options = {
-  :log_to       => nil,   # e.g. log/mailer.log or STDOUT
-  :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 => { ... }
-}
-```
-
-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
+Witch.once 'hello', do |name|
+  Witch.publish('message', "Well hello there #{name}")
+end
 
-config.action_mailer.delivery_method = :tuktuk
+Witch.on 'message', do |msg|
+  puts "Got message: #{msg}"
+end
 
-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')
-  }
-}
+Witch.publish('hello', 'bar')
 ```
 
 # Contributions

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Witch
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: witch
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler