actioncable 0.0.0 → 5.0.0.beta1

data/lib/assets/javascripts/action_cable/subscriptions.coffee

@@ -0,0 +1,78 @@
+# Collection class for creating (and internally managing) channel subscriptions. The only method intended to be triggered by the user
+# us ActionCable.Subscriptions#create, and it should be called through the consumer like so:
+#
+#   @App = {}
+#   App.cable = ActionCable.createConsumer "ws://example.com/accounts/1"
+#   App.appearance = App.cable.subscriptions.create "AppearanceChannel"
+#
+# For more details on how you'd configure an actual channel subscription, see ActionCable.Subscription.
+class ActionCable.Subscriptions
+  constructor: (@consumer) ->
+    @subscriptions = []
+    @history = []
+
+  create: (channelName, mixin) ->
+    channel = channelName
+    params = if typeof channel is "object" then channel else {channel}
+    new ActionCable.Subscription this, params, mixin
+
+  # Private
+
+  add: (subscription) ->
+    @subscriptions.push(subscription)
+    @notify(subscription, "initialized")
+    @sendCommand(subscription, "subscribe")
+
+  remove: (subscription) ->
+    @forget(subscription)
+
+    unless @findAll(subscription.identifier).length
+      @sendCommand(subscription, "unsubscribe")
+
+  reject: (identifier) ->
+    for subscription in @findAll(identifier)
+      @forget(subscription)
+      @notify(subscription, "rejected")
+
+  forget: (subscription) ->
+    @subscriptions = (s for s in @subscriptions when s isnt subscription)
+
+  findAll: (identifier) ->
+    s for s in @subscriptions when s.identifier is identifier
+
+  reload: ->
+    for subscription in @subscriptions
+      @sendCommand(subscription, "subscribe")
+
+  notifyAll: (callbackName, args...) ->
+    for subscription in @subscriptions
+      @notify(subscription, callbackName, args...)
+
+  notify: (subscription, callbackName, args...) ->
+    if typeof subscription is "string"
+      subscriptions = @findAll(subscription)
+    else
+      subscriptions = [subscription]
+
+    for subscription in subscriptions
+      subscription[callbackName]?(args...)
+
+      if callbackName in ["initialized", "connected", "disconnected", "rejected"]
+        {identifier} = subscription
+        @record(notification: {identifier, callbackName, args})
+
+  sendCommand: (subscription, command) ->
+    {identifier} = subscription
+    if identifier is ActionCable.INTERNAL.identifiers.ping
+      @consumer.connection.isOpen()
+    else
+      @consumer.send({command, identifier})
+
+  record: (data) ->
+    data.time = new Date()
+    @history = @history.slice(-19)
+    @history.push(data)
+
+  toJSON: ->
+    history: @history
+    identifiers: (subscription.identifier for subscription in @subscriptions)

data/lib/rails/generators/channel/USAGE

@@ -0,0 +1,14 @@
+Description:
+============
+    Stubs out a new cable channel for the server (in Ruby) and client (in CoffeeScript).
+    Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
+
+    Note: Turn on the cable connection in app/assets/javascript/cable.coffee after generating any channels.
+
+Example:
+========
+    rails generate channel Chat speak
+
+    creates a Chat channel class and CoffeeScript asset:
+        Channel:    app/channels/chat_channel.rb
+        Assets:     app/assets/javascript/channels/chat.coffee

data/lib/rails/generators/channel/channel_generator.rb

@@ -0,0 +1,21 @@
+module Rails
+  module Generators
+    class ChannelGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      check_class_collision suffix: "Channel"
+
+      def create_channel_file
+        template "channel.rb", File.join('app/channels', class_path, "#{file_name}_channel.rb")
+        template "assets/channel.coffee", File.join('app/assets/javascripts/channels', class_path, "#{file_name}.coffee")
+      end
+
+      protected
+        def file_name
+          @_file_name ||= super.gsub(/\_channel/i, '')
+        end
+    end
+  end
+end

data/lib/rails/generators/channel/templates/assets/channel.coffee

@@ -0,0 +1,14 @@
+App.<%= class_name.underscore %> = App.cable.subscriptions.create "<%= class_name %>Channel",
+  connected: ->
+    # Called when the subscription is ready for use on the server
+
+  disconnected: ->
+    # Called when the subscription has been terminated by the server
+
+  received: (data) ->
+    # Called when there's incoming data on the websocket for this channel
+<% actions.each do |action| -%>
+
+  <%= action %>: ->
+    @perform '<%= action %>'
+<% end -%>

data/lib/rails/generators/channel/templates/channel.rb

@@ -0,0 +1,17 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in an EventMachine loop that does not support auto reloading.
+<% module_namespacing do -%>
+class <%= class_name %>Channel < ApplicationCable::Channel
+  def subscribed
+    # stream_from "some_channel"
+  end
+
+  def unsubscribed
+    # Any cleanup needed when channel is unsubscribed
+  end
+<% actions.each do |action| -%>
+
+  def <%= action %>
+  end
+<% end -%>
+end
+<% end -%>

metadata

@@ -1,61 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 5.0.0.beta1
 platform: ruby
 authors:
-- claudiob
+- Pratik Naik
+- David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
+        version: 4.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 0.10.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: This is Action Cable.
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.2
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Structure many real-time application concerns into channels over a single
+  WebSocket connection.
 email:
-- claudiob@gmail.com
+- pratiknaik@gmail.com
+- david@loudthinking.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
+- CHANGELOG.md
+- MIT-LICENSE
 - README.md
-- Rakefile
-- actioncable.gemspec
-- bin/console
-- bin/setup
 - lib/action_cable.rb
+- lib/action_cable/channel.rb
+- lib/action_cable/channel/base.rb
+- lib/action_cable/channel/broadcasting.rb
+- lib/action_cable/channel/callbacks.rb
+- lib/action_cable/channel/naming.rb
+- lib/action_cable/channel/periodic_timers.rb
+- lib/action_cable/channel/streams.rb
+- lib/action_cable/connection.rb
+- lib/action_cable/connection/authorization.rb
+- lib/action_cable/connection/base.rb
+- lib/action_cable/connection/identification.rb
+- lib/action_cable/connection/internal_channel.rb
+- lib/action_cable/connection/message_buffer.rb
+- lib/action_cable/connection/subscriptions.rb
+- lib/action_cable/connection/tagged_logger_proxy.rb
+- lib/action_cable/connection/web_socket.rb
+- lib/action_cable/engine.rb
+- lib/action_cable/gem_version.rb
+- lib/action_cable/helpers/action_cable_helper.rb
+- lib/action_cable/process/logging.rb
+- lib/action_cable/remote_connections.rb
+- lib/action_cable/server.rb
+- lib/action_cable/server/base.rb
+- lib/action_cable/server/broadcasting.rb
+- lib/action_cable/server/configuration.rb
+- lib/action_cable/server/connections.rb
+- lib/action_cable/server/worker.rb
+- lib/action_cable/server/worker/active_record_connection_management.rb
 - lib/action_cable/version.rb
-homepage: https://github.com/rails/actioncable
+- lib/assets/javascripts/action_cable.coffee.erb
+- lib/assets/javascripts/action_cable/connection.coffee
+- lib/assets/javascripts/action_cable/connection_monitor.coffee
+- lib/assets/javascripts/action_cable/consumer.coffee
+- lib/assets/javascripts/action_cable/subscription.coffee
+- lib/assets/javascripts/action_cable/subscriptions.coffee
+- lib/rails/generators/channel/USAGE
+- lib/rails/generators/channel/channel_generator.rb
+- lib/rails/generators/channel/templates/assets/channel.coffee
+- lib/rails/generators/channel/templates/channel.rb
+homepage: http://rubyonrails.org
 licenses:
 - MIT
 metadata: {}
@@ -67,16 +201,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Action Cable.
+summary: WebSocket framework for Rails.
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in actioncable.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 claudiob
-
-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/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-

data/actioncable.gemspec

@@ -1,22 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'action_cable/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "actioncable"
-  spec.version       = ActionCable::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
-  spec.summary       = %q{Action Cable.}
-  spec.description   = %q{This is Action Cable.}
-  spec.homepage      = "https://github.com/rails/actioncable"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-end