socky-client-rails 0.4.3 → 0.4.5

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+## 0.4.5 / 2011-05-12
+
+- support for Rails 3.1
+
+## 0.4.4 / 2011-03-22
+
+- moved documentation to readme
+- added gemspec to repo - bundler require that
+- fix downloading scripts from repo
+
 ## 0.4.3 / 2010-11-05
 
 - new features:

data/README.md

@@ -3,20 +3,91 @@ Socky - client bindings for Ruby on Rails
 
 Socky is push server for Ruby based on WebSockets. It allows you to break border between your application and client browser by letting the server initialize a connection and push data to the client.
 
-## Getting Started
+## Example
 
-- [Install](http://github.com/socky/socky-client-rails/wiki/install) the gem
-- Read up about its [Usage](http://github.com/socky/socky-client-rails/wiki/usage), [Configuration](http://github.com/socky/socky-client-rails/wiki/configuration) and [Customizing JavaScript](http://github.com/socky/socky-js/wiki/Customizing-JavaScript)
-- Try [Example Application](http://github.com/socky/socky-example) or [demo page](http://sockydemo.imanel.org)
-- Fork and Contribute your own modifications
-- See [sites using socky](http://github.com/socky/socky-server-ruby/wiki/sites)
-- Discuss on [google group](http://groups.google.com/group/socky-framework)
+You can try [live example](http://sockydemo.imanel.org) or view its [source code](http://github.com/socky/socky-example)
+
+Also important information can be found on our [google group](http://groups.google.com/group/socky-users).
+
+## Install
+
+The best way to install Socky Ruby on Rails bindings is via RubyGems:
+
+    gem install socky-client-rails
+
+Socky Ruby on Rails bindings require the [socky-client](http://github.com/socky/socky-client-ruby) gem. It is automatically installed by the gem install command.
+
+You can also build it after clonning(this will require Jeweler gem)
+
+    git clone git://github.com/socky/socky-client-rails.git
+    rake gemspec
+    rake build
+
+## Configuration
+
+Configuration file is located in application config directory:
+
+    config/socky_hosts.yml
+
+If it isn't exists then you will need to generate it. In Rails 3 you can use rake task:
+
+    rake socky:install
+
+which also install Socky JS files.
+
+If you are using Rails 2 then you will need to generate rake tasks first(this will be required only once):
+
+    script/generate socky
+
+More about configuraton can be found in [socky-client-ruby](http://github.com/socky/socky-client-ruby).
+
+## Usage
+
+### View
+
+Socky Ruby on Rails bindings provide `socky` helper for views and :socky javascript expansion.
+
+At first you will need set of javascripts providing bridge between browser and WebSocket connection.
+
+    <%= javascript_include_tag :socky %>
+
+This will also load javascripts that will use flash to simulate WebSocket if browser don't support it.
+
+After that you can use @socky@ helper to create connection with Socky server.
+
+    <%= socky %>
+
+Helper is accepting following options in hash form:
+
+| *Option*       | *Value format*     | *Description* |
+| -------------- | ------------------ | ------------- |
+| `:host`        | `[string]`         | IP or hostname of Socky server - at default random server from socky_hosts.yml is taken
+| `:port`        | `[integer]`        | Port on with Socky server listens - at default random server from socky_hosts.yml is taken
+| `:user_id`     | `[string/integer]` | Hash by with user will be identified
+| `:user_secret` | `[string]`         | Hash by with user will be authenticated
+| `:channels`    | `[array]`          | List of channels to with user will be connected
+
+### Model and controller
+
+Socky Ruby on Rails bindings offers all functionality of [socky-client-ruby](http://github.com/socky/socky-client-ruby) and additional method to send data via `Socky.send` command. You can use block of code and passed object will be standard Rails JavaScript generator.
+
+    Socky.send do |page|
+      page.alert('ok!')
+    end
+
+Note that you can as usually use old methods and connect them with new method:
+
+    Socky.send :users => ["user1", "user2"] do |page|
+      page.alert('ok!')
+    end
+
+Also note that if you use block version any data passed as body will be overwritten.
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2010 Bernard Potocki 
+Copyright (c) 2010 Bernard Potocki
 
 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:
 

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.5

data/lib/socky-client-rails.rb

@@ -1,27 +1,35 @@
+require 'rails'
 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
-  
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
+  autoload :Helper,              "#{ROOT}/socky-client-rails/helper"
+  autoload :JavaScriptGenerator, "#{ROOT}/socky-client-rails/java_script_generator"
+
   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
 
+    # Javascript will not work in Rails >= 3.1 due to removing PrototypeHelper
+    unless Rails.version >= '3.1'
+      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
+    end
+
   end
+end
 
-end
+ActionView::Base.send(:include, Socky::Helper)
+ActionView::Helpers::AssetTagHelper.register_javascript_expansion :socky => ['socky']

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

@@ -1,5 +1,3 @@
-require 'action_view'
-
 module Socky
   module Helper
 
@@ -14,6 +12,3 @@ module Socky
 
   end
 end
-
-ActionView::Base.send(:include, Socky::Helper)
-ActionView::Helpers::AssetTagHelper.register_javascript_expansion :socky => ['socky']

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

@@ -1,11 +1,16 @@
 require 'fileutils'
 
+RAILS_ASSET_PATH = Rails.version >= '3.1' ? 'app/assets' : 'public'
+RAILS_ASSET_URL  = Rails.version >= '3.1' ? 'assets' : 'javascripts'
+
 SOCKY_JS_VERSION = File.read(File.dirname(__FILE__) + '/../../VERSION').strip.split('.')[0,2].join('.')
-SOCKY_JS_SERVER = 'https://github.com/socky/socky-js/raw'
-SOCKY_JS_DEST = Rails.root.join('public', 'javascripts').to_s
+SOCKY_JS_SERVER = 'http://js.socky.org'
+SOCKY_JS_DEST = Rails.root.join(RAILS_ASSET_PATH, 'javascripts').to_s
 SOCKY_JS_FILES = {
   'socky.js' => 'socky.js',
-  'WebSocketMain.swf' => 'socky/WebSocketMain.swf'
+  'assets/flashfallback.js'  => 'socky/flashfallback.js',
+  'assets/json2.js'          => 'socky/json2.js',
+  'assets/WebSocketMain.swf' => 'socky/WebSocketMain.swf'
 }
 
 CONFIG_PATH = File.join(File.dirname(__FILE__), '..', '..', 'assets', 'socky_hosts.yml')
@@ -40,7 +45,7 @@ namespace :socky do
     puts 'Downloading files...'
     SOCKY_JS_FILES.each do |source, dest|
       begin
-        uri = URI.parse(SOCKY_JS_SERVER + '/v' + SOCKY_JS_VERSION + '-stable/' + source)
+        uri = URI.parse(SOCKY_JS_SERVER + '/v' + SOCKY_JS_VERSION + '/' + source)
         file = File.join(SOCKY_JS_DEST, dest)
         puts ' + ' + dest
         FileUtils.mkdir_p(File.dirname(file))
@@ -58,7 +63,7 @@ namespace :socky do
       puts 'Updating assets info'
       text = File.read(script_file)
       open(script_file, 'wb') do |f|
-        f.write text.gsub('WEB_SOCKET_SWF_LOCATION = "WebSocketMain.swf"', 'WEB_SOCKET_SWF_LOCATION = "/javascripts/socky/WebSocketMain.swf"')
+        f.write text.gsub(/SOCKY_ASSET_LOCATION = '(.+)';/, "SOCKY_ASSET_LOCATION = \"/#{RAILS_ASSET_URL}/socky\";")
       end
     end
     puts "Done"

data/socky-client-rails.gemspec

@@ -0,0 +1,58 @@
+# 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{socky-client-rails}
+  s.version = "0.4.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bernard Potocki"]
+  s.date = %q{2011-05-12}
+  s.description = %q{Socky is a WebSocket server and client for Ruby}
+  s.email = %q{bernard.potocki@imanel.org}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "assets/socky_hosts.yml",
+    "generators/socky/socky_generator.rb",
+    "generators/socky/templates/socky.rake",
+    "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",
+    "socky-client-rails.gemspec",
+    "spec/socky-client-rails_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/config.rb",
+    "spec/support/config/socky_hosts.yml"
+  ]
+  s.homepage = %q{http://imanel.org/projects/socky}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.1}
+  s.summary = %q{Socky is a WebSocket server and client for Ruby}
+
+  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<socky-client>, ["~> 0.4.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<socky-client>, ["~> 0.4.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<socky-client>, ["~> 0.4.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+  end
+end
+

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: socky-client-rails
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 3
-  version: 0.4.3
+  prerelease: 
+  version: 0.4.5
 platform: ruby
 authors: 
 - Bernard Potocki
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-04 00:00:00 +01:00
+date: 2011-05-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 4
-        - 2
         version: 0.4.2
   type: :runtime
   version_requirements: *id001
@@ -42,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
         version: "2.0"
   type: :development
   version_requirements: *id002
@@ -71,6 +57,7 @@ files:
 - lib/socky-client-rails/java_script_generator.rb
 - lib/socky-client-rails/railtie.rb
 - lib/tasks/socky-client-rails.rake
+- socky-client-rails.gemspec
 - spec/socky-client-rails_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
@@ -80,8 +67,8 @@ homepage: http://imanel.org/projects/socky
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -89,27 +76,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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
+rubygems_version: 1.6.1
 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
+test_files: []
+