celluloid_pubsub 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96840919322edc81e5d6e77deb8579ad2a41f1d
-  data.tar.gz: 998c3da9bff6142d543e170a6c17a37703206ec8
+  metadata.gz: 1fd09c4be6a3a41e2e10ee14717df60bda21a008
+  data.tar.gz: 105b47986bcb0bcbb31a71e34a742218f8fb2836
 SHA512:
-  metadata.gz: 8c9c48887e176e1be23baf62bd328fc6af00d0607f725c4d1039650b74e627fa2dac00da6474406b8e06c65588f4e31056822bc215f22dd09d7d978e331f3185
-  data.tar.gz: d2556fb35ab937cfe303db592b198d5068b545fe141b735aae929f5d021da012aa84e8c55ffbe1a90cb742a182df79c4ac42f3ab4e717e4ccc411ff4fea72491
+  metadata.gz: e5b28bc53a3a2a947ffa64a969e61baef8792937708103d89b2b46e4d4aaba6a57029ef05791d133481ae8e465d5cfc237a5c1ccb9b365e24f356f2a21c5721b
+  data.tar.gz: 3635b6499fca2e4a2b950629d01fc0503474f8953033de53655d5656e995fb6c37d9b578df5acf727fc777f7590832b64385b5d3b54b1b59855eba8b169d299a

data/README.md

@@ -8,7 +8,7 @@ Description
 
 CelluloidPubsub is a simple ruby implementation of publish subscribe design patterns using celluloid actors and websockets, using Celluloid::Reel server
 
-Starting with version 0.4.0, Redis support was added [courtesy of em-hiredis](https://github.com/mloughran/em-hiredis)
+Starting with version 0.6.0, Redis support was moved into gem [celluloid_pubsub_redis_adapter](https://github.com/bogdanRada/celluloid_pubsub_redis_adapter)
 
 Requirements
 ------------
@@ -20,8 +20,7 @@ Requirements
 5.	[http >= 1.0.2](https://github.com/httprb/http)
 6.	[Celluloid-websocket-client = 0.0.1](https://github.com/jeremyd/celluloid-websocket-client)
 7.	[ActiveSuport >= 4.2.0](https://rubygems.org/gems/activesupport)
-8.	[em-hiredis >= 0.3.0](https://github.com/mloughran/em-hiredis)
-9.	[json >= 1.8.3](https://github.com/flori/json)
+8.	[json >= 1.8.3](https://github.com/flori/json)
 
 Compatibility
 -------------
@@ -51,7 +50,7 @@ Creating a websocket server is simple as doing this. This are all the options av
 ```ruby
 CelluloidPubsub::WebServer.supervise_as(:web_server,
   enable_debug: true, # if debug messages should be logged
-  use_redis: false ,  # if set to true, will instantiate a RedisReactor class to handle each connection, which requires Redis to be available. Otherwise will use a simple Reactor to handle the connections which  has no dependencies .
+  adapter: nil ,  # if set to nil, will instantiate a simple Reactor to handle the connections which  has no dependencies . Otherwise will try to use that adapter.  Please see [celluloid_pubsub_redis_adapter](https://github.com/bogdanRada/celluloid_pubsub_redis_adapter) for more details on using redis adapter
   log_file_path: "path/to/log_file.log", # The log file where all debugging information will be printed
   hostname: "0.0.0.0", # the hostname of the server.
   port: 1234, # the port on which the server will listen for connections

data/celluloid_pubsub.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'http', '~> 1.0', '>= 1.0.2'
   s.add_runtime_dependency 'celluloid-websocket-client', '~> 0.0', '>= 0.0.1'
   s.add_runtime_dependency 'activesupport', '~> 4.1', '>= 4.1.0'
-  s.add_runtime_dependency 'em-hiredis', '~> 0.3', '>= 0.3.0'
   s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
 
+
   s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4'
   s.add_development_dependency 'simplecov', '~> 0.10', '>= 0.10'
   s.add_development_dependency 'simplecov-summary', '~> 0.0.4', '>= 0.0.4'

data/examples/simple_test.rb

@@ -1,2 +1,71 @@
-ENV['USE_REDIS'] = 'false'
-require_relative './shared_classes'
+require 'bundler/setup'
+require 'celluloid_pubsub'
+require 'logger'
+
+debug_enabled = ENV['DEBUG'].present? && ENV['DEBUG'].to_s == 'true'
+log_file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'log', 'celluloid_pubsub.log')
+
+# actor that subscribes to a channel
+class FirstActor
+  include Celluloid
+  include Celluloid::Logger
+
+  def initialize(options = {})
+    @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel' }.merge(options))
+  end
+
+  def on_message(message)
+    if @client.succesfull_subscription?(message)
+      puts "subscriber got successful subscription #{message.inspect}"
+      @client.publish('test_channel2', 'data' => ' subscriber got successfull subscription') # the message needs to be a Hash
+    else
+      puts "subscriber got message #{message.inspect}"
+    end
+  end
+
+  def on_close(code, reason)
+    puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
+    terminate
+  end
+
+
+end
+
+# actor that publishes a message in a channel
+class SecondActor
+  include Celluloid
+  include Celluloid::Logger
+
+  def initialize(options = {})
+    @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel2' }.merge(options))
+  end
+
+  def on_message(message)
+    if @client.succesfull_subscription?(message)
+      puts "publisher got successful subscription #{message.inspect}"
+      @client.publish('test_channel', 'data' => ' my_message') # the message needs to be a Hash
+    else
+      puts "publisher got message #{message.inspect}"
+    end
+  end
+
+  def on_close(code, reason)
+    puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
+    terminate
+  end
+
+end
+
+
+CelluloidPubsub::WebServer.supervise_as(:web_server, enable_debug: debug_enabled, adapter: nil,log_file_path: log_file_path )
+FirstActor.supervise_as(:first_actor, enable_debug: debug_enabled)
+SecondActor.supervise_as(:second_actor, enable_debug: debug_enabled)
+signal_received = false
+
+Signal.trap('INT') do
+  puts "\nAn interrupt signal has been triggered!"
+  signal_received = true
+end
+
+puts 'Exited succesfully! =)'
+sleep 0.1 until signal_received

data/lib/celluloid_pubsub/reactor.rb

@@ -270,7 +270,7 @@ module CelluloidPubsub
       return unless channel.present?
       add_subscriber_to_channel(channel, message)
       log_debug "#{self.class} subscribed to #{channel} with #{message}"
-      @websocket << message.merge('client_action' => 'successful_subscription', 'channel' => channel).to_json unless @server.redis_enabled?
+      @websocket << message.merge('client_action' => 'successful_subscription', 'channel' => channel).to_json if @server.adapter == CelluloidPubsub::WebServer::CLASSIC_ADAPTER
     end
 
     # this method will return a list of all subscribers to a particular channel or a empty array

data/lib/celluloid_pubsub/version.rb

@@ -15,9 +15,9 @@ module CelluloidPubsub
     # major release version
     MAJOR = 0
     # minor release version
-    MINOR = 5
+    MINOR = 6
     # tiny release version
-    TINY = 2
+    TINY = 0
     # prelease version ( set this only if it is a prelease)
     PRE = nil
 

data/lib/celluloid_pubsub/web_server.rb

@@ -23,6 +23,8 @@ module CelluloidPubsub
     PORT = 1234
     # The request path that the webserver accepts by default
     PATH = '/ws'
+      # The name of the default adapter
+    CLASSIC_ADAPTER = 'classic'
 
     attr_accessor :server_options, :subscribers
     finalizer :shutdown
@@ -59,8 +61,9 @@ module CelluloidPubsub
     # @return [Boolean]  return true if redis can be used otherwise false
     #
     # @api public
-    def use_redis
-      @use_redis = @server_options.fetch('use_redis', false)
+    def adapter
+      @adapter ||= @server_options.fetch('adapter', CelluloidPubsub::WebServer::CLASSIC_ADAPTER)
+      @adapter.present? ? @adapter : CelluloidPubsub::WebServer::CLASSIC_ADAPTER
     end
 
     # the method will return true if debug is enabled otherwise false
@@ -145,15 +148,6 @@ module CelluloidPubsub
       @backlog = @server_options.fetch('backlog', 1024)
     end
 
-    # the method will return true if redis is enabled otherwise false
-    #
-    #
-    # @return [Boolean] returns true if redis is enabled otherwise false
-    #
-    # @api public
-    def redis_enabled?
-      use_redis.to_s.downcase == 'true'
-    end
 
     #  callback that will execute when receiving new conections
     # If the connections is a websocket will call method {#route_websocket}
@@ -196,7 +190,7 @@ module CelluloidPubsub
     #
     # @api public
     def reactor_class
-      redis_enabled? ? CelluloidPubsub::RedisReactor : CelluloidPubsub::Reactor
+      adapter == CelluloidPubsub::WebServer::CLASSIC_ADAPTER ? CelluloidPubsub::Reactor : "CelluloidPubsub::#{adapter.camelize}Reactor".constantize
     end
 
     # method will instantiate a new reactor object, will link the reactor to the current actor and will dispatch the request to the reactor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celluloid_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -130,26 +130,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-- !ruby/object:Gem::Dependency
-  name: em-hiredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -391,8 +371,6 @@ files:
 - README.md
 - Rakefile
 - celluloid_pubsub.gemspec
-- examples/redis_test.rb
-- examples/shared_classes.rb
 - examples/simple_test.rb
 - init.rb
 - lib/celluloid_pubsub.rb
@@ -400,7 +378,6 @@ files:
 - lib/celluloid_pubsub/helper.rb
 - lib/celluloid_pubsub/initializers/reel_colors.rb
 - lib/celluloid_pubsub/reactor.rb
-- lib/celluloid_pubsub/redis_reactor.rb
 - lib/celluloid_pubsub/registry.rb
 - lib/celluloid_pubsub/version.rb
 - lib/celluloid_pubsub/web_server.rb

data/examples/redis_test.rb

@@ -1,2 +0,0 @@
-ENV['USE_REDIS'] = 'true'
-require_relative './shared_classes'

data/examples/shared_classes.rb

@@ -1,72 +0,0 @@
-require 'bundler/setup'
-require 'celluloid_pubsub'
-require 'logger'
-
-debug_enabled = ENV['DEBUG'].present? && ENV['DEBUG'].to_s == 'true'
-use_redis = ENV['USE_REDIS'].present? && ENV['USE_REDIS'].to_s == 'true'
-log_file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'log', 'celluloid_pubsub.log')
-
-# actor that subscribes to a channel
-class Subscriber
-  include Celluloid
-  include Celluloid::Logger
-
-  def initialize(options = {})
-    @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel' }.merge(options))
-  end
-
-  def on_message(message)
-    if @client.succesfull_subscription?(message)
-      puts "subscriber got successful subscription #{message.inspect}"
-      @client.publish('test_channel2', 'data' => ' subscriber got successfull subscription') # the message needs to be a Hash
-    else
-      puts "subscriber got message #{message.inspect}"
-    end
-  end
-
-  def on_close(code, reason)
-    puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
-    terminate
-  end
-
-
-end
-
-# actor that publishes a message in a channel
-class Publisher
-  include Celluloid
-  include Celluloid::Logger
-
-  def initialize(options = {})
-    @client = CelluloidPubsub::Client.new({ actor: Actor.current, channel: 'test_channel2' }.merge(options))
-  end
-
-  def on_message(message)
-    if @client.succesfull_subscription?(message)
-      puts "publisher got successful subscription #{message.inspect}"
-      @client.publish('test_channel', 'data' => ' my_message') # the message needs to be a Hash
-    else
-      puts "publisher got message #{message.inspect}"
-    end
-  end
-
-  def on_close(code, reason)
-    puts "websocket connection closed: #{code.inspect}, #{reason.inspect}"
-    terminate
-  end
-
-end
-
-
-CelluloidPubsub::WebServer.supervise_as(:web_server, enable_debug: debug_enabled, use_redis: use_redis,log_file_path: log_file_path )
-Subscriber.supervise_as(:subscriber, enable_debug: debug_enabled)
-Publisher.supervise_as(:publisher, enable_debug: debug_enabled)
-signal_received = false
-
-Signal.trap('INT') do
-  puts "\nAn interrupt signal has been triggered!"
-  signal_received = true
-end
-
-sleep 0.1 until signal_received
-puts 'Exited succesfully! =)'

data/lib/celluloid_pubsub/redis_reactor.rb

@@ -1,282 +0,0 @@
-require_relative './reactor'
-require_relative './helper'
-module CelluloidPubsub
-  # reactor used for redis pubsub
-  # @!attribute connected
-  #   @return [Boolean] returns true if already connected to redis
-  # @!attribute connection
-  #   @return [EM::Hiredis] The connection used for redis
-  class RedisReactor < CelluloidPubsub::Reactor
-    include Celluloid
-    include Celluloid::IO
-    include Celluloid::Logger
-    include CelluloidPubsub::Helper
-
-    attr_accessor :connected, :connection
-
-    alias_method :connected?, :connected
-
-    # returns true if already connected to redis otherwise false
-    #
-    # @return [Boolean] returns true if already connected to redis otherwise false
-    #
-    # @api public
-    def connected
-      @connected ||= false
-    end
-
-    # method used to unsubscribe from a channel
-    # @see #redis_action
-    #
-    # @return [void]
-    #
-    # @api public
-    def unsubscribe(channel)
-      super
-      async.redis_action('unsubscribe', channel)
-    end
-
-    # method used to subscribe to a channel
-    # @see #redis_action
-    #
-    # @return [void]
-    #
-    # @api public
-    def add_subscriber_to_channel(channel, message)
-      super
-      async.redis_action('subscribe', channel, message)
-    end
-
-    # method used to unsubscribe from a channel
-    # @see #redis_action
-    #
-    # @return [void]
-    #
-    # @api public
-    def unsubscribe_from_channel(channel)
-      super
-      async.redis_action('unsubscribe', channel)
-    end
-
-    # method used to unsubscribe  from all channels
-    # @see #redis_action
-    #
-    # @return [void]
-    #
-    # @api public
-    def unsubscribe_all
-      info 'clearing connections'
-      shutdown
-    end
-
-    # method used to shutdown the reactor and unsubscribe from all channels
-    # @see #redis_action
-    #
-    # @return [void]
-    #
-    # @api public
-    def shutdown
-      @channels.dup.each do |channel|
-        redis_action('unsubscribe', channel)
-      end if @channels.present?
-      super
-    end
-
-    # method used to publish event using redis
-    #
-    # @return [void]
-    #
-    # @api public
-    def publish_event(topic, data)
-      return if topic.blank? || data.blank?
-      connect_to_redis do |connection|
-        connection.publish(topic, data)
-      end
-    rescue => exception
-      log_debug("could not publish message #{message} into topic #{current_topic} because of #{exception.inspect}")
-    end
-
-  private
-
-    # method used to run the enventmachine and setup the exception handler
-    # @see #run_the_eventmachine
-    # @see #setup_em_exception_handler
-    #
-    # @param [Proc] block the block that will use the connection
-    #
-    # @return [void]
-    #
-    # @api private
-    def connect_to_redis(&block)
-      require 'eventmachine'
-      require 'em-hiredis'
-      run_the_eventmachine(&block)
-      setup_em_exception_handler
-    end
-
-    # method used to connect to redis and yield the connection
-    #
-    # @param [Proc] block the block that will use the connection
-    #
-    # @return [void]
-    #
-    # @api private
-    def run_the_eventmachine(&block)
-      EM.run do
-        @connection ||= EM::Hiredis.connect
-        @connected = true
-        block.call @connection
-      end
-    end
-
-    # method used to setup the eventmachine exception handler
-    #
-    # @return [void]
-    #
-    # @api private
-    def setup_em_exception_handler
-      EM.error_handler do |error|
-        debug error unless filtered_error?(error)
-      end
-    end
-
-    # method used to fetch the pubsub client from the connection and yield it
-    #
-    # @return [void]
-    #
-    # @api private
-    def fetch_pubsub
-      connect_to_redis do |connection|
-        @pubsub ||= connection.pubsub
-        yield @pubsub if block_given?
-      end
-    end
-
-    # method used to fetch the pubsub client from the connection and yield it
-    # @see #action_subscribe
-    #
-    # @param [string] action The action that will be checked
-    # @param [string] channel The channel that reactor has subscribed to
-    # @param [string] message The initial message used to subscribe
-    #
-    # @return [void]
-    #
-    # @api private
-    def action_success(action, channel, message)
-      action_subscribe?(action) ? message.merge('client_action' => 'successful_subscription', 'channel' => channel) : nil
-    end
-
-    # method used execute an action (subscribe or unsubscribe ) to redis
-    # @see #prepare_redis_action
-    # @see #action_success
-    # @see #register_subscription_callbacks
-    #
-    # @param [string] action The action that will be checked
-    # @param [string] channel The channel that reactor has subscribed to
-    # @param [string] message The initial message used to subscribe
-    #
-    # @return [void]
-    #
-    # @api private
-    def redis_action(action, channel = nil, message = {})
-      fetch_pubsub do |pubsub|
-        callback = prepare_redis_action(pubsub, action)
-        success_message = action_success(action, channel, message)
-        args = action_subscribe?(action) ? [channel, callback] : [channel]
-        subscription = pubsub.send(action, *args)
-        register_subscription_callbacks(subscription, action, success_message)
-      end
-    end
-
-    # method used check if the action is subscribe and write the incoming message to be websocket or log the message otherwise
-    # @see #log_unsubscriptions
-    # @see #action_subscribe
-    #
-    # @param [String] action The action that will be checked if it is subscribed
-    #
-    # @return [void]
-    #
-    # @api private
-    def prepare_redis_action(pubsub, action)
-      log_unsubscriptions(pubsub)
-      proc do |subscribed_message|
-        action_subscribe?(action) ? (@websocket << subscribed_message) : log_debug(message)
-      end
-    end
-
-    # method used to listen to unsubscriptions and log them to log file
-    # @see #register_redis_callback
-    # @see #register_redis_error_callback
-    #
-    # @param [EM::Hiredis::PubsubClient] pubsub The pubsub client that will be used to listen to unsubscriptions
-    #
-    # @return [void]
-    #
-    # @api private
-    def log_unsubscriptions(pubsub)
-      pubsub.on(:unsubscribe) do |subscribed_channel, remaining_subscriptions|
-        log_debug [:unsubscribe_happened, subscribed_channel, remaining_subscriptions].inspect
-      end
-    end
-
-    # method used registers the sucess and error callabacks
-    # @see #register_redis_callback
-    # @see #register_redis_error_callback
-    #
-    # @param [EM::DefaultDeferrable] subscription The subscription object
-    # @param [string] action The action that will be checked
-    # @param [string] sucess_message The initial message used to subscribe
-    #
-    # @return [void]
-    #
-    # @api private
-    def register_subscription_callbacks(subscription, action, sucess_message = nil)
-      register_redis_callback(subscription, action, sucess_message)
-      register_redis_error_callback(subscription, action)
-    end
-
-    # the method will return true if debug is enabled
-    #
-    #
-    # @return [Boolean] returns true if debug is enabled otherwise false
-    #
-    # @api public
-    def debug_enabled?
-      @server.debug_enabled?
-    end
-
-    # method used to register a success callback  and if action is subscribe will write
-    # back to the websocket a message that will say it is a successful_subscription
-    # If action is something else, will log the incoming message
-    # @see #log_debug
-    #
-    # @param [EM::DefaultDeferrable] subscription The subscription object
-    # @param [string] sucess_message The initial message used to subscribe
-    #
-    # @return [void]
-    #
-    # @api private
-    def register_redis_callback(subscription, action, sucess_message = nil)
-      subscription.callback do |subscriptions_ids|
-        if sucess_message.present?
-          @websocket << sucess_message.merge('subscriptions' => subscriptions_ids).to_json
-        else
-          log_debug "#{action} success #{sucess_message.inspect}"
-        end
-      end
-    end
-
-    # Register an error callback on the deferrable object and logs to file the incoming message
-    # @see #log_debug
-    #
-    # @param [EM::DefaultDeferrable] subscription The subscription object
-    # @param [string] action The action that will be checked
-    #
-    # @return [void]
-    #
-    # @api private
-    def register_redis_error_callback(subscription, action)
-      subscription.errback { |reply| log_debug "#{action} error #{reply.inspect}" }
-    end
-  end
-end