websocket-eventmachine-base 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/*.gem

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+- initial release

data/README.md

@@ -0,0 +1,11 @@
+# WebSocket Base for Ruby client and server
+
+WebSocket-EventMachine-Base is base gem for [WebSocket-EventMachine-Client](http://github.com/imanel/websocket-eventmachine-client) and [WebSocket-EventMachine-Server](http://github.com/imanel/websocket-eventmachine-server)
+
+This gem should not be used directly - please refer to client or server gem for full specification.
+
+- [Docs](http://rdoc.info/github/imanel/websocket-eventmachine-base/master/frames)
+
+## License
+
+The MIT License - Copyright (c) 2012 Bernard Potocki

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/websocket/eventmachine/base/version.rb

@@ -0,0 +1,7 @@
+module WebSocket
+  module EventMachine
+    class Base
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/websocket/eventmachine/base.rb

@@ -0,0 +1,191 @@
+require 'websocket'
+require 'eventmachine'
+
+module WebSocket
+  module EventMachine
+
+    # WebSocket Base for Client and Server (using EventMachine)
+    class Base < ::EventMachine::Connection
+
+      ###########
+      ### API ###
+      ###########
+
+      # Called when connection is opened.
+      # No parameters are passed to block
+      def onopen(&blk);     @onopen = blk;    end
+
+      # Called when connection is closed.
+      # No parameters are passed to block
+      def onclose(&blk);    @onclose = blk;   end
+
+      # Called when error occurs.
+      # One parameter passed to block:
+      #   error - string with error message
+      def onerror(&blk);    @onerror = blk;   end
+
+      # Called when message is received.
+      # Two parameters passed to block:
+      #   message - string with received message
+      #   type - type of message. Valid values are :text and :binary
+      def onmessage(&blk);  @onmessage = blk; end
+
+      # Called when ping message is received
+      # One parameter passed to block:
+      #   message - string with ping message
+      def onping(&blk);     @onping = blk;    end
+
+      # Called when pond message is received
+      # One parameter passed to block:
+      #   message - string with pong message
+      def onpong(&blk);     @onpong = blk;    end
+
+      # Send data
+      # @param data [String] Data to send
+      # @param args [Hash] Arguments for send
+      # @option args [String] :type Type of frame to send - available types are "text", "binary", "ping", "pong" and "close"
+      # @option args [Integer] :code Code for close frame
+      # @return [Boolean] true if data was send, otherwise call on_error if needed
+      def send(data, args = {})
+        type = args[:type] || :text
+        unless type == :plain
+          frame = outgoing_frame.new(:version => @handshake.version, :data => data, :type => type.to_s, :code => args[:code])
+          if !frame.supported?
+            trigger_onerror("Frame type '#{type}' is not supported in protocol version #{@handshake.version}")
+            return false
+          elsif !frame.require_sending?
+            return false
+          end
+          data = frame.to_s
+        end
+        debug "Sending raw: ", data
+        send_data(data)
+        true
+      end
+
+      # Close connection
+      # @return [Boolean] true if connection is closed immediately, false if waiting for other side to close connection
+      def close(code = 1000, data = nil)
+        if @state == :open
+          @state = :closing
+          return false if send(data, :type => :close, :code => code)
+        else
+          send(data, :type => :close) if @state == :closing
+          @state = :closed
+        end
+        close_connection_after_writing
+        true
+      end
+
+      # Send ping message
+      # @return [Boolean] false if protocol version is not supporting ping requests
+      def ping(data = '')
+        send(data, :type => :ping)
+      end
+
+      # Send pong message
+      # @return [Boolean] false if protocol version is not supporting pong requests
+      def pong(data = '')
+        send(data, :type => :pong)
+      end
+
+      ############################
+      ### EventMachine methods ###
+      ############################
+
+      # Eventmachine internal
+      # @private
+      def receive_data(data)
+        debug "Received raw: ", data
+        case @state
+        when :connecting then handle_connecting(data)
+        when :open then handle_open(data)
+        when :closing then handle_closing(data)
+        end
+      end
+
+      # Eventmachine internal
+      # @private
+      def unbind
+        unless @state == :closed
+          @state = :closed
+          close
+          trigger_onclose('')
+        end
+      end
+
+      #######################
+      ### Private methods ###
+      #######################
+
+      private
+
+      ['onopen'].each do |m|
+        define_method "trigger_#{m}" do
+          callback = instance_variable_get("@#{m}")
+          callback.call if callback
+        end
+      end
+
+      ['onerror', 'onping', 'onpong', 'onclose'].each do |m|
+        define_method "trigger_#{m}" do |data|
+          callback = instance_variable_get("@#{m}")
+          callback.call(data) if callback
+        end
+      end
+
+      def trigger_onmessage(data, type)
+        @onmessage.call(data, type) if @onmessage
+      end
+
+      def handle_connecting(data)
+        @handshake << data
+        return unless @handshake.finished?
+        if @handshake.valid?
+          send(@handshake.to_s, :type => :plain) if @handshake.should_respond?
+          @frame = incoming_frame.new(:version => @handshake.version)
+          @state = :open
+          trigger_onopen
+          handle_open(@handshake.leftovers) if @handshake.leftovers
+        else
+          trigger_onerror(@handshake.error)
+          close
+        end
+      end
+
+      def handle_open(data)
+        @frame << data
+        while frame = @frame.next
+          case frame.type
+          when :close
+            @state = :closing
+            close
+            trigger_onclose(frame.to_s)
+          when :ping
+            pong(frame.to_s)
+            trigger_onping(frame.to_s)
+          when :pong
+            trigger_onpong(frame.to_s)
+          when :text
+            trigger_onmessage(frame.to_s, :text)
+          when :binary
+            trigger_onmessage(frame.to_s, :binary)
+          end
+        end
+        unbind if @frame.error?
+      end
+
+      def handle_closing(data)
+        @state = :closed
+        close
+        trigger_onclose
+      end
+
+      def debug(description, data)
+        return unless @debug
+        puts(description + data.bytes.to_a.collect{|b| '\x' + b.to_s(16).rjust(2, '0')}.join) unless @state == :connecting
+      end
+
+    end
+  end
+end

data/lib/websocket-eventmachine-base.rb

@@ -0,0 +1 @@
+require File.expand_path('../websocket/eventmachine/base', __FILE__)

data/websocket-eventmachine-base.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "websocket/eventmachine/base/version"
+
+Gem::Specification.new do |s|
+  s.name        = "websocket-eventmachine-base"
+  s.version     = WebSocket::EventMachine::Base::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernard Potocki"]
+  s.email       = ["bernard.potocki@imanel.org"]
+  s.homepage    = "http://github.com/imanel/websocket-eventmachine-base"
+  s.summary     = %q{WebSocket base for Ruby client and server}
+  s.description = %q{WebSocket base for Ruby client and server}
+
+  s.add_dependency 'websocket', '~> 1.0'
+  s.add_dependency 'websocket-native', '~> 1.0'
+  s.add_dependency 'eventmachine', '~> 1.0'
+
+  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"]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: websocket-eventmachine-base
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: websocket-native
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: WebSocket base for Ruby client and server
+email:
+- bernard.potocki@imanel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/websocket-eventmachine-base.rb
+- lib/websocket/eventmachine/base.rb
+- lib/websocket/eventmachine/base/version.rb
+- websocket-eventmachine-base.gemspec
+homepage: http://github.com/imanel/websocket-eventmachine-base
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: WebSocket base for Ruby client and server
+test_files: []