garufa 0.0.1.beta.0 → 0.0.1.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10052debad06b41d1ebb56145493aea97987d5e8
-  data.tar.gz: 9f6fbb6b447fd706042339f0b5c3d046b442a32d
+  metadata.gz: ed1fb1125ed40c4f3cc0a19dcae61dff59691948
+  data.tar.gz: 30e670e78a6ecdf3c678a8a32523bce7ad768ee9
 SHA512:
-  metadata.gz: de5feab7a14ac3ac6101398e681423f5657218da0e1e8e46777027a1e29b7578f659b4b068f892f744e30834d007c086251e7d0cdb3e92c56db1de5a6cc270b4
-  data.tar.gz: 7d05306034b82221c97e8f8d06e654c2e31f09981b953a1c0493e8a4afd02571989c580b9ad480c30754eed4e0101b923ce82abfe6a672d1cbc3a9aeee534992
+  metadata.gz: c92cfa90de87f3256e6b9e7888438d6ae2c014458ea4fd630a9f44e516861dece549eb9a47ee08c3b9384d7f1b962a7734bf8a26b3bb90dacb031b123790c567
+  data.tar.gz: f294190202d0cc16e2a7bd95e9d34d213ffaa003bcc473c67800e166ae6a9d409d91331ead19d5c02e77889e5f891250266520e2ece44291999897282f8db2ba

data/README.md

@@ -5,7 +5,7 @@ Garufa
 
 An open source server implementation of the [Pusher][pusher] protocol.
 
-**IMPORTANT:** Garufa is currently in alpha version, which means it is not
+**IMPORTANT:** Garufa is currently in beta version, which means it is not
 production ready, but you are free to use it and test it. Any feedback is
 welcome.
 

data/lib/garufa/connection.rb

@@ -84,7 +84,7 @@ module Garufa
 
       if subscription.success?
         @subscriptions[subscription.channel] = subscription
-        send_subscription_succeeded(subscription) unless subscription.public_channel?
+        send_subscription_succeeded(subscription)
       else
         error(subscription.error.code, subscription.error.message)
       end

data/lib/garufa/message.rb

@@ -32,11 +32,11 @@ module Garufa
     end
 
     def self.subscription_succeeded(channel)
-      new(event: 'pusher_internal:subscription_succeeded', channel: channel)
+      new(event: 'pusher_internal:subscription_succeeded', channel: channel, data: {})
     end
 
     def self.pong
-      new(event: 'pusher:pong')
+      new(event: 'pusher:pong', data: {})
     end
 
     def self.error(code, message)

data/lib/garufa/subscriptions.rb

@@ -52,10 +52,12 @@ module Garufa
 
     def subscribe
       case true
-      when invalid_channel?
-        set_error(nil, 'Invalid channnel or not present')
-      when invalid_signature?
+      when !valid_channel?
+        set_error(nil, 'Invalid channel')
+      when !public_channel? && !valid_signature?
         set_error(nil, 'Invalid signature')
+      when !public_channel? && !valid_app_key?
+        set_error(nil, 'Invalid key')
       when already_subscribed?
         set_error(nil, "Already subscribed to channel: #{channel}")
       else
@@ -97,17 +99,17 @@ module Garufa
 
     private
 
-    def invalid_channel?
-      !channel.is_a?(String) || channel.empty?
+    def valid_channel?
+      channel.is_a?(String) && !channel.empty?
     end
 
-    def invalid_signature?
-      return false if public_channel?
+    def valid_app_key?
+      app_key && app_key == Config[:app_key]
+    end
 
-      app_key, signature = @data["auth"].split(':')
+    def valid_signature?
       string_to_sign = [@connection.socket_id, channel].compact.join(':')
-
-      app_key != Config[:app_key] || token(string_to_sign) != signature
+      token(string_to_sign) == signature
     end
 
     def token(string_to_sign)
@@ -118,6 +120,14 @@ module Garufa
     def already_subscribed?
       Subscriptions.include? self
     end
+
+    def app_key
+      @data['auth'].split(':').first if @data['auth']
+    end
+
+    def signature
+      @data['auth'].split(':').last if @data['auth']
+    end
   end
 
   class SubscriptionError < Struct.new(:code, :message)

data/lib/garufa/version.rb

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

data/test/connection.rb

