websocket 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.3
+
+- improve pure ruby implementation performance by ~30%
+- add support for native extension
+
 ## 1.0.2
 
 - allow configuration of max frame size via WebSocket.max_frame_size option

data/README.md

@@ -1,6 +1,6 @@
 # WebSocket Ruby
 
-- Travis CI build: [![](http://travis-ci.org/imanel/websocket-ruby.png)](http://travis-ci.org/imanel/websocket-ruby)
+- Travis CI build: [![](https://travis-ci.org/imanel/websocket-ruby.png)](http://travis-ci.org/imanel/websocket-ruby)
 - Autobahn tests: [server](http://imanel.github.com/websocket-ruby/autobahn/server/), client
 
 Universal Ruby library to handle WebSocket protocol. It foucses on providing abstraction layer over [WebSocket API](http://dev.w3.org/html5/websockets/) instead of providing server or client functionality.
@@ -104,6 +104,12 @@ frame.next # "world!""
 
 For examples on how to use WebSocket Ruby see examples directory in the repository. Provided examples are fully working servers - they are passing full autobahn compatibility suit.
 
+## Native extension
+
+WebSocket gem is written in pure Ruby, without any dependencies or native extensions and still is one of the fastest implementations of WebSocket API. However, if you want to increase it's speed even further, I created additional gem with dedicated native extensions for both C and Java. Those extensions provide 20-30% increate in speed(more accurate comparision can be found in autobahn test results)
+
+In order to use native extension just install [websocket-native](http://github.com/imanel/websocket-ruby-native) gem or add it to Gemfile - WebSocket will automatically detect and load it.
+
 ## License
 
 (The MIT License)

data/autobahn-server.json

@@ -1,10 +1,15 @@
 {
-   "options": {"failByDrop": false},
-   "outdir": "./autobahn/server",
+  "options": {"failByDrop": false},
+  "outdir": "./autobahn/server",
 
-   "servers": [{"agent": "WebSocket-Ruby v1.0.2", "url": "ws://localhost:9001", "options": {"version": 18}}],
+  "servers": [
+    {"agent": "WebSocket-Ruby<br>(1.0.3 Pure)", "url": "ws://localhost:9001", "options": {"version": 18}},
+    {"agent": "WebSocket-Ruby<br>(1.0.3 Native)", "url": "ws://localhost:9002", "options": {"version": 18}},
+    {"agent": "Faye-WebSocket<br>(0.4.6 Thin)", "url": "ws://localhost:7000", "options": {"version": 18}},
+    {"agent": "EM-WebSocket<br>(0.3.8)", "url": "ws://localhost:8080", "options": {"version": 18}}
+  ],
 
-   "cases": ["*"],
-   "exclude-cases": [],
-   "exclude-agent-cases": {}
+  "cases": ["*"],
+  "exclude-cases": [],
+  "exclude-agent-cases": {}
 }

data/lib/websocket.rb

@@ -25,3 +25,9 @@ module WebSocket
   end
 
 end
+
+# Try loading websocket-native if available
+begin
+  require "websocket-native"
+rescue LoadError
+end

data/lib/websocket/frame/data.rb

@@ -12,7 +12,7 @@ module WebSocket
 
       def set_mask
         raise "Too short" if bytesize < 4 # TODO - change
-        @masking_key = Data.new(self[0..3])
+        @masking_key = self[0..3].bytes.to_a
       end
 
       def unset_mask
@@ -20,11 +20,8 @@ module WebSocket
       end
 
       def getbytes(start_index, count)
-        data = ''
-        data.force_encoding('ASCII-8BIT') if data.respond_to?(:force_encoding)
-        count.times do |i|
-          data << getbyte(start_index + i)
-        end
+        data = self[start_index, count]
+        data = mask(data.bytes.to_a, @masking_key).pack('C*') if @masking_key
         data
       end
 
@@ -35,18 +32,15 @@ module WebSocket
         end
       end
 
-      def getbyte_with_masking(index)
-        if @masking_key
-          masked_char = getbyte_without_masking(index)
-          masked_char ? masked_char ^ @masking_key.getbyte(index % 4) : nil
-        else
-          getbyte_without_masking(index)
+      def mask(payload, mask)
+        return mask_native(payload, mask) if respond_to?(:mask_native)
+        result = []
+        payload.each_with_index do |byte, i|
+          result[i] = byte ^ mask[i % 4]
         end
+        result
       end
 
-      alias_method :getbyte_without_masking, :getbyte
-      alias_method :getbyte, :getbyte_with_masking
-
     end
   end
 end

data/lib/websocket/version.rb

@@ -1,3 +1,3 @@
 module WebSocket
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/spec/frame/incoming_03_spec.rb

@@ -103,7 +103,7 @@ describe 'Incoming frame draft 03' do
     let(:decoded_text) { nil }
     let(:error) { :frame_too_long }
 
-    it_should_behave_like('valid_incoming_frame') unless RUBY_PLATFORM == "java"
+    it_should_behave_like 'valid_incoming_frame'
   end
 
   context "should raise error with continuation frame without more frame earlier" do

data/spec/frame/incoming_04_spec.rb

@@ -103,7 +103,7 @@ describe 'Incoming frame draft 04' do
     let(:decoded_text) { nil }
     let(:error) { :frame_too_long }
 
-    it_should_behave_like('valid_incoming_frame') unless RUBY_PLATFORM == "java"
+    it_should_behave_like 'valid_incoming_frame'
   end
 
   context "should raise error with continuation frame without more frame earlier" do

data/spec/frame/incoming_05_spec.rb

@@ -119,7 +119,7 @@ describe 'Incoming frame draft 05' do
     let(:decoded_text) { nil }
     let(:error) { :frame_too_long }
 
-    it_should_behave_like('valid_incoming_frame') unless RUBY_PLATFORM == "java"
+    it_should_behave_like 'valid_incoming_frame'
   end
 
   context "should raise error with continuation frame without more frame earlier" do

data/spec/frame/incoming_07_spec.rb

@@ -119,7 +119,7 @@ describe 'Incoming frame draft 07' do
     let(:decoded_text) { nil }
     let(:error) { :frame_too_long }
 
-    it_should_behave_like('valid_incoming_frame') unless RUBY_PLATFORM == "java"
+    it_should_behave_like 'valid_incoming_frame'
   end
 
   context "should raise error with continuation frame without more frame earlier" do

data/spec/frame/incoming_75_spec.rb

@@ -53,7 +53,7 @@ describe 'Incoming frame draft 75' do
     let(:encoded_text) { "\x00" + "a" * WebSocket.max_frame_size + "\xFF" }
     let(:error) { :frame_too_long }
 
-    it_should_behave_like('valid_incoming_frame') unless RUBY_PLATFORM == "java"
+    it_should_behave_like 'valid_incoming_frame'
   end
 
 end

data/spec/spec_helper.rb

@@ -2,3 +2,9 @@ require 'rspec'
 
 require 'websocket'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    WebSocket.max_frame_size = 100 * 1024 # 100kb
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -121,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 221385565863631789
+      hash: 159948745568353421
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 221385565863631789
+      hash: 159948745568353421
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24