slanger 0.1.0

data/bin/slanger

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby -Ku
+
+require 'optparse'
+require 'bundler/setup'
+require 'eventmachine'
+
+options = {
+  api_host: '0.0.0.0', api_port: '4567', websocket_host: '0.0.0.0',
+  websocket_port: '8080', debug: false, redis_address: 'redis://0.0.0.0:6379/0'
+  }
+
+OptionParser.new do |opts|
+  opts.on '-h', '--help', 'Display this screen' do
+    exit
+  end
+
+  opts.on '-k', '--app_key APP_KEY', "Pusher application key" do |k|
+    options[:app_key] = k
+  end
+
+  opts.on '-s', '--secret SECRET', "Pusher application secret" do |k|
+    options[:secret] = k
+  end
+
+  opts.on '-r', '--redis_address URL', "Address to bind to (Default: redis://127.0.0.1:6379/0)" do |h|
+    options[:redis_address] = h
+  end
+
+  opts.on '-a', '--api_host HOST', "API service address (Default: 0.0.0.0:4567)" do |p|
+    options[:api_host], options[:api_port] = p.split(':')
+  end
+
+  opts.on '-w', '--websocket_host HOST', "WebSocket service address (Default: 0.0.0.0:8080)" do |p|
+    options[:websocket_host], options[:websocket_port] = p.split(':')
+  end
+
+  opts.on "-v", "--[no-]verbose", "Run verbosely" do |v|
+    options[:debug] = v
+  end
+end.parse!
+
+%w<app_key secret>.each do |parameter|
+  raise RuntimeError.new "--#{parameter} STRING is a required argument. Use your Pusher #{parameter}." unless options[parameter.to_sym]
+end
+
+EM.run do
+  File.tap { |f| require f.expand_path(f.join(f.dirname(__FILE__),'..', 'slanger.rb')) }
+  Slanger::Config.load options
+  Slanger::Service.run
+
+  puts "\x1b[2J\x1b[H"
+  puts "\n"
+  puts "    .d8888b.  888                                               "
+  puts "   d88P  Y88b 888                                               "
+  puts "   Y88b.      888                                               "
+  puts '    "Y888b.   888  8888b.  88888b.   .d88b.   .d88b.  888d888   '
+  puts '       "Y88b. 888     "88b 888 "88b d88P"88b d8P  Y8b 888P"     '
+  puts '         "888 888 .d888888 888  888 888  888 88888888 888       '
+  puts "   Y88b  d88P 888 888  888 888  888 Y88b 888 Y8b.     888       "
+  puts '    "Y8888P"  888 "Y888888 888  888  "Y88888  "Y8888  888       '
+  puts "                                         888                    "
+  puts "                                    Y8b d88P                    "
+  puts '                                    "Y88P"                      '
+  puts "\n" * 2
+
+  puts "Slanger API server listening on port #{options[:api_port]}"
+  puts "Slanger WebSocket server listening on port #{options[:websocket_port]}"
+end

data/lib/slanger/api_server.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+require 'signature'
+require 'active_support/json'
+require 'active_support/core_ext/hash'
+require 'eventmachine'
+require 'em-hiredis'
+require 'rack'
+require 'fiber'
+require 'rack/fiber_pool'
+
+module Slanger
+  class ApiServer < Sinatra::Base
+    use Rack::FiberPool
+    set :raise_errors, lambda { false }
+    set :show_exceptions, false
+
+    # Respond with HTTP 401 Unauthorized if request cannot be authenticated.
+    error(Signature::AuthenticationError) { |c| halt 401, "401 UNAUTHORIZED\n" }
+
+    post '/apps/:app_id/channels/:channel_id/events' do
+      # authenticate request. exclude 'channel_id' and 'app_id', these are added the the params
+      # by the pusher client lib after computing HMAC
+      Signature::Request.new('POST', env['PATH_INFO'], params.except('channel_id', 'app_id')).
+        authenticate { |key| Signature::Token.new key, Slanger::Config.secret }
+
+      f = Fiber.current
+      Slanger::Redis.publish(params[:channel_id], payload).tap do |r|
+        r.callback { f.resume [202, {}, "202 ACCEPTED\n"] }
+        r.errback  { f.resume [500, {}, "500 INTERNAL SERVER ERROR\n"] }
+      end
+      Fiber.yield
+    end
+
+    def payload
+      payload = {
+        event: params['name'], data: request.body.read, channel: params[:channel_id], socket_id: params[:socket_id]
+      }
+      Hash[payload.reject { |k,v| v.nil? }].to_json
+    end
+  end
+end
+

data/lib/slanger/channel.rb

@@ -0,0 +1,25 @@
+require 'glamazon'
+require 'eventmachine'
+require 'forwardable'
+
+module Slanger
+  class Channel
+    include Glamazon::Base
+    extend  Forwardable
+
+    def_delegators :channel, :subscribe, :unsubscribe, :push
+
+    def initialize(attrs)
+      super
+      Slanger::Redis.subscribe channel_id
+    end
+
+    def channel
+      @channel ||= EM::Channel.new
+    end
+
+    def dispatch(message, channel)
+      push(message.to_json) unless channel =~ /^slanger:/
+    end
+  end
+end

data/lib/slanger/config.rb

@@ -0,0 +1,24 @@
+module Slanger
+  module Config
+    def load(opts={})
+      options.update opts
+    end
+
+    def [](key)
+      options[key]
+    end
+
+    def options
+      @options ||= {
+        api_host: '0.0.0.0', api_port: '4567', websocket_host: '0.0.0.0',
+        websocket_port: '8080', debug: false, redis_address: 'redis://0.0.0.0:6379/0'
+      }
+    end
+
+    def method_missing(meth, *args, &blk)
+      @options[meth]
+    end
+
+    extend self
+  end
+end

data/lib/slanger/handler.rb

@@ -0,0 +1,113 @@
+require 'active_support/json'
+require 'active_support/core_ext/hash'
+require 'securerandom'
+require 'signature'
+require 'fiber'
+
+module Slanger
+  class Handler
+    def initialize(socket)
+      @socket = socket
+      authenticate
+    end
+
+    # Dispatches message handling to method with same name as the event name
+    def onmessage(msg)
+      msg = JSON.parse msg
+      send msg['event'].gsub('pusher:', 'pusher_'), msg
+    end
+
+    # Unsubscribe this connection from the channel
+    def onclose
+      const   = @channel_id =~ /^presence-/ ? 'PresenceChannel' : 'Channel'
+      channel = Slanger.const_get(const).find_by_channel_id(@channel_id)
+      channel.try :unsubscribe, @subscription_id
+    end
+
+    private
+
+    # Verify app key. Send connection_established message to connection if it checks out. Send error message and disconnect if invalid.
+    def authenticate
+      app_key = @socket.request['path'].split(/\W/)[2]
+      if app_key == Slanger::Config.app_key
+        @socket_id = SecureRandom.uuid
+        @socket.send(payload 'pusher:connection_established', { socket_id: @socket_id })
+      else
+        @socket.send(payload 'pusher:error', { code: '4001', message: "Could not find app by key #{app_key}" })
+        @socket.close_websocket
+      end
+    end
+
+    # Dispatch to handler method if channel requires authentication, otherwise subscribe.
+    def pusher_subscribe(msg)
+      @channel_id = msg['data']['channel']
+      if match = @channel_id.match(/^((private)|(presence))-/)
+        send "handle_#{match.captures[0]}_subscription", msg
+      else
+        subscribe_channel
+      end
+    end
+
+    # Add connection to channel subscribers
+    def subscribe_channel
+      channel = Slanger::Channel.find_or_create_by_channel_id(@channel_id)
+      @subscription_id = channel.subscribe do |msg|
+        msg       = JSON.parse(msg)
+        socket_id = msg.delete 'socket_id'
+        @socket.send msg.to_json unless socket_id == @socket_id
+      end
+    end
+
+    # Validate authentication token for private channel and add connection to channel subscribers if it checks out
+    def handle_private_subscription(msg)
+      if msg['data']['auth'] && token(msg['data']['channel_data']) != msg['data']['auth'].split(':')[1]
+        @socket.send(payload 'pusher:error', {
+          message: "Invalid signature: Expected HMAC SHA256 hex digest of #{@socket_id}:#{msg['data']['channel']}, but got #{msg['data']['auth']}"
+        })
+      else
+        subscribe_channel
+      end
+    end
+
+    # Validate authentication token and check channel_data. Add connection to channel subscribers if it checks out
+    def handle_presence_subscription(msg)
+      if token(msg['data']['channel_data']) != msg['data']['auth'].split(':')[1]
+        @socket.send(payload 'pusher:error', {
+          message: "Invalid signature: Expected HMAC SHA256 hex digest of #{@socket_id}:#{msg['data']['channel']}, but got #{msg['data']['auth']}"
+        })
+      elsif !msg['data']['channel_data']
+        @socket.send(payload 'pusher:error', {
+          message: "presence-channel is a presence channel and subscription must include channel_data"
+        })
+      else
+        channel = Slanger::PresenceChannel.find_or_create_by_channel_id(@channel_id)
+        callback = Proc.new {
+          @socket.send(payload 'pusher_internal:subscription_succeeded', {
+            presence: {
+              count: channel.subscribers.size,
+              ids:   channel.ids,
+              hash:  channel.subscribers
+            }
+          })
+        }
+        @subscription_id = channel.subscribe(msg, callback) do |msg|
+          msg       = JSON.parse(msg)
+          socket_id = msg.delete 'socket_id'
+          @socket.send msg.to_json unless socket_id == @socket_id
+        end
+
+      end
+    end
+
+    # Message helper method. Converts a hash into the Pusher JSON protocol
+    def payload(event_name, payload = {})
+      { channel: @channel_id, event: event_name, data: payload }.to_json
+    end
+
+    # HMAC token validation
+    def token(params=nil)
+      string_to_sign = [@socket_id, @channel_id, params].compact.join ':'
+      HMAC::SHA256.hexdigest(Slanger::Config.secret, string_to_sign)
+    end
+  end
+end

