Socky - server in Ruby

About this fork

This fork of the socky-server-ruby adds Webhooks. For each application, a webhook callback url may be specified, and whenever something happens with this application (e.g. user connect/disconnect, channel subscribe/unsubscribe, channel occupied/vacated), a signed POST Request will be sent to the specified url containing information about the events.

Installation

Addthe following line to your Gemfile and run the bundle install command:

gem "socky-server", :git => "https://github.com/JulezJulian/socky-server-ruby.git"

Usage

Socky server provides two Rack middlewares - WebSocket and HTTP. Each one of them can be used separately, but they can be also used in one process. Example Rackup file could look like that:

require 'socky/server'

map '/websocket' do
  run Socky::Server::WebSocket.new
end

map '/http' do
  run Socky::Server::HTTP.new
end

Configuration

Both middlewares accept options as hash. Currently available options are:

:applications [Hash]

Hash of supported applications. Each key is application name, each value is either the application secret or a key-value list containing the applications options. Currently supported: secret and webhook_url. You can use as much applications as you want - each of them will have separate application address created by mixing hostname, middleware address and application name. So i.e. for app "my_app" WebSocket application uri will be:

http://example.org/websocket/my_app

:debug [Boolean]

Should application log output? Default Rack logger will be used, so demonized server will log to file. Please note that for HTTP middlewere Rack::CommonLogger will be more reliable that debug mode.

:config_file [String]

Path to YAML config file. Config file should contain hash with exactly the same syntax like normal options.

Example configuration

Create file 'config.ru':

require 'socky/server'

options = {
  :debug => true,
  :applications => {
    :my_app => {
      secret: 'my_secret',
      webhook_url: 'http://webhook.callback/url/'
    },
    :other_app => 'other_secret'
  }
}

map '/websocket' do
  run Socky::Server::WebSocket.new options
end

map '/http' do
  use Rack::CommonLogger
  run Socky::Server::HTTP.new options
end

Run file using Thin:

$ thin -R config.ru -p3001 start

Which Rack servers are currently supported?

All that are supported by websocket-rack. At the time of writing only Thin was supported, but it should change in near future. For the webhook extension an eventmachine loop is needed to process the http request. This works out of the box with Thin because Thin is based on eventmachine.

License

(The MIT License)

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.

julianschuh / socky-server-ruby