socket.io 0.0.1

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in socket.io-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Derek Kastner
+
+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.markdown

@@ -0,0 +1,17 @@
+= socket.io-ruby
+
+Description goes here.
+
+== 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) 2011 Derek Kastner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError
+  $stderr.puts "You must install bundler - run `gem install bundler`"
+end
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'bueller'
+Bueller::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:examples) do |examples|
+  examples.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov = true
+end
+
+task :default => :examples
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "socket.io-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/socket.io.rb

@@ -0,0 +1,6 @@
+require 'socket.io/packet'
+require 'socket.io/websocket'
+
+module SocketIo
+end
+

data/lib/socket.io/packet.rb

@@ -0,0 +1,59 @@
+require 'json'
+
+module SocketIo
+  class Packet
+    attr_accessor :data, :id, :ack, :type_id, :endpoint
+
+    PACKET_REGEX = /([^:]+):([0-9]+)?(\+)?:([^:]+)?:?([\s\S]*)?/
+
+    PACKET_TYPES = [:disconnect, :connect, :heartbeat, :message, :json, :event, :ack, :error, :noop]
+    PACKET_TYPES.each do |type|
+      require "socket.io/packet/#{type}_packet"
+    end
+
+    def self.parse(string)
+      pieces = string.match(PACKET_REGEX);
+      return nil if pieces.nil?
+
+      type = PACKET_TYPES[pieces[1].to_i]
+      packet_class = self.const_get "#{type.capitalize}Packet"
+
+      packet = packet_class.new :id => pieces[2] || '',
+        :ack => pieces[3] ? 'data' : true,
+        :data => pieces[5] || '',
+        :endpoint => pieces[4] || ''
+
+      packet.parse_pieces pieces if packet.respond_to?(:parse_pieces)
+      packet
+    end
+
+    def self.parse_json(str)
+      JSON.parse str
+    rescue
+      false
+    end
+
+    def initialize(options = {})
+      options.each do |name, value|
+        self.send "#{name}=", value
+      end
+    end
+
+    def json
+      @json ||= self.class.parse_json(data)
+    end
+
+    def ackdata?
+      ack == 'data'
+    end
+
+    def to_s(payload = nil)
+      parts = []
+      parts << type_id
+      parts << (id || '') + (ack == 'data' ? '+' : '') 
+      parts << endpoint
+      parts << payload if payload
+      parts.join ':'
+    end
+  end
+end

data/lib/socket.io/packet/ack_packet.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module SocketIo
+  class Packet
+    class AckPacket < Packet
+      attr_accessor :ack_id, :args
+
+      def parse_pieces(pieces)
+        if sub_pieces = data =~ /^([0-9]+)(\+)?(.*)/
+          self.ack_id = sub_pieces[1];
+          self.args = [];
+
+          if sub_pieces[3]
+            self.args = Packet.parse_json(sub_pieces[3]) || [];
+          end
+        end
+      end
+
+      def type_id; 6; end
+
+      def to_s
+        payload = ack_id.to_s
+        payload += '+' + args.to_json if args
+        super payload
+      end
+    end
+  end
+end

data/lib/socket.io/packet/connect_packet.rb

@@ -0,0 +1,15 @@
+module SocketIo
+  class Packet
+    class ConnectPacket < Packet
+      def qs
+        data
+      end
+
+      def type_id; 1; end
+
+      def to_s
+        super(qs)
+      end
+    end
+  end
+end

data/lib/socket.io/packet/disconnect_packet.rb

@@ -0,0 +1,7 @@
+module SocketIo
+  class Packet
+    class DisconnectPacket < Packet
+      def type_id; 0; end
+    end
+  end
+end

data/lib/socket.io/packet/error_packet.rb

@@ -0,0 +1,24 @@
+module SocketIo
+  class Packet
+    class ErrorPacket < Packet
+      REASONS = ['transport not supported', 'client not handshaken', 'unauthorized']
+      ADVICE = %w{reconnect}
+
+      def from_pieces(pieces)
+        sub_pieces = data.split('+');
+        self.reason = REASONS[sub_pieces[0]] || '';
+        self.advice = ADVICE[sub_pieces[1]] || '';
+      end
+
+      def type_id; 7; end
+
+      def to_s
+        payload = nil
+        if reason != '' || advice != ''
+          payload = reason + (advice != '' ? ('+' + advice) : '')
+        end
+        super payload
+      end
+    end
+  end
+end

data/lib/socket.io/packet/event_packet.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module SocketIo
+  class Packet
+    class EventPacket < Packet
+      def name
+        json['name']
+      end
+
+      def args
+        json['args'] || []
+      end
+
+      def type_id; 5; end
+
+      def to_s
+        ev = { 'name' => name }
+
+        if args && args.length
+          ev['args'] = args
+        end
+
+        super ev.to_json;
+      end
+    end
+  end
+end

data/lib/socket.io/packet/heartbeat_packet.rb

@@ -0,0 +1,7 @@
+module SocketIo
+  class Packet
+    class HeartbeatPacket < Packet
+      def type_id; 2; end
+    end
+  end
+end

data/lib/socket.io/packet/json_packet.rb

@@ -0,0 +1,11 @@
+module SocketIo
+  class Packet
+    class JsonPacket < Packet
+      def type_id; 4; end
+
+      def to_s
+        super json
+      end
+    end
+  end
+end

data/lib/socket.io/packet/message_packet.rb

@@ -0,0 +1,11 @@
+module SocketIo
+  class Packet
+    class MessagePacket < Packet
+      def type_id; 3; end
+
+      def to_s
+        super json
+      end
+    end
+  end
+end

data/lib/socket.io/packet/noop_packet.rb

@@ -0,0 +1,7 @@
+module SocketIo
+  class Packet
+    class NoopPacket < Packet
+      def type_id; 8; end
+    end
+  end
+end

data/lib/socket.io/version.rb

@@ -0,0 +1,3 @@
+module SocketIo
+  VERSION = "0.0.1"
+end

data/lib/socket.io/websocket.rb

@@ -0,0 +1,37 @@
+require 'socket.io/websocket/carrier_wave'
+require 'socket.io/websocket/receiver'
+require 'socket.io/websocket/sender'
+
+module SocketIo
+  module Websocket
+    include CarrierWave
+    include Receiver
+    include Sender
+
+    @@events = {}
+
+    def self.included(target)
+      target.transport = :websocket
+      target.on_start :init_session
+      target.on_data :handle_packet
+
+      target.extend ClassMethods
+
+      @@events[target] = {}
+    end
+
+    def events
+      @@events[self.class]
+    end
+
+    module ClassMethods
+      def events
+        Websocket.class_variable_get(:@@events)[self]
+      end
+
+      def on(event, method)
+        events[event.to_s] = method
+      end
+    end
+  end
+end

data/lib/socket.io/websocket/carrier_wave.rb

@@ -0,0 +1,28 @@
+module SocketIo
+  module Websocket
+    module CarrierWave
+      @@cache = {}
+
+      def init_session
+        if session.nil?
+          send_connect
+          self.session = Time.now
+        end
+      end
+
+      def session_id
+        params[:session_id]
+      end
+
+      def session_key
+        'sessions/' + session_id
+      end
+      def session
+        @@cache[session_key]
+      end
+      def session=(cid)
+        @@cache[session_key] = cid
+      end
+    end
+  end
+end

data/lib/socket.io/websocket/receiver.rb

@@ -0,0 +1,48 @@
+require 'socket.io/packet'
+
+module SocketIo
+  module Websocket
+    module Receiver
+      def handle_packet(data)
+        packet = SocketIo::Packet.parse(data)
+
+        case packet.class.to_s
+        when 'SocketIo::Packet::DisconnectPacket' then
+          self.channel_id = nil
+        when 'SocketIo::Packet::HeartbeatPacket' then
+          self.channel_id = Time.now
+        when 'SocketIo::Packet::MessagePacket' then
+          handle_message(packet)
+        when 'SocketIo::Packet::JsonPacket' then
+          handle_json(packet)
+        when 'SocketIo::Packet::EventPacket' then
+          handle_event(packet)
+        when 'SocketIo::Packet::AckPacket' then
+        when 'SocketIo::Packet::ErrorPacket' then
+        when 'SocketIo::Packet::NoopPacket' then
+        end
+      end
+
+      def handle_message(packet)
+        ack_args = send events['message'], packet.data
+        ack packet, args: ack_args
+      end
+
+      def handle_json(packet)
+        ack_args = send events['message'], packet.json
+        ack packet, args: ack_args
+      end
+
+      def handle_event(packet)
+        json = packet.json
+        name = json['name']
+        ack_args = send events[name].to_s, *json['args']
+        ack packet, args: ack_args
+      end
+
+      def handle_error(packet)
+        puts "Error from client: #{packet.inspect}"
+      end
+    end
+  end
+end

data/lib/socket.io/websocket/sender.rb

