celluloid_pubsub 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 504c5b5283795d2b2d0024075b948e9fdc1e33b5
-  data.tar.gz: a804f7569d91763c96d7c99143cf47bf03172056
+  metadata.gz: 7488182bb374aeba0db2f121fc0fb17b2c41560b
+  data.tar.gz: 38a24ef56d63549d013f51c76da3a17b3e56edd0
 SHA512:
-  metadata.gz: a91dab82e9dfcd1adc0301b97382fa9a128b0f923a68d41050f2cde6d2d6b7a80504ae154b53b23ed64df7bf90ecb24418b6cf2994fa1f37d03a9a45981d542d
-  data.tar.gz: d37314b65d6d1f86e71807f904d830c37b00395acb988c585335fb13e6718accf4583d8041b5f6e89d6930fe07f1b073addab63ea5c570fc652a4505dc827b5c
+  metadata.gz: 3f1875bd87ce12992e24b04c68a3316a70f582d24426e37d029d0f8e1a003b8b05a5571228df7e87c1ab1d9c2b68fed6f75dc8071290aafb676c39d3357d81d7
+  data.tar.gz: 0d4832b40b51b555d55b49253002b9f9d155eb1662c257142ecdd1f30cefb2595a15fd6f24a6b4858bf160047be57fec88154dd3f6f501bd98a675b0a83d05ef

data/README.md

@@ -8,15 +8,20 @@ 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)
+
 Requirements
 ------------
 
 1.	[Ruby 1.9.x or Ruby 2.x.x](http://www.ruby-lang.org)
 2.	[Celluloid >= 0.16.0](https://github.com/celluloid/celluloid)
 3.	[Celluloid-IO >= 0.16.2](https://github.com/celluloid/celluloid-io)
-4.	[Reel >= 0.5.0](https://github.com/celluloid/reel)
-5.	[Celluloid-websocket-client = 0.0.1](https://github.com/jeremyd/celluloid-websocket-client)
-6.	[ActiveSuport >= 4.2.0](https://rubygems.org/gems/activesupport)
+4.	[Reel >= 0.6.0](https://github.com/celluloid/reel)
+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)
 
 Compatibility
 -------------
@@ -38,6 +43,71 @@ Add the following to your Gemfile:
 
 Please read [Release Details](https://github.com/bogdanRada/celluloid_pubsub/releases) if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
 
+Usage
+-----
+
+Creating a websocket server is simple as doing this. This are all the options available with their default values.
+
+```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 .
+  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
+  path: '/ws', # the relative path used in the URL where connections are allowed to connect
+  spy: false, # whether to spy all internal Websocket connections in order to get more debugging information
+  backlog: 1024 # the number of connections allowed to be connected to the server at a certain time
+ )
+```
+
+Creating a client is simple as doing this. If you provide the channel when you initialize the **CelluloidPubsub::Client** it will automatically start the subscription to that channel. But sometimes, you might want to subscribe at a later time, so you can just omit the channel when you initialize the client, and use instead **@client.subscribe('test_channel')**. After the subscription has started, the client must implement the method **on_message** and the **on_close** method (called when client disconnects from the channel). The method **on_message** will receive all incoming messages from the server. You can test if the subscription was successful by doing this **@client.succesfull_subscription?(message)**.
+
+```ruby
+class MyAwesomeClient
+  include Celluloid
+  include Celluloid::Logger
+
+  def initialize(options = {})
+    @client = CelluloidPubsub::Client.new({
+      actor: Actor.current,
+      channel: 'test_channel', # the channel to which this client will subscribe to.
+      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 connection will be made to
+       path: '/ws', # the relative path used in the URL where the connection will be connecting to
+       enable_debug: false # if debug messages should be logged
+     }.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
+
+```
+
+The methods available that the **CelluloidPubsub::Client** instance can execute are:
+
+-	subscribe -- subscribe - accepts a string as a channel name
+-	publish - accepts a string as a channel name, and a Hash object
+-	unsubscribe - accepts a string as a channel_name from which the client will unsubscribe from
+-	unsubscribe_clients - accepts a string as a channel_name . This will disconnect all clients that are subscribed to that channel.
+-	unsubscribe_all - This does not have any parameters. Will unsubscribe all clients from all channnels
+-	on_close - This accepts a code and a reason as parameters. This method will be called when the client disconnects from the channel.
+
 Examples
 --------
 

data/lib/celluloid_pubsub/initializers/reel_colors.rb

@@ -0,0 +1,15 @@
+require 'reel/spy'
+Reel::Spy::Colors.class_eval do
+  alias_method :original_colorize, :colorize
+
+  def colorize(n, str)
+    force_utf8_encoding(str)
+  end
+
+  # Returns utf8 encoding of the msg
+  # @param [String] msg
+  # @return [String] ReturnsReturns utf8 encoding of the msg
+  def force_utf8_encoding(msg)
+    msg.respond_to?(:force_encoding) && msg.encoding.name != 'UTF-8' ? msg.force_encoding('UTF-8') : msg
+  end
+end

data/lib/celluloid_pubsub/version.rb

@@ -17,7 +17,7 @@ module CelluloidPubsub
     # minor release version
     MINOR = 5
     # tiny release version
-    TINY = 0
+    TINY = 1
     # prelease version ( set this only if it is a prelease)
     PRE = nil
 

data/lib/celluloid_pubsub/web_server.rb

@@ -48,6 +48,11 @@ module CelluloidPubsub
       super(hostname, port, { spy: spy, backlog: backlog }, &method(:on_connection))
     end
 
+    def run
+      @spy = Celluloid.logger
+      loop { async.handle_connection @server.accept }
+    end
+
     # the method will  return true if redis can be used otherwise false
     #
     #

data/lib/celluloid_pubsub.rb

@@ -4,4 +4,5 @@ require 'reel'
 require 'celluloid/websocket/client'
 require 'active_support/all'
 require 'json'
+Gem.find_files('celluloid_pubsub/initializers/**/*.rb').each { |path| require path }
 Gem.find_files('celluloid_pubsub/**/*.rb').each { |path| require path }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celluloid_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -398,6 +398,7 @@ files:
 - lib/celluloid_pubsub.rb
 - lib/celluloid_pubsub/client.rb
 - 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