action_channels 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDczOTM0NGIzOGZiYzJhNDkzNzQ3ZTc4ZDQ1NjU2NDhkZGEzYzFkNQ==
+    NDNlYzcxNjljYTNiNWJmNjk4ZDkyYjU1ZWU5ZGVhYTczNTA2MmVmYQ==
   data.tar.gz: !binary |-
-    Yzk0ODhhNzVkMjNlOTkxMWE2ZWFmMDJhNzRmOWVkNDY0MDQyYmIxNw==
+    NzlkYzg3MWNlZGZjNjNlOGY4YTIyZTRlNWQ5N2Y2ZTdiZWFiYTYyMA==
 SHA512:
   metadata.gz: !binary |-
-    ZDIzODE4ZWVmOTEyOGRhZjJlMzkxMGEzMjQ2YWIxMTZkZjdiNmYxNzMwNjJi
-    ZDA3NDk1OTgyMTdkZDI5NmE0YWZmMGM0NWRmZmM1MzkzNTBjOThlMmQyNDU0
-    YzgyNjI3ZmQ1MGVmN2MxZTU4OThiMTQ5ZjA3ZGU0NWVjYWM5ZmE=
+    MDBlOWUyZjEyYTkzOTE2ZDk2YWEzZjU4MDZlNzYwNDRkMWQzYTRiZTJiODY2
+    M2RhZGZmMTkyOTNjNWUwZDBjN2NiNzc2MWExMWQyODMwNWY2YWZiNmIzNGY1
+    NzZlOTljNTU0MzM3NWM5ZDlmYTkzZWMwMmQ0YThkYTEyMDcxZWU=
   data.tar.gz: !binary |-
-    ZDMyMDFkZTY3YWNjZGNiNTY4OTIzOWE4NmJiZjZjNjk1NzFiY2M0YTdlMDI1
-    OGJhYjUwNzFkMWFiNGY1YzMxMDIyYWViOGRmZjljZjRkYjA5NmQwYTcyMzg4
-    MmI3YjdmZTc3NjJmYmMyMjZkM2Q3NGM4YmY0ZDVhZGEyOTYwZDc=
+    NTM4MDFiMTlmNjNkNTU1MDVjN2Q2MzUyMzgxMDk1OGJlMTIxZTM3ZDIwMmY2
+    MmEyMTUxMTA5NWZjZDY0ZjUxYzNjNDc2YTUwYTQzZDQyMmYxNWI0OTU1YmM4
+    YTFlMTI2OGMwMjI5NGY0MGI1MjUzYThjNmUwOWE2NGYwMTdmZDg=

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /examples/*.log
+action_channels.log
 /examples/tmp/
 Gemfile.lock
 

data/README.md

@@ -1,4 +1,27 @@
 # Action channels
 
-1. The server runs on web sockets.
-2. The project contains a minimum of dependencies. 
+## Example
+
+``` ruby
+require 'action_channels'
+
+class PingPongChannel < ActionChannels::Channels::Base
+  def process_custom_message(message)
+    case message.type
+    when 'ping'
+      send_message message.author, ActionChannels::Message.new(channel: name, type: 'pong')
+    when 'pong'
+      send_message message.author, ActionChannels::Message.new(channel: name, type: 'ping')
+    else
+      on_unknown_type_message message
+    end
+  end
+end
+
+server = ActionChannels::Server.new(
+  port: 3050,
+  channels: [PingPongChannel.new(name: 'ping-pong')]
+)
+
+server.run
+```

data/lib/action_channels.rb

@@ -1,19 +1,27 @@
 require 'set'
+require 'logger'
+require 'nio/websocket'
 
 require "action_channels/version"
 require "action_channels/errors"
+require "action_channels/driver"
 require "action_channels/message"
 require "action_channels/message_senders"
-require "action_channels/channel"
+require "action_channels/client"
+require "action_channels/channels"
 require "action_channels/channel_repository"
 require "action_channels/server"
 
 module ActionChannels
   class << self
-    attr_accessor :logger
+    attr_writer :logger
 
     def configure(&block)
       yield(self)
     end
+
+    def logger
+      @logger ||= Logger.new('action_channels.log')
+    end
   end
 end

data/lib/action_channels/channel_repository.rb

@@ -29,7 +29,7 @@ module ActionChannels
     attr_reader :channels
 
     def create(channel_name)
-      channel = Channel.new name: channel_name
+      channel = Channels::NewsChannel.new name: channel_name
       channels << channel
       channel
     end

data/lib/action_channels/channels.rb

@@ -0,0 +1,7 @@
+require 'action_channels/channels/base'
+require 'action_channels/channels/news_channel'
+
+module ActionChannels
+  module Channels
+  end
+end

data/lib/action_channels/channels/base.rb

@@ -0,0 +1,89 @@
+module ActionChannels
+  module Channels
+    class Base
+      attr_reader :name, :clients
+      attr_accessor :message_sender
+
+      def initialize(attrs)
+        @name = attrs.fetch(:name)
+        @clients = Set.new
+        @message_sender = attrs.fetch :message_sender, MessageSenders::WebSocket.new
+      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"
+        ActionChannels.logger.debug "Count of client of channel ##{self.name} is #{self.clients.count}."
+      end
+
+      def remove_client(client)
+        clients.delete client
+
+        ActionChannels.logger.info "The channel ##{self.name} removed a client"
+        ActionChannels.logger.debug "Count of client of channel ##{self.name} is #{self.clients.count}."
+      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}"
+
+        if message.systemic?
+          process_system_message message
+        else
+          process_custom_message message
+        end
+      end
+
+      def process_system_message(message)
+        case message.type
+        when 'subscribe'
+          on_subscribe message.author, message.details
+        when 'unsubscribe'
+          on_unsubscribe message.author, message.details
+        else
+        end
+      end
+
+      def process_custom_message(message)
+        # nothing
+      end
+
+      def after_message_subscribe(subscriber, details)
+        # nothing
+      end
+
+      def after_message_unsubscribe(subscriber, details)
+        # nothing
+      end
+
+      private
+
+      def on_subscribe(subscriber, details)
+        add_client(subscriber)
+        send_message subscriber, Message.new(channel: name, type: 'subscribed')
+        after_message_subscribe subscriber, details
+      end
+
+      def on_unsubscribe(subscriber, details)
+        remove_client(subscriber)
+        send_message subscriber, Message.new(channel: name, type: 'unsubscribed')
+        after_message_unsubscribe subscriber, details
+      end
+
+      def on_unknown_type_message(message)
+        user, type = message.author, message.type
+        send_message user, Message.new(channel: name, type: 'invalid_message', details: { error: "Unknown type of message: #{type}" })
+      end
+    end
+  end
+end

data/lib/action_channels/channels/news_channel.rb

@@ -0,0 +1,21 @@
+module ActionChannels
+  module Channels
+    class NewsChannel < Base
+      def process_custom_message(message)
+        case message.type
+        when 'publish'
+          on_publish message.author, message.details
+        else
+          on_unknown_type_message message
+        end
+      end
+
+      private
+
+      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
+    end
+  end
+end

data/lib/action_channels/client.rb

@@ -0,0 +1,77 @@
+require 'timeout'
+
+module ActionChannels
+  class Client
+    class << self
+      def send_message(url, message, options = {})
+        client = new(url, options)
+        client.start
+        client.send_message(message)
+        client.stop
+
+        true
+      end
+    end
+
+    attr_reader :url, :message_sender
+
+    def initialize(url, options = {})
+      @url = url
+      self.is_connected = false
+      @message_sender = options.fetch :message_sender, MessageSenders::WebSocket.new
+    end
+
+    def start(waits_at = 20)
+      return true if connected?
+
+      do_connect
+
+      Timeout::timeout(waits_at, Errors::NotConnected) do
+        until connected? do
+          sleep 1
+        end
+      end
+
+      true
+    end
+
+    def stop
+      if connected?
+        connect.close
+        connect = nil
+      end
+
+      true
+    end
+
+    def send_message(message)
+      return false unless connected?
+
+      message_sender.do_send(connect, message)
+
+      true
+    end
+
+    def connected?
+      is_connected
+    end
+
+    private
+
+    attr_accessor :is_connected, :connect
+
+    def do_connect
+      client = self
+
+      ::NIO::WebSocket.connect(url) do |websocket|
+        on_open = lambda do |_|
+          client.send 'connect=', websocket
+          client.send 'is_connected=', true
+        end
+
+        websocket.on :open, on_open
+      end
+    end
+
+  end
+end

data/lib/action_channels/driver.rb

@@ -0,0 +1,9 @@
+require 'delegate'
+
+module ActionChannels
+  class Driver < SimpleDelegator
+    def data
+      @data ||= {}
+    end
+  end
+end

data/lib/action_channels/errors.rb

@@ -2,5 +2,6 @@ module ActionChannels
   module Errors
     class Base < StandardError; end
     class NotParseMessage < Base; end
+    class NotConnected < Base; end
   end
 end

data/lib/action_channels/message.rb

@@ -5,18 +5,18 @@ module ActionChannels
     attr_accessor(
       :channel, # [String]
       :type, # [String]
-      :author, # [WebSocket::Driver]
+      :author, # [Driver]
       :details # Hash
     )
 
     class << self
       def parse(message_raw)
-        command_json  = JSON.parse message_raw
+        command_json  = JSON.parse message_raw, symbolize_names: true
 
         new(
-          channel: command_json['channel'],
-          type: command_json['type'],
-          details: command_json.fetch('details', {})
+          channel: command_json[:channel],
+          type: command_json[:type],
+          details: command_json.fetch(:details, {})
         )
       rescue JSON::ParserError => exp
         raise Errors::NotParseMessage, exp.message
@@ -39,5 +39,9 @@ module ActionChannels
     def to_raw
       JSON.generate(channel: channel, type: type, details: details)
     end
+
+    def systemic?
+      %w(subscribe unsubscribe).include? type
+    end
   end
 end

data/lib/action_channels/server.rb

@@ -1,25 +1,20 @@
-require 'nio/websocket'
-
 module ActionChannels
   class Server
-    attr_reader :port
+    attr_reader :port, :channel_repository
 
     def initialize(options)
       @port = options.fetch(:port)
+      @channel_repository = ChannelRepository.new options.fetch(:channels, [])
     end
 
     def run
-      NIO::WebSocket.listen port: port do |client|
-        process_client client
+      NIO::WebSocket.listen port: port do |driver|
+        process_client Driver.new(driver)
       end
 
       ActionChannels.logger.info "Server started on port: #{port}"
     end
 
-    def channel_repository
-      @channel_repository ||= ChannelRepository.new
-    end
-
     def process_client(client)
       client.on :message, callback_on_message(client)
       client.on :close, callback_on_close(client)

data/lib/action_channels/version.rb

@@ -1,3 +1,3 @@
 module ActionChannels
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_channels
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - German Antsiferov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -97,8 +97,12 @@ files:
 - Rakefile
 - action_channels.gemspec
 - lib/action_channels.rb
-- lib/action_channels/channel.rb
 - lib/action_channels/channel_repository.rb
+- lib/action_channels/channels.rb
+- lib/action_channels/channels/base.rb
+- lib/action_channels/channels/news_channel.rb
+- lib/action_channels/client.rb
+- lib/action_channels/driver.rb
 - lib/action_channels/errors.rb
 - lib/action_channels/message.rb
 - lib/action_channels/message_senders.rb

data/lib/action_channels/channel.rb

@@ -1,80 +0,0 @@
-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(attrs)
-      @name = attrs.fetch(:name)
-      @clients = Set.new
-      @message_sender = attrs.fetch :message_sender, MessageSenders::WebSocket.new
-    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"
-      ActionChannels.logger.debug "Count of client of channel ##{self.name} is #{self.clients.count}."
-    end
-
-    def remove_client(client)
-      clients.delete client
-
-      ActionChannels.logger.info "The channel ##{self.name} removed a client"
-      ActionChannels.logger.debug "Count of client of channel ##{self.name} is #{self.clients.count}."
-    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