socketable-rails 0.1.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,62 @@
+= SocketableRails
+
+Tests coming soon.
+
+Socketable-rails uses @DanKnox Websocket-Rails gem: http://github.com/DanKnox/websocket-rails.
+
+== Installation
+
+Add to Gemfile
+    gem 'socketable-rails'
+
+Then
+    $ cd rails/app/path
+    $ bundle install
+    $ rake socketable:install
+    $ thin start
+
+
+== Usage
+
+Building a realtime chat:
+
+=== message.rb
+Normal model
+  class Message < ActiveRecord::Base
+    attr_accessible :content
+  end
+
+
+=== home/index.html.erb
+You need to add a :websocket => true parameter to your form
+  <%= form_for @message, :websocket => true do |f| %>
+    <%= f.text_area :content %>
+    <button class="btn">Submit</button>
+  <% end %>
+  <div id="msgs">
+  </div>
+
+=== messages_controller.rb
+Create a function named *websocket* in your controller to handle the request
+  class MessagesController < ApplicationController
+    def websocket(params, socket)
+      message = Message.create(params[:message])
+      socket.broadcast(message, :create_message)
+    end
+  end
+
+=== javascript
+Bind the event you triggered in the controller
+  Socketable.dispatcher().bind('create_message', function(data) {
+    $('#msgs').append($('<div></div>').html(data.content));
+  });
+
+
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SocketableRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/socketable_controller.rb

@@ -0,0 +1,44 @@
+class SocketableController < WebsocketRails::BaseController
+  attr_accessor :params
+
+  # Handle all requests
+	def request
+    begin
+      @params = formated_params
+      controller.new.websocket(params, self)
+  	rescue Exception => e
+      error_message e
+  	end
+  end
+
+  def emit(data, to_event)
+    send_message(to_event, data)
+  end
+
+  def broadcast(data, to_event)
+    broadcast_message(to_event, data)
+  end
+
+
+  private
+
+  def formated_params
+    params = {}
+    Rack::Utils.parse_nested_query(data).each do |key, value|
+      key  = key.to_sym
+      params[key] = value
+    end
+    params[:path] = Rails.application.routes.recognize_path(params[:path])
+    params
+  end
+
+  def error_message(e)
+    puts "-- Error in websocket function"
+    puts e.message
+  end
+
+  def controller
+    "#{@params[:path][:controller]}_controller".camelize.constantize
+  end
+
+end

data/config/initializers/events.rb

@@ -0,0 +1,32 @@
+WebsocketRails.setup do |config|
+  # Uncomment to override the default log level. The log level can be
+  # any of the standard Logger log levels. By default it will mirror the
+  # current Rails environment log level.
+  # config.log_level = :debug
+
+  # Uncomment to change the default log file path.
+  # config.log_path = "#{Rails.root}/log/websocket_rails.log"
+
+  # Set to true if you wish to log the internal websocket_rails events
+  # such as the keepalive `websocket_rails.ping` event.
+  # config.log_internal_events = false
+
+  # Change to true to enable standalone server mode
+  # Start the standalone server with rake websocket_rails:start_server
+  # * Requires Redis
+  config.standalone = false
+
+  # Change to true to enable channel synchronization between
+  # multiple server instances.
+  # * Requires Redis.
+  config.synchronize = false
+
+  # Uncomment and edit to point to a different redis instance.
+  # Will not be used unless standalone or synchronization mode
+  # is enabled.
+  # config.redis_options = {:host => 'localhost', :port => '6379'}
+end
+
+WebsocketRails::EventMap.describe do
+  subscribe :request, "socketable#request"
+end

data/config/initializers/form_builder.rb

@@ -0,0 +1,39 @@
+module ActionView::Helpers::FormHelper
+	alias :orig_form_for :form_for
+
+  def form_for(record, options = {}, &proc)
+		if options.include?(:websocket)
+			options[:html] ||= {}
+			options[:html][:websocket] = options.delete(:websocket) if options.has_key?(:websocket)
+		end
+		orig_form_for(record, options, &proc)
+	end
+end
+
+module ActionView::Helpers::FormTagHelper
+  def html_options_for_form(url_for_options, options)
+    options.stringify_keys.tap do |html_options|
+      html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart")
+      # The following URL is unescaped, this is just a hash of options, and it is the
+      # responsibility of the caller to escape all the values.
+      html_options["action"]  = url_for(url_for_options)
+      html_options["accept-charset"] = "UTF-8"
+
+      html_options["data-remote"] = true if html_options.delete("remote")
+
+      # Add option for data-websocket
+      html_options["data-websocket"] = true if html_options.delete("websocket")
+
+      if html_options["data-remote"] &&
+         !embed_authenticity_token_in_remote_forms &&
+         html_options["authenticity_token"].blank?
+        # The authenticity token is taken from the meta tag in this case
+        html_options["authenticity_token"] = false
+      elsif html_options["authenticity_token"] == true
+        # Include the default authenticity_token, which is only generated when its set to nil,
+        # but we needed the true value to override the default of no authenticity_token on data-remote.
+        html_options["authenticity_token"] = nil
+      end
+    end
+  end
+end

