async_cable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a73611b6db5ff3e6f0377115d65a02dc9ce18f5
+  data.tar.gz: a8982f7401992a3ef2ec0dd6bbb6f10309161682
+SHA512:
+  metadata.gz: 93f951f2178542ba41962a862e59f1ab0fefffdb2528ffbf785923e654363dd78ae550aff6872c3f525cdaf0706f1666b5a295d14a5445884c9512abd2247ade
+  data.tar.gz: 598bd856f068b973db1339651e39089c08b28029734816bf3d13e7060cee3c868655832c682758e2cfb3ab2ff274a20177c00c5919818e70f99d06b291011960

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+### 0.1.0
+* initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at senid231@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in async_cable.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Denis Talakevich
+
+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,106 @@
+# AsyncCable
+
+Very simple but functional websocket server for Rack async application.
+
+* Works on Fibers via [async](https://github.com/socketry/async).
+* Threadsafe
+* Supports broadcasting.
+* Works with [Falcon web server](https://github.com/socketry/falcon).
+* Supports authorization with cookies/header.
+
+Intended to use with [Falcon web server](https://github.com/socketry/falcon) or other web server based on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async_cable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install async_cable
+
+## Usage
+
+```ruby
+# config.ru
+require_relative 'lib/main_cable' 
+app = RackBuilder.new do
+  use Rack::Session::Cookie, key: 'test.app', secret: ENV['RACK_SECRET']
+  map '/cable' do
+    run AsyncCable::Server.new(connection_class: MainCable)
+  end
+end
+run app
+
+
+# lib/main_cable.rb
+class ChatCable < AsyncCable::Connection
+  identified_as :main
+  attr_reader :current_user
+
+  def on_open
+    @current_user = User.find_by id: request.session['user_id']
+    reject_unauthorized if current_user.nil?
+    stream_for request.params['room_name']
+    
+    logger.info { "User##{current_user.id} has joined to #{channel_name}/#{stream_name}." }
+    self.class.broadcast(stream_name, message: "#{current_user.username} has joined.")
+    transmit(message: "Welcome #{current_user.username}.")
+  end
+
+  def on_data(data)
+    self.class.broadcast(stream_name, message: data[:message].to_s, by_who: current_user.username)
+  end
+
+  def on_close
+    return if identifier.nil?
+
+    logger.info { "User##{current_user.id} has left #{channel_name}/#{stream_name}." }
+    self.class.broadcast(stream_name, message: "#{current_user.username} has left.")
+  end
+end
+```
+
+example of JS code for connecting with websocket server 
+```js
+  var socket = new WebSocket("ws://localhost:9292/cable");
+  socket.onopen = function(_event) { 
+    console.log("WebSocket connected"); 
+  };
+  socket.onerror = function(error) { 
+    console.log("WebSocket error", error); 
+  };
+  socket.onclose = function(event) { 
+    console.log("WebSocket closed", event.wasClean, event.code, event.reason);
+  };
+  socket.onmessage = function(event) { 
+    console.log("WebSocket data received", JSON.parse(event.data)); 
+  };
+
+  var transmit = function (data) {
+    socket.send( JSON.generate(data) );
+  };
+  var close = function (code, reason) {
+    socket.close(code || 1000, reason);
+  };
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/async_cable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/async_cable/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AsyncCable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/async_cable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/async_cable.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/async_cable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'async_cable'
+  spec.version       = AsyncCable::VERSION
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = 'Dead simple websocket middleware for Rack async app.'
+  spec.description   = 'Dead simple websocket middleware for Rack async app.'
+  spec.homepage      = 'https://github.com/senid231/async_cable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'async-websocket'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'anyway_config'
+  spec.add_dependency 'null-logger'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "async_cable"
+
+# 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(__FILE__)

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/lib/async_cable.rb

@@ -0,0 +1,24 @@
+require 'async_cable/version'
+require 'async_cable/errors'
+require 'async_cable/config'
+require 'async_cable/registry'
+require 'async_cable/connection'
+require 'async_cable/server'
+
+module AsyncCable
+  def config
+    @config ||= Config.new
+  end
+
+  def configure
+    yield config
+  end
+
+  def broadcast(data)
+    config.logger.debug { "#{name}.broadcast data=#{data.inspect}" }
+    Registry.find.each { |conn| conn.transmit(data) }
+  end
+
+  module_function :configure, :config, :broadcast
+  config # initialize config right away to prevent racing.
+end

data/lib/async_cable/config.rb

@@ -0,0 +1,15 @@
+require 'null_logger'
+
+module AsyncCable
+  class Config < Anyway::Config
+    attr_config logger: NullLogger.new
+
+    def log_level
+      logger.level
+    end
+
+    def log_level=(val)
+      logger.level = val
+    end
+  end
+end

data/lib/async_cable/connection.rb

@@ -0,0 +1,123 @@
+require 'async/websocket/connection'
+require 'protocol/websocket/error'
+
+module AsyncCable
+  class Connection < Async::WebSocket::Connection
+
+    class << self
+      def inherited(subclass)
+        subclass.identified_as subclass.name.demodulize.underscore
+      end
+
+      def identified_as(channel)
+        @channel_name = channel.to_s
+      end
+
+      def channel_name
+        @channel_name
+      end
+
+      def logger
+        AsyncCable.config.logger
+      end
+
+      # Transmit data to all WS connections in current channel and provided stream.
+      # @param data [Hash]
+      def broadcast(stream_name, data)
+        logger.debug { "#{name}.broadcast data=#{data.inspect}" }
+
+        Registry.find(channel_name, stream_name).each do |conn|
+          conn.transmit(data) unless conn.closed?
+        end
+      end
+    end
+
+    attr_reader :request
+    attr_writer :close_code
+    attr_accessor :close_reason
+
+    def initialize(*args, &block)
+      super
+      @mutex = Mutex.new
+    end
+
+    # Will be executed when WS connection opened.
+    # #stream_for must be called here with stream name
+    def on_open
+    end
+
+    # Will be executed when data received from WS client.
+    # @param data [Hash]
+    def on_data(data)
+    end
+
+    # Will be executed when WS connection closed.
+    # see #close_code, #close_reason for details.
+    def on_close
+    end
+
+    # call this method to transmit data to current WS client
+    # @param data [Hash]
+    def transmit(data)
+      logger.debug { "#{self.class}#transmit identifier=#{identifier} data=#{data.inspect}" }
+
+      @mutex.synchronize do
+        write(data)
+        flush
+      end
+    end
+
+    # @param stream_name [String]
+    def stream_for(stream_name)
+      @stream_name = stream_name
+    end
+
+    # @return [String] stream name
+    def stream_name
+      @stream_name
+    end
+
+    def reject_unauthorized(reason = nil)
+      raise UnauthorizedError, reason
+    end
+
+    # WS connection close code
+    # 1000 - clean close
+    # @return [Integer]
+    def close_code
+      @close_code || Protocol::WebSocket::Error::NO_ERROR
+    end
+
+    # Was WS connection closed clean or dirty.
+    # @return [Boolean]
+    def close_clean?
+      close_code == Protocol::WebSocket::Error::NO_ERROR
+    end
+
+    # @param env [Hash]
+    # @raise [AsyncCable::Errors::StreamNameNotSet] if #stream_for was not called
+    # @raise [AsyncCable::Errors::UnauthorizedError] if #reject_unauthorized was called
+    def handle_open(env)
+      logger.debug { "#{self.class}#handle_open" }
+      @request = Rack::Request.new(env)
+      on_open
+      raise Errors::StreamNameNotSet, self.class.name unless defined?(@stream_name)
+      Registry.add(channel_name, stream_name, self)
+    end
+
+    def handle_close
+      logger.debug { "#{self.class}#handle_close clean=#{close_clean?} code=#{close_code} reason=#{close_reason}" }
+      close
+      Registry.remove(channel_name, stream_name, self)
+      on_close
+    end
+
+    def channel_name
+      self.class.channel_name
+    end
+
+    def logger
+      self.class.logger
+    end
+  end
+end

data/lib/async_cable/errors.rb

@@ -0,0 +1,25 @@
+module AsyncCable
+  module Errors
+    class Error < StandardError
+      def code
+        1999
+      end
+    end
+
+    class StreamNameNotSet < Error
+      def initialize(class_name)
+        super("#stream_for must be called with stream name in #{class_name}#on_open")
+      end
+    end
+
+    class UnauthorizedError < Error
+      def initialize(reason = nil)
+        super(reason || 'unauthorized')
+      end
+
+      def code
+        1401
+      end
+    end
+  end
+end

data/lib/async_cable/registry.rb

@@ -0,0 +1,62 @@
+require 'singleton'
+require 'forwardable'
+
+module AsyncCable
+  class Registry
+    include Singleton
+    extend SingleForwardable
+    @mutex = Mutex.new
+
+    single_delegate [:add, :remove, :find, :all] => :instance
+
+    # Adds connection to registry.
+    # @param channel_name [String]
+    # @param stream_name [String]
+    # @param connection [AsyncCable::Connection]
+    def add(channel_name, stream_name, connection)
+      @mutex.synchronize do
+        subscribers[channel_name][stream_name].push(connection)
+        connection
+      end
+    end
+
+    # Removes connection from registry.
+    # @param channel_name [String]
+    # @param stream_name [String]
+    # @param connection [AsyncCable::Connection]
+    def remove(channel_name, stream_name, connection)
+      @mutex.synchronize do
+        subscribers[channel_name][stream_name].delete(connection)
+        subscribers[channel_name].delete(stream_name) if subscribers[channel_name][stream_name].empty?
+        connection
+      end
+    end
+
+    # Return all connections from all channels when `channel_name` omitted.
+    # Return all connections from channel when `stream_name` omitted.
+    # Return connections from channel stream when `channel_name` and `stream_name` provided.
+    # @param channel_name [String,NilClass]
+    # @param stream_name [String,NilClass]
+    # @return [Array<AsyncCable::Connection>,Array]
+    def find(channel_name = nil, stream_name = nil)
+      @mutex.synchronize do
+        return subscribers.values.map(&:values).flatten if channel_name.nil?
+        return subscribers[channel_name].values.flatten if stream_name.nil?
+        subscribers[channel_name][stream_name]
+      end
+    end
+
+    private
+
+    def subscribers
+      @subscribers ||= new_subscribers
+    end
+
+    def new_subscribers
+      Hash.new do |hash, channel_name|
+        hash[channel_name] = Hash.new { |h, stream_name| h[stream_name] = []; h }
+        hash
+      end
+    end
+  end
+end

data/lib/async_cable/server.rb

@@ -0,0 +1,50 @@
+require 'async/websocket'
+require 'async/websocket/adapters/rack'
+
+module AsyncCable
+  class Server
+    # Rack application should be used inside Async::Reactor loop.
+
+    attr_reader :connection_class
+
+    # @param connection_class [Class] subclass of AsyncCable::Connection.
+    # @param block [Proc<Hash>] yields when not valid WS request.
+    # @yieldreturn [Array] `[status,headers,body]`
+    def initialize(connection_class:, &block)
+      @connection_class = connection_class
+      @block = block
+    end
+
+    # @param env [Hash]
+    # @return [Array] `[status,headers,body]`
+    def call(env)
+      response = Async::WebSocket::Adapters::Rack.open(env, handler: connection_class) do |connection|
+        connection.handle_open(env)
+
+        while (data = connection.read)
+          connection.on_data(data)
+        end
+      rescue Protocol::WebSocket::ProtocolError => error
+        logger.debug { "#{self.class}#call rescue #{error.class} message=#{error.message} code=#{error.code}" }
+        connection.close_code = error.code
+        connection.close_reason = error.message
+      rescue AsyncCable::Connection::Error => error
+        connection.close_code = error.code
+        connection.close_reason = error.message
+      ensure
+        logger.debug { "#{self.class}#call connection closed" }
+        connection.handle_close
+      end
+      # response[1] ca be Protocol::HTTP::Headers::Merged here.
+      # We transform it to hash because we don't want to break other middleware logic.
+      response[1] = response[1].to_a.to_h if !response.nil? && !response[1].is_a?(Hash)
+      response || [400, { 'Content-Type' => 'text/plain' }, ['Not valid ws']]
+    end
+
+    private
+
+    def logger
+      AsyncCable.config.logger
+    end
+  end
+end

data/lib/async_cable/version.rb

@@ -0,0 +1,3 @@
+module AsyncCable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: async_cable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: null-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dead simple websocket middleware for Rack async app.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- async_cable.gemspec
+- bin/console
+- bin/setup
+- lib/async_cable.rb
+- lib/async_cable/config.rb
+- lib/async_cable/connection.rb
+- lib/async_cable/errors.rb
+- lib/async_cable/registry.rb
+- lib/async_cable/server.rb
+- lib/async_cable/version.rb
+homepage: https://github.com/senid231/async_cable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/senid231/async_cable
+  source_code_uri: https://github.com/senid231/async_cable
+  changelog_uri: https://github.com/senid231/async_cable/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Dead simple websocket middleware for Rack async app.
+test_files: []