sockjs 0.2.1 → 0.3.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9ba7f7379bb54e6043eec61b16e3e88ee48d2f0
+  data.tar.gz: ec3beafcaf422d4d4641360dd8e0e2f3e4512f5b
+SHA512:
+  metadata.gz: b4aed2c1dfa3b3d00cecf86de2815a3a26914c96812132c786d55f00b4782ceffc108e0428310060ad7525e0809a8273dff252f4ef4b36db0f9b0273afa45fdb
+  data.tar.gz: ef0f4e03c5dbf912e5ae0988fb308ffa749e2857679cbd810048f7da05bd121ddedda54b60b8655ba786e2b1a1636cf588c57cfffeb53fc25c867949f07fe3f7

data/LICENCE

@@ -1,4 +1,4 @@
-Copyright (C) 2011 VMware, Inc.
+Copyright (C) 2011 Judson Lester and VMware, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.textile

@@ -1,16 +1,28 @@
 h1. About
 
 _*Disclaimer:* This library is still work in progress._
+(It is coming together though)
 
-SockJS is WebSocket emulation library. It means that you use the WebSocket API, only instead of @WebSocket@ class you instantiate @SockJS@ class. I highly recommend to read "SockJS: WebSocket emulation":http://www.rabbitmq.com/blog/2011/09/13/sockjs-websocket-emulation on the RabbitMQ blog for more info.
+SockJS is WebSocket emulation library. It means that you use the WebSocket API,
+only instead of @WebSocket@ class you instantiate @SockJS@ class. I highly
+recommend to read "SockJS: WebSocket
+emulation":http://www.rabbitmq.com/blog/2011/09/13/sockjs-websocket-emulation
+on the RabbitMQ blog for more info.
 
 h2. Prerequisites
 
-Even though this library uses Rack interface, *Thin is required* as "it supports asynchronous callback":http://macournoyer.com/blog/2009/06/04/pusher-and-async-with-thin. For Websockets, we use "faye-websocket":http://blog.jcoglan.com/2011/11/28/announcing-faye-websocket-a-standards-compliant-websocket-library gem.
+Even though this library uses Rack interface, *Thin is required* as "it
+supports asynchronous
+callback":http://macournoyer.com/blog/2009/06/04/pusher-and-async-with-thin.
+For Websockets, we use
+"faye-websocket":http://blog.jcoglan.com/2011/11/28/announcing-faye-websocket-a-standards-compliant-websocket-library
+gem.
 
 h2. The Client-Side Part
 
-For the client-side part you have to use JS library "sockjs-client":http://sockjs.github.com/sockjs-client which provides WebSocket-like API. Here's an example:
+For the client-side part you have to use JS library
+"sockjs-client":http://sockjs.github.com/sockjs-client which provides
+WebSocket-like API. Here's an example:
 
 <pre>
 <script src="http://cdn.sockjs.org/sockjs-0.2.1.min.js"></script>
@@ -116,3 +128,8 @@ h1. Links
 * "SockJS: WebSocket emulation":http://www.rabbitmq.com/blog/2011/09/13/sockjs-websocket-emulation
 * "SockJS: web messaging ain't easy":http://www.rabbitmq.com/blog/2011/08/22/sockjs-web-messaging-aint-easy
 * "PubSubHuddle Realtime Web talk":http://www.rabbitmq.com/blog/2011/09/26/pubsubhuddle-realtime-web-talk
+
+h1. Contributors
+
+* Judson Lester ( @nyarly )
+* Kacper Kawecki ( @kacperk )

data/lib/meta-state.rb

@@ -1,5 +1,3 @@
-
-
 module MetaState
   class Error < ::StandardError; end
   class WrongStateError < Error; end
@@ -71,9 +69,9 @@ module MetaState
         @void_state_module = Module.new do
           methods.each do |method|
             if NON_MESSAGES.include?(method)
-              define_method(method){}
+              define_method(method){|*args| }
             else
-              define_method(method) do
+              define_method(method) do |*args|
                 raise WrongStateError, "Message #{method} received in state #{current_state}"
               end
             end
@@ -134,6 +132,9 @@ module MetaState
       return true if target_state == current_state
       source_state = current_state
 
+      if target_state == SockJS::Session::Closed
+        debug{ caller }
+      end
       debug{ "Transitioning from #{source_state.inspect} to #{target_state.inspect}" }
 
       on_exit

data/lib/rack/sockjs.rb

@@ -47,7 +47,7 @@ module Rack
   class SockJS
     SERVER_SESSION_REGEXP = %r{/([^/]*)/([^/]*)}
     DEFAULT_OPTIONS = {
-      :sockjs_url => "http://cdn.sockjs.org/sockjs-#{::SockJS::PROTOCOL_VERSION}.min.js"
+      :sockjs_url => "http://cdn.sockjs.org/sockjs-#{::SockJS::PROTOCOL_VERSION_STRING}.min.js"
     }
 
 

data/lib/sockjs/faye.rb

@@ -2,14 +2,17 @@
 
 require "faye/websocket"
 
+if defined? Thin
+  Faye::WebSocket.load_adapter('thin')
+end
+if defined? Rainbows
+  Faye::WebSocket.load_adapter('rainbows')
+end
+if defined? Goliath
+  Faye::WebSocket.load_adapter('goliath')
+end
+
 class Thin::Request
   WEBSOCKET_RECEIVE_CALLBACK = 'websocket.receive_callback'.freeze
   GET = 'GET'.freeze
-
-  def websocket?
-    @env['REQUEST_METHOD'] == GET and
-    @env['HTTP_CONNECTION'] and
-    @env['HTTP_CONNECTION'].split(/\s*,\s*/).include?('Upgrade') and
-    ['WebSocket', 'websocket'].include?(@env['HTTP_UPGRADE'])
-  end
 end

data/lib/sockjs/protocol.rb

@@ -82,7 +82,7 @@ module SockJS
 
 
     class ClosingFrame < Frame
-      def initialize(status, message)
+      def initialize(status=1000, message="Normal closing")
         validate Integer, status
         validate String, message
 

data/lib/sockjs/servers/request.rb

@@ -109,6 +109,7 @@ module SockJS
     end
 
     def origin
+      return "*" if self.headers["origin"] == "null"
       self.headers["origin"] || "*"
     end
 

data/lib/sockjs/servers/response.rb

@@ -109,6 +109,7 @@ module SockJS
     def set_access_control(origin)
       self.set_header("Access-Control-Allow-Origin", origin)
       self.set_header("Access-Control-Allow-Credentials", "true")
+      self.set_header("Access-Control-Allow-Headers", "Content-Type Origin Accept X-Requested-With X-CSRF-Token If-Modified-Since If-None-Match Auth-User-Token Authorization Connection Cookie User-Agent")
     end
 
     def set_cache_control

data/lib/sockjs/session.rb

@@ -15,7 +15,13 @@ module SockJS
 
       #Close the *response* not the *session*
       def disconnect
-        @response.finish
+        #WEBSOCKET shouldn't have limit of data - faye will send closing frame
+        #after 1GB
+        if @transport.kind_of?(SockJS::Transports::WebSocket)
+          @total_sent_length = 0
+          return
+        end
+        @response.finish if @response.respond_to?(:finish)
       end
 
       def heartbeat
@@ -55,7 +61,9 @@ module SockJS
 
       def attach_consumer(response, transport)
         @consumer = Consumer.new(response, transport)
+        activate
         transition_to :attached
+        after_consumer_attached
       end
 
       def detach_consumer
@@ -63,6 +71,12 @@ module SockJS
         close(1002,"Connection interrupted")
       end
 
+      def activate
+      end
+
+      def suspended
+      end
+
       def send(*messages)
         @outbox += messages
       end
@@ -72,6 +86,10 @@ module SockJS
         @close_message = message
         transition_to(:closed)
       end
+
+      def set_heartbeat_timer
+        _set_heartbeat_timer
+      end
     end
 
     state :Attached do
@@ -91,6 +109,7 @@ module SockJS
 
       def detach_consumer
         transition_to :detached
+        after_consumer_detached
       end
 
       def send(*messages)
@@ -102,13 +121,72 @@ module SockJS
         @consumer.heartbeat
       end
 
-      def close(status = nil, message = nil)
+      def suspend
+        transition_to :suspended
+      end
+
+      def activate
+      end
+
+      def close(status = 1002, message = "Connection interrupted")
+        @close_status = status
+        @close_message = message
+        @consumer.closing(@close_status, @close_message)
+        @consumer = nil
+        transition_to(:closed)
+      end
+
+      def set_heartbeat_timer
+        _set_heartbeat_timer
+      end
+    end
+
+    state :Suspended do
+      def on_enter
+        SockJS.debug "Session suspended - it is on hold"
+        suspended
+      end
+
+      def attach_consumer(response, transport)
+        SockJS.debug "Session#attach_consumer: another connection still open"
+        transport.closing_frame(response, 2010, "Another connection still open")
+        close(1002, "Connection interrupted")
+      end
+
+      def detach_consumer
+        transition_to :detached
+        after_consumer_detached
+      end
+
+      def send(*messages)
+        @outbox += messages
+      end
+
+      def send_heartbeat
+        @consumer.heartbeat
+      end
+
+      def suspend
+      end
+
+      def activate
+        SockJS.debug "Session activated - is not on hold anymore!"
+        transition_to :attached
+        activated
+      end
+
+
+      def close(status = 1002, message = "Connection interrupted")
         @close_status = status
         @close_message = message
         @consumer.closing(@close_status, @close_message)
         @consumer = nil
         transition_to(:closed)
       end
+
+      def set_heartbeat_timer
+        _set_heartbeat_timer
+      end
     end
 
     state :Closed do
@@ -117,11 +195,28 @@ module SockJS
         @close_message ||= "Go away!"
         clear_all_timers
         set_close_timer
+        closed
+      end
+
+      def suspend
+        SockJS.debug "Session#suspend: connection closed!"
+      end
+
+      def activate
+        SockJS.debug "Session#activate: connection closed!"
       end
 
       def attach_consumer(response, transport)
         transport.closing_frame(response, @close_status, @close_message)
       end
+
+      def close(status=nil, message=nil)
+        #can be called from faye onclose hook
+      end
+
+      def set_heartbeat_timer
+        SockJS.debug "trying to setup heartbeat on closed session!"
+      end
     end
 
 
@@ -132,6 +227,7 @@ module SockJS
     # of json-encoded messages, depending on transport.
     def receive_message(data)
       clear_timer(:disconnect)
+      activate
 
       SockJS.debug "Session receiving message: #{data.inspect}"
       messages = parse_json(data)
@@ -151,6 +247,7 @@ module SockJS
       if @consumer.total_sent_length >= max_permitted_content_length
         SockJS.debug "Maximum content length exceeded, closing the connection."
 
+        #shouldn't be restarting connection?
         @consumer.disconnect
       else
         SockJS.debug "Permitted content length: #{@consumer.total_sent_length} of #{max_permitted_content_length}"
@@ -159,7 +256,7 @@ module SockJS
 
     def run_user_app
       unless @received_messages.empty?
-        reset_heartbeat_timer
+        reset_heartbeat_timer #XXX Only one point which can set heartbeat while state is closed
 
         SockJS.debug "Executing user's SockJS app"
 
@@ -188,6 +285,20 @@ module SockJS
     def after_app_run
     end
 
+    def closed
+    end
+
+    def activated
+    end
+
+    def suspended
+    end
+
+    def after_consumer_attached
+    end
+
+    def after_consumer_detached
+    end
 
     attr_accessor :disconnect_delay, :interval
     attr_reader :transport, :response, :outbox, :closing_frame, :data
@@ -231,7 +342,7 @@ module SockJS
       end
 
       JSON.parse("[#{data}]")[0]
-    rescue JSON::ParserError => error
+    rescue JSON::ParserError
       raise SockJS::InvalidJSON.new(500, "Broken JSON encoding.")
     end
 
@@ -250,17 +361,17 @@ module SockJS
     def disconnect_expired
       SockJS.debug "#{@disconnect_delay} has passed, firing @disconnect_timer"
       close
+      #XXX Shouldn't destroy the session?
     end
 
-    #XXX Remove?  What's this for?
     def check_response_alive
       if @consumer
         begin
           @consumer.check_alive
         rescue Exception => error
-          puts "==> "
+          puts "==> #{error.message}"
           SockJS.debug error
-          puts "==> "
+          puts "==> #{error.message}"
           on_close
           @alive_checker.cancel
         end
