socky-client-rails 0.4.1

data/assets/socky_hosts.yml

@@ -0,0 +1,5 @@
+:hosts:
+  - :host: 127.0.0.1
+    :port: 8080
+    :secret: my_secret_key
+    :secure: false

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/socky-client-rails'

data/lib/socky-client-rails/helper.rb

@@ -0,0 +1,19 @@
+require 'action_view'
+
+module Socky
+  module Helper
+
+    def socky(options = {})
+      host = Socky.random_host
+      options = {
+        :host                 => (host[:secure] ? "wss://" : "ws://") + host[:host],
+        :port                 => host[:port],
+      }.merge(options)
+      javascript_tag "new Socky('#{options.delete(:host)}', '#{options.delete(:port)}', '#{options.to_query}');"
+    end
+
+  end
+end
+
+ActionView::Base.send(:include, Socky::Helper)
+ActionView::Helpers::AssetTagHelper.register_javascript_expansion :socky => ['socky']

data/lib/socky-client-rails/java_script_generator.rb

@@ -0,0 +1,30 @@
+require 'action_view'
+
+module Socky
+  class JavaScriptGenerator
+    include ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods
+
+    def initialize(&block)
+      @lines = []
+      
+      if defined?(Rails)
+        case Rails::VERSION::MAJOR
+        when 2
+          @context = eval("self.instance_variable_get('@template')", block.binding)
+          block.call(self)
+          unless @context.nil?
+            @context.controller.response.body = nil
+            @context.controller.instance_variable_set("@performed_render",false)
+          end
+        when 3
+          @context = eval("self.view_context", block.binding)
+          block.call(self)
+          @context.controller.instance_variable_set("@_response_body",nil) unless @context.nil?
+        end
+      else
+        block.call(self)
+      end
+    end
+
+  end
+end

data/lib/socky-client-rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'socky-client-rails'
+require 'rails'
+module Socky
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/socky-client-rails.rake"
+    end
+  end
+end

data/lib/socky-client-rails.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+require 'socky-client'
+require File.dirname(__FILE__) + '/socky-client-rails/helper'
+require File.dirname(__FILE__) + '/socky-client-rails/java_script_generator'
+require 'socky-client-rails/railtie' if defined?(Rails::Railtie)
+
+module Socky
+  
+  class << self
+
+    def config_path
+      @config_path ||= Rails.root.join("config","socky_hosts.yml")
+    end
+
+    def send(data = nil, options = {}, &block)
+      options = normalize_options(data, options)
+      options[:data] = JavaScriptGenerator.new(&block).to_s unless block.nil?
+      send_message(options.delete(:data), options)
+    end
+
+    def random_host
+      hosts[rand(hosts.size)]
+    end
+
+  end
+
+end

data/lib/tasks/socky-client-rails.rake

@@ -0,0 +1,70 @@
+require 'fileutils'
+
+SOCKY_SCRIPTS = ['/socky.js', '/socky']
+SOURCE_PREFIX = File.join(File.dirname(__FILE__), '..', '..', 'assets')
+DEST_PREFIX = Rails.root.join('public', 'javascripts').to_s
+
+namespace :socky do
+  desc 'Install the Socky scripts and create configuration file'
+  task :install => [:create_scripts, :create_config]
+
+  desc 'Update the Socky scripts'
+  task :update => [:create_scripts]
+
+  desc 'Remove the Socky scripts'
+  task :uninstall => [:remove_scripts]
+
+  task :create_config do
+    source = SOURCE_PREFIX + '/socky_hosts.yml'
+    dest = Rails.root.join('config', 'socky_hosts.yml').to_s
+    if File.exists?(dest)
+      puts "Removing #{dest}."
+      FileUtils.rm_rf dest
+    end
+    begin
+      puts "Copying to #{dest}."
+      FileUtils.cp_r source, dest
+      puts "Successfully updated #{dest}."
+    rescue
+      puts "ERROR: Problem creating config. Please manually copy " + source + " to " + dest
+    end
+  end
+
+
+  task :create_scripts do
+    SOCKY_SCRIPTS.each do |file_suffix|
+      source = SOURCE_PREFIX + file_suffix
+      dest = DEST_PREFIX + file_suffix
+      if File.exists?(dest)
+        puts "Removing #{dest}."
+        FileUtils.rm_rf dest
+      end
+      begin
+        puts "Copying to #{dest}."
+        FileUtils.cp_r source, dest
+        puts "Successfully updated #{dest}."
+      rescue
+        puts "ERROR: Problem updating scripts. Please manually copy " + source + " to " + dest
+      end
+    end
+  end
+
+  task :remove_scripts do
+    SOCKY_SCRIPTS.each do |dest_suffix|
+      dest = DEST_PREFIX + dest_suffix
+      if File.exists?(dest)
+         begin
+          puts "Removing #{dest}..."
+          FileUtils.rm_rf dest
+          puts "Successfully removed #{dest}"
+          rescue
+          puts "ERROR: Problem removing #{dest}. Please remove manually."
+         end
+      else
+        puts "ERROR: #{dest} not found."
+      end
+    end
+    puts "Successfully removed Socky."
+  end
+
+end

data/spec/socky-client-rails_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Socky do
+  context "#send" do
+    before(:each) do
+      described_class.stub!(:send_data)
+    end
+    context "should normalize options" do
+      it "when block given" do
+        described_class.should_receive(:send_data).with({:command => :broadcast, :body => "test"})
+        described_class.send do |page|
+          page << "test"
+        end
+      end
+    end
+    context "with block" do
+      it "should allow javascript helpers" do
+        described_class.should_receive(:send_data).with({:command => :broadcast, :body => "alert(\"test!\");"})
+        described_class.send do |page|
+          page.alert("test!")
+        end
+      end
+      it "should handle variables from current context" do
+        phrase = "test phrase"
+        described_class.should_receive(:send_data).with({:command => :broadcast, :body => phrase})
+        described_class.send do |page|
+          page << phrase
+        end
+      end
+    end
+  end
+  
+  it "#random_host should return host" do
+    described_class.random_host.should eql(described_class.hosts.first)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+require 'socky-client-rails'

data/spec/support/config/socky_hosts.yml

@@ -0,0 +1,5 @@
+:hosts:
+  - :host: 127.0.0.1
+    :port: 8080
+    :secret: my_secret_key
+    :secure: false

data/spec/support/config.rb

@@ -0,0 +1,9 @@
+unless defined?(Rails)
+  require 'pathname'
+  require 'rails/version'
+  module Rails
+    def self.root
+      Pathname.new(File.dirname(__FILE__))
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: socky-client-rails
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
+platform: ruby
+authors: 
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: socky-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+description: Socky is a WebSocket server and client for Ruby
+email: bernard.potocki@imanel.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- CHANGELOG.md
+- README.md
+- Rakefile
+- VERSION
+- assets/socky.js
+- assets/socky/WebSocketMain.swf
+- assets/socky_hosts.yml
+- init.rb
+- lib/socky-client-rails.rb
+- lib/socky-client-rails/helper.rb
+- lib/socky-client-rails/java_script_generator.rb
+- lib/socky-client-rails/railtie.rb
+- lib/tasks/socky-client-rails.rake
+- spec/socky-client-rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/config/socky_hosts.yml
+has_rdoc: true
+homepage: http://imanel.org/projects/socky
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Socky is a WebSocket server and client for Ruby
+test_files: 
+- spec/socky-client-rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.rb