websocket 1.0.7 → 1.1.0

data/lib/websocket/handshake/handler/client75.rb

@@ -1,9 +1,7 @@
 module WebSocket
   module Handshake
     module Handler
-      module Client75
-
-        include Client
+      class Client75 < Client
 
         private
 
@@ -13,10 +11,10 @@ module WebSocket
             ["Upgrade", "WebSocket"],
             ["Connection", "Upgrade"]
           ]
-          host = @host
-          host += ":#{@port}" if @port
+          host = @handshake.host
+          host += ":#{@handshake.port}" if @handshake.port
           keys << ["Host", host]
-          keys << ["Origin", @origin] if @origin
+          keys << ["Origin", @handshake.origin] if @handshake.origin
           keys
         end
 

data/lib/websocket/handshake/handler/client76.rb

@@ -3,9 +3,7 @@ require 'digest/md5'
 module WebSocket
   module Handshake
     module Handler
-      module Client76
-
-        include Client75
+      class Client76 < Client75
 
         # @see WebSocket::Handshake::Base#valid?
         def valid?
@@ -65,7 +63,7 @@ module WebSocket
         # Verify if challenge sent by server match generated one
         # @return [Boolena] True if challenge matches, false otherwise(sets appropriate error)
         def verify_challenge
-          set_error(:invalid_challenge) and return false unless @leftovers == challenge
+          raise WebSocket::Error::Handshake::InvalidAuthentication unless @handshake.instance_variable_get('@leftovers') == challenge
           true
         end
 
@@ -94,7 +92,7 @@ module WebSocket
 
         # Generate third key
         def generate_key3
-          return [rand(0x100000000)].pack("N") + [rand(0x100000000)].pack("N")
+          [rand(0x100000000)].pack("N") + [rand(0x100000000)].pack("N")
         end
 
       end

data/lib/websocket/handshake/handler/server.rb

@@ -1,9 +1,7 @@
 module WebSocket
   module Handshake
     module Handler
-      module Server
-
-        include Base
+      class Server < Base
 
       end
     end

data/lib/websocket/handshake/handler/server04.rb

@@ -4,13 +4,11 @@ require 'base64'
 module WebSocket
   module Handshake
     module Handler
-      module Server04
-
-        include Server
+      class Server04 < Server
 
         # @see WebSocket::Handshake::Base#valid?
         def valid?
-          super && (@headers['sec-websocket-key'] ? true : (set_error(:invalid_handshake_authentication) and false))
+          super && verify_key
         end
 
         private
@@ -32,11 +30,15 @@ module WebSocket
         # Signature of response, created from client request Sec-WebSocket-Key
         # @return [String] signature
         def signature
-          return unless key = @headers['sec-websocket-key']
+          return unless key = @handshake.headers['sec-websocket-key']
           string_to_sign = "#{key}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
           Base64.encode64(Digest::SHA1.digest(string_to_sign)).chomp
         end
 
+        def verify_key
+          (@handshake.headers['sec-websocket-key'] ? true : raise(WebSocket::Error::Handshake::InvalidAuthentication))
+        end
+
       end
     end
   end

data/lib/websocket/handshake/handler/server75.rb

@@ -1,9 +1,7 @@
 module WebSocket
   module Handshake
     module Handler
-      module Server75
-
-        include Server
+      class Server75 < Server
 
         private
 
@@ -17,8 +15,8 @@ module WebSocket
           [
             ["Upgrade", "WebSocket"],
             ["Connection", "Upgrade"],
-            ["WebSocket-Origin", @headers['origin']],
-            ["WebSocket-Location", uri]
+            ["WebSocket-Origin", @handshake.headers['origin']],
+            ["WebSocket-Location", @handshake.uri]
           ]
         end
 

data/lib/websocket/handshake/handler/server76.rb

@@ -3,9 +3,7 @@ require 'digest/md5'
 module WebSocket
   module Handshake
     module Handler
-      module Server76
-
-        include Server
+      class Server76 < Server
 
         # @see WebSocket::Handshake::Base#valid?
         def valid?
@@ -29,8 +27,8 @@ module WebSocket
           [
             ["Upgrade", "WebSocket"],
             ["Connection", "Upgrade"],
-            ["Sec-WebSocket-Origin", @headers['origin']],
-            ["Sec-WebSocket-Location", uri]
+            ["Sec-WebSocket-Origin", @handshake.headers['origin']],
+            ["Sec-WebSocket-Location", @handshake.uri]
           ]
         end
 