data/lib/assets/javascripts/socketable_rails/main.js

@@ -0,0 +1,3 @@
+//= require websocket_rails/main
+//= require ./socketable_ujs
+//= require ./socketable_init

data/lib/assets/javascripts/socketable_rails/socketable_init.js

@@ -0,0 +1,7 @@
+$(function() {
+  if (Socketable.exists()) {
+    Socketable.onDefaultAction(function() {
+      Socketable.dispatcher().trigger('request', Socketable.data());
+    });
+  }
+});

data/lib/assets/javascripts/socketable_rails/socketable_ujs.js

@@ -0,0 +1,33 @@
+(function(window, $) {
+  window.Socketable = function() {
+    var selector, dispatcher, path, host_with_port;
+
+    path           = window.location.pathname;
+    host_with_port = window.location.host;
+    selector   = 'form[data-websocket]';
+
+    return {
+      DEFAULT_EVENT_NAME: 'request',
+      dispatcher: function() {
+        if(typeof dispatcher !== 'object') {
+          dispatcher = new WebSocketRails(host_with_port + "/websocket");
+        }
+        return dispatcher;
+      },
+      exists: function() {
+        return $(selector).length > 0;
+      },
+      data: function() {
+        // if seletor is form
+        return $(selector).serialize() + "&path=" + $(selector).attr('action');
+      },
+      onDefaultAction: function(fn) {
+        // if selector is form
+        $(selector).submit(function(e) {
+          e.preventDefault();
+          fn();
+        });
+      }
+    };
+  }();
+})(window, jQuery);

data/lib/socketable-rails.rb

@@ -0,0 +1,5 @@
+require "socketable-rails/engine"
+require "websocket-rails"
+
+module SocketableRails
+end

data/lib/socketable-rails/engine.rb

@@ -0,0 +1,4 @@
+module SocketableRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/socketable-rails/version.rb

@@ -0,0 +1,3 @@
+module SocketableRails
+  VERSION = "0.1.2"
+end

data/lib/tasks/install.rake

@@ -0,0 +1,67 @@
+require 'rails'
+namespace :socketable do
+	task :install => [:add_js_to_manifest, :remove_rack_lock_on_development]
+
+	desc "Add config.middleware.delete(Rack::Lock)"
+	task :remove_rack_lock_on_development do
+		config = "config/environments/development.rb"
+
+		def remove_middleware_code
+			out = ?\n
+			out << "  # Line generated by socketable:install task"
+			out << ?\n
+			out << "  config.middleware.delete(Rack::Lock)"
+			out << ?\n
+			out << 'end'
+		end
+
+		def config.middleware_removed?
+			not (contents =~ /config\.middleware\.delete\(Rack::Lock\)/m).nil?
+		end
+
+		def config.contents
+			open(self).read
+		end
+
+		def config.add_configuration_code
+			data = contents
+			data = data.split('end')
+			data.delete_at(data.length-1)
+
+			data.last.concat ?\n
+			data.last.concat "  # Line generated by socketable:install task"
+			data.last.concat ?\n
+			data.last.concat "  config.middleware.delete(Rack::Lock)"
+			data.last.concat ?\n
+			data << nil
+
+			data = data.join('end')
+
+			open self, 'w' do |f|
+				f << data
+				# f << data.gsub!(/(.*)\nend/, "\1#{remove_middleware_code}")
+			end
+		end
+
+		unless config.middleware_removed?
+			config.add_configuration_code
+		end
+	end
+
+	desc "Add socketable javascript to manifest"
+	task :add_js_to_manifest do
+    manifest = "app/assets/javascripts/application.js"
+
+    def manifest.socketable_added?
+			not (open(self).read =~ /\/\/= require socketable_rails\/main/m).nil?
+    end
+
+    def manifest.add_socketable_js_to_manifest
+			open(self, 'a+'){ |f| f << "\n//= require socketable_rails/main\n" }
+    end
+
+    unless manifest.socketable_added?
+    	manifest.add_socketable_js_to_manifest
+    end
+	end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: socketable-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Rafael Garcia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: websocket-rails
+  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: coffee-rails
+  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'
+description: Very small and simple gem that makes using websockets really easy.
+email:
+- rafbgarcia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/socketable_controller.rb
+- config/initializers/form_builder.rb
+- config/initializers/events.rb
+- lib/socketable-rails.rb
+- lib/tasks/install.rake
+- lib/socketable-rails/version.rb
+- lib/socketable-rails/engine.rb
+- lib/assets/javascripts/socketable_rails/socketable_init.js
+- lib/assets/javascripts/socketable_rails/main.js
+- lib/assets/javascripts/socketable_rails/socketable_ujs.js
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/rafbgarcia/socketable-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails websocket made easy
+test_files: []