https://github.com/ngauthier/tubesock

Websocket interface on Rack Hijack w/ Rails support
https://github.com/ngauthier/tubesock

Last synced: 2 months ago
JSON representation

Websocket interface on Rack Hijack w/ Rails support

• Host: GitHub
• URL: https://github.com/ngauthier/tubesock
• Owner: ngauthier
• License: mit
• Created: 2013-03-12T20:18:21.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2019-09-18T14:17:47.000Z (over 5 years ago)
• Last Synced: 2024-10-18T18:58:22.644Z (3 months ago)
• Language: Ruby
• Size: 58.6 KB
• Stars: 622
• Watchers: 18
• Forks: 43
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ruby-toolbox - tubesock - Websocket interface on Rack Hijack w/ Rails support (Web Apps, Services & Interaction / HTTP Pub/Sub)

README

        
# Tubesock - !! This gem is no longer updated. We recommend you use Rails's built-in [ActionCable](https://guides.rubyonrails.org/action_cable_overview.html) !!

[![Build Status](https://travis-ci.org/ngauthier/tubesock.png)](https://travis-ci.org/ngauthier/tubesock) [![Code Climate](https://codeclimate.com/github/ngauthier/tubesock.png)](https://codeclimate.com/github/ngauthier/tubesock)

Tubesock lets you use websockets from rack and rails 4+ by using Rack's new hijack interface to access the underlying socket connection.

In contrast to other websocket libraries, Tubesock does not use a reactor (read: no eventmachine). Instead, it leverages Rails 4's new full-stack concurrency support. Note that this means you must use a concurrent server. We recommend Puma > 2.0.0.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'tubesock'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install tubesock

## Usage

### Rack

To use Tubesock with rack, you need to hijack the rack environment and then return an asynchronous response. For example:

```ruby

require 'tubesock'

class Server

  def call(env)

    if env["HTTP_UPGRADE"] == 'websocket'

      tubesock = Tubesock.hijack(env)

      tubesock.onmessage do |message|

        puts "Got #{message}"

      end

      tubesock.listen

      [ -1, {}, [] ]

    else

      [404, {'Content-Type' => 'text/plain'}, ['Not Found']]

    end

  end

end

```

Then you could do the following in your config.ru file to use this class:

```ruby

run Server.new

```

### Rails 4+

On Rails 4 there is a module you can use called `Tubesock::Hijack`. In a controller:

```ruby

class ChatController < ApplicationController

  include Tubesock::Hijack

  def chat

    hijack do |tubesock|

      tubesock.onopen do

        tubesock.send_data "Hello, friend"

      end

      tubesock.onmessage do |data|

        tubesock.send_data "You said: #{data}"

      end

    end

  end

end

```

## Contributing

1. Fork it

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 new Pull Request