@@ -316,7 +427,7 @@ module SockJS
       set_alive_timer
     end
 
-    def set_heartbeat_timer
+    def _set_heartbeat_timer
       clear_timer(:disconnect)
       clear_timer(:alive)
       set_timer(:heartbeat, EM::PeriodicTimer, 25) do

data/lib/sockjs/transport.rb

@@ -127,7 +127,12 @@ module SockJS
       "#{payload}\n"
     end
 
+    #How is this used?
+    #Thread safety?
+    attr_reader :remote_addr, :http_origin
     def call(env)
+      @remote_addr = env["REMOTE_ADDR"]
+      @http_origin = env["HTTP_ORIGIN"]
       SockJS.debug "Request for #{self.class}: #{env["REQUEST_METHOD"]}/#{env["PATH_INFO"]}"
       request = ::SockJS::Request.new(env)
       EM.next_tick do

data/lib/sockjs/transports/htmlfile.rb

@@ -41,6 +41,10 @@ module SockJS
           raise SockJS::HttpError.new(500, '"callback" parameter required')
         end
 
+        if !!/[^a-zA-Z0-9\-_.]/.match(response.request.callback)
+          raise SockJS::HttpError.new(500, 'invalid "callback" parameter')
+        end
+
         super
       end
 

data/lib/sockjs/transports/iframe.rb

@@ -28,6 +28,7 @@ module SockJS
       EOB
 
       def setup_response(request, response)
+        SockJS.debug("body: #{@body.inspect}")
         response.status = 200
         response.set_header("ETag", self.etag)
         response.set_cache_control
@@ -49,7 +50,6 @@ module SockJS
       # Handler.
       def handle_request(request)
         if request.fresh?(etag)
-          SockJS.debug "Content hasn't been modified."
           response = build_response(request)
           response.status = 304
           response.finish

data/lib/sockjs/transports/websocket.rb

@@ -1,5 +1,12 @@
 # encoding: utf-8
 
+=begin
+#XXX
+#kacperk added this:
+def activate
+end# encoding: utf-8
+=end
+
 require "forwardable"
 require "sockjs/faye"
 require "sockjs/transport"
@@ -61,8 +68,10 @@ module SockJS
         if not @options[:websocket]
           raise HttpError.new(404, "WebSockets Are Disabled")
         elsif request.env["HTTP_UPGRADE"].to_s.downcase != "websocket"
+          SockJS.debug("Wrong headers! HTTP_UPGRADE = #{request.env["HTTP_UPGRADE"].to_s}")
           raise HttpError.new(400, 'Can "Upgrade" only to "WebSocket".')
         elsif not ["Upgrade", "keep-alive, Upgrade"].include?(request.env["HTTP_CONNECTION"])
+          SockJS.debug("Wrong headers! HTTP_CONNECTION = #{request.env["HTTP_CONNECTION"].to_s}")
           raise HttpError.new(400, '"Connection" must be "Upgrade".')
         end
 
@@ -85,16 +94,17 @@ module SockJS
 
       def process_session(session, web_socket)
         #XXX Facade around websocket?
-
-        web_socket.onopen = lambda do |event|
+        @session = session
+        web_socket.on :open do |event|
           begin
+            SockJS.debug "Attaching consumer"
             session.attach_consumer(web_socket, self)
           rescue Object => ex
             SockJS::debug "Error opening (#{event.inspect[0..40]}) websocket: #{ex.inspect}"
           end
         end
 
-        web_socket.onmessage = lambda do |event|
+        web_socket.on :message do |event|
           begin
             session.receive_message(extract_message(event))
           rescue Object => ex
@@ -103,11 +113,11 @@ module SockJS
           end
         end
 
-        web_socket.onclose = lambda do |event|
+        web_socket.on :close do |event|
           begin
-            session.close
+            session.close(1000, "Session finished")
           rescue Object => ex
-            SockJS::debug "Error closing websocket (#{event.inspect[0..40]}): #{ex.inspect}"
+            SockJS::debug "Error closing websocket (#{event.inspect[0..40]}): #{ex.inspect} \n#{ex.message} \n#{ex.backtrace.join("\n")}"
           end
         end
       end
@@ -122,6 +132,7 @@ module SockJS
       end
 
       def finish_response(web_socket)
+        SockJS.debug "Finishing response"
         web_socket.close
       end
 
@@ -129,11 +140,36 @@ module SockJS
         SockJS.debug "Received message event: #{event.data.inspect}"
         event.data
       end
+
+      def heartbeat_frame(web_socket)
+        @pong = true if @pong.nil?
+
+        #no replay from last connection - susspend session
+        if !@pong
+          @session.suspend if @session
+        end
+        @pong = false
+        web_socket.ping("ping") do
+          SockJS.debug "pong"
+          @pong = true
+          @session.activate
+        end
+        super
+      end
     end
 
     class RawWebSocket < WebSocket
       register 'GET', 'websocket'
 
+      def handle_request(request)
+        ver = request.env["sec-websocket-version"] || ""
+        unless ['8', '13'].include?(ver)
+          raise HttpError.new(400, 'Only supported WebSocket protocol is RFC 6455.')
+        end
+
+        super
+      end
+
       def self.routing_prefix
         "/" + self.prefix
       end

data/lib/sockjs/version.rb

@@ -2,12 +2,12 @@
 
 module SockJS
   # SockJS protocol version.
-  PROTOCOL_VERSION = [0, 2, 1]
+  PROTOCOL_VERSION = [0, 3, 4]
 
   PROTOCOL_VERSION_STRING = PROTOCOL_VERSION.join(".")
 
   # Patch version of the gem.
-  PATCH_VERSION = []
+  PATCH_VERSION = [0]
 
   GEM_VERSION = (PROTOCOL_VERSION + PATCH_VERSION).join(".")
 end

data/spec/sockjs/transport_spec.rb

@@ -40,7 +40,7 @@ describe SockJS::Transport do
   end
 
   let :session do
-    mock("Session")
+    double("Session")
   end
 
   describe "#format_frame(payload)" do

data/spec/spec_helper.rb

@@ -17,11 +17,11 @@ module TransportSpecMacros
     describe SockJS::Transport do
       describe "transports[#{path}]" do
         let :route_set do
-          mock("Route Set")
+          double("Route Set")
         end
 
         let :connection do
-          mock("Connection")
+          double("Connection")
         end
 
         let :options do
@@ -105,7 +105,7 @@ class SockJS::Response
 end
 
 RSpec.configure do |config|
-  config.backtrace_clean_patterns.delete(/gems/)
+  config.backtrace_exclusion_patterns.delete(/gems/)
   config.extend(TransportSpecMacros)
   config.before do
     class SockJS::Transport

metadata

@@ -1,100 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: sockjs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.4.0
 platform: ruby
 authors:
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &76745750 !ruby/object:Gem::Requirement
-    none: true
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76745750
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &76744510 !ruby/object:Gem::Requirement
-    none: true
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76744510
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &76743770 !ruby/object:Gem::Requirement
-    none: true
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76743770
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
-  requirement: &76742940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3
-        segments:
-        - 0
-        - 4
-        - 3
+        version: 0.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *76742940
-- !ruby/object:Gem::Dependency
-  name: regin
-  requirement: &76741840 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.8
-        segments:
-        - 0
-        - 3
-        - 8
-  type: :runtime
-  prerelease: false
-  version_requirements: *76741840
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rack-mount
-  requirement: &76761770 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.3
-        segments:
-        - 0
-        - 8
-        - 3
   type: :runtime
   prerelease: false
-  version_requirements: *76761770
-description: ! '    SockJS is a WebSocket emulation library. It means that you use
-  the WebSocket API, only instead of WebSocket class you instantiate SockJS class.
-  In absence of WebSocket, some of the fallback transports will be used. This code
-  is compatible with SockJS protocol 0.2.1.
-
-'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: |2
+      SockJS is a WebSocket emulation library. It means that you use the WebSocket API, only instead of WebSocket class you instantiate SockJS class. In absence of WebSocket, some of the fallback transports will be used. This code is compatible with SockJS protocol 0.3.4.
 email: nyarly@gmail.com
 executables: []
 extensions: []
@@ -143,29 +130,25 @@ files:
 - spec/support/async-test.rb
 homepage: https://github.com/nyarly/sockjs-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ~>
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1068506783
 requirements: []
 rubyforge_project: sockjs
-rubygems_version: 1.8.15
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby server for SockJS
 test_files: []