faye_shards 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.10)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alex Kazeko
+
+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,97 @@
+= faye_shards
+
+* Provides some useful methods to push data from Ruby on Rails to Faye (by jcoglan, http://faye.jcoglan.com).
+* Designed to work with both HTTP and HTTPS connections (RoR pushes via HTTP, client can be connected using HTTPS). Check out http://rails-alex.blogspot.com/2011/10/ssl-support-for-high-loaded-faye-nodejs.html to see how to configure Stunnel in front of Faye to enable HTTPS.
+
+== Comments
+
+This gem will be helpful if you are planning to run more than one instance of Faye (doesn't matter on 1 server or on many).
+If users in your application are subscribed to unique channels (eg. "/#{current_user.id}") - faye_shards will fit all your needs.
+If you have global channels (which you use widely) and many instances of Faye - this game is not a perfect solution for you, but it will work.
+It doesn't matter if you use Redis as data storage or not.
+
+Check out these posts/discussions about Faye sharding:
+* http://rails-alex.blogspot.com/2011/10/high-performance-publishsubscribe.html
+* https://groups.google.com/forum/#!topic/faye-users/1B6pSKBZKFQ
+
+== Installing
+
+Simply add
+
+<code> gem 'faye_shards'</code>
+
+to your Gemfile
+
+== Configuration
+
+All you need to configure gem is to create file faye.yml in config folder. Here is an example:
+
+
+    development:
+      shards:
+        -
+          port: 42000
+          host: 127.0.0.1
+        -
+          port: 42001
+          host: 127.0.0.1
+    production:
+      shards:
+        -
+          local_host: 10.1.1.1
+          port: 42000
+          host: server1.myapp.com
+          secured: true
+          secured_port: 32000
+        -
+          local_host: 10.1.1.1
+          port: 42001
+          host: server1.myapp.com
+          secured: true
+          secured_port: 32001
+
+Required options:
+* <tt>host</tt> - IP or domain name where instance of Faye is running
+* <tt>port</tt> - port, instance of Faye is listening to
+
+Optional params:
+* <tt>local_host</tt> - local IP of server. Used for pushes from Rails instead of <tt>host</tt> if specified. Just to communicate via local interfaces.
+* <tt>secured</tt> - <tt>true/false</tt>. Specifies if there is a SSL Offloading configured for Faye instance.
+* <tt>secured_port</tt> - Required if secured is set to <tt>true</tt>.
+
+So, in my example for production I have 2 Faye instances listening to ports 42000 and 42001 using HTTP + Stunnel configured to listen 32000 and 32001.
+
+== Usage
+
+URL for Faye's client-side JS (unless you store it somewhere on diff storage) is returned by this methos:
+  FayeShards.shard(current_user.id).js_url
+
+Module <code>FayeShard::User::Faye</code> which can be included to your User model provides method <tt>faye_channel</tt> which returns unique channel id for user. If you do not want to include module to your model - you need to manage unique channels for users yourself.
+
+On client side, subscription should look like:
+  client = new Faye.Client(<%= raw FayeShards.shard(current_user.id).url(request.ssl?).inspect %>);
+  fayeSubscription = client.subscribe(<%= raw current_user.faye_channel.inspect %>, function(data) {});
+
+or
+  fayeSubscription = client.subscribe(<%= raw my_own_method_for_channel_id.inspect %>, function(data) {});
+
+
+Pushing data to user's channel also depends on your decision to include module <code>FayeShard::User::Faye</code>. So, 2 options:
+  current_user.push_to_faye(data) # Sends data to channel, returned by current_user.faye_channel
+or
+  FayeShards.shard(1).push(my_own_method_for_channel_id, data)
+
+Extensions can be passed as an additional hash after <tt>data</tt>
+
+How to push to global channel and more information about gem can be found here: TODO.
+
+== Roadmap / TODO
+* UT
+* Add example Rails app which uses faye_shards.
+* GOD scripts to start/monitor Faye instances based on faye.yml
+
+== Copyright
+
+Copyright (c) 2011 Alex Kazeko. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# 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_shards"
+  gem.homepage = "http://github.com/alexkazeko/faye_shards"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides support for easy communication with Faye shards}
+  gem.description = %Q{Provides support for easy communication with Faye shards}
+  gem.email = "alexandr.temp@gmail.com"
+  gem.authors = ["Alex Kazeko"]
+  gem.files.exclude 'tmp'
+  gem.files.include 'lib/faye_shard/*.rb'
+  # 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 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "faye_shards #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/examples/config/faye.yml

@@ -0,0 +1,25 @@
+development:
+  shards:
+    -
+      port: 42000
+      host: 127.0.0.1
+      secured: false
+    -
+      port: 42001
+      host: 127.0.0.1
+      secured: false
+
+production:
+  shards:
+    -
+      local_host: 10.1.1.1
+      port: 42000
+      host: server1.myapp.com
+      secured: true
+      secured_port: 32000
+    -
+      local_host: 10.1.1.1
+      port: 42001
+      host: server1.myapp.com
+      secured: true
+      secured_port: 32001

data/faye_shards.gemspec

@@ -0,0 +1,63 @@
+# 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 = %q{faye_shards}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Kazeko"]
+  s.date = %q{2011-11-01}
+  s.description = %q{Provides support for easy communication with Faye shards}
+  s.email = %q{alexandr.temp@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/config/faye.yml",
+    "faye_shards.gemspec",
+    "lib/faye_shard/shard.rb",
+    "lib/faye_shard/user/faye.rb",
+    "lib/faye_shards.rb",
+    "test/helper.rb",
+    "test/test_faye_shards.rb"
+  ]
+  s.homepage = %q{http://github.com/alexkazeko/faye_shards}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides support for easy communication with Faye shards}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/faye_shard/shard.rb

@@ -0,0 +1,54 @@
+module FayeShard
+
+  class Shard
+
+    attr_accessor :configuration
+
+    #  Creates a shard instance and assigns the config to it.
+    #
+    #  * <tt>config</tt>:: Config to use.
+    #
+    def initialize(config)
+      self.configuration = config.with_indifferent_access
+    end
+
+    #  Returns URL for client.
+    #
+    #  * <tt>https</tt>:: Specifies whether to use SSL connection or not
+    #
+    def url(https = false)
+      secured = (configuration['secured'] || false) & https
+      port = secured ? configuration["secured_port"] : configuration["port"]
+      "http#{secured ? 's' : ''}://#{configuration["host"]}:#{port}/faye"
+    end
+
+    #  Returns default client JS url
+    #
+    def js_url
+      url + '.js'
+    end
+
+    #  Local url, needed for RoR <-> Faye communication
+    #
+    def local_url
+      host = configuration["local_host"] || configuration["host"]
+      "http://#{host}:#{configuration["port"]}/faye"
+    end
+
+    #  Pushes data to a Faye shard
+    #
+    #  * <tt>channel</tt>:: User's channel
+    #  * <tt>data</tt>::    Data to push
+    #  * <tt>ext</tt>::     Faye extensions, eg. auth_token
+    #
+    def push(channel, data, ext = {})
+      uri = URI.parse(self.local_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      req = Net::HTTP::Post.new uri.path
+      req.set_form_data('message' => {'channel' => channel, 'data' => data, 'ext' => ext}.to_json)
+      http.request req
+    end
+
+  end
+
+end

data/lib/faye_shard/user/faye.rb

@@ -0,0 +1,29 @@
+module FayeShard
+
+  module User
+
+    # Module which is designed to be included to User model.
+    # It provides helper method to get token and method to push data to user's shard.
+    #
+    module Faye
+
+      #  Returns channel for a user, which is basically /ID
+      #
+      def faye_channel
+        "/#{self.id}"
+      end
+
+      #  Pushes data to User's Faye shard
+      #
+      #  * <tt>data</tt>::    Data to push
+      #  * <tt>ext</tt>::     Faye extensions, eg. auth_token
+      #
+      def push_to_faye(data, ext = {})
+        FayeShards.shard(self.id).push(self.faye_channel, data, ext)
+      end
+
+    end
+
+  end
+
+end

data/lib/faye_shards.rb

@@ -0,0 +1,38 @@
+require 'faye_shard/shard'
+require 'faye_shard/user/faye'
+
+class FayeShards
+
+  class << self
+
+    #  Returns configuration for current Rails environment.
+    #
+    #  * <tt>env</tt>:: Rails environment, defaults to +Rails.env+.
+    #
+    def config
+      @config ||= YAML.load(File.read(Rails.root.to_s + "/config/faye.yml"))
+      @config[Rails.env]
+    end
+
+    #  Returns the object which represents a connection to a specific shard. The object is effectively
+    #  an instance of +FayeShards::Shard+ class which can be found in this gem.
+    #
+    #  * <tt>id</tt>:: Id (an integer, string of whatever) to perform sharding based on.
+    #
+    def shard(id)
+      @shards ||= {}
+
+      shard_configs = config["shards"]
+
+      @shards[id % shard_configs.size] ||= FayeShard::Shard.new(shard_configs[id % shard_configs.size])
+    end
+
+    #  Returns all configured shards
+    #
+    def all_shards
+      @shards ||= config["shards"].map{ |shard_config| FayeShard::Shard.new(shard_config) }
+    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_shards'
+
+class Test::Unit::TestCase
+end

data/test/test_faye_shards.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFayeShards < 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,140 @@
+--- !ruby/object:Gem::Specification 
+name: faye_shards
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Kazeko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-01 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  type: :development
+  name: shoulda
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: rcov
+description: Provides support for easy communication with Faye shards
+email: alexandr.temp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/config/faye.yml
+- faye_shards.gemspec
+- lib/faye_shard/shard.rb
+- lib/faye_shard/user/faye.rb
+- lib/faye_shards.rb
+- test/helper.rb
+- test/test_faye_shards.rb
+has_rdoc: true
+homepage: http://github.com/alexkazeko/faye_shards
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides support for easy communication with Faye shards
+test_files: []
+