data/lib/slanger/logger.rb

@@ -0,0 +1,7 @@
+module Slanger
+  module Logger
+    def log(msg)
+    end
+    extend self
+  end
+end

data/lib/slanger/presence_channel.rb

@@ -0,0 +1,120 @@
+require 'glamazon'
+require 'eventmachine'
+require 'forwardable'
+require 'fiber'
+
+module Slanger
+  class PresenceChannel < Channel
+    def_delegators :channel, :push
+
+    def dispatch(message, channel)
+      if channel =~ /^slanger:/
+        update_subscribers message
+      else
+        push message.to_json
+      end
+    end
+
+    def initialize(attrs)
+      super
+      Slanger::Redis.subscribe 'slanger:connection_notification'
+    end
+
+    def subscribe(msg, callback, &blk)
+      channel_data = JSON.parse msg['data']['channel_data']
+      public_subscription_id = SecureRandom.uuid
+
+      publisher = publish_connection_notification subscription_id: public_subscription_id, online: true,
+        channel_data: channel_data, channel: channel_id
+
+      roster_add public_subscription_id, channel_data
+
+      # fuuuuuuuuuccccccck!
+      publisher.callback do
+        EM.next_tick do
+          callback.call
+          internal_subscription_table[public_subscription_id] = channel.subscribe &blk
+        end
+      end
+
+      public_subscription_id
+    end
+
+    def ids
+      subscriptions.map { |k,v| v['user_id'] }
+    end
+
+    def subscribers
+      Hash[subscriptions.map { |k,v| [v['user_id'], v['user_info']] }]
+    end
+
+    def unsubscribe(public_subscription_id)
+      # Unsubcribe from EM::Channel
+      channel.unsubscribe(internal_subscription_table.delete(public_subscription_id)) # if internal_subscription_table[public_subscription_id]
+      roster_remove public_subscription_id
+      # Notify all instances
+      publish_connection_notification subscription_id: public_subscription_id, online: false, channel: channel_id
+    end
+
+    private
+
+    def get_roster
+      Fiber.new do
+        f = Fiber.current
+        Slanger::Redis.hgetall(channel_id).
+          callback { |res| f.resume res }
+        Fiber.yield
+      end.resume
+    end
+
+    def roster_add(key, value)
+      Slanger::Redis.hset(channel_id, key, value)
+    end
+
+    def roster_remove(key)
+      Slanger::Redis.hdel(channel_id, key)
+    end
+
+    def publish_connection_notification(payload, retry_count=0)
+      Slanger::Redis.publish('slanger:connection_notification', payload.to_json).
+        tap { |r| r.errback { publish_connection_notification payload, retry_count.succ unless retry_count == 5 } }
+    end
+
+    # This is the state of the presence channel across the system. kept in sync
+    # with redis pubsub
+    def subscriptions
+      @subscriptions = @subscriptions || get_roster || Hash.new
+    end
+
+    # This is used map public subscription ids to em channel subscription ids.
+    # em channel subscription ids are incremented integers, so they cannot
+    # be used as keys in distributed system because they will not be unique
+    def internal_subscription_table
+      @internal_subscription_table ||= {}
+    end
+
+    def update_subscribers(message)
+      if message['online']
+        # Don't tell the channel subscriptions a new member has been added if the subscriber data
+        # is already present in the subscriptions hash, i.e. multiple browser windows open.
+        unless subscriptions.has_value? message['channel_data']
+          push payload('pusher_internal:member_added', message['channel_data'])
+        end
+        subscriptions[message['subscription_id']] = message['channel_data']
+      else
+        # Don't tell the channel subscriptions the member has been removed if the subscriber data
+        # still remains in the subscriptions hash, i.e. multiple browser windows open.
+        subscriber = subscriptions.delete message['subscription_id']
+        unless subscriptions.has_value? subscriber
+          push payload('pusher_internal:member_removed', {
+            user_id: subscriber['user_id']
+          })
+        end
+      end
+    end
+
+    def payload(event_name, payload = {})
+      { channel: channel_id, event: event_name, data: payload }.to_json
+    end
+  end
+end

data/lib/slanger/redis.rb

@@ -0,0 +1,39 @@
+require 'forwardable'
+
+module Slanger
+  module Redis
+    extend Forwardable
+
+    def self.extended base
+      base.on(:message) do |channel, message|
+        message = JSON.parse message
+        const = message['channel'] =~ /^presence-/ ? 'PresenceChannel' : 'Channel'
+        Slanger.const_get(const).find_or_create_by_channel_id(message['channel']).dispatch message, channel
+      end
+    end
+
+    def_delegator  :publisher, :publish
+    def_delegators :subscriber, :on, :subscribe
+    def_delegators :regular_connection, :hgetall, :hdel, :hset
+
+    private
+
+    def regular_connection
+      @regular_connection ||= new_connection
+    end
+
+    def publisher
+      @publisher ||= new_connection
+    end
+
+    def subscriber
+      @subscriber ||= new_connection
+    end
+
+    def new_connection
+      EM::Hiredis.connect Slanger::Config.redis_address
+    end
+
+    extend self
+  end
+end

data/lib/slanger/service.rb

@@ -0,0 +1,19 @@
+require 'thin'
+require 'rack'
+
+module Slanger
+  module Service
+    def run
+      Thin::Logging.silent = true
+      Rack::Handler::Thin.run Slanger::ApiServer, Host: Slanger::Config.api_host, Port: Slanger::Config.api_port
+      Slanger::WebSocketServer.run
+    end
+
+    def stop
+      EM.stop if EM.reactor_running?
+    end
+
+    extend self
+    Signal.trap('HUP') { Slanger::Service.stop }
+  end
+end

data/lib/slanger/web_socket_server.rb

@@ -0,0 +1,20 @@
+require 'eventmachine'
+require 'em-websocket'
+
+module Slanger
+  module WebSocketServer
+    def run
+      EM.run do
+        EM::WebSocket.start host:  Slanger::Config[:websocket_host], port:  Slanger::Config[:websocket_port], debug: Slanger::Config[:debug], app_key:  Slanger::Config[:app_key] do |ws|
+          # Keep track of handler instance in instance of EM::Connection to ensure a unique handler instance is used per connection.
+          ws.class_eval    { attr_accessor :connection_handler }
+          # Delegate connection management to handler instance.
+          ws.onopen        { ws.connection_handler = Slanger::Handler.new ws }
+          ws.onmessage     { |msg| ws.connection_handler.onmessage msg }
+          ws.onclose       { ws.connection_handler.onclose }
+        end
+      end
+    end
+    extend self
+  end
+end

data/slanger.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+
+require 'eventmachine'
+require 'em-hiredis'
+require 'rack'
+require 'active_support/core_ext/string'
+
+module Slanger; end
+
+EM.run do
+  File.tap do |f|
+    Dir[f.expand_path(f.join(f.dirname(__FILE__),'lib', 'slanger', '*.rb'))].each do |file|
+      Slanger.autoload File.basename(file, '.rb').classify, file
+    end
+  end
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: slanger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Stevie Graham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70311444305760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444305760
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: &70311444305300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444305300
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: &70311444304840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444304840
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70311444304380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444304380
+- !ruby/object:Gem::Dependency
+  name: rack-fiber_pool
+  requirement: &70311444303920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444303920
+- !ruby/object:Gem::Dependency
+  name: signature
+  requirement: &70311444303460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444303460
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70311444303000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444303000
+- !ruby/object:Gem::Dependency
+  name: glamazon
+  requirement: &70311444302540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444302540
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70311444328700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444328700
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70311444328240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444328240
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &70311444327780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311444327780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70311444327320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70311444327320
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: &70311444326860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: *70311444326860
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &70311444326400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *70311444326400
+description: A websocket service compatible with Pusher libraries
+email: sjtgraham@mac.com
+executables:
+- slanger
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/slanger/api_server.rb
+- lib/slanger/channel.rb
+- lib/slanger/config.rb
+- lib/slanger/handler.rb
+- lib/slanger/logger.rb
+- lib/slanger/presence_channel.rb
+- lib/slanger/redis.rb
+- lib/slanger/service.rb
+- lib/slanger/web_socket_server.rb
+- slanger.rb
+- bin/slanger
+homepage: http://github.com/stevegraham/pusher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A websocket service compatible with Pusher libraries
+test_files: []