faye-client 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/faye-client.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "faye-client"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Goff"]
+  s.date = "2012-09-08"
+  s.description = "Quickly and easily connect your app to a Faye server"
+  s.email = "cpuguy83@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "faye-client.gemspec",
+    "lib/faye-client.rb",
+    "lib/faye_client/channel_handlers/default_channel_handler.rb",
+    "lib/faye_client/faye_client.rb",
+    "test/helper.rb",
+    "test/test_faye-client.rb"
+  ]
+  s.homepage = "http://github.com/cpuguy83/faye-client"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Quickly and easily connect your app to a Faye server"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faye>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<sidekiq>, [">= 0"])
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<faye>, [">= 0"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<sidekiq>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<faye>, [">= 0"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<sidekiq>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/faye_client/faye_client.rb

@@ -1,4 +1,27 @@
 module FayeClient
+	# extend FayeClient in your class to use
+	# the "start" method spins off the EM instance with the Faye client to it's own thread
+	# You can access the the client itself or the thread using the class accessor methods "messaging_client" and "messaging_client_thread", respectively
+	# You must specify a :messaging_server_url and :messaging_channels using the available class accessors
+	# You should also supply a default_channel_handler_class_name and a default_channel_handler_method or it will default to the built-in handler, which is useless
+	# Alternatively (or in addition to), you can specify a Hash for your channel which would specify which class/method to use to handler the incoming message
+	# Example:
+	#
+	# 	class MyClientClass
+	# 		extend FayeClient
+	# 		self.messaging_server_url = 'http://myserver/faye'
+	# 		self.messaging_channels = ['/foo', '/bar', {name: '/foofoo', handler_class_name: FooFooHandlerClass, handler_method_name: 'foofoo_handler_method' }]
+	# 		self.default_channel_handler_class_name = 'MyDefaultHandlerClass'
+	# 		self.default_channel_handler_method = 'my_default_handler_method'
+	# 	end
+	#
+	# 	MyClient.start
+	#
+	# Channels for '/foo' and '/bar' in the above example will use the default class/method combo specified
+	# Channel '/foofoo' will use the specified class/method, assuming they are defined
+
+	 
+
 	attr_accessor :messaging_client, :messaging_client_thread, :messaging_server_url, :messaging_channels
 	attr_accessor :default_channel_handler_class_name, :default_channel_handler_method
 
@@ -24,11 +47,20 @@ module FayeClient
 		end
 	end
 
+	# Publish a :message to a :channel
+	def publish(options)
+		raise 'NoChannelProvided' unless options[:channel]
+		raise 'NoMessageProvided' unless options[:message]
+		messaging_client.publish(options[:channel], options[:message])
+	end
+
+	# Stop the running client
 	def stop
 		raise "NotRunning" if !running?
-		EM.stop
+		self.messaging_client.disconnect
 	end
 
+	# Restart the running client
 	def restart
 		stop
 		start
@@ -37,9 +69,14 @@ module FayeClient
 
 	# Is the client running?
 	def running?
-		EM.reactor_running?
+		if self.messaging_client and self.messaging_client.state == :CONNECTED
+			true
+		else
+			false
+		end
 	end
 
+	# Set the handler class/method to be used for a given channel
 	def get_channel_handler(channel)
 		if channel.is_a? String
 			parsed_channel_name = channel.gsub(/^\//, '').gsub('/','::')
@@ -47,7 +84,7 @@ module FayeClient
 			handler[:name] = channel
 		elsif channel.is_a? Hash
 			# Can provide a Hash to get full customization of handler names/methods
-			handler = get_channel_handler_for_hash
+			handler = get_channel_handler_for_hash(channel)
 			handler[:name] = channel[:name]
 		else
 			raise TypeError, 'Channel Must be a String or a Hash'
@@ -56,6 +93,7 @@ module FayeClient
 		handler
 	end
 
+	# If just a string is provided for a channel
 	def get_channel_handler_for_string(channel)
 		handler = {}
 		# Set handler class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faye-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
@@ -154,6 +154,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- faye-client.gemspec
 - lib/faye-client.rb
 - lib/faye_client/channel_handlers/default_channel_handler.rb
 - lib/faye_client/faye_client.rb
@@ -174,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1052917701805139625
+      hash: -1692075111458930586
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: