faye-client 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+gem 'faye'
+gem 'eventmachine'
+gem 'sidekiq'
+gem 'active_support'
+
+group :development do
+	gem "shoulda", ">= 0"
+	gem "rdoc", "~> 3.12"
+	gem "bundler", "~> 1.1.1"
+	gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    addressable (2.3.2)
+    celluloid (0.11.1)
+      timers (>= 1.0.0)
+    connection_pool (0.9.2)
+    cookiejar (0.3.0)
+    em-http-request (0.3.0)
+      addressable (>= 2.0.0)
+      escape_utils
+      eventmachine (>= 0.12.9)
+    escape_utils (0.2.4)
+    eventmachine (0.12.10)
+    faye (0.8.3)
+      cookiejar (>= 0.3.0)
+      em-http-request (>= 0.3.0)
+      eventmachine (>= 0.12.0)
+      faye-websocket (>= 0.4.0)
+      rack (>= 1.0.0)
+      yajl-ruby (>= 1.0.0)
+    faye-websocket (0.4.6)
+      eventmachine (>= 0.12.0)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (3.0.1)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+    sidekiq (2.2.1)
+      celluloid (~> 0.11.1)
+      connection_pool (~> 0.9.2)
+      multi_json (~> 1)
+      redis (~> 3)
+      redis-namespace
+    timers (1.0.1)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  bundler (~> 1.1.1)
+  eventmachine
+  faye
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  shoulda
+  sidekiq

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brian Goff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= faye-client
+
+This is a wrapper for Faye::Client
+It handles managing the client and spinning it off to another thread, so you can easily run this in any ruby app without blocking the main thread.
+
+To use extend your class with FayeClient.
+You will need to set self.messaging_server_url, and self.messaging_channels where the url is the url of your Faye Server, channels are the channels you want to subscribe to, e.g. ['/example']
+
+Channels are expected to have a Handler for processing the message.
+We are expecting a SidekiqWorker class here by default.
+It will search for a class with MyClass::ChannelNameHandler where MyClass is the class that you extended for FayeClient, and ChannelName is the name of the channel, capitalied, without the begingin "/" and '::' for any other slash.
+
+So a channel called '/example' should have a handler at MyClass::ExampleHandler
+This class is by default expected to be a Sidekiq::Worker (Check out the Sidekiq project @ https://github.com/mperham/sidekiq ).
+This class should have a method called "perform", which you would be passing the received message to.
+Look at the Sidekiq docs for more details.
+
+If MyClass::ExampleHandler is not found it will look for defaults from your class:
+	self.default_channel_handler_class_name
+	self.default_channel_handler_method
+
+You can also further set this on a per channel bases where instead of passing in ['/message'] as your list of channels, you would do something like:
+	
+	[{name: '/message', handler_class_name: 'MyExampleClassName', handler_class_method: 'my_method'}]
+
+Keep in mind your channel handlers need to return quickly so that FayeClient can keep handling incoming messages.  This is why by default this is getting done asyncronously with Sidekiq.
+
+
+== Contributing to faye-client
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Brian Goff. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "faye-client"
+  gem.homepage = "http://github.com/cpuguy83/faye-client"
+  gem.license = "MIT"
+  gem.summary = %Q{Quickly and easily connect your app to a Faye server}
+  gem.description = %Q{Quickly and easily connect your app to a Faye server}
+  gem.email = "cpuguy83@gmail.com"
+  gem.authors = ["Brian Goff"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+
+#task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "faye-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/faye-client.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'eventmachine'
+require 'Faye'
+require 'sidekiq'
+require 'active_support'
+require './faye_client/faye_client'
+require './faye_client/channel_handlers/default_channel_handler'

data/lib/faye_client/channel_handlers/default_channel_handler.rb

@@ -0,0 +1,10 @@
+module FayeClient
+	class DefaultChannelHandler
+		include Sidekiq::Worker
+		sidekiq_options :queue => :messaging
+
+		def perform(message)
+			message
+		end
+	end
+end

data/lib/faye_client/faye_client.rb

@@ -0,0 +1,122 @@
+module FayeClient
+	attr_accessor :messaging_client, :messaging_client_thread, :messaging_server_url, :messaging_channels
+	attr_accessor :default_channel_handler_class_name, :default_channel_handler_method
+
+
+	# Start client
+	# Will need to restart client anytime you want to add more channels
+	def start
+		raise "AlreadyRunning" if running?
+		self.messaging_client_thread = Thread.new do
+			# Must be run inside EventMachine
+			EventMachine.run {
+				# Create the actual Faye client
+				self.messaging_client = Faye::Client.new(messaging_server_url)
+				self.messaging_channels.each do |channel|
+					# Channel Handlers provide customization for how to handle a message
+					channel_handler = self.get_channel_handler(channel)
+					raise 'NoChannelNameProvided' if !channel_handler[:name]
+					self.messaging_client.subscribe(channel_handler[:name]) do |message|
+						channel_handler[:handler_class_name].send(channel_handler[:handler_method_name], message)
+					end
+				end
+			}
+		end
+	end
+
+	def stop
+		raise "NotRunning" if !running?
+		EM.stop
+	end
+
+	def restart
+		stop
+		start
+	end
+
+
+	# Is the client running?
+	def running?
+		EM.reactor_running?
+	end
+
+	def get_channel_handler(channel)
+		if channel.is_a? String
+			parsed_channel_name = channel.gsub(/^\//, '').gsub('/','::')
+			handler = get_channel_handler_for_string(parsed_channel_name)
+			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[:name] = channel[:name]
+		else
+			raise TypeError, 'Channel Must be a String or a Hash'
+		end
+
+		handler
+	end
+
+	def get_channel_handler_for_string(channel)
+		handler = {}
+		# Set handler class
+		handler[:handler_class_name] = get_channel_handler_class_name_for_string(channel)
+		# Set handler method
+		handler[:handler_method_name] = get_default_channel_handler_method_name
+		
+		handler
+	end
+
+	# Build channel handler pointers when hash is provided for channel
+	def get_channel_handler_for_hash(channel)
+		handler = {}
+		if channel[:handler_class_name] 
+			# if class name is provided, then you use it
+			handler[:handler_class_name] = channel[:handler_class_name]
+		else
+			# Get default class ifnone is provided
+			handler[:handler_class_name] = get_channel_handler_class_name_for_string(channel[:name])
+		end
+
+		if channel[:handler_method_name]
+			# Get method to use if one is provided
+			handler[:handler_method_name] = channel[:handler_method_name]
+		else
+			# Use default method if none is provided
+			handler[:handler_method_name] = get_default_channel_handler_method_name
+		end
+		return handler
+	end
+
+	def get_channel_handler_class_name_for_string(channel)
+		# Try to use the channel name to determine the class to use
+		class_name = "#{self.class}::#{channel.capitalize}Handler"
+		rescue_counter = 0
+		begin
+		class_name = ActiveSupport::Inflector.constantize class_name if class_name.is_a? String
+		rescue NameError
+			# If class_name can't be constantized, try to use a default
+			if self.default_channel_handler_class_name and rescue_counter == 0
+				# Try to use defined default from class
+				class_name = self.default_channel_handler_class_name
+			else
+				# Use gem default if defined default doesn't work
+				class_name = "FayeClient::DefaultChannelHandler"
+			end
+			rescue_counter += 1
+			retry if rescue_counter <= 1
+			raise 'CannotLoadConstant' if rescue_counter > 1
+		end
+		return class_name
+	end
+
+	def get_default_channel_handler_method_name
+		if self.default_channel_handler_method
+			# Use defined default if available
+			return self.default_channel_handler_method
+		else
+			# By default we are using Sidekiq Workers to handle incoming messages.
+			# 'perform_async' comes from Sidekiq
+			return 'perform_async'
+		end
+	end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'faye-client'
+
+class Test::Unit::TestCase
+end

data/test/test_faye-client.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFayeClient < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: faye-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Goff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Quickly and easily connect your app to a Faye server
+email: cpuguy83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- 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
+homepage: http://github.com/cpuguy83/faye-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1052917701805139625
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Quickly and easily connect your app to a Faye server
+test_files: []