socky-authenticator 0.5.0.beta4 → 0.5.0.beta5

data/README.md

@@ -36,4 +36,4 @@ Otherwise you will need to provide secret each time when authenticating data.
 
 Except of that you can enable or disable authenticaton of user rights - if disabled(default) then user will not be able to change their rights. Full version of authenticator call will look like that:
 
-    Socky::Authenticator.authenticate(<data>, allow_changing_rights, secret)
+    Socky::Authenticator.authenticate(<data>, :allow_changing_rights => true, :secret => 'mysecret')

data/lib/socky/authenticator.rb

@@ -4,36 +4,35 @@ require 'hmac-sha2'
 
 module Socky
   class Authenticator
-    VERSION = '0.5.0.beta4'
-    
     DEFAULT_RIGHTS = {
-      'read' => true,
-      'write' => false,
-      'hide' => false
+      :read => true,
+      :write => false,
+      :hide => false
     }
     
     class << self
       attr_accessor :secret
       
-      def authenticate(args = {}, allow_changing_rights = false, secret = nil)
-        self.new(args, allow_changing_rights, secret).result
+      def authenticate(params, opts = {})
+        self.new(params, opts).result
       end
     end
     
-    attr_accessor :secret, :salt
+    attr_accessor :secret, :salt, :method
     
-    def initialize(args = {}, allow_changing_rights = false, secret = nil)
-      @args = (args.is_a?(String) ? JSON.parse(args) : args) rescue nil
-      raise ArgumentError, 'Expected hash or JSON' unless @args.kind_of?(Hash)
-      @secret = secret || self.class.secret
-      @allow_changing_rights = allow_changing_rights
+    def initialize(params, opts = {})
+      @params = (params.is_a?(String) ? JSON.parse(params) : params) rescue nil
+      raise ArgumentError, 'Expected hash or JSON' unless @params.kind_of?(Hash)
+      @secret = opts[:secret] || opts['secret'] || self.class.secret
+      @method = opts[:method] || opts['method'] || :websocket
+      @allow_changing_rights = opts[:allow_changing_rights] || false
     end
     
     def result
       raise ArgumentError, 'set Authenticator.secret first' unless self.secret
       raise ArgumentError, 'expected connection_id' unless self.connection_id
-      raise ArgumentError, 'expected channel' unless self.channel_name
-      raise ArgumentError, 'user are not allowed to change channel rights' unless self.rights
+      raise ArgumentError, 'expected channel' unless self.channel
+      raise ArgumentError, 'expected event' unless self.method != :http || self.event
       
       r = { 'auth' => auth }
       r.merge!('data' => user_data) unless user_data.nil?
@@ -49,7 +48,8 @@ module Socky
     end
     
     def string_to_sign
-      args = [salt, connection_id, channel_name, rights]
+      args = [salt, connection_id, channel]
+      args << (@method == :websocket ? rights_string : event.to_s)
       args << user_data unless user_data.nil?
       args.collect(&:to_s).join(":")
     end
@@ -59,35 +59,58 @@ module Socky
     end
     
     def connection_id
-      @args['connection_id']
+      @params[:connection_id] || @params['connection_id']
     end
     
-    def channel_name
-      @args['channel']
+    def channel
+      @params[:channel] || @params['channel']
     end
     
+    def event
+      @params[:event] || @params['event']
+    end
+        
     def rights
-      return @rights if defined?(@rights)
-      r = DEFAULT_RIGHTS.merge(@args)
-      
-      # Return nil if user is trying to change rights when this option is disabled
-      return nil if !@allow_changing_rights && DEFAULT_RIGHTS.any?{ |right,val| r[right] != val }
-      
-      @rights = ['read', 'write', 'hide'].collect do |right|
-        r[right] && !(right == 'hide' && !self.presence?) ? '1' : '0'
-      end.join
+      {
+        :read => read_right,
+        :write => write_right,
+        :hide => hide_right
+      }
     end
     
     def user_data
-      @user_data ||= case @args['data']
+      @user_data ||= case (@params[:data] || @params['data'])
         when NilClass then nil
-        when String then @args['data']
-        else @args['data'].to_json
+        when String then @params['data']
+        else @params['data'].to_json
       end
     end
     
     def presence?
-      self.channel_name.is_a?(String) && !!self.channel_name.match(/\Apresence-/)
+      self.channel.is_a?(String) && !!self.channel.match(/\Apresence-/)
+    end
+    
+    private
+    
+    def read_right
+      return DEFAULT_RIGHTS[:read] unless @allow_changing_rights
+      [ @params[:read], @params['read'], DEFAULT_RIGHTS[:read] ].reject(&:nil?).first
+    end
+    
+    def write_right
+      return DEFAULT_RIGHTS[:write] unless @allow_changing_rights
+      [ @params[:write], @params['write'], DEFAULT_RIGHTS[:write] ].reject(&:nil?).first
+    end
+    
+    def hide_right
+      return DEFAULT_RIGHTS[:hide] unless self.presence? && @allow_changing_rights
+      [ @params[:hide], @params['hide'], DEFAULT_RIGHTS[:hide] ].reject(&:nil?).first
+    end
+    
+    def rights_string
+      [ rights[:read], rights[:write], rights[:hide] ].collect do |right|
+        right ? '1' : '0'
+      end.join
     end
     
   end

data/lib/socky/authenticator/version.rb

@@ -0,0 +1,5 @@
+module Socky
+  class Authenticator
+    VERSION = '0.5.0.beta5'
+  end
+end

data/socky-authenticator.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "socky/authenticator"
+require "socky/authenticator/version"
 
 Gem::Specification.new do |s|
   s.name        = "socky-authenticator"

data/spec/authenticator_spec.rb

@@ -11,12 +11,12 @@ describe Socky::Authenticator do
   
   it "should allow passing Hash" do
     subject = Socky::Authenticator.new('some' => 'data')
-    subject.instance_variable_get('@args').should eql('some' => 'data')
+    subject.instance_variable_get('@params').should eql('some' => 'data')
   end
   
   it "should allow passing JSON-encoded Hash" do
     subject = Socky::Authenticator.new('{"some":"data"}')
-    subject.instance_variable_get('@args').should eql('some' => 'data')
+    subject.instance_variable_get('@params').should eql('some' => 'data')
   end
   
   it "should raise on JSON-encoded non-Hash" do
@@ -24,14 +24,15 @@ describe Socky::Authenticator do
   end
   
   context "instance" do
-    subject { Socky::Authenticator.new('connection_id' => '1234ABCD', 'channel' => 'some_channel') }
+    let(:default_params) { {:connection_id => '1234ABCD', :channel => 'some_channel'} }
+    subject { Socky::Authenticator.new(default_params) }
     # Set salt to constant to make tests non-random
     before { subject.salt =  'somerandomstring' }
   
     its(:salt) { should eql('somerandomstring') }
     its(:connection_id) { should eql('1234ABCD') }
-    its(:channel_name) { should eql('some_channel') }
-    its(:rights) { should eql('100') }
+    its(:channel) { should eql('some_channel') }
+    its(:rights) { should eql(:read => true, :write => false, :hide => false) }
     its(:presence?) { should eql(false) }
     its(:string_to_sign) { should eql('somerandomstring:1234ABCD:some_channel:100') }
     its(:signature) { should eql('28f138d68b1d4971d85355a5aa5a301be9084176b6ae1bbe2399de990de2039d') }
@@ -44,48 +45,45 @@ describe Socky::Authenticator do
     end
   
     it "should raise if connection_id is nil" do
-      subject.instance_variable_get('@args').delete('connection_id')
+      subject = Socky::Authenticator.new(default_params.reject{|k,v| k == :connection_id})
       subject.connection_id.should be_nil
       lambda { subject.result }.should raise_error ArgumentError, 'expected connection_id'
     end
   
     it "should raise if channel is nil" do
-      subject.instance_variable_get('@args').delete('channel')
-      subject.channel_name.should be_nil
+      subject = Socky::Authenticator.new(default_params.reject{|k,v| k == :channel})
+      subject.channel.should be_nil
       lambda { subject.result }.should raise_error ArgumentError, 'expected channel'
     end
   
     it "should not allow to changing rights at default" do
