Opal wrapper for rails actioncable
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 14 commits ahead of merongivian:master.
Latest commit 4959503 Jun 10, 2017
Permalink
Failed to load latest commit information.
bin first Dec 15, 2015
lib Bump to 0.2.3 Jun 10, 2017
opal Fix constant lookup Jun 10, 2017
test first Dec 15, 2015
.gitignore first Dec 15, 2015
.travis.yml first Dec 15, 2015
Gemfile first Dec 15, 2015
README.md Enable syntax highlighting in the README Jun 11, 2016
Rakefile first Dec 15, 2015
opal-actioncable.gemspec js order Jun 3, 2016

README.md

Opal::Actioncable

Bring ActionCable support to Opal.

Installation

Add this line to your application's Gemfile:

gem 'opal-actioncable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install opal-actioncable

Usage

# assets/javascript/application.rb
require 'opal-actioncable'

class TestChannel < ActionCable::Subscription
  def connected
    perform 'send', {data: 23}
  end

  def disconnected
  end

  def received data
  end
end

consumer = ActionCable.createConsumer
consumer.subscriptions.create TestChannel

# or

ChatChannel =  TestChannel
consumer.subscriptions.create ChatChannel, {channel: 'Chat', room: 'default'}

Skip client-side dispatching

If you send your messages in the format {action: ..., data: ...}

ActionCable.server.broadcast "channel", {action: 'action_name', data: {some: 'data'}}

And if action and data are the only keys in your hash, you can catch it on client side like this:

class TestChannel < ActionCable::Subscription
  def action_name params
    puts params # > {some: 'data'}
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/MichaelSp/opal-actioncable/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request