witch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4aec34f53b5eefdb9e1ef701556c0b9834f23ae
+  data.tar.gz: 99bf4a228960cc0e830136b57e00562e4254b5fc
+SHA512:
+  metadata.gz: 3b6c2d058d1fc8c524756b0662b65f7d7d4a601902e96c699b886b96348a47e9e2291f2514df161e95e13d4368d411b3ae3828c7ccad8726e5fcc6e3952bdcd2
+  data.tar.gz: a55381d307d1c6cea404640a135da9d553730074b39807d5397e5f35c6b13cba06e3c87b8f0c80ef554bcb08878ab58654fcb3df1567d936f1f7ff5ecc810ad8

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# specified in tuktuk.gemspec
+gemspec

data/README.md

@@ -0,0 +1,146 @@
+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
+---------------
+
+``` ruby
+require 'tuktuk'
+
+message = {
+  :from    => 'you@username.com',
+  :to      => 'user@yoursite.com',
+  :body    => 'Hello there',
+  :subject => 'Hiya'
+}
+
+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
+[...]
+
+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!'
+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
+
+end
+```
+
+Options & DKIM
+--------------
+
+Now, if you want to enable DKIM (and you should):
+
+``` ruby
+require 'tuktuk'
+
+Tuktuk.options = {
+  :dkim => {
+    :domain      => 'yoursite.com',
+    :selector    => 'mailer',
+    :private_key => IO.read('ssl/yoursite.com.key')
+  }
+}
+
+message = { ... }
+
+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
+
+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')
+  }
+}
+```
+
+# Contributions
+
+You're more than welcome. Send a pull request, including tests, and make sure you don't break anything. That's it.
+
+# Copyright
+
+(c) Fork Limited. MIT license.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Witch
+  VERSION = '0.0.2'
+end

data/lib/witch.rb

@@ -0,0 +1,154 @@
+require 'redis'
+require 'json'
+
+module Witch
+
+  class ConsumerDisconnected < Exception; end
+
+  class << self
+
+    def init(options = {})
+      raise 'Already initialized!' if @queue
+      @queue     = options.delete(:queue) || 'eventstream'
+      @options   = options
+      @callbacks = {:once => {}, :on => {}}
+      @channels  = []
+      @id = Socket.gethostname + '-' + $$.to_s
+    end
+
+    def once(*events, &block)
+      raise 'Not initialized' unless @callbacks
+      events.each do |event|
+        @callbacks[:once][event.to_sym] ||= []
+        @callbacks[:once][event.to_sym].push(block)
+        register_for(event)
+      end
+      listen(:once, @id) unless listening_on?(@id)
+    end
+
+    def on(*events, &block)
+      raise 'Not initialized' unless @callbacks
+      events.each do |event|
+        @callbacks[:on][event.to_sym] ||= []
+        @callbacks[:on][event.to_sym].push(block)
+      end
+      listen(:on, @queue) unless listening_on?(@queue)
+    end
+
+    def off(*events)
+      raise 'Not initialized' unless @callbacks
+      events.each do |event|
+        @callbacks[:on].delete(event.to_sym)
+      end
+    end
+
+    def publish(event, data = nil)
+      str = event + '___' + data.to_s
+
+      lock.synchronize do
+        # first, send to everyone on the main queue
+        puts '[publisher] Publishing on queue ' + @queue
+        connection.publish(@queue, str)
+
+        # if one or more clients are subscribed to the 'once' queue, choose one and notify.
+        if consumer = connection.smembers('subscribers:' + event.to_s).shuffle.first
+          # connection.publish(['events', event, subscriber].join(':'), data)
+          puts "[publisher] Found consumer for #{event}: #{consumer}"
+          count = connection.publish(consumer, str)
+
+          if count == 0
+            puts "[publisher] Consumer #{consumer} disconnected! Removing and retrying..."
+            connection.srem('subscribers:' + event.to_s, consumer)
+            raise ConsumerDisconnected, "name: #{consumer}"
+          end
+        end
+
+      end # lock
+
+    rescue ConsumerDisconnected => e
+      retry
+    end
+
+    def disconnect
+      return unless @id
+      @callbacks[:once].keys.each do |event|
+        unregister_from(event)
+      end
+    end
+
+    private
+
+    def register_for(event)
+      lock.synchronize do
+        count = connection.sadd('subscribers:' + event.to_s, @id)
+        puts "[consumer] Registered. Queue contains #{count} listeners."
+      end
+    end
+
+    def unregister_from(event)
+      lock.synchronize do
+        puts "[consumer] Unregistering from #{event} processing queue."
+        connection.srem('subscribers:' + event.to_s, @id)
+      end
+    rescue => e
+      puts e.inspect
+    end
+
+    def listen(type, queue)
+      lock.synchronize do
+        puts "[consumer] Subscribing to queue #{queue} on new thread..."
+        @channels.push(queue)
+        Thread.new do
+          # connection.subscribe(['events' + event + id].join(':')) do |on|
+          connection.subscribe(queue) do |on|
+            on.subscribe do |channel, subscriptions|
+
+              puts "[consumer] Subscribed to #{channel} (#{subscriptions} subscriptions)"
+              raise "Existing subscribers!" if subscriptions > 1
+            end
+            on.message do |channel, msg|
+              process(type, msg)
+            end
+          end
+        end
+      end
+    rescue => e
+      @channels.delete(queue)
+      puts e.message
+    end
+
+    def process(type, msg)
+      parts = msg.split('___')
+      data = parts[1] ? JSON.parse(parts[1]) : nil
+      fire_callbacks(type, parts[0], data)
+    rescue => e
+      puts "[consumer] Error parsing message: #{e.message}"
+    end
+
+    def fire_callbacks(type, event, data)
+      return if @callbacks.nil?
+      lock.synchronize do
+        (@callbacks[type][event.to_sym] || []).each do |callback|
+          callback.call(data)
+        end
+      end
+    rescue => e
+      puts "[consumer] Error firing callback: #{e.message}"
+    end
+
+    def lock
+      @lock ||= Mutex.new
+    end
+
+    def connection
+      raise 'Not initialized!' unless @options
+      Thread.current[:redis] ||= Redis.new(@options)
+    end
+
+    def listening_on?(queue)
+      @channels.include?(queue)
+    end
+
+  end
+
+end

data/sandbox/api.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'witch'
+
+Witch.init
+
+puts 'API server...'
+
+Signal.trap 'EXIT' do
+  Thread.new { Witch.disconnect }.join
+end
+
+module Events
+  def self.device_dead
+    puts Time.now.to_s + ' - marking device dead'
+  end
+end
+
+Redis.new.subscribe('test') do |on|
+  on.message do |channel, message|
+    puts 'got message: ' + message
+    Events.send(message) if Events.respond_to?(message)
+    Witch.publish(message)
+  end
+end

data/sandbox/mailer.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'witch'
+
+Witch.init
+
+puts 'mailer server...'
+
+Witch.once 'device_dead' do |data|
+  puts Time.now.to_s + ' sending email to user'
+end
+
+Signal.trap 'EXIT' do
+  Thread.new { Witch.disconnect }.join
+end
+
+loop { sleep 1; }

data/sandbox/test.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'witch'
+
+Witch.init
+
+puts 'API server...'
+
+Witch.once 'foo' do |data|
+  puts 'got message: ' + data.inspect
+end
+
+Signal.trap 'EXIT' do
+  Thread.new { Witch.disconnect }.join
+end
+
+loop { sleep 1; }

data/sandbox/web.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'witch'
+
+Witch.init
+
+puts 'web server...'
+
+Witch.on 'device_dead', 'device_away' do |data|
+  puts Time.now.to_s + ' - showing device dead message in UI '
+end
+
+Signal.trap 'EXIT' do
+  Thread.new { Witch.disconnect }.join
+end
+
+loop { sleep 1; }

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+
+this_path = File.dirname(__FILE__)
+require File.join(this_path, '..', 'lib', 'witch.rb')

data/spec/witch/witch_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'witch' do
+
+  before do
+    @called = {}
+  end
+
+  after(:all) do
+    # Witch.disconnect
+  end
+
+  def register(type)
+    Witch.init
+    Witch.send(type, 'some_event') do
+      # puts 'calledxxxxxxxxx'
+      @called[$$] = true
+    end
+    sleep 0.1
+  end
+
+  describe 'once' do
+
+    describe 'single process' do
+
+      before do
+        register :once
+      end
+
+      it 'fires event once' do
+        puts 'publishing'
+        Witch.publish 'some_event'
+        puts @called.inspect
+        # @called.keys.should == $$
+      end
+
+    end
+
+    describe 'multi process' do
+
+      it 'fires event once' do
+
+      end
+
+    end
+
+  end
+
+  describe 'on' do
+
+  end
+
+  describe 'off' do
+
+  end
+
+end

data/witch.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "witch"
+  s.version     = Witch::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Tomás Pollak']
+  s.email       = ['tomas@forkhq.com']
+  s.homepage    = "https://github.com/tomas/witch"
+  s.summary     = "Reliable pub/sub for multi-process architectures."
+  s.description = "Reliable pub/sub for multi-process architectures."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "tuktuk"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", '~> 3.0', '>= 3.0.0'
+  s.add_runtime_dependency "redis", ">= 3.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: witch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tomás Pollak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Reliable pub/sub for multi-process architectures.
+email:
+- tomas@forkhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/version.rb
+- lib/witch.rb
+- sandbox/api.rb
+- sandbox/mailer.rb
+- sandbox/test.rb
+- sandbox/web.rb
+- spec/spec_helper.rb
+- spec/witch/witch_spec.rb
+- witch.gemspec
+homepage: https://github.com/tomas/witch
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Reliable pub/sub for multi-process architectures.
+test_files: []
+has_rdoc: