jugglite 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edc6fd8a925f529423f772ed4493aec51792f0bb
-  data.tar.gz: 45a96b192198b88cdb63d870864438190e671e5b
+  metadata.gz: 1b81b7cc5bc16c5f0fe6377c9f26217631a8bf0a
+  data.tar.gz: 38d82a7c27038f3f9fa2dbac6fa424ae594989fe
 SHA512:
-  metadata.gz: 19a58f0d57d06b71e5bcc17d559697deff5d74cecac1955888725f1f0ce0c1a7cdee697f50713c33f06f3660a0eeb2e041d5f2216440c372ef438b2e86e6693b
-  data.tar.gz: 468cb7af0fcd57f9dcbb00021439773ed9ce595d0c905e0b015e231cff5ca9a103ec942483151d94f01a77068ac49569427f7885f75b125cbb8b5c548978ebd1
+  metadata.gz: 50dbbe1c5535754c7887ec7fbfb2cd7ed63099c9875b46f03b303ea24c82fd008a760b0bc1c2f63e6c1428b1acacf816463af8ad2f2c5228fd67918bf55df88f
+  data.tar.gz: 0b8c90aac69b801d2cfc3eef9d6fde260bf73c6db28c75fb36efeb984dce54c8c85820859b3e919c3cc5e57c65ebae25f0a2b84ee84d3817dfd0da1253cd7bd8

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 0.5.0 / 2014-05-03
+
+ * New option: +allowed_channels+ to limit/authorize which channels a request can listen to
+
 = 0.4.0 / 2014-03-12
 
  * Support for listening to multiple channels

data/lib/jugglite/app.rb

@@ -11,8 +11,12 @@ module Jugglite
     }
 
     # Options include:
-    # +path+ : the URI path to listen to ('/stream')
-    # +keepalive_timeout+ : the timeout in seconds between keepalive comments
+    # +path+ : the URI path to listen to (defaults to '/stream')
+    # +keepalive_timeout+ : the timeout in seconds between keepalive comments (defaults to 20)
+    # +namespace+ : a namespace used as prefix for redis pubsub channels
+    # +allowed_channels+ :
+    #  * an array with allowed channel names
+    #  * a proc that takes a Rack::Request and returns an array of allowed channels for that particular request
     def initialize(app = nil, options = {})
       @app = app
       @options = {
@@ -51,7 +55,7 @@ module Jugglite
       connection.callback { unregister_connection(connection) }
       connection.errback { unregister_connection(connection) }
 
-      # Needed for crappy Rack::Lint
+      # Needed for Rack::Lint
       throw :async
 
       # Returning a status of -1 keeps the connection open
@@ -77,12 +81,21 @@ module Jugglite
     end
 
     def channels_for_request(request)
-      # TODO: Sanitize? Check signature?
       channels = Array(request.params["channel"].split(","))
+      # Sanitize channels
+      channels = channels & allowed_channels(request) if @options[:allowed_channels]
       channels.map! { |channel| @options[:namespace] + channel }
       Set.new(channels)
     end
 
+    def allowed_channels(request)
+      case @options[:allowed_channels]
+      when Proc then @options[:allowed_channels].call(request)
+      when Array then @options[:allowed_channels]
+      else raise(ArgumentError, ":allowed_channels should be nil, Array or a Proc")
+      end
+    end
+
     def register_connection(connection)
       requested_channels = channels_for_request(connection.request)
       subscribe_to_new_channels(requested_channels - @redis_channels)

data/lib/jugglite/version.rb

@@ -1,3 +1,3 @@
 module Jugglite
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/acceptance/allowed_channels_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'net/http'
+
+def start_server(jugglite)
+  @app = nil
+  @thread = Thread.new do
+    @app = Thin::Server.new(@host, @port, jugglite)
+    @app.start
+  end
+  sleep(0.01) until @app && @app.running?
+end
+
+def stop_server
+  @app.stop!
+  @thread.join
+end
+
+describe "allowed_channels" do
+  before(:each) do
+    @host = '127.0.0.1'
+    @port = rand(10000)+10000
+    @channel1 = "randomized:test:#{rand(2**32)}"
+    @channel2 = "randomized:test:#{rand(2**32)}"
+  end
+
+  after(:each) do
+    stop_server
+  end
+
+  describe "as an array" do
+    before(:each) do
+      @jugglite = Jugglite::App.new(nil, allowed_channels: [@channel1])
+      start_server(@jugglite)
+    end
+
+    it "should only registers to channel 1" do
+      Net::HTTP.start(@host, @port) do |http|
+        request = Net::HTTP::Get.new("/?channel=#{@channel1},#{@channel2}")
+
+        body = ""
+        http.request(request) do |response|
+          response.read_body do |chunk|
+            body << chunk
+            body.should include(": registered to channels: #{@channel1}")
+            body.should_not include(@channel2)
+            http.finish
+            break
+          end
+          break
+        end
+      end
+    end
+  end
+
+  describe "as a Proc" do
+    before(:each) do
+      @jugglite = Jugglite::App.new(nil, allowed_channels: ->(request) { [@channel2] })
+      start_server(@jugglite)
+    end
+
+    it "should only registers to channel 2" do
+      Net::HTTP.start(@host, @port) do |http|
+        request = Net::HTTP::Get.new("/?channel=#{@channel1},#{@channel2}")
+
+        body = ""
+        http.request(request) do |response|
+          response.read_body do |chunk|
+            body << chunk
+            body.should include(": registered to channels: #{@channel2}")
+            body.should_not include(@channel1)
+            http.finish
+            break
+          end
+          break
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jugglite
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - andruby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
@@ -89,6 +89,7 @@ files:
 - lib/jugglite/deferrable_body.rb
 - lib/jugglite/sse_connection.rb
 - lib/jugglite/version.rb
+- spec/acceptance/allowed_channels_spec.rb
 - spec/acceptance/stream_and_publish_spec.rb
 - spec/benchmark/max_connections.rb
 - spec/spec_helper.rb
@@ -111,12 +112,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Server Sent Events server written in rack on top of thin inspired by Juggernaut
   for real time push
 test_files:
+- spec/acceptance/allowed_channels_spec.rb
 - spec/acceptance/stream_and_publish_spec.rb
 - spec/benchmark/max_connections.rb
 - spec/spec_helper.rb