faye-server 0.2.0 → 0.2.1

data/README.rdoc

@@ -1,11 +1,22 @@
 = faye-server
 
 Extend FayServer in your class and you will get the following accessors for the class:
-    - messaging_server_options
-    - messaging_server_port
+    - messaging_server_options - passes in options to the faye server, can include faye extensions here
+    - messaging_server_port - sets the port your faye server will listen on
 With these you can customize your server, including the mount point, timeout, and any extension you want to add.
 
-This is just a basic wrapper for the Faye::RackAdatper
+This is just a basic wrapper for the Faye::RackAdatper.
+It does, however, spawn the Faye server into another thread where it can be monitored and controlled but not lock up your main thread, be it in Rails or any project.
+
+There are also two more accessors for your class not mentioned above:
+    - messaging_server_thread - Simply the thread running the faye server
+    - messaging_server - the faye server itself
+
+In your class you can call :start, :stop, :publish.
+Start/Stop are pretty straight forward, they start and stop the faye server.
+
+Publish publishes a message to your channel and takes an options hash, requiring a :channel and a :message
+
 
 == Contributing to faye-server
  

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/faye-server.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "faye-server"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Goff"]

data/lib/faye-server/faye_server.rb

@@ -1,6 +1,7 @@
 module FayeServer
 	attr_accessor :messaging_server_thread, :messaging_server, :messaging_server_port, :messaging_server_options
 
+	# Starts the Faye Server in a new thread
 	def start(options={})
 		raise 'Already Running' if self.messaging_server and self.messaging_server_thread.status
 		self.messaging_server_thread = Thread.new do
@@ -9,6 +10,8 @@ module FayeServer
 		end
 	end
 
+	# Stops Faye Server
+	# Somtimes Thin will return that it is wating on a client connection and you need to hit "ctrl-c"
 	def stop
 		raise 'Not Running' if !self.messaging_server or !self.messaging_server_thread.status
 		self.messaging_server.stop
@@ -19,6 +22,8 @@ module FayeServer
 		end
 	end
 
+	# Publish a message to a given channel
+	# Requres a :channel, and a :message
 	def publish(options={})
 		raise 'No Channel Provided' if !options[:channel]
 		raise 'No Message Provided' if !options[:message]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye-server
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -158,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3962348033638534507
+      hash: -3672171128834934857
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: