garufa 0.0.1.alpha.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e75a892c17eda812e7d24f2eb34282c2cb34b992
+  data.tar.gz: c2a7430113bb000c5c2c061a70c8f1cbe24bbe8e
+SHA512:
+  metadata.gz: 1bb546c89b9fb29bf16bfd7bcdf9c883aeedc9fef507cf33b2b6b353567c3cbadf67d073b639df3157bb412ddc1a383d8d51b2d02e6854a1e87c0edd6660a014
+  data.tar.gz: 40f0cdd7e0a2c2e6246de48332e082190be57ec66fd297806c5fc80cdddfc79cf34efe099d8b57954d731e53613fa94a0267e72e8d35951be22c40e20104ef1c

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Juan Manuel Cuello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+Garufa
+====
+
+A websocket server compatible with the Pusher protocol.
+
+**IMPORTANT:** Garufa is currently in alpha version, which means it is not
+production ready, but you are free to use it and test it. Any feedback is
+welcome.
+
+Intro
+-----
+
+Garufa is a websocket server which implements the [Pusher][pusher] protocol. It
+was built on top of [Goliath][goliath], a high performance non-blocking web
+server.
+
+It was based on [Slanger][slanger], another server compatible with Pusher.
+
+[pusher]: http://pusher.com
+[goliath]: https://github.com/postrank-labs/goliath/
+[slanger]: https://github.com/stevegraham/slanger
+
+Install
+-------
+
+Make sure you have a ruby version >= 1.9.2
+
+``` console
+$ gem install garufa --pre
+
+$ garufa --help
+
+$ garufa -sv -p 4567 --app_key my-application-key --secret my-secret-string
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*.rb"
+end
+
+task default: :test

data/bin/garufa

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'goliath/runner'
+require 'garufa'
+
+module Garufa
+  runner = Goliath::Runner.new(ARGV, GarufaApp.new)
+  runner.app = Goliath::Rack::Builder.build(GarufaApp, runner.api)
+
+  if runner.daemonize
+    runner.log_file ||= './garufa.log'
+    runner.pid_file ||= './garufa.pid'
+  end
+
+  runner.run
+end

data/bin/garufa.log

@@ -0,0 +1 @@
+[4707:INFO] 2013-12-21 18:43:01 :: Starting server on 0.0.0.0:9000 in development mode. Watch out for stones.

data/bin/garufa.log_stdout.log

@@ -0,0 +1,2 @@
+terminate called after throwing an instance of 'std::runtime_error'
+  what():  setuid_string failed: no setuid

data/bin/garufa.pid

@@ -0,0 +1 @@
+4707

data/garufa.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'garufa/version'
+
+Gem::Specification.new do |s|
+  s.name              = "garufa"
+  s.version           = Garufa::VERSION
+  s.summary           = "Websocket server compatible with Pusher."
+  s.description       = "Garufa is a websocket server compatible with the Pusher service protocol."
+  s.authors           = ["Juan Manuel Cuello"]
+  s.email             = ["juanmacuello@gmail.com"]
+  s.homepage          = "http://github.com/Juanmcuello/garufa"
+  s.bindir            = 'bin'
+  s.executables       << 'garufa'
+
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "bin/*",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "goliath"
+  s.add_dependency "faye-websocket"
+  s.add_dependency "cuba"
+  s.add_dependency "signature"
+end

data/lib/garufa.rb

@@ -0,0 +1 @@
+require 'garufa/garufa_app'

data/lib/garufa/api_server.rb

@@ -0,0 +1,35 @@
+require 'cuba'
+require 'garufa/cuba/authentication'
+require 'garufa/message'
+require 'garufa/subscriptions'
+
+module Garufa
+  Cuba.plugin Cuba::Authentication
+
+  ApiServer = Cuba.new do
+
+    on "apps/:app_id" do |app_id|
+
+      authenticate
+
+      # Events
+      on post, "events" do
+        message = Message.new(JSON.parse(req.body.read))
+        options = { data: message.data, socket_id: message.socket_id }
+        Subscriptions.notify message.channels, message.name, options
+        res.write "{}"
+      end
+
+      # Channels
+      on get, "channels" do
+      end
+
+      on get, "channels/:channel" do
+      end
+
+      # Users
+      on get, "channels/:channel/users" do
+      end
+    end
+  end
+end

data/lib/garufa/config.rb

@@ -0,0 +1,17 @@
+module Garufa
+  module Config
+    extend self
+
+    def [](key)
+      settings[key]
+    end
+
+    def []=(key, value)
+      settings[key] = value
+    end
+
+    def settings
+      @settings ||= {}
+    end
+  end
+end

data/lib/garufa/connection.rb

@@ -0,0 +1,105 @@
+require 'uri'
+
+module Garufa
+  class Connection
+
+    attr_reader :socket_id
+
+    def initialize(socket, logger)
+      @socket = socket
+      @logger = logger
+      @socket_id = SecureRandom.uuid
+      @subscriptions = {}
+    end
+
+    def establish
+      if valid_app_key?
+        send_message Message.connection_established(@socket_id)
+      else
+        error(4001, "Could not find app by key #{app_key}")
+        close
+      end
+    end
+
+    def handle_incomming_data(data)
+      @logger.debug "Incomming message. #{@socket_id}: #{data}"
+
+      message = Message.new(JSON.parse(data))
+      event, data = message.event, message.data
+
+      case event
+      when /^pusher:/
+        handle_pusher_event(event, data)
+      when /^client-/
+        handle_client_event(event, data)
+      end
+    end
+
+    def error(code, message)
+      send_message Message.error(code, message)
+    end
+
+    def send_message(message)
+      @logger.debug "Outgoing message: #{message.to_json}"
+
+      @socket.send message.to_json
+    end
+
+    def close
+      @socket.close
+    end
+
+    private
+
+    def handle_pusher_event(event, data)
+      accepted_events = %w{ping pong subscribe unsubscribe}
+      event_name = event.partition(':').last
+
+      if accepted_events.include?(event_name)
+        method("pusher_#{event_name}").call data
+      end
+    end
+
+    def handle_client_event(event, data)
+      # NOTE: not supported yet
+      error(nil, 'Client events are not supported yet')
+    end
+
+    def pusher_ping(data)
+      send_message Message.pong
+    end
+
+    def pusher_pong(data)
+      # There is nothing to do with a pong message
+    end
+
+    def pusher_subscribe(data)
+      subscription = Subscription.new(data, self)
+      subscription.subscribe
+
+      if subscription.success?
+        @subscriptions[subscription.channel] = subscription
+        send_subscription_succeeded(subscription) unless subscription.public_channel?
+      else
+        error(subscription.error.code, subscription.error.message)
+      end
+    end
+
+    def pusher_unsubscribe(data)
+      subscription = @subscriptions.delete data["channel"]
+      subscription.unsubscribe if subscription
+    end
+
+    def valid_app_key?
+      app_key && (app_key == Config[:app_key])
+    end
+
+    def app_key
+      @app_key ||= URI.parse(@socket.url).path.split('/').last
+    end
+
+    def send_subscription_succeeded(subscription)
+      send_message Message.subscription_succeeded(subscription.channel)
+    end
+  end
+end

data/lib/garufa/cuba/authentication.rb

@@ -0,0 +1,14 @@
+require 'signature'
+require 'garufa/config'
+
+class Cuba
+  module Authentication
+    def authenticate
+      request = Signature::Request.new(req.request_method, env['REQUEST_PATH'], req.params)
+      request.authenticate { |key| Signature::Token.new(key, Garufa::Config[:secret]) }
+
+    rescue Signature::AuthenticationError
+      halt([401, {}, ['401 Unauthorized']])
+    end
+  end
+end

data/lib/garufa/faye_websocket_patch.rb

@@ -0,0 +1,16 @@
+# This is included only to provide a fix when the 'env' was not set.
+# This fix was already included in 'master' of faye-websocket-ruby,
+# but not released as a gem yet.
+#
+# See https://github.com/faye/faye-websocket-ruby/issues/38
+#
+module Faye
+  class WebSocket
+    module Adapter
+      def websocket?
+        e = defined?(@env) ? @env : env
+        e && WebSocket.websocket?(e)
+      end
+    end
+  end
+end

data/lib/garufa/garufa_app.rb

@@ -0,0 +1,39 @@
+require 'goliath/api'
+require 'goliath/connection'
+require 'faye/websocket'
+require 'garufa/config'
+require 'garufa/ws_server'
+require 'garufa/api_server'
+
+# Remove this require after next release of faye-websocket-ruby.
+# See https://github.com/faye/faye-websocket-ruby/issues/38
+require 'garufa/faye_websocket_patch'
+
+module Garufa
+  Faye::WebSocket.load_adapter('goliath')
+
+  class GarufaApp < Goliath::API
+
+    # Extend goliath options with our own options.
+    def options_parser(opts, options)
+      opts.separator ""
+      opts.separator "Pusher options:"
+
+      new_options = {
+        app_key: ['--app_key APP_KEY', 'Pusher application key (required)'],
+        secret:  ['--secret SECRET',   'Pusher application secret (required)']
+      }
+      new_options.each do |k, v|
+        opts.on(v.first, v.last) { |value| Garufa::Config[k] = value }
+      end
+    end
+
+    def response(env)
+      if Faye::WebSocket.websocket?(env)
+        WsServer.call(env)
+      else
+        ApiServer.call(env)
+      end
+    end
+  end
+end

data/lib/garufa/message.rb

@@ -0,0 +1,47 @@
+require 'json'
+
+module Garufa
+  class Message
+
+    ACTIVITY_TIMEOUT = 120
+
+    ATTRIBUTES = [:channels, :channel, :event, :data, :name, :socket_id]
+
+    def initialize(attributes)
+      @attributes = ATTRIBUTES.each_with_object({}) do |key, hash|
+        hash[key] = attributes[key] || attributes[key.to_s]
+      end
+
+      @attributes.each do |name, value|
+        instance_variable_set("@#{name}", value)
+        self.class.send(:attr_reader, name)
+      end
+    end
+
+    def to_json
+      @attributes.delete_if { |k, v| v.nil? }.to_json
+    end
+
+    def self.channel_event(channel, event, data)
+       new(channel: channel, event: event, data: data)
+    end
+
+    def self.connection_established(socket_id)
+      data = { socket_id: socket_id, activity_timeout: ACTIVITY_TIMEOUT }.to_json
+      new(event: 'pusher:connection_established', data: data)
+    end
+
+    def self.subscription_succeeded(channel)
+      new(event: 'pusher_internal:subscription_succeeded', channel: channel)
+    end
+
+    def self.pong
+      new(event: 'pusher:pong')
+    end
+
+    def self.error(code, message)
+      data = { code: code, message: message }.to_json
+      new(event: 'pusher:error', data: data)
+    end
+  end
+end

data/lib/garufa/subscriptions.rb

@@ -0,0 +1,121 @@
+require 'set'
+
+module Garufa
+  module Subscriptions
+    extend self
+
+    def all
+      subscriptions
+    end
+
+    def add(subscription)
+      subscriptions[subscription.channel].add subscription
+    end
+
+    def remove(subscription)
+      subscriptions[subscription.channel].delete subscription
+    end
+
+    def notify(channels, event, options = {})
+      channels.each do |channel|
+        connections = subscriptions[channel].map { |s| s.connection }
+        next unless connections.any?
+
+        connections.each do |connection|
+          next if connection.socket_id == options[:socket_id]
+
+          message = Message.channel_event(channel, event, options[:data])
+          connection.send_message(message)
+        end
+      end
+    end
+
+    def include?(subscription)
+      subscriptions[subscription.channel].include? subscription
+    end
+
+    private
+
+    def subscriptions
+      @subscriptions ||= Hash.new(Set.new)
+    end
+  end
+
+  class Subscription
+    attr_reader :data, :connection, :error
+
+    def initialize(data, connection)
+      @data, @connection = data, connection
+    end
+
+    def subscribe
+      case true
+      when invalid_channel?
+        set_error(nil, 'Invalid channnel or not present')
+      when invalid_signature?
+        set_error(nil, 'Invalid signature')
+      when already_subscribed?
+        set_error(nil, "Already subscribed to channel: #{channel}")
+      else
+        Subscriptions.add self
+      end
+    end
+
+    def unsubscribe
+      Subscriptions.remove self
+    end
+
+    def public_channel?
+      !(private_channel? || presence_channel?)
+    end
+
+    def private_channel?
+      channel_prefix == 'private'
+    end
+
+    def presence_channel?
+      channel_prefix == 'presence'
+    end
+
+    def set_error(code, message)
+      @error = SubscriptionError.new(code, message)
+    end
+
+    def success?
+      @error.nil?
+    end
+
+    def channel
+      @data['channel']
+    end
+
+    def channel_prefix
+      channel[/^private-|presence-/].to_s[0...-1]
+    end
+
+    private
+
+    def invalid_channel?
+      !channel.is_a?(String) || channel.empty?
+    end
+
+    def invalid_signature?
+      return false if public_channel?
+
+      string_to_sign = [@connection.socket_id, channel].compact.join(':')
+      token(string_to_sign) != @data["auth"].split(':').last
+    end
+
+    def token(string_to_sign)
+      digest = OpenSSL::Digest::SHA256.new
+      OpenSSL::HMAC.hexdigest(digest, Config[:secret], string_to_sign)
+    end
+
+    def already_subscribed?
+      Subscriptions.include? self
+    end
+  end
+
+  class SubscriptionError < Struct.new(:code, :message)
+  end
+end

data/lib/garufa/version.rb

@@ -0,0 +1,4 @@
+module Garufa
+  VERSION = '0.0.1.alpha.0'
+end
+

data/lib/garufa/ws_server.rb

@@ -0,0 +1,23 @@
+require 'garufa/connection'
+
+module Garufa
+  WsServer = lambda do |env|
+    socket = Faye::WebSocket.new(env)
+    connection = Connection.new(socket, env.logger)
+
+    socket.on :open do |event|
+      connection.establish
+    end
+
+    socket.on :message do |event|
+      connection.handle_incomming_data(event.data)
+    end
+
+    socket.on :close do |event|
+      socket = nil
+    end
+
+    # Return async Rack response
+    socket.rack_response
+  end
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require "garufa"
+require 'minitest/autorun'

data/test/message.rb

@@ -0,0 +1,85 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+module Garufa
+  describe Message do
+    describe '.connection_established' do
+      before do
+        @socket_id = '123123-123123'
+        @message = Message.connection_established @socket_id
+      end
+
+      it 'should response with data attribute as string' do
+        @message.data.class.must_equal String
+      end
+
+      it 'should response with expected event' do
+        @message.event.must_equal 'pusher:connection_established'
+      end
+
+      it 'should response with expected data' do
+        data = JSON.parse(@message.data)
+        data["socket_id"].must_equal @socket_id
+        data["activity_timeout"].must_equal 120
+      end
+    end
+
+    describe '.channel_event' do
+     before do
+        @channel = 'channel-123'
+        @event = 'my-event'
+        @data = { itemId: 1, value: 'Sample Item' }
+        @message = Message.channel_event @channel, @event, @data
+      end
+
+      it 'should response with expected event' do
+        @message.event.must_equal @event
+      end
+
+      it 'should response with expected data' do
+        @message.data.must_equal @data
+      end
+
+      it 'should response with expected channel' do
+        @message.channel.must_equal @channel
+      end
+    end
+
+    describe '.subscription_succeeded' do
+      before do
+        @channel = 'channel-123'
+        @message = Message.subscription_succeeded @channel
+      end
+
+      it 'should response with expected event' do
+        @message.event.must_equal 'pusher_internal:subscription_succeeded'
+      end
+
+      it 'should response with expected channel' do
+        @message.channel.must_equal @channel
+      end
+    end
+
+    describe '.pong' do
+      it 'should response with a pong event' do
+        Message.pong.event.must_equal 'pusher:pong'
+      end
+    end
+
+    describe '.error' do
+      before do
+        @code, @error_message = 4000, 'There was an error!'
+        @message = Message.error @code, @error_message
+      end
+
+      it 'should response with expected event' do
+        @message.event.must_equal 'pusher:error'
+      end
+
+      it 'should response with expected data' do
+        data = JSON.parse(@message.data)
+        data["code"].must_equal @code
+        data["message"].must_equal @error_message
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: garufa
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.0
+platform: ruby
+authors:
+- Juan Manuel Cuello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: goliath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: signature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Garufa is a websocket server compatible with the Pusher service protocol.
+email:
+- juanmacuello@gmail.com
+executables:
+- garufa
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/garufa/version.rb
+- lib/garufa/ws_server.rb
+- lib/garufa/message.rb
+- lib/garufa/config.rb
+- lib/garufa/cuba/authentication.rb
+- lib/garufa/subscriptions.rb
+- lib/garufa/garufa_app.rb
+- lib/garufa/connection.rb
+- lib/garufa/faye_websocket_patch.rb
+- lib/garufa/api_server.rb
+- lib/garufa.rb
+- bin/garufa.pid
+- bin/garufa
+- bin/garufa.log_stdout.log
+- bin/garufa.log
+- garufa.gemspec
+- test/helper.rb
+- test/message.rb
+homepage: http://github.com/Juanmcuello/garufa
+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.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Websocket server compatible with Pusher.
+test_files: []
+has_rdoc: