slanger 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,91 @@
+# Slanger
+
+Slanger is an open source server implementation of the Pusher protocol written in Ruby. It is designed to scale horizontally across N nodes and to be agnostic as to which Slanger node a subscriber is connected to, i.e subscribers to the same channel are NOT required to be connected to the same Slanger node. Multiple Slanger nodes can sit behind a load balancer with no special configuration. In essence it was designed to be very easy to scale.
+
+Presence channel state is shared using Redis. Channels are lazily instantiated internally within a given Slanger node when the first subscriber connects. When a presence channel is instantiated within a Slanger node, it queries Redis for the global state across all nodes within the system for that channel, and then copies that state internally. Afterwards, when subscribers connect or disconnect the node publishes a presence message to all interested nodes, i.e. all nodes with at least one subscriber interested in the given channel.
+
+Slanger is smart enough to know if a new channel subscription belongs to the same user. It will not send presence messages to subscribers in this case. This happens when the user has multiple browser tabs open for example. Using a chat room backed by presence channels as a real example, one would not want "Micheil" to show up N times in the presence roster because Micheil is a retard and has the chat room open in N browser tabs.
+
+Slanger was designed to be highly available and partition tolerant with eventual consistency, which in practise is instantaneous.
+
+# How to use it
+
+## Requirements
+
+- Ruby 1.9
+- Redis
+
+## Starting the service
+
+Slanger is packaged as a Rubygem. Installing the gem makes the 'slanger' executable available. The `slanger` executable takes arguments, of which two are mandatory: `--app_key` and `--secret`. These can but do not have to be the same as the credentials you use for Pusher. They are required because Slanger performs the same HMAC signing of API requests that Pusher does.
+
+__IMPORTANT:__ Redis must be running where Slanger expects it to be (either on localhost:6379 or somewhere else you told Slanger it would be using the option flag) or Slanger will fail silently. I haven't yet figured out how to get em-hiredis to treat an unreachable host as an error
+
+<pre>
+$ gem install slanger
+
+$ redis-server 1>2 &
+
+$ slanger --app_key 765ec374ae0a69f4ce44 --secret your-pusher-secret
+</pre>
+
+If all went to plan you should see the following output to STDOUT
+
+<pre>
+
+    .d8888b.  888
+   d88P  Y88b 888
+   Y88b.      888
+    "Y888b.   888  8888b.  88888b.   .d88b.   .d88b.  888d888
+       "Y88b. 888     "88b 888 "88b d88P"88b d8P  Y8b 888P"
+         "888 888 .d888888 888  888 888  888 88888888 888
+   Y88b  d88P 888 888  888 888  888 Y88b 888 Y8b.     888
+    "Y8888P"  888 "Y888888 888  888  "Y88888  "Y8888  888
+                                         888
+                                    Y8b d88P
+                                    "Y88P"
+
+
+Slanger API server listening on port 4567
+Slanger WebSocket server listening on port 8080
+
+</pre>
+
+## Modifying your application code to use the Slanger service
+
+Once you have a Slanger instance listening for incoming connections you need to alter you application code to use the Slanger endpoint instead of Pusher. Fortunately this is very simple, unobtrusive, easily reversable, and very painless.
+
+
+First you will need to add code to your server side component that publishes events to the Pusher HTTP REST API, usually this means telling the Pusher client to use a different host and port, e.g. consider this Ruby example
+
+<pre>
+...
+
+Pusher.host   = 'slanger.example.com'
+Pusher.port   = 4567
+
+</pre>
+
+You will also need to do the same to the Pusher JavaScript client in your client side JavaScript, e.g
+
+<pre>
+
+<script type="text/javascript">
+  ...
+
+  Pusher.host    = 'slanger.example.com'
+  Pusher.ws_port = 8080
+
+</script>
+</pre>
+
+Of course you could proxy all requests to `ws.example.com` to port 8080 of your Slanger node and `api.example.com` to port 4567 of your Slanger node for example, that way you would only need to set the host property of the Pusher client.
+
+# Why use Slanger instead of Pusher?
+
+There are many reasons you might want to use Slanger instead of Pusher, e.g.
+
+- You operate in a heavily regulated industry and are worried about sending data to 3rd parties, and it is an organisational requirement that you own your own infrastructure.
+- You might be travelling on an airplane without internet connctivity as I am right now. Airplane rides are very good times to get a lot done, unfortunately external services are also usually unreachable. Remove internet connectivity as a dependendancy of your development envirionment by running a local Slanger instance in development and Pusher in production.
+- You want to extend the Pusher protocol or have some special requirement. If this applies to you, chances are you are out of luck as Pusher is unlikely to implement something to suit your special use case, and rightly so. With Slanger you are free to modify and extend its behavior anyway that suits your purpose.
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slanger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2011-12-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70311444305760 !ruby/object:Gem::Requirement
+  requirement: &70279989838940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.12.10
   type: :runtime
   prerelease: false
-  version_requirements: *70311444305760
+  version_requirements: *70279989838940
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &70311444305300 !ruby/object:Gem::Requirement
+  requirement: &70279989865080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +32,21 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70311444305300
+  version_requirements: *70279989865080
 - !ruby/object:Gem::Dependency
   name: em-websocket
-  requirement: &70311444304840 !ruby/object:Gem::Requirement
+  requirement: &70279989864620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *70311444304840
+  version_requirements: *70279989864620
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70311444304380 !ruby/object:Gem::Requirement
+  requirement: &70279989864160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *70311444304380
+  version_requirements: *70279989864160
 - !ruby/object:Gem::Dependency
   name: rack-fiber_pool
-  requirement: &70311444303920 !ruby/object:Gem::Requirement
+  requirement: &70279989863700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *70311444303920
+  version_requirements: *70279989863700
 - !ruby/object:Gem::Dependency
   name: signature
-  requirement: &70311444303460 !ruby/object:Gem::Requirement
+  requirement: &70279989863240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70311444303460
+  version_requirements: *70279989863240
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70311444303000 !ruby/object:Gem::Requirement
+  requirement: &70279989862780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70311444303000
+  version_requirements: *70279989862780
 - !ruby/object:Gem::Dependency
   name: glamazon
-  requirement: &70311444302540 !ruby/object:Gem::Requirement
+  requirement: &70279989862320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *70311444302540
+  version_requirements: *70279989862320
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70311444328700 !ruby/object:Gem::Requirement
+  requirement: &70279989861860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70311444328700
+  version_requirements: *70279989861860
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70311444328240 !ruby/object:Gem::Requirement
+  requirement: &70279989861400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.2.11
   type: :runtime
   prerelease: false
-  version_requirements: *70311444328240
+  version_requirements: *70279989861400
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70311444327780 !ruby/object:Gem::Requirement
+  requirement: &70279989860940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70311444327780
+  version_requirements: *70279989860940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70311444327320 !ruby/object:Gem::Requirement
+  requirement: &70279989860480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,10 +142,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70311444327320
+  version_requirements: *70279989860480
 - !ruby/object:Gem::Dependency
   name: pusher
-  requirement: &70311444326860 !ruby/object:Gem::Requirement
+  requirement: &70279989860020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -153,10 +153,10 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *70311444326860
+  version_requirements: *70279989860020
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70311444326400 !ruby/object:Gem::Requirement
+  requirement: &70279989859560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -164,7 +164,7 @@ dependencies:
         version: 3.1.2
   type: :development
   prerelease: false
-  version_requirements: *70311444326400
+  version_requirements: *70279989859560
 description: A websocket service compatible with Pusher libraries
 email: sjtgraham@mac.com
 executables:
@@ -172,6 +172,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/slanger/api_server.rb
 - lib/slanger/channel.rb
 - lib/slanger/config.rb