socky-client 0.4.2 → 0.4.3

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## 0.4.3 / 2010-10-30
+
+- new features:
+  - new, simpler syntax
+- bugfixes
+  - none
+
 ## 0.4.2 / 2010-10-29
 
 - new features:

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/lib/socky-client.rb

@@ -1,5 +1,6 @@
-require 'yaml'
 require 'json'
+require 'logger'
+require 'yaml'
 
 require File.dirname(__FILE__) + '/socky-client/websocket'
 
@@ -7,7 +8,7 @@ module Socky
 
   class << self
     
-    attr_accessor :config_path
+    attr_accessor :config_path, :logger
     def config_path
       @config_path ||= 'socky_hosts.yml'
     end
@@ -28,6 +29,14 @@ module Socky
     def hosts
       config[:hosts]
     end
+    
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+    
+    def deprecation_warning(msg)
+      logger.warn "DEPRECATION WARNING: " + msg.to_s
+    end
 
   private
 
@@ -48,6 +57,16 @@ module Socky
     def send_message(data, opts = {})
       to = opts[:to] || {}
       except = opts[:except] || {}
+      
+      # Move to new syntax
+      if opts[:to] || opts[:except]
+        deprecation_warning "Using of :to and :except will be removed in next version - please move to new syntax."        
+      end
+      to[:client]   ||= opts[:client]
+      to[:clients]  ||= opts[:clients]
+      to[:channel]  ||= opts[:channel]
+      to[:channels] ||= opts[:channels]
+      # end of new syntax
 
       unless to.is_a?(Hash) && except.is_a?(Hash)
         raise "recipiend data should be in hash format"

data/spec/socky-client_spec.rb

@@ -37,6 +37,35 @@ describe Socky do
       end
     end
     context "should handle recipient conditions for" do
+      # New syntax
+      it ":client" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test", :to => { :clients => "first" }})
+        Socky.send("test", :client => "first")
+      end
+      it ":clients" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test", :to => { :clients => ["first","second"] }})
+        Socky.send("test", :clients => ["first","second"])
+      end
+      it ":channel" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test", :to => { :channels => "first" }})
+        Socky.send("test", :channel => "first")
+      end
+      it ":channels" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test", :to => { :channels => ["first","second"] }})
+        Socky.send("test", :channels => ["first","second"])
+      end
+      it "combination" do
+        Socky.should_receive(:send_data).with({
+          :command => :broadcast,
+          :body => "test",
+          :to => {
+            :clients => "allowed_user",
+            :channels => "allowed_channel"
+          }
+        })
+        Socky.send("test", :clients => "allowed_user", :channels => "allowed_channel")
+      end      
+      # Old syntax
       it ":to => :client" do
         Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test", :to => { :clients => "first" }})
         Socky.send("test", :to => { :client => "first" })
@@ -93,6 +122,17 @@ describe Socky do
       end
     end
     context "should ignore nil value for" do
+      # New syntax
+      it ":clients" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test"})
+        Socky.send("test", :clients => nil)
+      end
+      it ":channels" do
+        Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test"})
+        Socky.send("test", :channels => nil)
+      end
+      
+      # Old syntax
       it ":to => :clients" do
         Socky.should_receive(:send_data).with({:command => :broadcast, :body => "test"})
         Socky.send("test", :to => { :clients => nil })
@@ -111,6 +151,17 @@ describe Socky do
       end
     end
     context "should handle empty array for" do
+      # New syntax
+      it ":clients by not sending message" do
+        Socky.should_not_receive(:send_data)
+        Socky.send("test", :clients => [])
+      end
+      it ":channels by not sending message" do
+        Socky.should_not_receive(:send_data)
+        Socky.send("test", :channels => [])
+      end
+      
+      # Old syntax
       it ":to => :clients by not sending message" do
         Socky.should_not_receive(:send_data)
         Socky.send("test", :to => { :clients => [] })

data/spec/spec_helper.rb

@@ -3,3 +3,5 @@ require 'rspec'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 require 'socky-client'
+
+Socky.logger.level = Logger::ERROR

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: socky-client
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Bernard Potocki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2010-10-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency