spinderella-client 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Darcy Laycock
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= spinderella-client
+
+A set of client libraries for spinderella.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "spinderella-client"
+    gem.summary = %Q{A Simple, Synchronous TCPSocket client for Spinderella}
+    gem.description = %Q{A client library for spinderella (http://github.com/Sutto/spinderella)}
+    gem.email = "sutto@sutto.net"
+    gem.homepage = "http://github.com/Sutto/spinderella-client"
+    gem.authors = ["Darcy Laycock"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "perennial", ">= 1.2.4"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "spinderella-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/spinderella-client.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'spinderella', 'client')

data/lib/spinderella/client.rb

@@ -0,0 +1,9 @@
+lib_path = File.expand_path(File.dirname(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+module Spinderella
+  module Client
+    autoload :Broadcaster, 'spinderella/client/broadcaster'
+    autoload :Subscriber,  'spinderella/client/subscriber'
+  end
+end

data/lib/spinderella/client/broadcaster.rb

@@ -0,0 +1,96 @@
+require 'perennial/protocols/pure_ruby/json_transport'
+require 'thread'
+
+module Spinderella
+  module Client
+    class Broadcaster < Perennial::Protocols::PureRuby::JSONTransport
+    
+      def initialize(options = {})
+        @authenticated = false
+        @auth_callback = []
+        @options       = options
+        @host          = (options[:host] || "localhost").to_s
+        @port          = (options[:port] || 42341).to_i
+        @timeout       = (options[:timeout] || 15).to_f
+        @read_timeout  = (options[:read_timeout] || 5).to_f
+        @token         = options[:token]
+        @mutex         = Mutex.new
+        authenticate(@token) if @token
+      end
+    
+      def authenticate(token)
+        write_message(:authenticate, :token => token)
+        action, payload = read_message(@timeout)
+        @authenticated = (action == "authenticated")
+        if @authenticated
+          @auth_callback.each { |b| b.call }
+          @auth_callback = []
+        end
+        @authenticated
+      rescue NoConnection
+        @authenticated = false
+        return false
+      end
+    
+      def authenticated?
+        !!@authenticated
+      end
+    
+      def close
+        super
+        @authenticated = false
+      end
+    
+      def broadcast_to_all(message)
+        once_authenticated do
+          write_message :broadcast, "type" => "all", "message" => message.to_s
+        end
+      end
+  
+      def broadcast_to_users(message, users)
+        once_authenticated do
+          write_message :broadcast, "type" => "users", "message" => message.to_s,
+            "users" => Array(users).map { |u| u.to_s }
+        end
+      end
+  
+      def broadcast_to_channels(message, channels)
+        once_authenticated do
+          write_message :broadcast, "type" => "channels", "message" => message.to_s,
+            "channels" => Array(channels).map { |c| c.to_s }
+        end
+      end
+  
+      def broadcast_to_channel(message, channel)
+        once_authenticated do
+          write_message :broadcast, "type" => "channel", "message" => message.to_s, "channel" => channel.to_s
+        end
+      end
+      
+      def inspect
+        "#<#{self.class.name} authenticated=#{authenticated?}, host=\"#{@host}:#{@port}\" connected=#{alive?}>"
+      end
+    
+      protected
+    
+      def once_authenticated(&blk)
+        if authenticated?
+          blk.call
+        else
+          @auth_callback << blk
+        end
+        nil
+      end
+      
+      def write_message(name, data = {})
+        @mutex.synchronize { super }
+      end
+      
+      def read_message(timeout = nil)
+        @mutex.synchronize { super }
+      end
+      
+    end
+    
+  end
+end

data/lib/spinderella/client/subscriber.rb

@@ -0,0 +1,115 @@
+require 'perennial/protocols/pure_ruby/json_transport'
+require 'thread'
+
+module Spinderella
+  module Client
+    class Subscriber < Perennial::Protocols::PureRuby::JSONTransport
+      
+      attr_writer :should_stop
+      
+      def initialize(options = {})
+        @options       = options
+        @host          = (options[:host] || "localhost").to_s
+        @port          = (options[:port] || 42340).to_i
+        @timeout       = (options[:timeout] || 15).to_f
+        @read_timeout  = (options[:read_timeout] || 5).to_f
+        @callbacks     = {}
+        @mutex         = Mutex.new
+        @should_stop   = false
+      end
+      
+      def subscribe(*channels)
+        write_message :subscribe, :channels => Array(channels)
+        true
+      end
+      
+      def unsubscribe(*channels)
+        write_message :unsubscribe, :channels => Array(channels)
+        true
+      end
+      
+      def identify(identifier)
+        write_message :identify, :identifier => identifier
+        true
+      end
+      
+      def channels
+        write_message :channels
+        action, payload = read_message(@read_timeout)
+        if action == "channels"
+          Array(payload["channels"])
+        else
+          []
+        end
+      end
+      
+      def watch
+        loop do
+          action, payload = read_message(@read_timeout)
+          # When action is nil, it means there is nothing to read yet.
+          case action
+            when "ping"
+              write_message :pong
+            when "disconnected"
+              @should_stop = true
+              close
+            when "receive_message"
+              process_message(payload)
+          end
+          break if @should_stop
+          # In the case we didn't receive data, sleep for half a second
+          # so as not to steal all of the available CPU.
+          sleep 0.5 if action.nil?
+        end
+      end
+      
+      def on_user(&blk)
+        (@callbacks[:user] ||= []) << blk
+        true
+      end
+      
+      def on_channels(*channels, &blk)
+        channel_callbacks = @callbacks[:channels] ||= {}
+        (channel_callbacks[channels] ||= []) << blk
+        true
+      end
+      
+      def on_broadcast(&blk)
+        (@callbacks[:broadcast] ||= []) << blk
+        true
+      end
+      
+      def stop
+        @should_stop = true
+      end
+      
+      protected
+      
+      def process_message(payload)
+        type, message = payload["type"], payload["message"]
+        case type
+          when "user"
+            Array(@callbacks[:user]).each { |cb| cb.call(message) }
+          when "broadcast"
+            Array(@callbacks[:broadcast]).each { |cb| cb.call(message) }
+          when "channel", "channels"
+            channels = Array(payload["channels"] || payload["channel"])
+            channel_callbacks = @callbacks[:channels] ||= {}
+            channel_callbacks.each_pair do |c, callbacks|
+              p(channels & Array(c))
+              callbacks.each { |cb| p cb; cb.call(message) } if !(channels & Array(c)).empty?
+            end
+        end
+      end
+      
+      def write_message(name, data = {})
+        @mutex.synchronize { super }
+      end
+      
+      def read_message(timeout = nil)
+        @mutex.synchronize { super }
+      end
+      
+    end
+  end
+end

data/spinderella-client.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{spinderella-client}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darcy Laycock"]
+  s.date = %q{2010-01-03}
+  s.description = %q{A client library for spinderella (http://github.com/Sutto/spinderella)}
+  s.email = %q{sutto@sutto.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/spinderella-client.rb",
+     "lib/spinderella/client.rb",
+     "lib/spinderella/client/broadcaster.rb",
+     "lib/spinderella/client/subscriber.rb",
+     "spinderella-client.gemspec",
+     "test/helper.rb",
+     "test/test_spinderella-client.rb"
+  ]
+  s.homepage = %q{http://github.com/Sutto/spinderella-client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Simple, Synchronous TCPSocket client for Spinderella}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_spinderella-client.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<perennial>, [">= 1.2.4"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<perennial>, [">= 1.2.4"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<perennial>, [">= 1.2.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'spinderella-client'
+
+class Test::Unit::TestCase
+end

data/test/test_spinderella-client.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSpinderellaClient < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: spinderella-client
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: perennial
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+description: A client library for spinderella (http://github.com/Sutto/spinderella)
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/spinderella-client.rb
+- lib/spinderella/client.rb
+- lib/spinderella/client/broadcaster.rb
+- lib/spinderella/client/subscriber.rb
+- spinderella-client.gemspec
+- test/helper.rb
+- test/test_spinderella-client.rb
+has_rdoc: true
+homepage: http://github.com/Sutto/spinderella-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Simple, Synchronous TCPSocket client for Spinderella
+test_files: 
+- test/helper.rb
+- test/test_spinderella-client.rb