danthes 1.0.3 → 1.0.4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # d'Anthès
 
+## 1.0.4 (February 25 2013)
+
+* Added possibility to activate Faye's subscription later on subscribe call
+
+## 1.0.3 (September 26 2012)
+
+* Fix IE support
+
 ## 1.0.2 (September 7 2012)
 
 * Subscription callback through sign call

data/Gemfile

@@ -5,7 +5,7 @@ gem 'rake'
 gem 'faye-redis'
 gem 'guard'
 gem 'guard-coffeescript'
-gem 'jasmine', '1.2.0.rc3'
-gem 'rspec', '2.10.0'
-gem 'rspec-mocks', '2.10.0'
+gem 'jasmine', '1.3.0'
+gem 'rspec'
+gem 'rspec-mocks'
 gem 'webmock'

data/README.md

@@ -1,12 +1,12 @@
-# d'Anthès [![Build Status](https://secure.travis-ci.org/simonoff/danthes.png?branch=master)](http://travis-ci.org/simonoff/danthes)
+# d'Anthès [![Build Status](https://secure.travis-ci.org/phenomena/danthes.png?branch=master)](http://travis-ci.org/phenomena/danthes)
 
 d'Anthès is a Ruby gem for use with Rails to publish and subscribe to messages through [Faye](http://faye.jcoglan.com/). It allows you to easily provide real-time updates through an open socket without tying up a Rails process. All channels are private so users can only listen to events you subscribe them to. Based on PrivatePub gem.
 
 ## Docs
 
-[Ruby](http://rubydoc.info/github/simonoff/danthes/frames)
+[Ruby](http://rubydoc.info/github/phenomena/danthes/frames)
 
-[CoffeeScript](https://github.com/simonoff/danthes/wiki/CoffeeScript-documentation)
+[CoffeeScript](https://github.com/phenomena/danthes/wiki/CoffeeScript-documentation)
 
 ## Setup
 
@@ -146,7 +146,7 @@ The `publish_to` method will send a post request to the Faye server (using `Net:
 
 ## Development & Feedback
 
-Questions or comments? Please use the [issue tracker](https://github.com/simonoff/danthes/issues). Tests can be run with `bundle` and `rake` commands.
+Questions or comments? Please use the [issue tracker](https://github.com/phenomena/danthes/issues). Tests can be run with `bundle` and `rake` commands.
 
 ## TODO
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'rake'
 require 'rspec/core/rake_task'
+require 'yaml'
 require 'jasmine'
 require 'coffee-script'
 load 'jasmine/tasks/jasmine.rake'

data/app/assets/javascripts/danthes.js.coffee

@@ -10,16 +10,18 @@
 #     channel: 'somechannel'
 #     signature: 'dc1c71d3e959ebb6f49aa6af0c86304a0740088d'
 #     timestamp: 1302306682972
-#     callback: (data) ->
-#       console.log(data)
+#     connect: (subscription) ->
+#       console.log(subscription)
+#     error: (subscription, error) ->
+#       console.log("error: #{error}")
 
 window.Danthes = class Danthes
-  
-  @debug: false    
+
+  @debug: false
 
   @debugMessage: (message) ->
     console.log(message) if @debug
-  
+
   # Reset all
   @reset: ->
     @connecting = false
@@ -58,7 +60,7 @@ window.Danthes = class Danthes
       else
         @debugMessage 'faye already inited'
         @connectToFaye()
-  
+
   # Faye extension for incoming and outgoing messages
   @fayeExtension:
     incoming : (message, callback) =>
@@ -73,7 +75,7 @@ window.Danthes = class Danthes
         message.ext.danthes_signature = subscription.signature
         message.ext.danthes_timestamp = subscription.timestamp
       callback(message)
-  
+
   # Initialize Faye client
   @connectToFaye: ->
     if @server && Faye?
@@ -96,18 +98,28 @@ window.Danthes = class Danthes
       @subscriptions[channel]['callback'] = options['callback'] if options['callback']?
       @subscriptions[channel]['opts'] =
         signature: options['signature']
-        timestamp: options['timestamp']     
-      @faye (faye) =>
-        subscription = faye.subscribe channel, (message) => @handleResponse(message)
-        if subscription?
-          @subscriptions[channel]['sub'] = subscription
-          subscription.callback =>
-            options['connect']?(subscription)
-            @debugMessage "subscription for #{channel} is active now"
-          subscription.errback (error) =>
-            options['error']?(subscription, error)
-            @debugMessage "error for #{channel}: #{error.message}"
-  
+        timestamp: options['timestamp']
+      # If we have 'connect' or 'error' option then force channel activation
+      if options['connect']? || options['error']?
+        @activateChannel channel, options
+
+  # Activating channel subscription
+  # @param channel [String] channel name
+  # @param options [Object] subscription callback options
+  @activateChannel: (channel, options = {}) ->
+    return true if @subscriptions[channel]['activated']
+    @faye (faye) =>
+      subscription = faye.subscribe channel, (message) => @handleResponse(message)
+      if subscription?
+        @subscriptions[channel]['sub'] = subscription
+        subscription.callback =>
+          options['connect']?(subscription)
+          @debugMessage "subscription for #{channel} is active now"
+        subscription.errback (error) =>
+          options['error']?(subscription, error)
+          @debugMessage "error for #{channel}: #{error.message}"
+        @subscriptions[channel]['activated'] = true
+
   # Handle response from Faye
   # @param [Object] message from Faye
   @handleResponse: (message) ->
@@ -117,7 +129,7 @@ window.Danthes = class Danthes
     return unless @subscriptions[channel]?
     if callback = @subscriptions[channel]['callback']
       callback(message.data, channel)
-  
+
   # Disable transports
   # @param [String] name of transport
   @disableTransport: (transport) ->
@@ -126,29 +138,36 @@ window.Danthes = class Danthes
       @disables.push(transport)
       @debugMessage "#{transport} faye transport will be disabled"
     true
-  
+
   # Subscribe to channel with callback
   # @param channel [String] Channel name
   # @param callback [Function] Callback function
-  @subscribe: (channel, callback) ->
+  # @param options [Object] subscription callbacks options
+  @subscribe: (channel, callback, options = {}) ->
     @debugMessage "subscribing to #{channel}"
     if @subscriptions[channel]?
+      @activateChannel(channel, options)
       # Changing callback on every call
       @subscriptions[channel]['callback'] = callback
     else
       @debugMessage "Cannot subscribe on channel '#{channel}'. You need sign to channel first."
       return false
     true
-  
+
   # Unsubscribe from channel
   # @param [String] Channel name
-  @unsubscribe: (channel) ->
+  # @param [Boolean] Full unsubscribe
+  @unsubscribe: (channel, fullUnsubscribe = false) ->
     @debugMessage "unsubscribing from #{channel}"
-    if @subscriptions[channel]
+    if @subscriptions[channel] && @subscriptions[channel]['activated']
       @subscriptions[channel]['sub'].cancel()
-      delete @subscriptions[channel]
-  
-  # Unsubscribe from all channels 
+      if fullUnsubscribe
+        delete @subscriptions[channel]
+      else
+        delete @subscriptions[channel]['activated']
+        delete @subscriptions[channel]['sub']
+
+  # Unsubscribe from all channels
   @unsubscribeAll: ->
     @unsubscribe(channel) for channel, _ of @subscriptions
 

data/danthes.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.author      = ["Alexander Simonov"]
   s.email       = ["alex@simonov.me"]
-  s.homepage    = "http://github.com/simonoff/danthes"
+  s.homepage    = "http://github.com/phenomena/danthes"
   s.summary     = "Private pub/sub messaging through Faye."
   s.description = "Private pub/sub messaging in Rails through Faye. More Faye features supported. Based on PrivatePub."
   s.files         = `git ls-files`.split($\)

data/lib/danthes/version.rb

@@ -1,3 +1,3 @@
 module Danthes
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/lib/generators/templates/danthes.ru

@@ -1,4 +1,4 @@
-# Run with: rackup private_pub.ru -s thin -E production
+# Run with: rackup danthes.ru -s thin -E production
 require "bundler/setup"
 require "yaml"
 require "faye"

data/spec/coffeescripts/danthes_spec.js.coffee

@@ -1,22 +1,25 @@
 describe "Danthes", ->
   window.Faye = undefined
   pub = undefined
-  
-  signToChannel = (channel) ->
-    faye = {subscribe: jasmine.createSpy()}
+
+  signToChannel = (channel, addOptions = {}) ->
+    sub = {callback: jasmine.createSpy(), errback: jasmine.createSpy()}
+    faye = {subscribe: jasmine.createSpy().andReturn(sub)}
     spyOn(pub, 'faye').andCallFake (callback) ->
       callback(faye)
     options = {server: "server", channel: "#{channel}", timestamp: 1234567890, signature: '1234567890'}
+    options['connect'] = addOptions['connect'] if addOptions['connect']?
+    options['error'] = addOptions['error'] if addOptions['error']?
     pub.sign(options)
     return [faye, options]
-  
+
   beforeEach ->
     pub = window.Danthes
     pub.reset()
     script = document.getElementById('faye-connection-script')
     if script?
       script.parentNode.removeChild(script)
-  
+
   it "not adds a subscription callback without signing", ->
     expect(pub.subscribe("hello", "callback")).toBe(false)
     expect(pub.subscriptions).toEqual({})
@@ -73,13 +76,35 @@ describe "Danthes", ->
     expect(script).toBeDefined()
     expect(script.type).toEqual("text/javascript")
     expect(script.src).toMatch("path/to/faye/client.js")
-  
-  it "adds a faye subscription with response handler when signing", ->
+
+  it "adds a signed channel to subscribe later", ->
+    pub.fayeClient = 'string'
+    [faye, options] = signToChannel('somechannel')
+    expect(faye.subscribe).not.toHaveBeenCalled()
+    expect(pub.subscriptions.somechannel.activated).toBeUndefined()
+    expect(pub.subscriptions.somechannel).toBeDefined()
+    expect(pub.subscriptions.somechannel.opts.signature).toEqual('1234567890')
+    expect(pub.subscriptions.somechannel.opts.timestamp).toEqual(1234567890)
+    expect(pub.subscriptions.somechannel.activated).toBeUndefined()
+
+  it "adds a faye subscription with response handler when sign with connect option", ->
+    pub.fayeClient = 'string'
+    [faye, options] = signToChannel('somechannel', {'connect': jasmine.createSpy()})
+    expect(faye.subscribe).toHaveBeenCalled()
+    expect(pub.subscriptions.somechannel.activated).toBeDefined()
+
+  it "adds a faye subscription with response handler when sign with error option", ->
+    pub.fayeClient = 'string'
+    [faye, options] = signToChannel('somechannel', {'error': jasmine.createSpy()})
+    expect(faye.subscribe).toHaveBeenCalled()
+    expect(pub.subscriptions.somechannel.activated).toBeDefined()
+
+  it "adds a faye subscription with response handler when first time subscribing", ->
     pub.fayeClient = 'string'
     [faye, options] = signToChannel('somechannel')
+    pub.subscribe('somechannel', ->)
     expect(faye.subscribe).toHaveBeenCalled()
-    expect(pub.server).toEqual("server")
-    expect(pub.subscriptions.somechannel.opts).toEqual(timestamp: options['timestamp'], signature: options['signature'])
+    expect(pub.subscriptions.somechannel.activated).toBeDefined()
 
   it "connects to faye server, adds extension, and executes callbacks", ->
     callback = jasmine.createSpy()
@@ -95,20 +120,20 @@ describe "Danthes", ->
     expect(pub.fayeClient).toEqual(client)
     expect(client.addExtension).toHaveBeenCalledWith(pub.fayeExtension)
     expect(callback).toHaveBeenCalledWith(client)
-    
+
   it "adds transport to disables", ->
     expect(pub.disableTransport('websocket')).toBeTruthy()
     expect(pub.disables).toEqual(['websocket'])
-  
+
   it "adds transport to disables only one time", ->
     pub.disableTransport('websocket')
     pub.disableTransport('websocket')
     expect(pub.disables).toEqual(['websocket'])
-    
+
   it "returns false if not accepted transport wants to be disabled", ->
     expect(pub.disableTransport('websocket123')).toBeUndefined()
     expect(pub.disables).toEqual([])
-    
+
   it "connects to faye server, and executes disable once", ->
     callback = jasmine.createSpy()
     client = {addExtension: jasmine.createSpy(), disable: jasmine.createSpy()}
@@ -118,7 +143,7 @@ describe "Danthes", ->
     pub.disableTransport('websocket')
     pub.connectToFaye()
     expect(client.disable).toHaveBeenCalledWith('websocket')
-    
+
   it "connects to faye server, and executes disable once", ->
     callback = jasmine.createSpy()
     client = {addExtension: jasmine.createSpy(), disable: jasmine.createSpy()}
@@ -130,53 +155,57 @@ describe "Danthes", ->
     pub.connectToFaye()
     expect(client.disable).toHaveBeenCalledWith('websocket')
     expect(client.disable).toHaveBeenCalledWith('long-polling')
-    
+
   it "adds subscription faye object into channel object", ->
     sub = {callback: jasmine.createSpy(), errback: jasmine.createSpy()}
     pub.fayeClient = {subscribe: jasmine.createSpy().andReturn(sub)}
     options = {server: "server", channel: 'somechannel'}
     pub.sign(options)
+    pub.subscribe("somechannel", jasmine.createSpy())
     expect(sub.callback).toHaveBeenCalled()
     expect(sub.errback).toHaveBeenCalled()
     expect(pub.subscriptions.somechannel.sub).toEqual(sub)
-    
+
   it "adds subscription faye object into channel object and call connect callback after connection", ->
-    sub = 
-      callback: (f) -> 
+    sub =
+      callback: (f) ->
         f()
       errback: jasmine.createSpy()
     pub.fayeClient = {subscribe: jasmine.createSpy().andReturn(sub)}
-    options = {server: "server", channel: 'somechannel', connect: jasmine.createSpy()}
+    options = {server: "server", channel: 'somechannel'}
     pub.sign(options)
-    expect(options.connect).toHaveBeenCalledWith(sub)
-  
+    connectSpy = jasmine.createSpy()
+    pub.subscribe('somechannel', jasmine.createSpy(), connect: connectSpy)
+    expect(connectSpy).toHaveBeenCalledWith(sub)
+
   it "adds subscription faye object into channel object and call error callback after connection", ->
-    sub = 
+    sub =
       callback: jasmine.createSpy()
-      errback: (f) -> 
+      errback: (f) ->
         f('error')
     pub.fayeClient = {subscribe: jasmine.createSpy().andReturn(sub)}
-    options = {server: "server", channel: 'somechannel', error: jasmine.createSpy()}
+    erroSpy = jasmine.createSpy()
+    options = {server: "server", channel: 'somechannel'}
     pub.sign(options)
-    expect(options.error).toHaveBeenCalledWith(sub, 'error')
-        
+    pub.subscribe("somechannel", jasmine.createSpy(), error: erroSpy)
+    expect(erroSpy).toHaveBeenCalledWith(sub, 'error')
+
   it "removes subscription to the channel", ->
     sub = {callback: jasmine.createSpy(), errback: jasmine.createSpy(), cancel: jasmine.createSpy()}
     pub.fayeClient = {subscribe: jasmine.createSpy().andReturn(sub)}
     options = {server: "server", channel: 'somechannel'}
     pub.sign(options)
+    pub.subscribe('somechannel', jasmine.createSpy())
     pub.unsubscribe('somechannel')
     expect(sub.cancel).toHaveBeenCalled()
-    expect(pub.subscriptions.somechannel).toBeUndefined()
-    expect(pub.subscriptions).toEqual({})
-    
+    expect(pub.subscriptions.somechannel.sub).toBeUndefined()
+
   it "removes all subscription to the channels", ->
     sub = {callback: jasmine.createSpy(), errback: jasmine.createSpy(), cancel: jasmine.createSpy()}
     pub.fayeClient = {subscribe: jasmine.createSpy().andReturn(sub)}
     options = {server: "server", channel: 'somechannel'}
     pub.sign(options)
+    pub.subscribe "somechannel", jasmine.createSpy()
     pub.unsubscribeAll()
     expect(sub.cancel).toHaveBeenCalled()
-    expect(pub.subscriptions.somechannel).toBeUndefined()
-    expect(pub.subscriptions).toEqual({})
-    
+    expect(pub.subscriptions.somechannel.sub).toBeUndefined()

data/spec/javascripts/support/jasmine_config.rb

@@ -1,4 +1,5 @@
 module Jasmine
+  require 'yaml'
   class Config
 
     # Add your overrides or custom config code here

data/spec/javascripts/support/jasmine_runner.rb

@@ -1,6 +1,7 @@
 $:.unshift(ENV['JASMINE_GEM_PATH']) if ENV['JASMINE_GEM_PATH'] # for gem testing purposes
 
 require 'rubygems'
+require 'yaml'
 require 'jasmine'
 jasmine_config_overrides = File.expand_path(File.join(File.dirname(__FILE__), 'jasmine_config.rb'))
 require jasmine_config_overrides if File.exist?(jasmine_config_overrides)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danthes
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
@@ -67,7 +67,7 @@ files:
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
 - spec/spec_helper.rb
-homepage: http://github.com/simonoff/danthes
+homepage: http://github.com/phenomena/danthes
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -101,4 +101,3 @@ test_files:
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
 - spec/spec_helper.rb
-has_rdoc: