faye-authentication 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 184e59a30a70d8300c56d55355689fc266f4c1d8
-  data.tar.gz: e27e148c68384f0f1f8d74cec6e7bbd92769dd51
+  metadata.gz: 5c557cbf72df6369ab2dcc5ad4ca635cc06220ad
+  data.tar.gz: ce322da963e471760990647799e6ac430a56bd4e
 SHA512:
-  metadata.gz: 62c1b8a62630230868e2f748219970745e72a868dcafdc3de4112c82f25a25e4ee0f7de829caa7b7e85fdf017040287b13d7ce6b47495a9475f3aa6f772a0c81
-  data.tar.gz: 8dd4d44413f43949c21512b3932f3f06659ee1ff5193eed99c5ef75cba04218b68dfafcb33042b9af251d1169bf984538d6e29e4b2b4e255e3d4c735e37060f3
+  metadata.gz: 15b99a92f41c1ff17cafd508ff2ebd55710ea52b20b828f00adcce50cefe9822e302d0fb41e7e40bb005bb7ba122ccdad9c640434701a0f988eb9b809e33a1c1
+  data.tar.gz: e470c75679e72fa27515ace5f16bf844e36fba64f4d7ed89ee5466d2a7e6c88f083c58d9c478aa16cd1a836f09e7da8b7aa6ba273b0d1d749501363f3d8e6274

data/.rspec

@@ -1,3 +1,2 @@
 --color
---warnings
 --require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## 0.3.0
+- Rename ``Faye::Authentication::Extension`` to ``Faye::Authentication::ServerExtension``
+- Add extension for faye Ruby Client : ``Faye::Authentication::ClientExtension``
+
 ## 0.2.0
 
   - Use JWT instead of HMAC for signing the messages
   - Allow expiration of the signature
-  - The client javascript extension now takes the faye client as its frst parameter
+  - The client javascript extension now takes the faye client as its first parameter

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in faye-authentication.gemspec
+group :development do
+  gem 'rspec-eventmachine', '~> 0.1', github: 'jcoglan/rspec-eventmachine'
+end
 gemspec

data/README.md

@@ -18,6 +18,7 @@ is incorrect or not present.
 Currently Implemented :
   - Javascript Client Extention (JQuery needed)
   - Ruby Faye Server Extension
+  - Ruby Faye Client Extension
   - Ruby utils to signing messages in your webapp
   - **Want another one ? Pull requests are welcome.**
 
@@ -92,22 +93,31 @@ If you wish to change the endpoint, you can supply it as the second argument of
 
     client.addExtension(new FayeAuthentication(client, '/my_custom_auth_endpoint'));
 
-### Faye server extension
+### Ruby Faye server extension
 
 Instanciate the extension with your secret key and add it to the server :
 
 ````ruby
 server = Faye::RackAdapter.new(:mount => '/faye', :timeout => 15)
-server.add_extension Faye::Authentication::Extension.new('your shared secret key')
+server.add_extension Faye::Authentication::ServerExtension.new('your shared secret key')
 ````
 
-Faye::Authentication::Extension expect that :
+Faye::Authentication::ServerExtension expect that :
 - a ``signature`` is present in the message for publish/subscribe request
 - this signature is a valid JWT token
 - the JWT payload contains "channel", "clientId" and a expiration timestamp "exp" that is not in the past.
 
 Otherwise Faye Server will refuse the message.
 
+### Ruby Faye client extension
+
+This extension allows the ruby ``Faye::Client`` to auto-sign its messages before sending them to the server.
+
+````ruby
+client = Faye::Client.new('http://localhost:9292/faye')
+client.add_extension Faye::Authentication::ClientExtension.new('your shared secret key')
+````
+
 ## Contributing
 
 1. Fork it ( https://github.com/dimelo/faye-authentication/fork )

data/lib/faye/authentication.rb

@@ -1,6 +1,7 @@
 require 'jwt'
 require 'faye/authentication/version'
-require 'faye/authentication/extension'
+require 'faye/authentication/server_extension'
+require 'faye/authentication/client_extension'
 require 'faye/authentication/http_client'
 require 'faye/authentication/engine'
 
@@ -10,7 +11,7 @@ module Faye
     class ExpiredError < AuthError; end
     class PayloadError < AuthError; end
 
-    # Return jwt signature, pass hash of payload including channel and client_id 
+    # Return jwt signature, pass hash of payload including channel and client_id
     def self.sign(payload, secret, options = {})
       options = {expires_at: Time.now + 12*3600, algorithm: 'HS256'}.merge(options)
       JWT.encode(payload.merge(exp: options[:expires_at].to_i), secret, options[:algorithm])

data/lib/faye/authentication/client_extension.rb

@@ -0,0 +1,19 @@
+module Faye
+  module Authentication
+    class ClientExtension
+
+      def initialize(secret, options = {})
+        @secret = secret
+        @options = options
+      end
+
+      def outgoing(message, callback)
+        if message['channel'] == '/meta/subscribe' || !(message['channel'] =~ /^\/meta\/.*/)
+          message['signature'] = Faye::Authentication.sign({channel: message['subscription'] || message['channel'], clientId: message['clientId']}, @secret, @options)
+        end
+        callback.call(message)
+      end
+
+    end
+  end
+end

data/lib/faye/authentication/{extension.rb → server_extension.rb}

@@ -2,7 +2,7 @@ require 'faye'
 
 module Faye
   module Authentication
-    class Extension
+    class ServerExtension
       include Faye::Logging
 
       def initialize(secret)
@@ -12,8 +12,8 @@ module Faye
       def incoming(message, callback)
         if message['channel'] == '/meta/subscribe' || !(message['channel'] =~ /^\/meta\/.*/)
           begin
-            Faye::Authentication.validate(message['signature'], 
-                                          message['subscription'] || message['channel'], 
+            Faye::Authentication.validate(message['signature'],
+                                          message['subscription'] || message['channel'],
                                           message['clientId'],
                                           @secret)
             debug("Authentication sucessful")

data/lib/faye/authentication/version.rb

@@ -1,5 +1,5 @@
 module Faye
   module Authentication
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/javascripts/support/jasmine_helper.rb

@@ -21,7 +21,7 @@ fork do
     faye = Faye::RackAdapter.new(:mount => '/faye')
     #require 'logger'
     #Faye.logger = Logger.new(STDOUT)
-    faye.add_extension Faye::Authentication::Extension.new(FAYE_SECRET_KEY)
+    faye.add_extension Faye::Authentication::ServerExtension.new(FAYE_SECRET_KEY)
    Rack::Handler::Thin.run faye, :Port => 9296
 end.tap do |id|
   parent = $$

data/spec/lib/faye/authentication/client_extension_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'rspec/em'
+require 'faye/authentication'
+
+ClientSteps = RSpec::EM.async_steps do
+  def client(name, channels, enable_extension = false, &callback)
+    @clients ||= {}
+    @inboxes ||= {}
+    @errors ||= {}
+    @clients[name] = Faye::Client.new('http://127.0.0.1:9876/faye')
+    @clients[name].add_extension(Faye::Authentication::ClientExtension.new('macaroni')) if enable_extension
+    @inboxes[name] = {}
+    @errors[name] ||= []
+
+    n = channels.size
+    return @clients[name].connect(&callback) if n.zero?
+
+    channels.each do |channel|
+      subscription = @clients[name].subscribe(channel) do |message|
+        @inboxes[name][channel] ||= []
+        @inboxes[name][channel] << message
+      end
+      subscription.errback do |e|
+        n -= 1
+        @errors[name] << e.message
+        callback.call if n.zero?
+      end
+      subscription.callback do
+        n -= 1
+        callback.call if n.zero?
+      end
+    end
+  end
+
+  def publish(name, channel, message, &callback)
+    @clients[name].publish(channel, message)
+    EM.add_timer(0.1, &callback)
+  end
+
+  def check_inbox(name, channel, messages, &callback)
+    inbox = @inboxes[name][channel] || []
+    expect(inbox).to eq(messages)
+    callback.call
+  end
+
+  def check_errors(name, errors, &callback)
+    expect(@errors[name]).to eq(errors)
+    callback.call
+  end
+
+  def launch_server(&callback)
+      Faye::WebSocket.load_adapter('thin')
+      app = Faye::RackAdapter.new(:mount => '/faye', :timeout => 25)
+      app.add_extension(Faye::Authentication::ServerExtension.new('macaroni'))
+      Thin::Logging.silent = true
+      Thin::Server.start('127.0.0.1', 9876, app)
+      callback.call
+  end
+end
+
+describe Faye::Authentication::ClientExtension do
+
+  include ClientSteps
+
+  before(:each) { launch_server }
+
+  context 'without extension' do
+
+    before(:each) do
+      client 'foo', ['/foo']
+    end
+
+    it 'fails to deliver the message' do
+      check_inbox 'foo', '/foo', []
+      check_errors 'foo', ['Invalid signature']
+    end
+
+  end
+
+  context 'with extension' do
+
+    before(:each) do
+      client 'foo', ['/foo'], true
+      client 'bar', ['/foo'], true
+    end
+
+    it 'succeeds to deliver the message' do
+      publish 'foo', '/foo', 'Hello'
+      check_inbox 'foo', '/foo', ['Hello']
+      check_errors 'foo', []
+    end
+
+  end
+
+end

data/spec/lib/faye/authentication/{extension_spec.rb → server_extension_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
-require 'faye/authentication/extension'
+require 'faye/authentication/server_extension'
 
-describe Faye::Authentication::Extension do
+describe Faye::Authentication::ServerExtension do
 
   let(:secret) { 'macaroni' }
-  let(:extension) { Faye::Authentication::Extension.new(secret) }
+  let(:extension) { Faye::Authentication::ServerExtension.new(secret) }
 
   it 'does not add an eror if the message is correctly signed' do
     message = {'channel' => '/foo/bar', 'clientId' => '42', 'text' => 'whatever'}

data/spec/spec_helper.rb

@@ -18,6 +18,7 @@
 require 'webmock/rspec'
 
 RSpec.configure do |config|
+  WebMock.disable_net_connect!(:allow_localhost => true)
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faye-authentication
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adrien Siami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -154,17 +154,19 @@ files:
 - app/assets/javascripts/faye-authentication.js
 - faye-authentication.gemspec
 - lib/faye/authentication.rb
+- lib/faye/authentication/client_extension.rb
 - lib/faye/authentication/engine.rb
-- lib/faye/authentication/extension.rb
 - lib/faye/authentication/http_client.rb
+- lib/faye/authentication/server_extension.rb
 - lib/faye/authentication/version.rb
 - spec/javascripts/faye-authentication_spec.js
 - spec/javascripts/faye-extension_spec.js
 - spec/javascripts/helpers/.gitkeep
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_helper.rb
-- spec/lib/faye/authentication/extension_spec.rb
+- spec/lib/faye/authentication/client_extension_spec.rb
 - spec/lib/faye/authentication/http_client_spec.rb
+- spec/lib/faye/authentication/server_extension_spec.rb
 - spec/lib/faye/authentication_spec.rb
 - spec/spec_helper.rb
 - spec/utils/javascripts/core.js
@@ -204,8 +206,9 @@ test_files:
 - spec/javascripts/helpers/.gitkeep
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_helper.rb
-- spec/lib/faye/authentication/extension_spec.rb
+- spec/lib/faye/authentication/client_extension_spec.rb
 - spec/lib/faye/authentication/http_client_spec.rb
+- spec/lib/faye/authentication/server_extension_spec.rb
 - spec/lib/faye/authentication_spec.rb
 - spec/spec_helper.rb
 - spec/utils/javascripts/core.js