sinapse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0830fca767543791482bb3d24747a07b2e8cd7e
+  data.tar.gz: e34f207abe290e1ea3f15a7f4625c011090f8e04
+SHA512:
+  metadata.gz: 6ed6da3772bdf393658bf7de7780cfee57692847e1d6647215eaa3954d7242aba8888cf977f5f35e9959c1719474c473cf93899e4fa55406ff006c1bd727a837
+  data.tar.gz: 75b3ee32acbf69e8461374e8c36994ab7b88fbca86e10f7a4baf6222ee72c0fa09d579c1e10a3ec49b59a0deedabb775c026ee57ad4c16b0dd6527a75a7783ea

data.tar.gz.sig

@@ -0,0 +1 @@
+�1v��?}��^=xŌ������a���c��8� Es��s�x��PO�>>?�l{�kl��*���ݬ79����|�g�C�F 	���h�_��J����β۵�ó��W�"�ًѪ�|դ�8�e:)V;�]�*��F���8�d��<�7\��7�h�!��:�5�ϰ6͍�(�B@t��b3(�nD�"7�!�����|A풝S�9���P듳�=2�*C�}�c(j(��~kV'8?�?��mX��`T

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - rbx-2.2.3
+services:
+  - redis-server
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+platform :rbx do
+  gem 'rubysl-securerandom'
+
+  group :development do
+    gem 'rubysl-prettyprint'
+  end
+
+  group :test do
+    gem 'rubysl-singleton'  # required by rake
+    gem 'rubysl-base64'     # required by em-http-request
+    gem 'rubysl-mutex_m'    # required by minitest 5.2
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    sinapse (0.0.1)
+      activesupport (>= 3.0.0)
+      connection_pool
+      goliath (>= 1.0.3)
+      hiredis
+      msgpack (>= 0.5.0)
+      redis (>= 3.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.5)
+    ansi (1.4.3)
+    async-rack (0.5.1)
+      rack (~> 1.1)
+    builder (3.2.2)
+    connection_pool (1.2.0)
+    cookiejar (0.3.0)
+    em-http-request (1.1.1)
+      addressable (>= 2.3.4)
+      cookiejar
+      em-socksify (>= 0.3)
+      eventmachine (>= 1.0.3)
+      http_parser.rb (>= 0.6.0.beta.2)
+    em-socksify (0.3.0)
+      eventmachine (>= 1.0.0.beta.4)
+    em-synchrony (1.0.3)
+      eventmachine (>= 1.0.0.beta.1)
+    em-websocket (0.3.8)
+      addressable (>= 2.1.1)
+      eventmachine (>= 0.12.9)
+    eventmachine (1.0.3)
+    goliath (1.0.3)
+      async-rack
+      em-synchrony (>= 1.0.0)
+      em-websocket (= 0.3.8)
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (= 0.6.0.beta.2)
+      log4r
+      multi_json
+      rack (>= 1.2.2)
+      rack-contrib
+      rack-respond_to
+    hashie (2.0.5)
+    hiredis (0.4.5)
+    http_parser.rb (0.6.0.beta.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    log4r (1.1.10)
+    minitest (5.2.0)
+    minitest-reporters (1.0.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      powerbar
+    msgpack (0.5.8)
+    multi_json (1.10.0)
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+    rack (1.5.2)
+    rack-accept-media-types (0.9)
+    rack-contrib (1.1.0)
+      rack (>= 0.9.1)
+    rack-respond_to (0.9.8)
+      rack-accept-media-types (>= 0.6)
+    rake (10.1.1)
+    redis (3.0.7)
+    rubysl-base64 (2.0.0)
+    rubysl-mutex_m (2.0.0)
+    rubysl-prettyprint (2.0.2)
+    rubysl-securerandom (2.0.0)
+    rubysl-singleton (2.0.0)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  em-http-request
+  minitest (>= 5.2.0)
+  minitest-reporters
+  rake
+  rubysl-base64
+  rubysl-mutex_m
+  rubysl-prettyprint
+  rubysl-securerandom
+  rubysl-singleton
+  sinapse!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Julien Portalier
+
+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,173 @@
+# Sinapse
+
+EventSource service for pushing messages written in Ruby.
+
+Pushing messages to the browser or any other kind or client should be as easy as
+posting from a browser. The technology is there with the PUB/SUB solution
+offered by Redis and the simple server push protocol allowed by EventSource
+(Server-Sent Events) over regular HTTP.
+
+Sinapse is a push service running in an event-loop (thanks to Goliath and
+EventMachine) and takes care of pushing all your events, and to deliver them to
+whoever is allowed to receive them.
+
+
+## How it works
+
+A user connects to the Sinapse server using a token. That token will be
+associated to a list of channels that the user is authorized to listen to. That
+list of channels can be updated at any time and will be applied live to existing
+connection, so users will only ever receive what they are allowed to receive.
+
+This is different from [Faye](http://faye.jcoglan.com) for example, which is
+a PUB/SUB solution to have clients subscribe and publish to whatever channels
+they want. Sinapse is a push service to notify clients about changes that
+happened on the backend, and the list of authorized channels is thus kept on
+the server.
+
+
+## Features
+
+Sinapse is still a work in progress, and the API subject to changes, but it
+already features:
+
+- A solid architecture (Goliath + EventMachine + Redis).
+- EventSource (Server-Sent Events) server with support for CORS requests,
+  authentication and a live updating list of channels.
+- Keep EventSource connection alive by sending comments are regular intervals.
+- Ruby library to manipulate user channels, authentication and to publish
+  messages.
+
+TODO:
+
+- Support [Yaffle EventSource polyfill](https://github.com/Yaffle/EventSource)
+  (for Internet Explorer support)
+- Support for Web Sockets alongside EventSource (for native IE10+ support)
+- Retain messages with some expiry to avoid missing messages because of
+  network connection problems.
+
+
+## Requirements
+
+Sinapse is compatible and actively tested with Ruby 1.9.3+ and Rubinius 2.2+. It
+requires a Redis 2.2+ server instance. Sinapse should be compatible with Ubuntu
+12.04 LTS out of the box. It may be compatible with older versions of Ruby,
+Rubinius or Redis but this isn't supported.
+
+Sinapse comes with a Ruby library, but it can be used from other languages,
+because all the communication to the Sinapse server happens through Redis. The
+protocol hasn't been formalized yet and you will have to check the ruby
+implementation and test suite to understand it.
+
+
+## Usage
+
+Declare sinapse in your Gemfile and run `bundle`:
+
+```ruby
+gem "sinapse", github: "ysbaddaden/sinapse"
+```
+
+You may now start the server with `bundle exec sinapse` or generate a binstub
+with `bundle binstubs sinapse` then start the server with `bin/sinapse`.
+
+Once started the server will be available on http://0.0.0.0:9000/ by default.
+It can be configured to run on a UNIX socket or a specific host and port. Run
+`sinapse --help` or read the Goliath documentation for more information.
+
+### Configuration
+
+The Sinapse server may be configured using environment variables:
+
+  - `SINAPSE_CORS_ORIGIN` — restrict origins for CORS browser requests (defaults to `*`).
+  - `SINAPSE_KEEP_ALIVE` — send a comment every n seconds to keep the connection alive (defaults to `15`).
+  - `SINAPSE_RETRY` — EventSource retry parameter (defaults to `5`).
+  - `SINAPSE_CHANNEL_EVENT` — set the channel name as the event type to sent messages.
+
+Sinapse (both the client and the server) will connect to the Redis instance
+defined in the `REDIS_URL` environment variable and fallback to the default
+`redis://localhost:6379/0`.
+
+### Authenticate
+
+Include `Sinapse` into the subjects that will authenticate to the Sinapse
+server. The example below uses ActiveRecord but Sinapse should work with any
+Ruby class, as long as it responds to `#to_param`.
+
+```ruby
+class User < ActiveRecord::Base
+  include Sinapse
+end
+```
+
+Once your subjects are defined, you must generate tokens for the subjects, then
+declare a list of channels they are authorized to access. You are responsible
+for generating and replacing the token when your application requires it. For
+example you may create the token when creating the user:
+
+```ruby
+class User < ActiveRecord::Base
+  include Sinapse
+end
+
+# create the token and initialize channels
+user = User.create(attributes)
+token = user.sinapse.auth.generate
+
+# destroy the token and the user channels
+sinapse.auth.clear
+```
+
+You may now connect to `http://localhost:9000/?access_token=<token>` but it
+will return a `401 Unauthorized` because the connected subject doesn't have any
+channel to listen to.
+
+A 401 Unauthorized HTTP status will be returned whenever an `access_token` is
+invalid or the list of channels is empty. The connection may also be closed
+immediately whenever the list of channels gets emptied.
+
+### Channels
+
+You may now add and remove the channels that a user may be notified of at any
+time. Usually a channel will be a class instance. Include `Sinapse::Publishable`
+into the classes that may publish events, add them to the authorized channels of
+a user, then publish your messages through the class:
+
+```ruby
+class Room < ActiveRecord::Base
+  include Sinapse::Publishable
+end
+
+# add the channel to a user's channel list
+room = Room.find(params[:id])
+user.sinapse.add_channel(room)
+
+# publish a message (the user will receive it)
+room.publish(room.to_json)
+
+# remove the channel
+user.sinapse.remove_channel(room)
+
+# publish another message (the user won't receive it)
+room.publish(room.to_json)
+```
+
+
+## Example
+
+Please see the [example](https://github.com/ysbaddaden/sinapse/tree/master/example)
+for up to date working code. To try it start the Sinapse server with `bin/sinapse`
+then the example rack application. Open http://localhost:3000 in different
+browsers, and start a chat!
+
+
+## Author
+
+- Julien Portalier
+
+
+## License
+
+Distributed under the MIT License.
+See [LICENSE](LICENSE.m://github.com/ysbaddaden/sinapse/blob/master/LICENSE).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/sinapse

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+$:.unshift File.expand_path("../../lib", File.realpath(__FILE__))
+
+RACK_ENV ||= ENV['RACK_ENV'] ||= 'development'
+
+require 'bundler/setup'
+Bundler.require(:default, RACK_ENV)
+
+require 'sinapse/server'
+

data/certs/ysbaddaden.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZqdWxp
+ZW4xGTAXBgoJkiaJk/IsZAEZFglwb3J0YWxpZXIxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMTQwMTE0MjIzMTQ4WhcNMTUwMTE0MjIzMTQ4WjBBMQ8wDQYDVQQDDAZq
+dWxpZW4xGTAXBgoJkiaJk/IsZAEZFglwb3J0YWxpZXIxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDpxWuWRJXEz2+p
+2EW4NOPzkKloRLWoj+WQnqhQKT46GbH3ToDId8AMELTDIKpTQFiG2ty6D7S4IBFv
+7ceFKNk/EJc17mSYE1DzrtItor2/eeGC1zeNfvLjyDtyHKyKUZ891C1D0so5coUx
+2YbDW5npFkJkPaA5GneH7DFaCoIFLrD7ekbzaZAjlH+EH2fhd1XLhSsPEIiE+OnD
+ilWnsPoRJAZwQOiVAtvh7xuc+29uSNndIIm2rU00SxbJnzsAq9ZddwPpMU/UcQpD
+4gCBCaNGzrLz4+upQdYEOuggM7rR3P934qfhIwb+aRGglqdNunmUrdCuhsGXrxq2
+FvqwDvFZAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBQoESDCnNz3LmbpUzOrGeXOpk9sqjAfBgNVHREEGDAWgRRqdWxpZW5AcG9ydGFs
+aWVyLmNvbTAfBgNVHRIEGDAWgRRqdWxpZW5AcG9ydGFsaWVyLmNvbTANBgkqhkiG
+9w0BAQUFAAOCAQEAML4w0F/VF0gi5JqMqYSO05TakAauG8jQX0hov5H8M0Xhl79G
+BdUllH0QEw0cP6J2g46zAk0FGHIGthx0OKKi5YMYTs/KPqOVIAcJslt2sGIC1Ukm
+wpOWIg1XMe68+JVTktBKcBFAvc0pLtty1TgdSd2wr7KQgfmBU9I8G6AoPYhJOhkG
+SHTTSX3ms2/XePuSnyOfir/AQC7U0NalnKLNdwY9gkEdNwiTf5Ga/lZVDQ607bow
+KVqCN//9bevjMk5OiMi9X3Wu/GtVWDwC6OTWFWKd54KgbuWlakO8LC1SMmStnCIF
+W4qpyMWMZMcB4ZN/0mUVzY5xwrislBtsmQVUSw==
+-----END CERTIFICATE-----

data/config/rainbows.rb

@@ -0,0 +1,3 @@
+Rainbows! do
+  use :EventMachine
+end

data/ext/mkrf_conf.rb

@@ -0,0 +1,22 @@
+# http://en.wikibooks.org/wiki/Ruby_Programming/RubyGems#How_to_install_different_versions_of_gems_depending_on_which_version_of_ruby_the_installee_is_using
+require 'rubygems'
+require 'rubygems/command.rb'
+require 'rubygems/dependency_installer.rb'
+
+begin
+  Gem::Command.build_args = ARGV
+rescue NoMethodError
+end
+
+inst = Gem::DependencyInstaller.new
+
+begin
+  if RUBY_ENGINE == "rbx"
+    inst.install "rubysl-securerandom"
+    #inst.install "rubysl-base64"
+  end
+rescue
+  exit 1
+end
+
+exit 0

data/lib/sinapse.rb

@@ -0,0 +1,42 @@
+require 'sinapse/version'
+require 'sinapse/authentication'
+require 'sinapse/channels'
+require 'sinapse/publishable'
+require 'connection_pool'
+require 'redis'
+require 'hiredis'
+
+module Sinapse
+  def sinapse
+    @sinapse ||= Sinapse::Channels.new(self)
+  end
+
+  class << self
+    def redis(&block)
+      raise ArgumentError, "requires a block" unless block
+      @redis ||= ConnectionPool.new(pool_options) { Redis.new(url: config[:url]) }
+      @redis.with(&block)
+    end
+
+    def redis=(redis)
+      raise ArgumentError, "requires a ConnectionPool" unless redis.kind_of?(ConnectionPool)
+      @redis = redis
+    end
+
+    def config
+      @config ||= {
+        size: 5,
+        timeout: 5,
+        url: ENV['REDIS_URL'] || 'redis://localhost:6379/0'
+      }
+    end
+
+    def config=(options)
+      @config = config.merge(options.symbolize_keys)
+    end
+
+    def pool_options
+      @pool_options ||= { size: config[:size], timeout: config[:timeout] }
+    end
+  end
+end