edmond-danthes 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c00bc2184b0c3d500760616b2ed8c1e09b77ecf73bec59e749b12e0478fcbc6c
+  data.tar.gz: 3826ce0b71a309ff0e2ac67cbee1b85f19c7a247234b49330b995f564943b5b7
+SHA512:
+  metadata.gz: 6b5638531601eab5c8b4ac24d3d632c3129fe825066aab4359eb874bd39058628170c5144249a5ab9300e99678fd21c3502bae08ac49928d5164bdc07ef25e68
+  data.tar.gz: 776e9f3c7c4dbfb42aeb758a86667cfdfc559ac394e8a11fbcc47dd04d5ecb45701d257947c0304127a9d343075bf0a2593a173c8c97fd90e3eb9b648df3046f

data/.gitignore

@@ -0,0 +1,10 @@
+*.swp
+**/*.swp
+**/*.log
+*.gem
+Gemfile.lock
+.bundle
+app/assets/javascripts/compiled
+spec/coffeescripts/compiled
+coverage
+.idea

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+Style/LineLength:
+  Max: 99
+Style/FileName:
+  Enabled: false
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 2.1.7
+  - 2.2.1
+  - 2.2.2
+  - 2.2.3
+  - rbx-2
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,84 @@
+# d'Anthès
+
+## 2.0.1 (March 20 2015)
+
+* Fix issue with websocket-driver >= 0.5.1
+
+## 2.0.0 (February 18 2015)
+
+* Added ERB support in redis configuration file
+* Fix generators for supporting only Rails 4.x
+* Fix config loading in Rails 4.x
+* Drop support of Rails 3.x
+
+## 1.0.5 (May 19 2014)
+
+* Added ERB support in configuration files
+
+## 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
+* On subscription connect callback
+* On subscription error callback
+* Transport disabling
+
+## 1.0.1 (August 26 2012)
+
+* Generator for redis config file
+* Fixes for rackup file
+* Fixes for full server url
+* CoffeeScript class documentation
+
+## 1.0 (August 25 2012)
+
+* initial release
+
+
+# PrivatePub
+
+## 1.0.0 (January 25, 2012)
+
+* Rails 3.2 compatibility with SecureRandom fix (thanks windigo) - issue #26
+
+## 1.0.0 (January 15, 2012)
+
+* setting config defaults to nil so everything must be set in `private_pub.yml`
+
+* Documentation improvements
+
+
+## 0.3.0 (January 14, 2012)
+
+* adding `PrivatePub.publish_to` method for publishing from anywhere - issue #15
+
+* rewriting `private_pub.js` so it is framework agnostic
+
+* Rails 3.1 compatibility (thanks BinaryMuse) - issue #25
+
+* adding faye gem dependency so it doesn't need to be installed separately
+
+* renaming `faye.ru` to `private_pub.ru`
+
+* truncate token for client for security (thanks jameshuynh) - issue #19
+
+
+## 0.2.0 (April 7, 2011)
+
+* switched to YAML file for config. BACKWARDS INCOMPATIBLE: you will need to remove config/initializers/private_pub.rb
+
+* moved view helpers into Railtie so helper file is no longer generated
+
+* error out when signature has expired
+
+
+## 0.1.0 (April 4, 2011)
+
+* initial release

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+gemspec
+
+gem 'faye-redis'
+
+group :development, :test do
+  gem 'rake'
+  gem 'guard'
+  gem 'guard-coffeescript'
+  gem 'jasmine', '>= 2.0.0'
+  gem 'rspec', '>= 3.0.0'
+  gem 'rspec-mocks', '>= 3.0.0'
+  gem 'webmock'
+  gem 'coveralls', require: false
+  gem 'rails'
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'coffeescript', output: 'app/assets/javascripts/compiled' do
+  watch /^app\/assets\/javascripts\/(.*)\.coffee/
+end
+
+guard 'coffeescript', output: 'spec/coffeescripts/compiled' do
+  watch /^spec\/coffeescripts\/(.*)\.coffee/
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Dmitry Zuev
+Copyright (c) 2012 Alexander Simonov
+Copyright (c) 2012 Ryan Bates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# d'Anthès [![Build Status](https://secure.travis-ci.org/dotpromo/danthes.png?branch=master)](http://travis-ci.org/dotpromo/danthes)[![Code Climate](https://codeclimate.com/github/dotpromo/danthes.png)](https://codeclimate.com/github/dotpromo/danthes)[![Coverage Status](https://coveralls.io/repos/dotpromo/danthes/badge.png?branch=master)](https://coveralls.io/r/dotpromo/danthes)
+
+This is a fork of [d'Anthès](https://github.com/amoniacou/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/dotpromo/danthes/frames)
+
+[CoffeeScript](https://github.com/dotpromo/danthes/wiki/CoffeeScript-documentation)
+
+## Setup
+
+Add the gem to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem 'edmond-danthes'
+```
+
+Run the generator to create the initial files.
+
+```
+rails g danthes:install
+```
+
+Next, start up Faye using the rackup file that was generated.
+
+```
+rackup danthes.ru -s thin -E production
+```
+
+**In Rails 3.1** add the JavaScript file to your application.js file manifest.
+
+```javascript
+//= require danthes
+```
+
+**NOTE**: On your local machine `secret_token` must be equal for all environments because danthes process working only in production mode.
+
+It's not necessary to include faye's connect.js since that will be handled automatically for you.
+
+## Serving Faye over HTTPS (with Thin)
+
+To serve Faye over HTTPS you could create a thin configuration file `config/danthes_thin.yml` similar to the following:
+
+```yaml
+---
+port: 4443
+ssl: true
+ssl_key_file: /path/to/server.pem
+ssl_cert_file: /path/to/certificate_chain.pem
+environment: production
+rackup: danthes.ru
+```
+
+The `certificate_chain.pem` file should contain your signed certificate, followed by intermediate certificates (if any) and the root certificate of the CA that signed the key.
+
+Next reconfigure the URL in `config/danthes.yml` to look like `https://your.hostname.com:4443/faye`
+
+Finally start up Thin from the project root.
+
+```
+thin -C config/danthes_thin.yml start
+```
+
+## Serving Faye with Redis engine
+
+Run the generator to create the initial redis config file.
+
+```
+rails g danthes:redis_install
+```
+
+## Usage
+
+Use the `subscribe_to` helper method on any page to subscribe to a channel.
+
+```rhtml
+<%= subscribe_to "/messages/new" %>
+```
+
+Use the `publish_to` helper method to send JavaScript to that channel. This is usually done in a JavaScript AJAX template (such as a create.js.erb file).
+
+```rhtml
+<% publish_to "/messages/new" do %>
+  $("#chat").append("<%= j render(@messages) %>");
+<% end %>
+```
+
+This JavaScript will be immediately evaluated on all clients who have subscribed to that channel. In this example they will see the new chat message appear in real-time without reloading the browser.
+
+
+## Alternative Usage
+
+If you prefer to work through JSON instead of `.js.erb` templates, you can pass a hash to `publish_to` instead of a block and it will be converted `to_json` behind the scenes. This can be done anywhere (such as the controller).
+
+```ruby
+Danthes.publish_to "/messages/new", :chat_message => "Hello, world!"
+```
+
+And then handle this through JavaScript on the client side.
+
+```javascript
+Danthes.subscribe("/messages/new", function(data, channel) {
+  $("#chat").append(data.chat_message);
+});
+```
+
+The Ruby `subscribe_to` helper call is still necessary with this approach to grant the user access to the channel. The JavaScript is just a callback for any custom behavior.
+
+## Debugging
+
+To enable debugging for faye connection process set `debug` to true before first `sign` call.
+
+``` javascript
+Danthes.debug = true
+```
+
+## Configuration
+
+The configuration is set separately for each environment in the generated `config/danthes.yml` file. Here are the options.
+
+* `server`: The URL to use for the Faye server such as `http://localhost:9292`.
+* `mount`: The mount path for Faye
+* `secret_token`: A secret hash to secure the server. Can be any string.
+* `signature_expiration`: The length of time in seconds before a subscription signature expires. If this is not set there is no expiration. Note: if Faye is on a separate server from the Rails app, the system clocks must be in sync for the expiration to work properly.
+* `adapter`: Adapter for the Rack application
+
+
+## How It Works
+
+The `subscribe_to` helper will output the following script which subscribes the user to a specific channel and server.
+
+```html
+<script type="text/javascript">
+  Danthes.sign({
+    channel: "/messages/new",
+    timestamp: 1302306682972,
+    signature: "dc1c71d3e959ebb6f49aa6af0c86304a0740088d",
+    server: "http://localhost:9292/faye"
+  });
+</script>
+```
+
+The signature and timestamp checked on the Faye server to ensure users are only able to access channels you subscribe them to. The signature will automatically expire after the time specified in the configuration.
+
+The `publish_to` method will send a post request to the Faye server (using `Net::HTTP`) instructing it to send the given data back to the browser.
+
+## Development & Feedback
+
+Questions or comments? Please use the [issue tracker](https://github.com/dotpromo/danthes/issues). Tests can be run with `bundle` and `rake` commands.
+
+## TODO
+
+- Add support for faye subscribe callbacks

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'yaml'
+require 'jasmine'
+require 'coffee-script'
+require 'bundler/gem_tasks'
+load 'jasmine/tasks/jasmine.rake'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task default: [:spec, 'compile_js', 'jasmine:ci']
+
+def compile_coffee_script(file, path)
+  source = File.read File.expand_path("#{path}/#{file}.coffee", __FILE__)
+  compiled_path = File.expand_path("#{path}/compiled/", __FILE__)
+  unless File.exist?(compiled_path) && File.directory?(compiled_path)
+    Dir.mkdir compiled_path
+  end
+  destination = File.open File.join(compiled_path, file), 'w+'
+  destination.write CoffeeScript.compile(source)
+end
+
+desc 'Compile coffeescript'
+task :compile_js do
+  compile_coffee_script('danthes.js', '../app/assets/javascripts')
+  compile_coffee_script('danthesSpec.js', '../spec/coffeescripts')
+end

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

@@ -0,0 +1,174 @@
+# Danthes Privat pub/sub Faye wrapper
+#
+# @example Howto enable debug
+#   Danthes.debug = true
+# @example reset all internal data
+#   Danthes.reset()
+# @example Howto sign and subscribe on channel with callback function
+#   Danthes.sign
+#     server: 'faye.example.com'
+#     channel: 'somechannel'
+#     signature: 'dc1c71d3e959ebb6f49aa6af0c86304a0740088d'
+#     timestamp: 1302306682972
+#     connect: (subscription) ->
+#       console.log(subscription)
+#     error: (subscription, error) ->
+#       console.log("error: #{error}")
+
+window.Danthes = class Danthes
+
+  @debug: false
+
+  @debugMessage: (message) ->
+    console.log(message) if @debug
+
+  # Reset all
+  @reset: ->
+    @connecting = false
+    @fayeClient = null
+    @fayeCallbacks = []
+    @subscriptions = {}
+    @server = null
+    @disables = []
+    @connectionSettings =
+      timeout: 120
+      retry: 5
+      endpoints: {}
+
+  # Connect to faye
+  @faye: (callback) =>
+    if @fayeClient?
+      callback(@fayeClient)
+    else
+      @fayeCallbacks.push(callback)
+      if @server && !@connecting
+        @connecting = true
+        unless Faye?
+          script = document.createElement 'script'
+          script.type = 'text/javascript'
+          script.src = "#{@server}/client.js"
+          script.id = "faye-connection-script"
+          complete = false
+          script.onload = script.onreadystatechange = () =>
+            if !complete && (!script.readyState || script.readyState is "loaded" || script.readyState is "complete")
+              complete = true
+              script.onload = script.onreadystatechange = null
+              @debugMessage 'connect to faye after script loaded'
+              @connectToFaye()
+          @debugMessage 'faye script init'
+          document.documentElement.appendChild script
+      else
+        @debugMessage 'faye already inited'
+        @connectToFaye()
+
+  # Faye extension for incoming and outgoing messages
+  @fayeExtension:
+    incoming : (message, callback) =>
+      @debugMessage "incomming message #{JSON.stringify(message)}"
+      callback(message)
+    outgoing : (message, callback) =>
+      @debugMessage "outgoing message #{JSON.stringify(message)}"
+      if message.channel == "/meta/subscribe"
+        subscription = @subscriptions[message.subscription]['opts']
+        # Attach the signature and timestamp to subscription messages
+        message.ext = {} unless message.ext?
+        message.ext.danthes_signature = subscription.signature
+        message.ext.danthes_timestamp = subscription.timestamp
+      callback(message)
+
+  # Initialize Faye client
+  @connectToFaye: ->
+    if @server && Faye?
+      @debugMessage 'trying to connect faye'
+      @fayeClient = new Faye.Client(@server, @connectionSettings)
+      @fayeClient.addExtension(@fayeExtension)
+      # Disable any features what we want
+      @fayeClient.disable(key) for key in @disables
+      @debugMessage 'faye connected'
+      callback(@fayeClient) for callback in @fayeCallbacks
+
+  # Sign to channel
+  # @param [Object] options for signing
+  @sign: (options) ->
+    @debugMessage 'sign to faye'
+    @server = options.server unless @server
+    channel = options.channel
+    unless @subscriptions[channel]?
+      @subscriptions[channel] = {}
+      @subscriptions[channel]['callback'] = options['callback'] if options['callback']?
+      @subscriptions[channel]['opts'] =
+        signature: options['signature']
+        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) ->
+    if message.eval
+      eval(message.eval)
+    channel = message.channel
+    return unless @subscriptions[channel]?
+    if callback = @subscriptions[channel]['callback']
+      callback(message.data, channel)
+
+  # Disable transports
+  # @param [String] name of transport
+  @disableTransport: (transport) ->
+    return unless transport in ['websocket', 'long-polling', 'callback-polling', 'in-process']
+    unless transport in @disables
+      @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
+  # @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
+  # @param [Boolean] Full unsubscribe
+  @unsubscribe: (channel, fullUnsubscribe = false) ->
+    @debugMessage "unsubscribing from #{channel}"
+    if @subscriptions[channel] && @subscriptions[channel]['activated']
+      @subscriptions[channel]['sub'].cancel()
+      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
+
+window.Danthes.reset()