@@ -0,0 +1,75 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+require 'logger'
+
+module Garufa
+  describe Connection do
+
+    before do
+      @socket = MiniTest::Mock.new
+      @connection = Connection.new(@socket, Logger.new('/dev/null'))
+    end
+
+    describe '.handle_incomming_data' do
+
+      describe 'pusher:subscribe' do
+
+        let(:data) { { event: 'pusher:subscribe', data: { channel: 'ch1' } } }
+
+        it 'should add a new Subscription to Subscriptions' do
+          @socket.expect :send, true, [String]
+          @connection.handle_incomming_data data.to_json
+          Subscriptions.all['ch1'].first.class.must_equal Subscription
+          Subscriptions.all['ch1'].count.must_equal 1
+        end
+
+        describe 'public channels' do
+         it 'should response with subscription_succeeded' do
+            message = Message.subscription_succeeded(data[:data][:channel])
+            @socket.expect :send, true, [message.to_json]
+            @connection.handle_incomming_data data.to_json
+            @socket.verify
+          end
+        end
+
+        describe 'private channels' do
+
+          let(:channel) { 'private-ch1' }
+          let(:app_key) { Config[:app_key] }
+          let(:signature) { sign(@connection.socket_id, channel) }
+          let(:data) { { event: 'pusher:subscribe', data: { channel: channel, auth: "#{app_key}:#{signature}" } } }
+
+          it 'should response with subscription_succeeded' do
+            message = Message.subscription_succeeded(channel)
+            @socket.expect :send, true, [message.to_json]
+            @connection.handle_incomming_data data.to_json
+            @socket.verify
+          end
+
+          it 'should response with invalid channel' do
+            data[:data][:channel] = ''
+            message = Message.error(nil, 'Invalid channel')
+            @socket.expect :send, true, [message.to_json]
+            @connection.handle_incomming_data data.to_json
+            @socket.verify
+          end
+
+          it 'should response with invalid signature' do
+            data[:data][:auth] = "#{app_key}:invalid-signature"
+            message = Message.error(nil, 'Invalid signature')
+            @socket.expect :send, true, [message.to_json]
+            @connection.handle_incomming_data data.to_json
+            @socket.verify
+          end
+
+          it 'should response with invalid key' do
+            data[:data][:auth] = "invalid-app-key:#{signature}"
+            message = Message.error(nil, 'Invalid key')
+            @socket.expect :send, true, [message.to_json]
+            @connection.handle_incomming_data data.to_json
+            @socket.verify
+          end
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -2,3 +2,13 @@ $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 
 require "garufa"
 require 'minitest/autorun'
+require 'minitest/mock'
+
+Garufa::Config[:app_key] = '123123-123123'
+Garufa::Config[:secret] = '456456-456456'
+
+def sign(socket_id, custom_string = nil)
+  string_to_sign = [socket_id, custom_string].join(':')
+  digest = OpenSSL::Digest::SHA256.new
+  return OpenSSL::HMAC.hexdigest(digest, Garufa::Config[:secret], string_to_sign)
+end

data/test/message.rb

@@ -3,9 +3,11 @@ require File.expand_path("helper", File.dirname(__FILE__))
 module Garufa
   describe Message do
     describe '.connection_established' do
+
+      let(:socket_id) { '123123-123123' }
+
       before do
-        @socket_id = '123123-123123'
-        @message = Message.connection_established @socket_id
+        @message = Message.connection_established socket_id
       end
 
       it 'should response with data attribute as string' do
@@ -18,36 +20,40 @@ module Garufa
 
       it 'should response with expected data' do
         data = JSON.parse(@message.data)
-        data["socket_id"].must_equal @socket_id
+        data["socket_id"].must_equal socket_id
         data["activity_timeout"].must_equal 120
       end
     end
 
     describe '.channel_event' do
+
+     let(:channel) { 'channel-123' }
+     let(:event) { 'my-event' }
+     let(:data) { { itemId: 1, value: 'Sample Item' } }
+
      before do
-        @channel = 'channel-123'
-        @event = 'my-event'
-        @data = { itemId: 1, value: 'Sample Item' }
-        @message = Message.channel_event @channel, @event, @data
+        @message = Message.channel_event channel, event, data
       end
 
       it 'should response with expected event' do
-        @message.event.must_equal @event
+        @message.event.must_equal event
       end
 
       it 'should response with expected data' do
-        @message.data.must_equal @data
+        @message.data.must_equal data
       end
 
       it 'should response with expected channel' do
-        @message.channel.must_equal @channel
+        @message.channel.must_equal channel
       end
     end
 
     describe '.subscription_succeeded' do
+
+      let(:channel) { 'channel-123' }
+
       before do
-        @channel = 'channel-123'
-        @message = Message.subscription_succeeded @channel
+        @message = Message.subscription_succeeded channel
       end
 
       it 'should response with expected event' do
@@ -55,20 +61,36 @@ module Garufa
       end
 
       it 'should response with expected channel' do
-        @message.channel.must_equal @channel
+        @message.channel.must_equal channel
+      end
+
+      it 'should response with empty data' do
+        @message.data.must_equal({})
       end
     end
 
     describe '.pong' do
-      it 'should response with a pong event' do
-        Message.pong.event.must_equal 'pusher:pong'
+
+      before do
+        @message = Message.pong
+      end
+
+      it 'should response with expected event' do
+        @message.event.must_equal 'pusher:pong'
+      end
+
+      it 'should response with empty data' do
+        @message.data.must_equal({})
       end
     end
 
     describe '.error' do
+
+      let(:code) { 4000 }
+      let(:error_message) { 'There was an error!' }
+
       before do
-        @code, @error_message = 4000, 'There was an error!'
-        @message = Message.error @code, @error_message
+        @message = Message.error code, error_message
       end
 
       it 'should response with expected event' do
@@ -77,8 +99,8 @@ module Garufa
 
       it 'should response with expected data' do
         data = JSON.parse(@message.data)
-        data["code"].must_equal @code
-        data["message"].must_equal @error_message
+        data["code"].must_equal code
+        data["message"].must_equal error_message
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garufa
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.0
+  version: 0.0.1.beta.1
 platform: ruby
 authors:
 - Juan Manuel Cuello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -103,11 +103,11 @@ files:
 - lib/garufa/garufa_app.rb
 - lib/garufa/connection.rb
 - lib/garufa.rb
-- bin/garufa.pid
 - bin/garufa
 - garufa.gemspec
 - test/helper.rb
 - test/message.rb
+- test/connection.rb
 homepage: http://github.com/Juanmcuello/garufa
 licenses: []
 metadata: {}

data/bin/garufa.pid

@@ -1 +0,0 @@
-16262