@@ -0,0 +1,23 @@
+require 'socket.io/packet'
+
+module SocketIo
+  module Websocket
+    module Sender
+      Packet::PACKET_TYPES.each do |type|
+        define_method "send_#{type}" do |*args|
+          options = args[0] || {}
+          klass = Packet.const_get("#{type.capitalize}Packet")
+          packet = klass.new options
+          str = packet.to_s
+          render str
+        end
+      end
+
+      def ack(calling_packet, options = {})
+        ack_params = { ack_id: calling_packet.id }
+        ack_params[:args] = options[:args] if calling_packet.ackdata?
+        send_ack ack_params
+      end
+    end
+  end
+end

data/socket.io.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'socket.io/version'
+
+Gem::Specification.new do |s|
+  s.name = 'socket.io'
+  s.version = SocketIo::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = '2011-11-21'
+  s.authors = ['Derek Kastner']
+  s.email = 'dkastner@gmail.com'
+  s.homepage = 'http://github.com/dkastner/socket.io-ruby'
+  s.summary = %Q{A ruby implementation of a Socket.io-compliant websocket server}
+  s.description = %Q{A plugin for Cramp that enables websockets using the Socket.io protocol}
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.markdown',
+  ]
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
+  s.rubygems_version = '1.3.7'
+  s.specification_version = 3
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+
+  s.add_dependency 'cramp', '~> 0.15.1'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rcov'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.setup
+
+require 'socket.io'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/websocket/receiver_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'socket.io/websocket'
+require 'socket.io/websocket/receiver'
+require 'json'
+
+describe SocketIo::Websocket::Receiver do
+  class MyAction
+    def self.transport=(val); end
+    def self.on_start(val); end
+    def self.on_data(val); end
+    include SocketIo::Websocket
+
+    on :quux, :qat
+
+    def qat(one, two); end
+  end
+
+  let(:data) do
+    { 'name' => 'quux', 'args' => ['hi', 5] }.to_json
+  end
+
+  describe '#handle_packet' do
+    it 'handles an event packet' do
+      packet = SocketIo::Packet::EventPacket.new :data => data
+      SocketIo::Packet.stub!(:parse).and_return(packet)
+
+      action = MyAction.new
+      action.should_receive(:handle_event).with(packet)
+      action.handle_packet ''
+    end
+  end
+
+  describe '#handle_event' do
+    it 'fires the specified event callback' do
+      packet = SocketIo::Packet::EventPacket.new :data => data
+
+      action = MyAction.new
+      action.should_receive(:qat).with('hi',5).once
+      action.stub! :ack
+      action.handle_event packet
+    end
+  end
+end

data/spec/websocket_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'socket.io/websocket'
+
+describe SocketIo::Websocket do
+  class SocketAction
+    def self.transport=(val); end
+    def self.on_start(val); end
+    def self.on_data(val); end
+    include SocketIo::Websocket
+  end
+
+  describe '.included' do
+    it 'initializes an `events` class variable' do
+      SocketAction.events.should == {}
+    end
+  end
+
+  describe '.on' do
+    it 'stores a callback for the specified event' do
+      SocketAction.on(:melody, :play_riff)
+      SocketAction.events['melody'].should == :play_riff
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: socket.io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Derek Kastner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cramp
+  requirement: &2165211900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165211900
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165211100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165211100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165210000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165210000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2165203780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165203780
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2165202980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165202980
+description: A plugin for Cramp that enables websockets using the Socket.io protocol
+email: dkastner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/socket.io.rb
+- lib/socket.io/packet.rb
+- lib/socket.io/packet/ack_packet.rb
+- lib/socket.io/packet/connect_packet.rb
+- lib/socket.io/packet/disconnect_packet.rb
+- lib/socket.io/packet/error_packet.rb
+- lib/socket.io/packet/event_packet.rb
+- lib/socket.io/packet/heartbeat_packet.rb
+- lib/socket.io/packet/json_packet.rb
+- lib/socket.io/packet/message_packet.rb
+- lib/socket.io/packet/noop_packet.rb
+- lib/socket.io/version.rb
+- lib/socket.io/websocket.rb
+- lib/socket.io/websocket/carrier_wave.rb
+- lib/socket.io/websocket/receiver.rb
+- lib/socket.io/websocket/sender.rb
+- socket.io.gemspec
+- spec/spec_helper.rb
+- spec/websocket/receiver_spec.rb
+- spec/websocket_spec.rb
+homepage: http://github.com/dkastner/socket.io-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.7
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A ruby implementation of a Socket.io-compliant websocket server
+test_files:
+- spec/spec_helper.rb
+- spec/websocket/receiver_spec.rb
+- spec/websocket_spec.rb