@@ -45,9 +43,9 @@ module WebSocket
         # @return [String] Challenge response or nil if error occured
         def challenge_response
           # Refer to 5.2 4-9 of the draft 76
-          first = numbers_over_spaces(@headers['sec-websocket-key1']) || return
-          second = numbers_over_spaces(@headers['sec-websocket-key2']) || return
-          third = @leftovers.strip
+          first = numbers_over_spaces(@handshake.headers['sec-websocket-key1'].to_s)
+          second = numbers_over_spaces(@handshake.headers['sec-websocket-key2'].to_s)
+          third = @handshake.instance_variable_get('@leftovers').strip
 
           sum = [first].pack("N*") +
                 [second].pack("N*") +
@@ -63,14 +61,14 @@ module WebSocket
 
           spaces = string.scan(/ /).size
           # As per 5.2.5, abort the connection if spaces are zero.
-          set_error(:invalid_handshake_authentication) and return if spaces == 0
+          raise WebSocket::Error::Handshake::InvalidAuthentication if spaces == 0
 
           # As per 5.2.6, abort if numbers is not an integral multiple of spaces
-          set_error(:invalid_handshake_authentication) and return if numbers % spaces != 0
+          raise WebSocket::Error::Handshake::InvalidAuthentication if numbers % spaces != 0
 
           quotient = numbers / spaces
 
-          set_error(:invalid_handshake_authentication) and return if quotient > 2**32-1
+          raise WebSocket::Error::Handshake::InvalidAuthentication if quotient > 2**32-1
 
           return quotient
         end

data/lib/websocket/handshake/server.rb

@@ -65,6 +65,48 @@ module WebSocket
           set_version
         end
       end
+      rescue_method :<<
+
+      # Parse the request from a rack environment
+      # @param env Rack Environment
+      #
+      # @example
+      #   @handshake.from_rack(env)
+      def from_rack(env)
+        @headers = env.select {|key, value|
+          key =~ /\AHTTP_/
+        }.inject({}) {|memo, tuple|
+          key, value = tuple
+          memo[key.gsub(/\AHTTP_/, '').gsub('_', '-').downcase] = value
+          memo
+        }
+
+        @path      = env["REQUEST_PATH"]
+        @query     = env["QUERY_STRING"]
+        @leftovers = env['rack.input'].read
+
+        set_version
+        @state = :finished
+      end
+
+      # Parse the request from hash
+      # @param hash Hash to import data
+      # @option hash [Hash] :headers HTTP headers of request, downcased
+      # @option hash [String] :path Path for request(without host and query string)
+      # @option hash [String] :query Query string for request
+      # @option hash [String] :body Body of request(if exists)
+      #
+      # @example
+      #   @handshake.from_hash(hash)
+      def from_hash(hash)
+        @headers = hash[:headers] || {}
+        @path = hash[:path] || "/"
+        @query = hash[:query] || ""
+        @leftovers = hash[:body]
+
+        set_version
+        @state = :finished
+      end
 
       # Should send content to client after finished parsing?
       # @return [Boolean] true
@@ -98,13 +140,12 @@ module WebSocket
       # Include set of methods for selected protocol version
       # @return [Boolean] false if protocol number is unknown, otherwise true
       def include_version
-        case @version
-          when 75 then extend Handler::Server75
-          when 76, 0..3 then extend Handler::Server76
-          when 4..13 then extend Handler::Server04
-          else set_error(:unknown_protocol_version) and return false
+        @handler = case @version
+          when 75 then Handler::Server75.new(self)
+          when 76, 0..3 then Handler::Server76.new(self)
+          when 4..13 then Handler::Server04.new(self)
+          else raise WebSocket::Error::Handshake::UnknownVersion
         end
-        return true
       end
 
       PATH = /^(\w+) (\/[^\s]*) HTTP\/1\.1$/
@@ -114,14 +155,12 @@ module WebSocket
       # @return [Boolean] True if parsed correctly. False otherwise
       def parse_first_line(line)
         line_parts = line.match(PATH)
-        set_error(:invalid_header) and return unless line_parts
+        raise WebSocket::Error::Handshake::InvalidHeader unless line_parts
         method = line_parts[1].strip
