litecable 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4640e78d6f9a77cf9257cb0774ff249ec1b5f699
+  data.tar.gz: a2cc894fc9e355baa79d82afde6682c570ddc21c
+SHA512:
+  metadata.gz: '0588bb0b62119753f79382bfe9955f7db54a693f2625c05426bcf08f131ed8b5b10fdb1e2bd0950545e030530ecfa823383c037747e654b43e7aa650db7187cb'
+  data.tar.gz: 6365980a8eece62d0d092349ed583afb1a04e749577f994da5da004dfe4576b64c07edc8744680eecda8f9637d726e6c878a0d50cd281c322070adb67c36df37

data/.gitignore

@@ -0,0 +1,40 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+*.iml
+.idea/
+
+# Sublime
+*.sublime-project
+*.sublime-workspace
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+Thumbs.db
+
+.bundle/
+log/*.log
+*.gz
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/tmp/
+
+Gemfile.lock
+Gemfile.local
+.rspec
+*.gem
+tmp/
+coverage/

data/.rubocop.yml

@@ -0,0 +1,63 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'bench/**/*'
+    - 'lib/anycable/rpc/**/*'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.3.3
+    - rvm: 2.4.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## master
+
+- Initial version. ([@palkan][])
+
+[@palkan]: https://github.com/palkan

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 palkan
+
+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,128 @@
+[![Gem Version](https://badge.fury.io/rb/litecable.svg)](https://rubygems.org/gems/litecable) [![Build Status](https://travis-ci.org/anycable/litecable.svg?branch=master)](https://travis-ci.org/anycable/litecable) [![Circle CI](https://circleci.com/gh/anycable/litecable/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycable/tree/master)
+
+# Lite Cable
+
+Lightweight ActionCable implementation.
+
+Contains application logic (channels, streams, broadcasting) and also (optional) Rack hijack based server (suitable only for development and test due to its simplicity).
+
+Compatible with [AnyCable](http://anycable.io) (for production usage).
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+## Examples
+
+- [Sinatra Lite Cable Chat](https://github.com/palkan/litecable/tree/master/examples/sinatra)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'litecable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install litecable
+
+## Usage
+
+Please, checkout [Action Cable guides](http://guides.rubyonrails.org/action_cable_overview.html) for general information. Lite Cable aims to be compatible with Action Cable as much as possible without the loss of simplicity and _ligthness_.
+
+You can use Action Cable javascript client without any change (precompiled version can be found [here](https://github.com/palkan/litecable/tree/master/examples/sinatra/assets/cable.js)).
+
+Here are the differences:
+
+- Use `LiteCable::Connection::Base` as a base class for your connection (instead of `ActionCable::Connection::Base`)
+
+- Use `LiteCable::Channel::Base` as a base class for your channels (instead of `ActionCable::Channel::Base`)
+
+- Use `LiteCable.broadcast` to broadcast messages (instead of `ActionCable.server.broadcast`)
+
+- Explicitly specify channels names:
+
+```ruby
+class MyChannel < LiteCable::Channel::Base
+  # Use this id in your client to create subscriptions
+  identifier :chat
+end
+```
+
+```js
+App.cable.subscriptions.create('chat', ...)
+```
+
+### Using built-in server (middleware)
+
+Lite Cable comes with a simple Rack middleware for development/testing usage.
+To use Lite Cable server:
+
+- Add `gem "websocket"` to your Gemfile
+
+- Add `require "lite_cable/server"`
+
+- Add `LiteCable::Server::Middleware` to your Rack stack, for example:
+
+```ruby
+Rack::Builder.new do
+  map '/cable' do
+    # You have to specify your app's connection class
+    use LiteCable::Server::Middleware, connection_class: App::Connection
+    run proc { |_| [200, { 'Content-Type' => 'text/plain' }, ['OK']] }
+  end
+end
+```
+
+### Using with AnyCable
+
+Lite Cable is AnyCable-compatible out-of-the-box. You should write a simple server script:
+
+```ruby
+#!/usr/bin/env ruby
+
+require "my_app"
+require "rack"
+require "anycable"
+
+# Turn AnyCable compatibility mode
+LiteCable.anycable!
+
+Anycable.configure do |config|
+  config.connection_factory = MyApp::Connection
+end
+
+Anycable::Server.start
+```
+
+And then run this script along with your application. See [Sinatra example](https://github.com/palkan/litecable/tree/master/examples/sinatra) for more.
+
+### Configuration
+
+Lite Cable uses [anyway_config](https://github.com/palkan/anyway_config) for configuration.
+
+See [config](https://github.com/palkan/litecable/blob/master/lib/lite_cable/config.rb) for available options.
+
+### Unsupported features
+
+- Channel callbacks (`after_subscribe`, etc)
+
+- Stream callbacks (`stream_from "xyz" { |msg| ... }`)
+
+- Periodical timers
+
+- Remote connections.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/litecable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "litecable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 2.3.0
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.11.2
+  

data/examples/sinatra/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'sinatra-contrib'
+gem 'slim'
+
+gem 'puma'
+
+gem 'pry-byebug'
+
+# litecable deps
+gem "anyway_config", "~>0.5.0"
+gem "websocket"
+
+# anycable
+gem "anycable", "~> 0.4.2"

data/examples/sinatra/Procfile

@@ -0,0 +1,3 @@
+web:  ANYCABLE=1 bundle exec puma
+rpc:  bundle exec ./anycable
+ws:   sleep 2 && ./bin/anycable-go -log -addr=localhost:9293

data/examples/sinatra/README.md

@@ -0,0 +1,33 @@
+# Lite Cable Sinatra Demo
+
+Sample chat application built with [Sinatra](http://www.sinatrarb.com) and Lite Cable.
+
+## Usage
+
+Install dependencies:
+
+```sh
+bundle install
+```
+
+Run server:
+
+```sh
+bundle exec puma
+```
+
+Open your browser at [localhost:9292](http://localhost:9292), enter your name and a chat room ID (anything you want).
+
+Then open another session (another browser, incognito window) and repeat all steps using the same room ID.
+
+Now you can chat with yourself!
+
+## AnyCable usage
+
+This example also can be used with [AnyCable](http://anycable.io).
+
+Just run `Procfile` with your favourite tool ([hivemind](https://github.com/DarthSim/hivemind) or [Foreman](http://ddollar.github.io/foreman/)):
+
+```sh
+hivemind
+```

data/examples/sinatra/anycable

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+lib = File.expand_path("../../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "./chat"
+require "rack"
+require "anycable"
+
+# Turn AnyCable compatibility mode
+LiteCable.anycable!
+
+Anycable.configure do |config|
+  config.connection_factory = Chat::Connection
+  config.debug = true
+end
+
+Anycable::Server.start

data/examples/sinatra/app.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "sinatra"
+require "sinatra/cookies"
+
+CABLE_URL = ENV['ANYCABLE'] ? "ws://localhost:9293/cable" : "/cable"
+
+class App < Sinatra::Application # :nodoc:
+  set :public_folder, 'assets'
+
+  enable :sessions
+  set :session_secret, 'my_secrets'
+
+  get '/' do
+    if session[:user]
+      slim :index
+    else
+      slim :login
+    end
+  end
+
+  get '/sign_in' do
+    slim :login
+  end
+
+  post '/sign_in' do
+    if params['user']
+      session[:user] = params['user']
+      cookies["user"] = params['user']
+      redirect '/'
+    else
+      slim :login
+    end
+  end
+
+  post '/rooms' do
+    if params['id']
+      redirect "/rooms/#{params['id']}"
+    else
+      slim :index
+    end
+  end
+
+  get '/rooms/:id' do
+    if session[:user]
+      @room_id = params['id']
+      @user = session[:user]
+      slim :room
+    else
+      slim :login
+    end
+  end
+end