celluloid_pubsub 0.0.5 → 0.0.6

data/lib/celluloid_pubsub/web_server.rb

@@ -1,14 +1,56 @@
 require_relative './reactor'
 module CelluloidPubsub
+  # webserver to which socket connects should connect to .
+  # the server will dispatch each request into a new Reactor
+  # which will handle the action based on the message
+  # @!attribute options
+  #   @return [Hash] options used to configure the webserver
+  #   @option options [String]:hostname The hostname on which the webserver runs on
+  #   @option options [Integer] :port The port on which the webserver runs on
+  #   @option options [String] :path The request path that the webserver accepts
+  #   @option options [Boolean] :spy Enable this only if you want to enable debugging for the webserver
+  #
+  # @!attribute subscribers
+  #   @return [Hash] The hostname on which the webserver runs on
+  #
+  # @!attribute backlog
+  #   @return [Integer] Determines how many connections can be used
+  #   Defaults to 1024
+  #
+  # @!attribute hostname
+  #   @return [String] The hostname on which the webserver runs on
+  #
+  # @!attribute port
+  #  @return [String] The port on which the webserver runs on
+  #
+  # @!attribute path
+  #   @return [String] The hostname on which the webserver runs on
+  #
+  # @!attribute spy
+  #   @return [Boolean] Enable this only if you want to enable debugging for the webserver
   class WebServer < Reel::Server::HTTP
     include Celluloid::Logger
 
+    # The hostname on which the webserver runs on by default
     HOST = '0.0.0.0'
+    # The port on which the webserver runs on by default
     PORT = 1234
+    # The request path that the webserver accepts by default
     PATH = '/ws'
 
     attr_accessor :options, :subscribers, :backlog, :hostname, :port, :path, :spy
 
+    #  receives a list of options that are used to configure the webserver
+    #
+    # @param  [Hash]  options the options that can be used to connect to webser and send additional data
+    # @option options [String]:hostname The hostname on which the webserver runs on
+    # @option options [Integer] :port The port on which the webserver runs on
+    # @option options [String] :path The request path that the webserver accepts
+    # @option options [Boolean] :spy Enable this only if you want to enable debugging for the webserver
+    #
+    # @return [void]
+    #
+    # @api public
     def initialize(options = {})
       parse_options(options)
       @subscribers = {}
@@ -16,6 +58,18 @@ module CelluloidPubsub
       super(@hostname, @port, { spy: @spy, backlog: @backlog }, &method(:on_connection))
     end
 
+    #  receives a list of options that are used to configure the webserver
+    #
+    # @param  [Hash]  options the options that can be used to connect to webser and send additional data
+    # @option options [String]:hostname The hostname on which the webserver runs on
+    # @option options [Integer] :port The port on which the webserver runs on
+    # @option options [String] :path The request path that the webserver accepts
+    # @option options [Boolean] :spy Enable this only if you want to enable debugging for the webserver
+    # @option options [Integer]:backlog How many connections the server accepts
+    #
+    # @return [void]
+    #
+    # @api public
     def parse_options(options)
       raise 'Options is not a hash ' unless options.is_a?(Hash)
       @options = options.stringify_keys
@@ -26,14 +80,32 @@ module CelluloidPubsub
       @spy = @options.fetch(:spy, false)
     end
 
+    #  checks if debug is enabled
+    #
+    # @return [boolean]
+    #
+    # @api public
     def debug_enabled?
       self.class.debug_enabled?
     end
 
+    #  checks if debug is enabled
+    #
+    # @return [boolean]
+    #
+    # @api public
     def self.debug_enabled?
       ENV['DEBUG_CELLULOID'].present? && (ENV['DEBUG_CELLULOID'] == 'true' || ENV['DEBUG_CELLULOID'] == true)
     end
 
+    #  checks if debug is enabled
+    #
+    # @param [String] current_topic The Channel to which the reactor instance {CelluloidPubsub::Rector} will publish the message to
+    # @param [Object] message
+    #
+    # @return [void]
+    #
+    # @api public
     def publish_event(current_topic, message)
       return if current_topic.blank? || message.blank?
       @subscribers[current_topic].each do |hash|
@@ -41,6 +113,19 @@ module CelluloidPubsub
       end
     end
 
+    #  callback that will execute when receiving new conections
+    # If the connections is a websocket will call method {#route_websocket}
+    # and if the connection is HTTP will call method {#route_request}
+    # For websocket connections , the connection is detached from the server and dispatched to another actor
+    #
+    # @see #route_websocket
+    # @see #route_request
+    #
+    # @param [Reel::WebSocket] connection The connection that was made to the webserver
+    #
+    # @return [void]
+    #
+    # @api public
     def on_connection(connection)
       while request = connection.request
         if request.websocket?
@@ -62,11 +147,29 @@ module CelluloidPubsub
       end
     end
 
+    #  HTTP connections are not accepted so this method will show 404 message "Not Found"
+    #
+    # @param [Reel::WebSocket] connection The HTTP connection that was received
+    # @param [Reel::Request] request The request that was made to the webserver and contains the type , the url, and the parameters
+    #
+    # @return [void]
+    #
+    # @api public
     def route_request(connection, request)
       info "404 Not Found: #{request.path}" if debug_enabled?
       connection.respond :not_found, 'Not found'
     end
 
+    #  If the socket url matches with the one accepted by the server, it will dispatch the socket connection to a new reactor {CelluloidPubsub::Reactor#work}
+    # The new actor is linked to the webserver
+    #
+    # @see CelluloidPubsub::Reactor#work
+    #
+    #  @param [Reel::WebSocket] socket The  web socket connection that was received
+    #
+    # @return [void]
+    #
+    # @api public
     def route_websocket(socket)
       if socket.url == @path
         info 'Reactor handles new socket connection' if debug_enabled?
@@ -79,6 +182,15 @@ module CelluloidPubsub
       end
     end
 
+    # If the message can be parsed into a Hash it will respond to the reactor's websocket connection with the same message in JSON format
+    # otherwise will try send the message how it is and escaped into JSON format
+    #
+    # @param [CelluloidPubsub::Reactor] reactor The  reactor that received an unhandled message
+    # @param [Object] data The message that the reactor could not handle
+    #
+    # @return [void]
+    #
+    # @api public
     def handle_dispatched_message(reactor, data)
       debug "Webserver trying to dispatch message  #{data.inspect}" if debug_enabled?
       message = reactor.parse_json_data(data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celluloid_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -339,25 +339,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
-  name: yardstick
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.5.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
-    - - '>='
+        version: 0.5.10
+- !ruby/object:Gem::Dependency
+  name: guard-inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 0.1.0
 description: CelluloidPubsub is a simple ruby implementation of publish subscribe
   design patterns using celluloid actors and websockets, using Reel server for inter-process
   communication
@@ -388,6 +396,7 @@ files:
 - bin/erubis
 - bin/guard
 - bin/htmldiff
+- bin/inch
 - bin/ldiff
 - bin/listen
 - bin/nokogiri
@@ -405,6 +414,7 @@ files:
 - bin/sass-convert
 - bin/scss
 - bin/scss-lint
+- bin/sparkr
 - bin/term_display
 - bin/term_mandel
 - bin/thor
@@ -413,6 +423,27 @@ files:
 - bin/yardstick
 - bin/yri
 - celluloid_pubsub.gemspec
+- doc/CelluloidPubsub.html
+- doc/CelluloidPubsub/Client.html
+- doc/CelluloidPubsub/Client/PubSubWorker.html
+- doc/CelluloidPubsub/Reactor.html
+- doc/CelluloidPubsub/Registry.html
+- doc/CelluloidPubsub/VERSION.html
+- doc/CelluloidPubsub/WebServer.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - examples/simple_test.rb
 - init.rb
 - lib/celluloid_pubsub.rb