-        set_error(:get_request_required) and return unless method == "GET"
+        raise WebSocket::Error::Handshake::GetRequestRequired unless method == "GET"
 
         resource_name = line_parts[2].strip
         @path, @query = resource_name.split('?', 2)
-
-        return true
       end
 
     end

data/lib/websocket/version.rb

@@ -1,3 +1,3 @@
 module WebSocket
-  VERSION = '1.0.7'
+  VERSION = '1.1.0'
 end

data/spec/frame/incoming_03_spec.rb

@@ -94,7 +94,7 @@ describe 'Incoming frame draft 03' do
   context "should raise error with invalid opcode" do
     let(:encoded_text) { "\x09\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unknown_opcode }
+    let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -102,7 +102,7 @@ describe 'Incoming frame draft 03' do
   context "should raise error with too long frame" do
     let(:encoded_text) { "\x04\x7F" + "a" * WebSocket.max_frame_size }
     let(:decoded_text) { nil }
-    let(:error) { :frame_too_long }
+    let(:error) { WebSocket::Error::Frame::TooLong }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -110,7 +110,7 @@ describe 'Incoming frame draft 03' do
   context "should raise error with continuation frame without more frame earlier" do
     let(:encoded_text) { "\x00\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unexpected_continuation_frame }
+    let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
     it_should_behave_like 'valid_incoming_frame'
   end

data/spec/frame/incoming_04_spec.rb

@@ -94,7 +94,7 @@ describe 'Incoming frame draft 04' do
   context "should raise error with invalid opcode" do
     let(:encoded_text) { "\x89\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unknown_opcode }
+    let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -102,7 +102,7 @@ describe 'Incoming frame draft 04' do
   context "should raise error with too long frame" do
     let(:encoded_text) { "\x84\x7F" + "a" * WebSocket.max_frame_size }
     let(:decoded_text) { nil }
-    let(:error) { :frame_too_long }
+    let(:error) { WebSocket::Error::Frame::TooLong }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -110,7 +110,7 @@ describe 'Incoming frame draft 04' do
   context "should raise error with continuation frame without more frame earlier" do
     let(:encoded_text) { "\x80\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unexpected_continuation_frame }
+    let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
     it_should_behave_like 'valid_incoming_frame'
   end

data/spec/frame/incoming_05_spec.rb

@@ -110,7 +110,7 @@ describe 'Incoming frame draft 05' do
   context "should raise error with invalid opcode" do
     let(:encoded_text) { "\x89\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unknown_opcode }
+    let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -118,7 +118,7 @@ describe 'Incoming frame draft 05' do
   context "should raise error with too long frame" do
     let(:encoded_text) { "\x84\x7F" + "a" * WebSocket.max_frame_size }
     let(:decoded_text) { nil }
-    let(:error) { :frame_too_long }
+    let(:error) { WebSocket::Error::Frame::TooLong }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -126,7 +126,7 @@ describe 'Incoming frame draft 05' do
   context "should raise error with continuation frame without more frame earlier" do
     let(:encoded_text) { "\x80\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unexpected_continuation_frame }
+    let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
     it_should_behave_like 'valid_incoming_frame'
   end

data/spec/frame/incoming_07_spec.rb

@@ -110,7 +110,7 @@ describe 'Incoming frame draft 07' do
   context "should raise error with invalid opcode" do
     let(:encoded_text) { "\x85\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unknown_opcode }
+    let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -118,7 +118,7 @@ describe 'Incoming frame draft 07' do
   context "should raise error with too long frame" do
     let(:encoded_text) { "\x81\x7F" + "a" * WebSocket.max_frame_size }
     let(:decoded_text) { nil }
-    let(:error) { :frame_too_long }
+    let(:error) { WebSocket::Error::Frame::TooLong }
 
     it_should_behave_like 'valid_incoming_frame'
   end
@@ -126,7 +126,7 @@ describe 'Incoming frame draft 07' do
   context "should raise error with continuation frame without more frame earlier" do
     let(:encoded_text) { "\x80\x05Hello" }
     let(:decoded_text) { nil }
-    let(:error) { :unexpected_continuation_frame }
+    let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
     it_should_behave_like 'valid_incoming_frame'
   end

data/spec/frame/incoming_75_spec.rb

@@ -45,14 +45,14 @@ describe 'Incoming frame draft 75' do
 
   context "with invalid frame" do
     let(:encoded_text) { "invalid" }
-    let(:error) { :invalid_frame }
+    let(:error) { WebSocket::Error::Frame::Invalid }
 
     it_should_behave_like 'valid_incoming_frame'
   end
 
   context "with too long frame" do
     let(:encoded_text) { "\x00" + "a" * WebSocket.max_frame_size + "\xFF" }
-    let(:error) { :frame_too_long }
+    let(:error) { WebSocket::Error::Frame::TooLong }
 
     it_should_behave_like 'valid_incoming_frame'
   end

data/spec/handshake/client_04_spec.rb

@@ -4,8 +4,8 @@ describe 'Client draft 4 handshake' do
   let(:handshake) { WebSocket::Handshake::Client.new({ :uri => 'ws://example.com/demo', :origin => 'http://example.com', :version => version }.merge(@request_params || {})) }
 
   let(:version) { 4 }
-  let(:client_request) { client_handshake_04({ :key => handshake.send(:key), :version => version }.merge(@request_params || {})) }
-  let(:server_response) { server_handshake_04({ :accept => handshake.send(:accept) }.merge(@request_params || {})) }
+  let(:client_request) { client_handshake_04({ :key => handshake.handler.send(:key), :version => version }.merge(@request_params || {})) }
+  let(:server_response) { server_handshake_04({ :accept => handshake.handler.send(:accept) }.merge(@request_params || {})) }
 
   it_should_behave_like 'all client drafts'
 
@@ -15,6 +15,6 @@ describe 'Client draft 4 handshake' do
 
     handshake.should be_finished
     handshake.should_not be_valid
-    handshake.error.should eql(:invalid_accept)
+    handshake.error.should eql(:invalid_handshake_authentication)
   end
 end

data/spec/handshake/client_76_spec.rb

@@ -4,8 +4,8 @@ describe 'Client draft 76 handshake' do
   let(:handshake) { WebSocket::Handshake::Client.new({ :uri => 'ws://example.com/demo', :origin => 'http://example.com', :version => version }.merge(@request_params || {})) }
 
   let(:version) { 76 }
-  let(:client_request) { client_handshake_76({ :key1 => handshake.send(:key1), :key2 => handshake.send(:key2), :key3 => handshake.send(:key3) }.merge(@request_params || {})) }
-  let(:server_response) { server_handshake_76({ :challenge => handshake.send(:challenge) }.merge(@request_params || {})) }
+  let(:client_request) { client_handshake_76({ :key1 => handshake.handler.send(:key1), :key2 => handshake.handler.send(:key2), :key3 => handshake.handler.send(:key3) }.merge(@request_params || {})) }
+  let(:server_response) { server_handshake_76({ :challenge => handshake.handler.send(:challenge) }.merge(@request_params || {})) }
 
   it_should_behave_like 'all client drafts'
 
@@ -15,6 +15,6 @@ describe 'Client draft 76 handshake' do
 
     handshake.should be_finished
     handshake.should_not be_valid
-    handshake.error.should eql(:invalid_challenge)
+    handshake.error.should eql(:invalid_handshake_authentication)
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'webrick'
 
 require 'websocket'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/all_server_drafts.rb

@@ -83,4 +83,37 @@ shared_examples_for 'all server drafts' do
     handshake.should_not be_valid
     handshake.error.should eql(:get_request_required)
   end
+
+  it "should parse a rack request" do
+    request = WEBrick::HTTPRequest.new( :ServerSoftware => "rspec" )
+    request.parse(StringIO.new(client_request)).should be_true
+    rest    = client_request.slice((request.to_s.length..-1))
+
+    handshake.from_rack(request.meta_vars.merge(
+      "rack.input" => StringIO.new(rest)
+    ))
+    validate_request
+  end
+
+  it "should parse a hash request" do
+    request = WEBrick::HTTPRequest.new( :ServerSoftware => "rspec" )
+    request.parse(StringIO.new(client_request)).should be_true
+    body = client_request.slice((request.to_s.length..-1))
+
+    path = request.path
+    query = request.query_string
+    headers = request.header.inject({}) do |hash, header|
+      hash[header[0]] = header[1].first if header[0] && header[1]
+      hash
+    end
+
+    handshake.from_hash({
+      :headers => headers,
+      :path => path,
+      :query => query,
+      :body => body
+    })
+
+    validate_request
+  end
 end