faye 0.1.0

data/test/test_channel.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+require "faye"
+
+class TestChannel < Test::Unit::TestCase
+  include Faye
+  
+  def test_channel_storage
+    tree = Channel::Tree.new
+    tree['invalid/name']    = 1
+    tree['/valid/name']     = 2
+    tree['/va()$$lid/name'] = 3
+    
+    assert_equal nil, tree['invalid/name']
+    assert_equal 2,   tree['/valid/name']
+    assert_equal 3,   tree['/va()$$lid/name']
+  end
+  
+  def test_globbing
+    globber = Channel::Tree.new
+    globber['/foo/bar']     = 1
+    globber['/foo/boo']     = 2
+    globber['/foo']         = 3
+    globber['/foobar']      = 4
+    globber['/foo/bar/boo'] = 5
+    globber['/foobar/boo']  = 6
+    globber['/foo/*']       = 7
+    globber['/foo/**']      = 8
+    
+    assert_equal  [1,2,7,8],    globber.glob('/foo/*').sort
+    assert_equal  [1,7,8],      globber.glob('/foo/bar').sort
+    assert_equal  [1,2,5,7,8],  globber.glob('/foo/**').sort
+    assert_equal  [5,8],        globber.glob('/foo/bar/boo').sort
+  end
+end

data/test/test_grammar.rb

@@ -0,0 +1,86 @@
+require "test/unit"
+require "faye"
+
+class TestGrammar < Test::Unit::TestCase
+  include Faye::Grammar
+  
+  def test_single_chars
+    assert LOWALPHA =~ 'a'
+    assert LOWALPHA !~ 'A'
+    assert LOWALPHA !~ 'aa'
+    
+    assert UPALPHA !~ 'a'
+    assert UPALPHA =~ 'A'
+    assert UPALPHA !~ 'AA'
+    
+    assert ALPHA =~ 'a'
+    assert ALPHA =~ 'A'
+    assert ALPHA !~ '0'
+    assert ALPHA !~ 'aA'
+    
+    assert DIGIT =~ '0'
+    assert DIGIT !~ '90'
+    assert DIGIT !~ 'z'
+    
+    assert ALPHANUM =~ '6'
+    assert ALPHANUM =~ 'b'
+    assert ALPHANUM !~ '6b'
+    assert ALPHANUM !~ '/'
+    
+    assert MARK =~ '-'
+    assert MARK =~ '@'
+    assert MARK !~ '!-'
+  end
+  
+  def test_strings
+    assert STRING =~ ''
+    assert STRING =~ ' 4tv4 (($ !/~ ..* /) ___'
+    assert STRING !~ ' 4tv4 (($ !/~ ..* /) _}_'
+    
+    assert TOKEN =~ '$a9b'
+    assert TOKEN !~ ''
+    
+    assert INTEGER =~ '9'
+    assert INTEGER =~ '09'
+    assert INTEGER !~ '9.0'
+    assert INTEGER !~ '9a'
+  end
+  
+  def test_channels
+    assert CHANNEL_NAME =~ '/fo_o/$@()bar'
+    assert CHANNEL_NAME !~ '/foo/$@()bar/'
+    assert CHANNEL_NAME !~ 'foo/$@()bar'
+    assert CHANNEL_NAME !~ '/fo o/$@()bar'
+    
+    assert CHANNEL_PATTERN =~ '/!!/$/*'
+    assert CHANNEL_PATTERN =~ '/!!/$/**'
+    assert CHANNEL_PATTERN !~ '/!!/$/**/'
+    assert CHANNEL_PATTERN !~ '!!/$/**'
+    assert CHANNEL_PATTERN !~ '/!!/$/**/*'
+  end
+  
+  def test_version
+    assert VERSION =~ '9'
+    assert VERSION =~ '9.a-delta4'
+    assert VERSION !~ '9.a-delta4.'
+    assert VERSION !~ 'K.a-delta4'
+  end
+  
+  def test_ids
+    assert CLIENT_ID =~ '9'
+    assert CLIENT_ID =~ 'j'
+    assert CLIENT_ID !~ ''
+    assert CLIENT_ID =~ 'dfghs5r'
+    assert CLIENT_ID !~ 'dfg_hs5r'
+  end
+  
+  def test_errors
+    assert ERROR =~ '401::No client ID'
+    assert ERROR !~ '401:No client ID'
+    assert ERROR !~ '40::No client ID'
+    assert ERROR !~ '40k::No client ID'
+    assert ERROR =~ '402:xj3sjdsjdsjad:Unknown Client ID'
+    assert ERROR =~ '403:xj3sjdsjdsjad,/foo/bar:Subscription denied'
+    assert ERROR =~ '404:/foo/bar:Unknown Channel'
+  end
+end

data/test/test_server.rb

@@ -0,0 +1,420 @@
+require "test/unit"
+require "faye"
+
+class TestServer < Test::Unit::TestCase
+  include Faye
+  
+  def setup
+    @server = Server.new
+  end
+  
+  def get_client_id
+    handshake(  'version' => '1.0',
+                'supportedConnectionTypes' => %w[long-polling] )
+    @r['clientId']
+  end
+  
+  def method_missing(*args, &block)
+    @r = @server.__send__(*args, &block)
+  end
+  
+  def test_handshake
+    #================================================================
+    # MUST
+    handshake(  'version' => '1.0',
+                'supportedConnectionTypes' => %w[long-polling] )
+    # MAY include minimumVersion, ext, id
+    # SHOULD NOT send other messages with handshake
+    
+    # MUST
+    assert_equal  '/meta/handshake',                  @r['channel']
+    assert_not_equal  nil,                            @r['version']
+    assert_equal  %w[long-polling callback-polling],  @r['supportedConnectionTypes']
+    assert_match  /[a-z0-9]+/,                        @r['clientId']
+    assert_equal  true,                               @r['successful']
+    # MAY
+    assert_equal  nil,                                @r['id']
+    # MAY include minimumVersion, advice, ext, authSuccessful
+    
+    #================================================================
+    # Unique IDs
+    id1 = @r['clientId']
+    assert_equal [id1], @server.client_ids
+    handshake( 'version' => '1.0', 'supportedConnectionTypes' => %w[callback-polling] )
+    id2 = @r['clientId']
+    assert_not_equal id1, id2
+    assert_equal [id1, id2].sort, @server.client_ids.sort
+    
+    #================================================================
+    handshake(  'version' => '1.0',
+                'supportedConnectionTypes' => %w[long-polling],
+                'id' => 'foo' )
+    # MAY
+    assert_equal 'foo', @r['id']
+    
+    #================================================================
+    # missing version
+    handshake('supportedConnectionTypes' => %w[long-polling])
+    # MUST
+    assert_equal  '/meta/handshake',      @r['channel']
+    assert_equal  false,                  @r['successful']
+    assert_equal  '402:version:Missing required parameter', @r['error']
+    # MAY
+    assert_not_equal  nil,                            @r['version']
+    assert_equal  %w[long-polling callback-polling],  @r['supportedConnectionTypes']
+    # MAY include advice, minimumVersion, ext, id
+    
+    #================================================================
+    # no matching connection type
+    handshake('supportedConnectionTypes' => %w[iframe flash])
+    # MUST
+    assert_equal  '/meta/handshake',      @r['channel']
+    assert_equal  false,                  @r['successful']
+    assert_equal  '301:iframe,flash:Connection types not supported', @r['error']
+    # MAY
+    assert_equal  %w[long-polling callback-polling],  @r['supportedConnectionTypes']
+    assert_equal  nil,                    @r['id']
+    
+    #================================================================
+    # no given connection type
+    handshake('version' => '1.0', 'id' => 'foo')
+    # MUST
+    assert_equal  '/meta/handshake',      @r['channel']
+    assert_equal  false,                  @r['successful']
+    assert_equal  '402:supportedConnectionTypes:Missing required parameter', @r['error']
+    # MAY
+    assert_equal  %w[long-polling callback-polling],  @r['supportedConnectionTypes']
+    assert_equal  'foo',                  @r['id']
+  end
+  
+  def test_connect
+    @id = get_client_id
+    #================================================================
+    # MUST
+    connect(  'clientId'        => @id,
+              'connectionType'  => 'long-polling' )
+    # MUST
+    assert_equal  '/meta/connect',    @r['channel']
+    assert_equal  true,               @r['successful']
+    assert_equal  @id,                @r['clientId']
+    # MAY
+    assert_equal  nil,                @r['id']
+    # MAY include error, advice, ext, timestamp
+    
+    #================================================================
+    connect(  'clientId'        => @id,
+              'connectionType'  => 'long-polling',
+              'id'              => 'foo' )
+    # MUST
+    assert_equal  '/meta/connect',    @r['channel']
+    assert_equal  true,               @r['successful']
+    assert_equal  @id,                @r['clientId']
+    # MAY
+    assert_equal  'foo',              @r['id']
+    
+    #================================================================
+    # no client ID
+    connect(  'connectionType'  => 'long-polling' )
+    # MUST
+    assert_equal  '/meta/connect',    @r['channel']
+    assert_equal  false,              @r['successful']
+    assert_equal  nil,                @r['clientId']
+    # MAY
+    assert_equal  '402:clientId:Missing required parameter', @r['error']
+    assert_equal  nil,                @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # no connection type
+    connect(  'clientId'  => @id )
+    # MUST
+    assert_equal  '/meta/connect',    @r['channel']
+    assert_equal  false,              @r['successful']
+    assert_equal  nil,                @r['clientId']
+    # MAY
+    assert_equal  '402:connectionType:Missing required parameter', @r['error']
+    assert_equal  nil,                @r['id']
+    # MAY include advice, ext, timestamp
+  end
+  
+  def test_disconnect
+    @id = get_client_id
+    assert_equal  [@id], @server.client_ids
+    
+    #================================================================
+    # MUST
+    disconnect( 'clientId' => @id )
+    # MUST
+    assert_equal  '/meta/disconnect',   @r['channel']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  true,                 @r['successful']
+    # MAY
+    assert_equal  nil,                  @r['id']
+    # MAY include error, ext
+    assert_equal  [], @server.client_ids
+    
+    #================================================================
+    # missing client ID
+    disconnect( 'id' => 'foo' )
+    # MUST
+    assert_equal  '/meta/disconnect',   @r['channel']
+    assert_equal  nil,                  @r['clientId']
+    assert_equal  false,                @r['successful']
+    # MAY
+    assert_equal  '402:clientId:Missing required parameter', @r['error']
+    assert_equal  'foo',                @r['id']
+    # MAY include ext
+    
+    #================================================================
+    # unrecognised client ID
+    disconnect( 'clientId' => @id )
+    # MUST
+    assert_equal  '/meta/disconnect',   @r['channel']
+    assert_equal  nil,                  @r['clientId']
+    assert_equal  false,                @r['successful']
+    # MAY
+    assert_equal  "401:#{@id}:Unknown client", @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include ext
+  end
+  
+  def test_subscribe
+    @id = get_client_id
+    #================================================================
+    # MUST
+    subscribe(  'clientId'      => @id,
+                'subscription'  => '/foo' )     # channel name
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  true,                 @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/foo'],             @r['subscription']
+    # MAY
+    assert_equal  nil,                  @r['id']
+    # MAY include error, advice, ext, timestamp
+    
+    #================================================================
+    # MUST
+    subscribe(  'clientId'      => @id,
+                'subscription'  => '/foo/**' )  # channel pattern
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  true,                 @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/foo/**'],          @r['subscription']
+    # MAY
+    assert_equal  nil,                  @r['id']
+    # MAY include error, advice, ext, timestamp
+    
+    #================================================================
+    # MUST
+    subscribe(  'clientId'      => @id,
+                'subscription'  => ['/bar/*', '/foo'],  # channel list
+                'id'            => 'baz' )
+    # MAY include ext
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  true,                 @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/bar/*', '/foo'],   @r['subscription']
+    # MAY
+    assert_equal  'baz',                @r['id']
+    # MAY include error, advice, ext, timestamp
+    
+    #================================================================
+    # missing client ID
+    subscribe(  'subscription'  => '/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  nil,                  @r['clientId']
+    assert_equal  ['/foo'],             @r['subscription']
+    # MAY
+    assert_equal  '402:clientId:Missing required parameter', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # unknown client
+    subscribe(  'clientId'      => 'nonesuch',
+                'subscription'  => '/j' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  'nonesuch',           @r['clientId']
+    assert_equal  ['/j'],               @r['subscription']
+    # MAY
+    assert_equal  '401:nonesuch:Unknown client', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # missing subscription
+    subscribe(  'clientId'  => @id )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  [],                   @r['subscription']
+    # MAY
+    assert_equal  '402:subscription:Missing required parameter', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # invalid channel
+    subscribe(  'clientId'      => @id,
+                'subscription'  => '/not/**/valid' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/not/**/valid'],    @r['subscription']
+    # MAY
+    assert_equal  "405:/not/**/valid:Invalid channel", @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # cannot subscribe to meta channels
+    subscribe(  'clientId'      => @id,
+                'subscription'  => '/meta/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/meta/foo'],        @r['subscription']
+    # MAY
+    assert_equal  "403:/meta/foo:Forbidden channel", @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # cannot subscribe to service channels
+    subscribe(  'clientId'      => @id,
+                'subscription'  => '/service/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/subscribe',    @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/service/foo'],     @r['subscription']
+    # MAY
+    assert_equal  "403:/service/foo:Forbidden channel", @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+  end
+  
+  def test_unsubscribe
+    @id = get_client_id
+    subscribe( 'clientId' => @id, 'subscription' => '/foo' )
+    
+    #================================================================
+    # MUST
+    unsubscribe(  'clientId'      => @id,
+                  'subscription'  => '/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/unsubscribe',  @r['channel']
+    assert_equal  true,                 @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/foo'],             @r['subscription']
+    # MAY
+    assert_equal  nil,                  @r['id']
+    # MAY include error, advice, ext, timestamp
+    
+    #================================================================
+    # missing client ID
+    unsubscribe(  'subscription'  => '/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/unsubscribe',  @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  nil,                  @r['clientId']
+    assert_equal  ['/foo'],             @r['subscription']
+    # MAY
+    assert_equal  '402:clientId:Missing required parameter', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # unknown client
+    unsubscribe(  'clientId'      => 'matz',
+                  'subscription'  => '/foo' )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/unsubscribe',  @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  'matz',               @r['clientId']
+    assert_equal  ['/foo'],             @r['subscription']
+    # MAY
+    assert_equal  '401:matz:Unknown client', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # missing subscription
+    unsubscribe(  'clientId' => @id )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/unsubscribe',  @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  [],                   @r['subscription']
+    # MAY
+    assert_equal  '402:subscription:Missing required parameter', @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+    
+    #================================================================
+    # invalid channel
+    unsubscribe(  'clientId'      => @id,
+                  'subscription'  => '/not/**/valid'  )
+    # MAY include ext, id
+    
+    # MUST
+    assert_equal  '/meta/unsubscribe',  @r['channel']
+    assert_equal  false,                @r['successful']
+    assert_equal  @id,                  @r['clientId']
+    assert_equal  ['/not/**/valid'],    @r['subscription']
+    # MAY
+    assert_equal  "405:/not/**/valid:Invalid channel", @r['error']
+    assert_equal  nil,                  @r['id']
+    # MAY include advice, ext, timestamp
+  end
+  
+  def test_advice
+    handle( 'channel' => '/meta/subscribe', 'subscription' => '/foo', 'clientId' => 'fake' ) do |r|
+      assert_equal  '401:fake:Unknown client', r['error']
+      assert_equal  'handshake',      r['advice']['reconnect']
+      assert_equal  1000,             r['advice']['interval']
+    end
+    
+    id = get_client_id
+    handle( 'channel' => '/meta/subscribe', 'subscription' => '/foo', 'clientId' => id ) do |r|
+      assert_equal  true,             r['successful']
+      assert_equal  'retry',          r['advice']['reconnect']
+      assert_equal  1000,             r['advice']['interval']
+    end
+  end
+end