-      subject.instance_variable_get('@args').merge!('write' => true)
-      subject.rights.should be_nil
-      lambda { subject.result }.should raise_error ArgumentError, 'user are not allowed to change channel rights'
+      subject = Socky::Authenticator.new(default_params.merge(:read => false, :write => true, :hide => true))
+      subject.rights.should eql(:read => true, :write => false, :hide => false)
     end
   
     context "with changing rights enables" do
-      before { subject.instance_variable_set('@allow_changing_rights', true) }
-    
       it "should allow changing 'read' to false" do
-        subject.instance_variable_get('@args').merge!('read' => false)
-        subject.rights.should eql('000')
+        subject = Socky::Authenticator.new(default_params.merge(:read => false), :allow_changing_rights => true)
+        subject.rights[:read].should eql(false)
       end
     
       it "should allow changing 'write' to true" do
-        subject.instance_variable_get('@args').merge!('write' => true)
-        subject.rights.should eql('110')
+        subject = Socky::Authenticator.new(default_params.merge(:write => true), :allow_changing_rights => true)
+        subject.rights[:write].should eql(true)
       end
     
       it "should not allow changing 'hide' to true" do
-        subject.instance_variable_get('@args').merge!('hide' => true)
-        subject.rights.should eql('100')
+        subject = Socky::Authenticator.new(default_params.merge(:hide => true), :allow_changing_rights => true)
+        subject.rights[:hide].should eql(false)
       end
     
     end
   
     context "presence channel" do
-      before { subject.instance_variable_get('@args').merge!('channel' => 'presence-channel') }
+      subject { Socky::Authenticator.new(default_params.merge(:channel => 'presence-channel')) }
     
-      its(:channel_name) { should eql('presence-channel') }
-      its(:rights) { should eql('100') }
+      its(:channel) { should eql('presence-channel') }
+      its(:rights) { should eql(:read => true, :write => false, :hide => false) }
       its(:presence?) { should eql(true) }
       its(:user_data) { should eql(nil) }
       its(:string_to_sign) { should eql('somerandomstring:1234ABCD:presence-channel:100') }
@@ -94,7 +92,7 @@ describe Socky::Authenticator do
       its(:result) { should eql('auth' => 'somerandomstring:f0332936d0c3e59e2d9840d0c0b538ad88fba467ba546d8f9f91bc8d3cd95a1c') }
     
       context "with hash user data provided" do
-        before { subject.instance_variable_get('@args').merge!('data' => { 'some' => 'data' }) }
+        subject { Socky::Authenticator.new(default_params.merge(:channel => 'presence-channel', 'data' => { 'some' => 'data' })) }
       
         its(:user_data) { should eql('{"some":"data"}') }
         its(:string_to_sign) { should eql('somerandomstring:1234ABCD:presence-channel:100:{"some":"data"}') }
@@ -104,7 +102,7 @@ describe Socky::Authenticator do
       end
       
       context "with string user data provided" do
-        before { subject.instance_variable_get('@args').merge!('data' => '{"some":"data"}') }
+        subject { Socky::Authenticator.new(default_params.merge(:channel => 'presence-channel', 'data' => '{"some":"data"}')) }
       
         its(:user_data) { should eql('{"some":"data"}') }
         its(:string_to_sign) { should eql('somerandomstring:1234ABCD:presence-channel:100:{"some":"data"}') }

metadata

@@ -1,98 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: socky-authenticator
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.5.0.beta5
   prerelease: 6
-  version: 0.5.0.beta4
 platform: ruby
-authors: 
+authors:
 - Bernard Potocki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-16 00:00:00 +02:00
+date: 2011-07-30 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70200339058460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ruby-hmac
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70200339058460
+- !ruby/object:Gem::Dependency
+  name: ruby-hmac
+  requirement: &70200339057920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70200339057920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70200339057300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70200339057300
 description: Socky is a WebSocket-based framework for realtime web applications.
-email: 
+email:
 - bernard.potocki@imanel.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
 - Rakefile
 - example/config.ru
 - lib/socky/authenticator.rb
+- lib/socky/authenticator/version.rb
 - socky-authenticator.gemspec
 - spec/authenticator_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://socky.org
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Socky - Authentication Module
-test_files: 
+test_files:
 - spec/authenticator_spec.rb
 - spec/spec_helper.rb