libwebsocket 0.1.5 → 0.1.6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.6 / 2012-11-18
+
+- Migrate to websocket gem
+- Remove most of deprecated and not working code
+- Frame migration is last thing that prevents this gem to support drafts 00-17(RFC)
+
 ## 0.1.5 / 2012-07-27
 
 - Fixed problem caused by invalid draft 10 support

data/README.md

@@ -3,6 +3,8 @@
 A WebSocket message parser/constructor. It is not a server and is not meant to
 be one. It can be used in any server, event loop etc.
 
+**Note:** this implementation is supporting only hixie -75 and -76 drafts. Current development of newer drafts are handled within [websocket-ruby](https://github.com/imanel/websocket-ruby) gem and if you are starting new project it will be best to use it instead of libwebsocket. However, if you are already using libwebsocket then you don't need to hurry with transition - this gem will use websocket-rack to support newer drafts.
+
 ## Server handshake
 
     h = LibWebSocket::OpeningHandshake::Server.new

data/examples/plain_client.rb

@@ -7,7 +7,7 @@ class WebSocket
     @hs ||= LibWebSocket::OpeningHandshake::Client.new(:url => url, :version => params[:version])
     @frame ||= LibWebSocket::Frame.new
 
-    @socket = TCPSocket.new(@hs.url.host, @hs.url.port || 80)
+    @socket = TCPSocket.new(@hs.controller.host, @hs.controller.port || 80)
 
     @socket.write(@hs.to_s)
     @socket.flush

data/lib/libwebsocket.rb

@@ -1,15 +1,10 @@
+require 'websocket'
 # Client/server WebSocket message and frame parser/constructor. This module does
 # not provide a WebSocket server or client, but is made for using in http servers
 # or clients to provide WebSocket support.
 module LibWebSocket
 
-  autoload :Cookie,        "#{File.dirname(__FILE__)}/libwebsocket/cookie"
   autoload :Frame,         "#{File.dirname(__FILE__)}/libwebsocket/frame"
   autoload :OpeningHandshake, "#{File.dirname(__FILE__)}/libwebsocket/opening_handshake"
-  autoload :Message,       "#{File.dirname(__FILE__)}/libwebsocket/message"
-  autoload :Request,       "#{File.dirname(__FILE__)}/libwebsocket/request"
-  autoload :Response,      "#{File.dirname(__FILE__)}/libwebsocket/response"
-  autoload :Stateful,      "#{File.dirname(__FILE__)}/libwebsocket/stateful"
-  autoload :URL,           "#{File.dirname(__FILE__)}/libwebsocket/url"
 
 end

data/lib/libwebsocket/opening_handshake.rb

@@ -5,23 +5,21 @@ module LibWebSocket
     autoload :Client, "#{File.dirname(__FILE__)}/opening_handshake/client"
     autoload :Server, "#{File.dirname(__FILE__)}/opening_handshake/server"
 
-    attr_accessor :secure, :error
+    extend Forwardable
 
-    # Convert all hash keys to instance variables.
-    def initialize(hash = {})
-      hash.each do |k,v|
-        instance_variable_set("@#{k}",v)
-      end
-    end
+    def_delegator :controller, :secure
+    def_delegator :controller, :error
+    def_delegator :controller, :to_s
+    def_delegator :controller, :finished?, :done?
 
-    # WebSocket request object.
-    def req
-      @req ||= Request.new
+    def controller
+      @controller
     end
 
-    # WebSocket response object.
-    def res
-      @res ||= Response.new
+    def parse(opts)
+      @controller << opts
+      return false if @controller.error
+      return true
     end
 
   end

data/lib/libwebsocket/opening_handshake/client.rb

@@ -34,94 +34,10 @@ module LibWebSocket
     #   h.done? # Returns true
     class Client < OpeningHandshake
 
-      attr_accessor :url
+      def_delegator :controller, :uri, :url
 
       def initialize(hash = {})
-        super
-
-        self.set_url(self.url) if self.url
-      end
-
-      # Set or get WebSocket url.
-      # @see LibWebSocket::URL#initialize
-      # @example
-      #   handshake.url = 'ws://example.com/demo'
-      def url=(val)
-        self.set_url(val)
-
-        return self
-      end
-
-      # Parse server response
-      # @example
-      #   h.parse \<<EOF
-      #   HTTP/1.1 101 WebSocket Protocol Handshake
-      #   Upgrade: WebSocket
-      #   Connection: Upgrade
-      #   Sec-WebSocket-Origin: http://example.com
-      #   Sec-WebSocket-Location: ws://example.com/demo
-      #
-      #   fQJ,fN/4F4!~K~MH
-      #   EOF
-      def parse(opts)
-        req = self.req
-        res = self.res
-
-        unless res.done?
-          unless res.parse(opts)
-            self.error = res.error
-            return
-          end
-
-          if res.done?
-            if req.version > 75 && req.checksum != res.checksum
-              self.error = 'Checksum is wrong.'
-              return
-            end
-          end
-        end
-
-        return true
-      end
-
-      # Check if response is correct
-      def done?
-        res.done?
-      end
-
-      # Create request
-      # @example
-      #   h.to_s # GET /demo HTTP/1.1
-      #          # Upgrade: WebSocket
-      #          # Connection: Upgrade
-      #          # Host: example.com
-      #          # Origin: http://example.com
-      #          # Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8
-      #          # Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0
-      #          #
-      #          # Tm[K T2u
-      def to_s
-        req.to_s
-      end
-
-      protected
-
-      def build_url
-        LibWebSocket::URL.new
-      end
-
-      def set_url(url)
-        @url = self.build_url.parse(url) unless url.is_a?(LibWebSocket::URL)
-
-        req = self.req
-
-        host = @url.host
-        host += ':' + @url.port if @url.port
-        req.host = host
-
-        req.resource_name = @url.resource_name
-
-        return self
+        @controller = ::WebSocket::Handshake::Client.new({:version => 76}.merge(hash))
       end
 
     end

data/lib/libwebsocket/opening_handshake/server.rb

@@ -34,79 +34,8 @@ module LibWebSocket
     #          # fQJ,fN/4F4!~K~MH
     class Server < OpeningHandshake
 
-      # Parse client request
-      # @example
-      #   h.parse \<<EOF
-      #   GET /demo HTTP/1.1
-      #   Upgrade: WebSocket
-      #   Connection: Upgrade
-      #   Host: example.com
-      #   Origin: http://example.com
-      #   Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8
-      #   Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0
-      #
-      #   Tm[K T2u
-      #   EOF
-      def parse(opts)
-        req = self.req
-        res = self.res
-
-        unless req.done?
-          unless req.parse(opts)
-            self.error = req.error
-            return
-          end
-
-          if req.done?
-            res.version = req.version
-            res.host = req.host
-
-            # res.secure = req.secure
-            res.resource_name = req.resource_name
-            res.origin = req.origin
-
-            if req.version > 75
-              res.number1 = req.number1
-              res.number2 = req.number2
-              res.challenge = req.challenge
-            end
-          end
-        end
-
-        return true
-      end
-
-      # Check if request is correct and done
-      def done?
-        req.done?
-      end
-
-      # Create response in string format
-      # @example
-      #   h.to_s # HTTP/1.1 101 WebSocket Protocol Handshake
-      #          # Upgrade: WebSocket
-      #          # Connection: Upgrade
-      #          # Sec-WebSocket-Origin: http://example.com
-      #          # Sec-WebSocket-Location: ws://example.com/demo
-      #          #
-      #          # fQJ,fN/4F4!~K~MH
-      def to_s
-        res.to_s
-      end
-
-      # Create response in rack format
-      # @example
-      #   h.to_rack # [ 101,
-      #             # {
-      #             #   'Upgrade'                => 'WebSocket'
-      #             #   'Connection'             => 'Upgrade'
-      #             #   'Sec-WebSocket-Origin'   => 'http://example.com'
-      #             #   'Sec-WebSocket-Location' => 'ws://example.com/demo'
-      #             #   'Content-Length'         => 16
-      #             # },
-      #             # [ 'fQJ,fN/4F4!~K~MH' ] ]
-      def to_rack
-        res.to_rack
+      def initialize(hash = {})
+        @controller = ::WebSocket::Handshake::Server.new({:version => 76}.merge(hash))
       end
 
     end

data/lib/libwebsocket/version.rb

@@ -1,3 +1,3 @@
 module LibWebSocket
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/libwebsocket.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{Universal Ruby library to handle WebSocket protocol}
   s.description = %q{Universal Ruby library to handle WebSocket protocol}
 
-  s.add_dependency 'addressable'
+  s.add_dependency 'websocket'
   s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")

data/test/libwebsocket/opening_handshake/test_client.rb

@@ -3,40 +3,25 @@ require 'test_helper'
 class TestServerOpeningHandshake < Test::Unit::TestCase
 
   def test_to_s
-    h = LibWebSocket::OpeningHandshake::Client.new
-    h.url = 'ws://example.com/demo?param=true&another=hello'
-
-    # Mocking
-    h.req.key1 = "18x 6]8vM;54 *(5:  {   U1]8  z [  8"
-    h.req.key2 = "1_ tx7X d  <  nw  334J702) 7]o}` 0"
-    h.req.challenge = "Tm[K T2u"
+    h = LibWebSocket::OpeningHandshake::Client.new(:url => 'ws://example.com/demo?param=true&another=hello')
 
     assert_equal h.to_s, "GET /demo?param=true&another=hello HTTP/1.1\x0d\x0a" +
       "Upgrade: WebSocket\x0d\x0a" +
       "Connection: Upgrade\x0d\x0a" +
       "Host: example.com\x0d\x0a" +
-      "Origin: http://example.com\x0d\x0a" +
-      "Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\x0d\x0a" +
-      "Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\x0d\x0a" +
-      "Content-Length: 8\x0d\x0a" +
-      "\x0d\x0aTm[K T2u"
+      "Sec-WebSocket-Key1: #{h.controller.key1}\x0d\x0a" +
+      "Sec-WebSocket-Key2: #{h.controller.key2}\x0d\x0a" +
+      "\x0d\x0a#{h.controller.key3}"
 
     h = LibWebSocket::OpeningHandshake::Client.new(:url => 'ws://example.com')
 
-    # Mocking
-    h.req.key1 = "18x 6]8vM;54 *(5:  {   U1]8  z [  8"
-    h.req.key2 = "1_ tx7X d  <  nw  334J702) 7]o}` 0"
-    h.req.challenge = "Tm[K T2u"
-
     assert_equal h.to_s, "GET / HTTP/1.1\x0d\x0a" +
       "Upgrade: WebSocket\x0d\x0a" +
       "Connection: Upgrade\x0d\x0a" +
       "Host: example.com\x0d\x0a" +
-      "Origin: http://example.com\x0d\x0a" +
-      "Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\x0d\x0a" +
-      "Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\x0d\x0a" +
-      "Content-Length: 8\x0d\x0a" +
-      "\x0d\x0aTm[K T2u"
+      "Sec-WebSocket-Key1: #{h.controller.key1}\x0d\x0a" +
+      "Sec-WebSocket-Key2: #{h.controller.key2}\x0d\x0a" +
+      "\x0d\x0a#{h.controller.key3}"
 
     assert !h.done?
     assert h.parse('')
@@ -56,9 +41,9 @@ class TestServerOpeningHandshake < Test::Unit::TestCase
     assert h.parse(message)
     assert !h.error
 
-    h = LibWebSocket::OpeningHandshake::Client.new
-    assert !h.parse("HTTP/1.0 foo bar\x0d\x0a")
-    assert_equal 'Wrong response line', h.error
+    h = LibWebSocket::OpeningHandshake::Client.new(:url => "ws://example.com")
+    assert !h.parse("HTTP/1.0 foo bar\x0d\x0a\x0d\x0a")
+    assert_equal :invalid_header, h.error
   end
 
 end

data/test/libwebsocket/opening_handshake/test_server.rb

@@ -32,8 +32,8 @@ class TestServerOpeningHandshake < Test::Unit::TestCase
     assert_nil h.error
 
     h = LibWebSocket::OpeningHandshake::Server.new
-    assert_nil h.parse("GET /demo\x0d\x0a")
-    assert_equal 'Wrong request line', h.error
+    h.parse("GET /demo\x0d\x0a\x0d\x0a")
+    assert_equal :invalid_header, h.error
   end
 
 end

metadata

@@ -1,60 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: libwebsocket
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
 platform: ruby
-authors: 
+authors:
 - Bernard Potocki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: addressable
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Universal Ruby library to handle WebSocket protocol
-email: 
+email:
 - bernard.potocki@imanel.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -63,84 +58,49 @@ files:
 - Rakefile
 - examples/eventmachine_server.rb
 - examples/plain_client.rb
-- examples/thin_server.rb
 - lib/libwebsocket.rb
-- lib/libwebsocket/cookie.rb
-- lib/libwebsocket/cookie/request.rb
-- lib/libwebsocket/cookie/response.rb
 - lib/libwebsocket/frame.rb
-- lib/libwebsocket/message.rb
 - lib/libwebsocket/opening_handshake.rb
 - lib/libwebsocket/opening_handshake/client.rb
 - lib/libwebsocket/opening_handshake/server.rb
-- lib/libwebsocket/request.rb
-- lib/libwebsocket/response.rb
-- lib/libwebsocket/stateful.rb
-- lib/libwebsocket/url.rb
 - lib/libwebsocket/version.rb
 - libwebsocket.gemspec
-- test/libwebsocket/cookie/request.rb
-- test/libwebsocket/cookie/response.rb
 - test/libwebsocket/opening_handshake/test_client.rb
 - test/libwebsocket/opening_handshake/test_server.rb
-- test/libwebsocket/test_cookie.rb
 - test/libwebsocket/test_frame.rb
-- test/libwebsocket/test_message.rb
-- test/libwebsocket/test_request_75.rb
-- test/libwebsocket/test_request_76.rb
-- test/libwebsocket/test_request_common.rb
-- test/libwebsocket/test_response_75.rb
-- test/libwebsocket/test_response_76.rb
-- test/libwebsocket/test_response_common.rb
-- test/libwebsocket/test_url.rb
 - test/test_helper.rb
 homepage: http://github.com/imanel/libwebsocket
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4506301570578533171
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -4506301570578533171
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Universal Ruby library to handle WebSocket protocol
-test_files: 
-- test/libwebsocket/cookie/request.rb
-- test/libwebsocket/cookie/response.rb
+test_files:
 - test/libwebsocket/opening_handshake/test_client.rb
 - test/libwebsocket/opening_handshake/test_server.rb
-- test/libwebsocket/test_cookie.rb
 - test/libwebsocket/test_frame.rb
-- test/libwebsocket/test_message.rb
-- test/libwebsocket/test_request_75.rb
-- test/libwebsocket/test_request_76.rb
-- test/libwebsocket/test_request_common.rb
-- test/libwebsocket/test_response_75.rb
-- test/libwebsocket/test_response_76.rb
-- test/libwebsocket/test_response_common.rb
-- test/libwebsocket/test_url.rb
 - test/test_helper.rb
-has_rdoc: