action_channels 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a86a68b94af2eef6fcb59c71974a5906905c130
+  data.tar.gz: f24eb7b22f1eeafe33183e2686f591a427bf0801
+SHA512:
+  metadata.gz: 65665230caaa80943f0d94cd0e561403fb71cbec5b9aae2bfb8bf3446109595c2e91e07bae8c59300eb1eacb557cad59a8c1ac180ee34ff6a637919c042d4dfb
+  data.tar.gz: 3f74d7b19fe79a651d50cfb57e8f437f7bf1f140dbadf0e605dddb9def7eec3ff19342cd711331d5d4a842d54797f0b7501f4e42da3ce1f86fbd66edb30e29f0

data/.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in action_channels.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    action_channels (0.0.1)
+      nio4r-websocket
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    nio4r (2.2.0)
+    nio4r-websocket (0.6.2)
+      nio4r (>= 1.2.1, < 3.0)
+      websocket-driver (~> 0.7)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action_channels!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 German Antsiferov
+
+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,4 @@
+# Action channels
+
+1. The server runs on web sockets.
+2. The project contains a minimum of dependencies. 

data/Rakefile

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

data/action_channels.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_channels/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_channels"
+  spec.version       = ActionChannels::VERSION
+  spec.authors       = ["German Antsiferov"]
+  spec.email         = ["dxdy@bk.ru"]
+
+  spec.summary       = %q{Easy server on websockets.}
+  spec.description   = %q{Easy server on websockets.}
+  spec.homepage      = "https://github.com/mr-dxdy/action_channels"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'nio4r-websocket'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/action_channels.rb

@@ -0,0 +1,19 @@
+require 'set'
+
+require "action_channels/version"
+require "action_channels/errors"
+require "action_channels/message"
+require "action_channels/message_senders"
+require "action_channels/channel"
+require "action_channels/channel_repository"
+require "action_channels/server"
+
+module ActionChannels
+  class << self
+    attr_accessor :logger
+
+    def configure(&block)
+      yield(self)
+    end
+  end
+end

data/lib/action_channels/channel.rb

@@ -0,0 +1,76 @@
+module ActionChannels
+  class Channel
+    def self.input_message_types
+      %w(subscribe unsubscribe publish)
+    end
+
+    def self.output_message_types
+      %w(subscribed unsubscribed published news invalid_message)
+    end
+
+    attr_reader :name, :clients
+    attr_accessor :message_sender
+
+    def initialize(name:, message_sender: MessageSenders::WebSocket.new)
+      @name = name
+      @clients = Set.new
+      @message_sender = message_sender
+    end
+
+    def send_message(receiver, message)
+      message_sender.do_send(receiver, message)
+    end
+
+    def add_client(client)
+      clients << client
+      ActionChannels.logger.info "The channel ##{self.name} added a client"
+    end
+
+    def remove_client(client)
+      clients.delete client
+      ActionChannels.logger.info "The channel ##{self.name} removed a client"
+    end
+
+    def notify_all(message)
+      clients.each do |client|
+        send_message client, message
+      end
+    end
+
+    def process_message(message)
+      ActionChannels.logger.debug "The channel ##{self.name} received a message #{message.inspect}"
+
+      case message.type
+      when 'subscribe'
+        on_subscribe message.author, message.details
+      when 'unsubscribe'
+        on_unsubscribe message.author, message.details
+      when 'publish'
+        on_publish message.author, message.details
+      else
+        on_unknown_type_message message.author, message.type
+      end
+    end
+
+    private
+
+    def on_subscribe(subscriber, details)
+      add_client(subscriber)
+      send_message subscriber, Message.new(channel: name, type: 'subscribed')
+    end
+
+    def on_unsubscribe(subscriber, details)
+      remove_client(subscriber)
+      send_message subscriber, Message.new(channel: name, type: 'unsubscribed')
+    end
+
+    def on_publish(speaker, details)
+      notify_all Message.new(channel: name, type: 'news', details: details)
+      send_message speaker, Message.new(channel: name, type: 'published')
+    end
+
+    def on_unknown_type_message(user, type)
+      send_message user, Message.new(channel: name, type: 'invalid_message', details: { error: "Unknown type of message: #{type}" })
+    end
+  end
+end

data/lib/action_channels/channel_repository.rb

@@ -0,0 +1,37 @@
+module ActionChannels
+  class ChannelRepository
+    def initialize(channels = [])
+      @channels = Set.new channels
+    end
+
+    def all
+      channels.to_a
+    end
+
+    def find_by_name(channel_name)
+      channels.find { |channel| channel.name.eql? channel_name }
+    end
+
+    def find_by_name_or_create(channel_name)
+      find_by_name(channel_name) || create(channel_name)
+    end
+
+    def add(channel)
+      channels.add channel
+    end
+
+    def delete(channel)
+      channels.delete channel
+    end
+
+    private
+
+    attr_reader :channels
+
+    def create(channel_name)
+      channel = Channel.new name: channel_name
+      channels << channel
+      channel
+    end
+  end
+end

data/lib/action_channels/errors.rb

@@ -0,0 +1,6 @@
+module ActionChannels
+  module Errors
+    class Base < StandardError; end
+    class NotParseMessage < Base; end
+  end
+end

data/lib/action_channels/message.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module ActionChannels
+  class Message
+    attr_accessor(
+      :channel, # [String]
+      :type, # [String]
+      :author, # [WebSocket::Driver]
+      :details # Hash
+    )
+
+    class << self
+      def parse(message_raw)
+        command_json  = JSON.parse message_raw
+
+        new(
+          channel: command_json['channel'],
+          type: command_json['type'],
+          details: command_json.fetch('details', {})
+        )
+      rescue JSON::ParserError => exp
+        raise Errors::NotParseMessage, exp.message
+      end
+
+      def parse_and_setup_author(message_raw, author)
+        command = parse(message_raw)
+        command.author = author
+        command
+      end
+    end
+
+    def initialize(channel:, type:, author: nil, details: {})
+      @channel = channel
+      @type = type
+      @author = author
+      @details = details
+    end
+
+    def to_raw
+      JSON.generate(channel: channel, type: type, details: details)
+    end
+  end
+end

data/lib/action_channels/message_senders.rb

@@ -0,0 +1,8 @@
+require "action_channels/message_senders/base"
+require "action_channels/message_senders/websocket"
+require "action_channels/message_senders/buffer"
+
+module ActionChannels
+  module MessageSenders
+  end
+end

data/lib/action_channels/message_senders/base.rb

@@ -0,0 +1,8 @@
+module ActionChannels
+  module MessageSenders
+    class Base
+      def do_send(receiver, message)
+      end
+    end
+  end
+end

data/lib/action_channels/message_senders/buffer.rb

@@ -0,0 +1,13 @@
+module ActionChannels
+  module MessageSenders
+    class Buffer < Base
+      def do_send(receiver, message)
+        queue << [receiver, message]
+      end
+
+      def queue
+        @queue ||= []
+      end
+    end
+  end
+end

data/lib/action_channels/message_senders/websocket.rb

@@ -0,0 +1,9 @@
+module ActionChannels
+  module MessageSenders
+    class WebSocket < Base
+      def do_send(receiver, message)
+        receiver.text message.to_raw
+      end
+    end
+  end
+end

data/lib/action_channels/server.rb

@@ -0,0 +1,43 @@
+require 'nio/websocket'
+
+module ActionChannels
+  class Server
+    attr_reader :port
+
+    def initialize(port:)
+      @port = port
+    end
+
+    def run
+      NIO::WebSocket.listen port: port do |client|
+        on_message = lambda do |event|
+          ActionChannels.logger.info "Received new message: #{event.data}"
+
+          message = Message.parse_and_setup_author event.data, client
+          process_message message
+        end
+
+        on_close = lambda do |event|
+          ActionChannels.logger.info "Client closed connection."
+          channel_repository.all.each { |channel| channel.remove_client(client) }
+        end
+
+        client.on :message, on_message
+        client.on :close, on_close
+      end
+
+      ActionChannels.logger.info "Server started on port: #{port}"
+    end
+
+    def channel_repository
+      @channel_repository ||= ChannelRepository.new
+    end
+
+    private
+
+    def process_message(message)
+      channel = channel_repository.find_by_name_or_create message.channel
+      channel.process_message message
+    end
+  end
+end

data/lib/action_channels/version.rb

@@ -0,0 +1,3 @@
+module ActionChannels
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: action_channels
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- German Antsiferov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nio4r-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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Easy server on websockets.
+email:
+- dxdy@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_channels.gemspec
+- lib/action_channels.rb
+- lib/action_channels/channel.rb
+- lib/action_channels/channel_repository.rb
+- lib/action_channels/errors.rb
+- lib/action_channels/message.rb
+- lib/action_channels/message_senders.rb
+- lib/action_channels/message_senders/base.rb
+- lib/action_channels/message_senders/buffer.rb
+- lib/action_channels/message_senders/websocket.rb
+- lib/action_channels/server.rb
+- lib/action_channels/version.rb
+homepage: https://github.com/mr-dxdy/action_channels
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Easy server on websockets.
+test_files: []