socky 0.0.7 → 0.0.8

data/CHANGELOG.textile

@@ -0,0 +1,25 @@
+h1. Changelog
+
+h2. 0.0.8 / 2010-06-06
+
+* new features:
+** full rspec suite
+** allow admin param to be both "1" and "true"
+* bugfixes:
+** proper configuration options parsing order
+** rescue from invalid config file
+** rescue from invalid args
+** symbolize_keys will no longer raise error if argument is not hash
+** modules will no longer depend on parent class
+** message will no longer raise exeption is JSON is invalid
+
+h2. 0.0.7 / 2010-05-25
+
+* new features:
+** user authentication is now async
+* bugfixes:
+** server will no longer fail when starting from source instead of gem
+
+h2. 0.0.6 / 2010-05-24
+
+* initial release

data/README.textile

@@ -0,0 +1,27 @@
+h1. Socky
+
+Socky is push server for Ruby on Rails based on WebSockets. It allows you to breake border between your application and client browser by letting the server initialize a connection and push data to the client.
+
+h2. Getting Started
+
+* "Install":http://wiki.github.com/imanel/socky_gem/install the gem
+* Read up about its "Usage":http://wiki.github.com/imanel/socky_gem/usage and "Configuration":http://wiki.github.com/imanel/socky_gem/configuration
+* Try "Example Application":http://github.com/imanel/socky_example
+* Fork and Contribute your own modifications
+
+h2. Runtime Dependencies
+
+* EM-WebSocket: Backend for WebSocket server
+* EM-HTTP-Client: Sending authorize requests
+
+h2. License
+
+(The MIT License)
+
+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:
+
+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/Rakefile

@@ -1,3 +1,13 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.ruby_opts = ['-rtest/unit']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
@@ -13,4 +23,13 @@ begin
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+    # config.graph_engine = :gchart
+  end
+rescue LoadError
+  puts "MetricFu not available. Install it with: gem install metric_fu"
 end

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/em-websocket_hacks.rb

@@ -2,9 +2,7 @@ EventMachine::WebSocket::Connection.class_eval do
 
   def debug(*data)
     if @debug
-      data.each do |d|
-        Socky.logger.debug "Socket " + d.collect{|dd| dd.to_s.gsub("\r\n","\n").gsub("\n","\\n")}.join(" ")
-      end
+      Socky.logger.debug "Socket " + data.flatten.collect{|line| line.to_s.gsub("\r\n","\n").gsub("\n","\\n")}.join(" ")
     end
   end
 

data/lib/socky.rb

@@ -7,36 +7,30 @@ require 'em-websocket_hacks'
 
 module Socky
 
-  class SockyError < StandardError #:nodoc:
-  end
+  class SockyError < StandardError; end #:nodoc:
 
   VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip
 
-  @@options = {}
-
   class << self
     def options
-      @@options
+      @options ||= {}
     end
 
     def options=(val)
-      @@options = val
+      @options = val
     end
 
     def logger
-      return @@logger if defined?(@@logger) && !@@logger.nil?
-      FileUtils.mkdir_p(File.dirname(log_path))
-      @@logger = Logger.new(log_path)
-      @@logger.level = Logger::INFO unless options[:debug]
-      @@logger
+      return @logger if defined?(@logger) && !@logger.nil?
+      path = log_path
+      FileUtils.mkdir_p(File.dirname(path))
+      prepare_logger(path)
     rescue
-      @@logger = Logger.new(STDOUT)
-      @@logger.level = Logger::INFO unless options[:debug]
-      @@logger
+      prepare_logger(STDOUT)
     end
 
     def logger=(logger)
-      @@logger = logger
+      @logger = logger
     end
 
     def log_path
@@ -46,6 +40,14 @@ module Socky
     def config_path
       options[:config_path] || File.join(%w( / var run socky.yml ))
     end
+
+    private
+
+    def prepare_logger(output)
+      @logger = Logger.new(output)
+      @logger.level = Logger::INFO unless options[:debug]
+      @logger
+    end
   end
 end
 

data/lib/socky/connection.rb

@@ -7,13 +7,11 @@ module Socky
     include Socky::Connection::Authentication
     include Socky::Connection::Finders
 
-    @@connections = []
-
     attr_reader :socket
 
     class << self
       def connections
-        @@connections
+        @connections ||= []
       end
     end
 
@@ -22,7 +20,7 @@ module Socky
     end
 
     def admin
-      socket.request["Query"]["admin"] == "1"
+      ["true","1"].include?(socket.request["Query"]["admin"])
     end
 
     def client
@@ -64,12 +62,20 @@ module Socky
       socket.close_connection_after_writing
     end
 
+    def connection_pool
+      self.class.connections
+    end
+
+    def in_connection_pool?
+      connection_pool.include?(self)
+    end
+
     def add_to_pool
-      @@connections << self unless self.admin || @@connections.include?(self)
+      connection_pool << self unless self.admin || in_connection_pool?
     end
 
     def remove_from_pool
-      @@connections.delete(self)
+      connection_pool.delete(self)
     end
 
     def to_json

data/lib/socky/connection/authentication.rb

@@ -1,6 +1,7 @@
 module Socky
   class Connection
     module Authentication
+      include Socky::Misc
 
       def subscribe_request
         send_subscribe_request do |response|
@@ -27,7 +28,7 @@ module Socky
       end
 
       def authenticate_as_admin
-        true
+        admin
       end
 
       def authenticate_as_user
@@ -59,11 +60,11 @@ module Socky
       end
 
       def params_for_request
-        params = {}
-        params.merge!(:client_id => self.client) unless self.client.nil?
-        params.merge!(:client_secret => self.secret) unless self.secret.nil?
-        params.merge!(:channels => self.channels) unless self.channels.empty?
-        params
+        {
+          :client_id => client,
+          :client_secret => secret,
+          :channels => channels
+        }.reject{|key,value| value.nil? || value.empty?}
       end
 
     end

data/lib/socky/connection/finders.rb

@@ -8,7 +8,7 @@ module Socky
 
       module ClassMethods
         def find_all
-          connections
+          Socky::Connection.connections
         end
 
         def find(opts = {})
@@ -36,11 +36,11 @@ module Socky
         private
 
         def filter_by_clients(connections, clients)
-          connections.collect{ |con| con if clients.include? con.client }.compact
+          connections.collect{ |connection| connection if clients.include? connection.client }.compact
         end
 
         def filter_by_channels(connections, channels)
-          connections.collect{ |con| con if channels.any?{ |chan| con.channels.include?(chan) } }.compact
+          connections.collect{ |connection| connection if channels.any?{ |channel| connection.channels.include?(channel) } }.compact
         end
 
       end

data/lib/socky/message.rb

@@ -4,29 +4,24 @@ module Socky
   class Message
     include Socky::Misc
 
-    class UnauthorisedQuery < Socky::SockyError #:nodoc:
-    end
-
-    class InvalidBroadcast < Socky::SockyError #:nodoc:
-    end
-
-    class InvalidQuery < Socky::SockyError #:nodoc:
-    end
+    class InvalidJSON < Socky::SockyError; end #:nodoc:
+    class UnauthorisedQuery < Socky::SockyError; end #:nodoc:
+    class InvalidQuery < Socky::SockyError; end #:nodoc:
 
     attr_reader :params, :creator
 
     class << self
       def process(connection, message)
-        m = new(connection, message)
-        m.process
-      rescue SockyError => e
-        error connection.name, e
-        m.respond e.message
+        message = new(connection, message)
+        message.process
+      rescue SockyError => error
+        error connection.name, error
+        connection.send_message(error.message.to_json)
       end
     end
 
     def initialize(creator, message)
-      @params = symbolize_keys JSON.parse(message)
+      @params = symbolize_keys(JSON.parse(message)) rescue raise(InvalidJSON, "invalid request")
       @creator = creator
     end
 
@@ -35,23 +30,32 @@ module Socky
 
       verify_secret!
 
-      case params[:command].to_sym
-        when :broadcast then broadcast
-        when :query then query
-      end
+      execute
     end
 
     def verify_secret!
       raise(UnauthorisedQuery, "invalid secret") unless options[:secret].nil? || options[:secret] == params[:secret]
     end
 
+    def execute
+      case params[:command].to_sym
+        when :broadcast then broadcast
+        when :query then query
+        else raise
+      end
+    rescue
+      raise(InvalidQuery, "unknown command")
+    end
+
     def broadcast
       case params[:type].to_sym
         when :to_clients then broadcast_to_clients
         when :to_channels then broadcast_to_channels
         when :to_clients_on_channels then broadcast_to_clients_on_channels
-        else raise InvalidQuery, "unknown broadcast type"
+        else raise
       end
+    rescue
+      raise(InvalidQuery, "unknown broadcast type")
     end
 
     def broadcast_to_clients
@@ -73,8 +77,10 @@ module Socky
     def query
       case params[:type].to_sym
         when :show_connections then query_show_connections
-        else raise InvalidQuery, "unknown query type"
+        else raise
       end
+    rescue
+      raise(InvalidQuery, "unknown query type")
     end
 
     def query_show_connections

data/lib/socky/misc.rb

@@ -38,9 +38,9 @@ module Socky
     end
 
     def symbolize_keys(hash)
-      return self unless hash.is_a?(Hash)
+      return hash unless hash.is_a?(Hash)
       hash.inject({}) do |options, (key, value)|
-        options[(key.to_sym rescue key) || key] = value
+        options[(key.to_sym if key.respond_to?(:to_sym)) || key] = value
         options
       end
     end

data/lib/socky/net_request.rb

@@ -11,8 +11,8 @@ module Socky
         http.errback  { yield false }
         http.callback { yield http.response_header.status == 200 }
         true
-      rescue => e
-        error "Bad request", e
+      rescue => error
+        error "Bad request", error
         false
       end
 

data/lib/socky/options.rb

@@ -1,28 +1,26 @@
-require 'optparse'
-require 'yaml'
-require 'erb'
 require 'socky/options/config'
 require 'socky/options/parser'
 
 module Socky
-  module Options
-    include Socky::Options::Config
-    include Socky::Options::Parser
+  class Options
+    include Socky::Misc
 
-    def prepare_options(argv)
-      self.options = {
-        :config_path => config_path
-      }
+    class << self
+      def prepare(argv)
+        self.options = {
+          :config_path => config_path,
+          :port => 8080,
+          :debug => false,
+          :deep_debug => false,
+          :log_path => log_path
+        }
 
-      parse_options(argv)
-      read_config_file
+        parsed_options = Parser.parse(argv)
+        config_options = Config.read(parsed_options[:config_path] || config_path)
 
-      self.options = {
-        :port => 8080,
-        :debug => false,
-        :deep_debug => false,
-        :log_path => log_path
-      }.merge(self.options)
+        self.options.merge!(config_options)
+        self.options.merge!(parsed_options)
+      end
     end
 
   end

data/lib/socky/options/config.rb

@@ -1,30 +1,48 @@
+require 'yaml'
+require 'erb'
+
 module Socky
-  module Options
-    module Config
+  class Options
+    class Config
 
-      def read_config_file
-        if !File.exists?(config_path)
-          puts "You must generate a config file (socky -g filename.yml)"
-          exit
-        end
+      class NoConfigFile < Socky::SockyError #:nodoc:
+      end
+
+      class InvalidConfig < Socky::SockyError #:nodoc:
+      end
+
+      class AlreadyExists < Socky::SockyError #:nodoc:
+      end
+
+      class ConfigUnavailable < Socky::SockyError #:nodoc:
+      end
 
-        self.options = YAML::load(ERB.new(IO.read(config_path)).result).merge!(self.options)
+      class SuccessfullyCreated < Socky::SockyError #:nodoc:
       end
 
-      def generate_config_file
-        if File.exists?(config_path)
-          puts "Config file already exists. You must remove it before generating a new one."
+      class << self
+        def read(path)
+          raise(NoConfigFile, "You must generate a config file (socky -g filename.yml)") unless File.exists?(path)
+          result = YAML::load(ERB.new(IO.read(path)).result)
+          raise(InvalidConfig, "Provided config file is invalid.") unless result.is_a?(Hash)
+          result
+        rescue SockyError => error
+          puts error.message
           exit
         end
-        puts "Generating config file...."
-        File.open(config_path, 'w+') do |file|
-          file.write DEFAULT_CONFIG_FILE
+
+        def generate(path)
+          raise(AlreadyExists, "Config file already exists. You must remove it before generating a new one.") if File.exists?(path)
+          File.open(path, 'w+') do |file|
+            file.write DEFAULT_CONFIG_FILE
+          end rescue raise(ConfigUnavailable, "Config file is unavailable - please choose another.")
+          raise(SuccessfullyCreated, "Config file generated at #{path}")
+        rescue SockyError => error
+          puts error.message
+          exit
         end
-        puts "Config file generated at #{config_path}"
-        exit
-      end
 
-      DEFAULT_CONFIG_FILE= <<-EOF
+        DEFAULT_CONFIG_FILE= <<-EOF
 :port: 8080
 :debug: false
 
@@ -35,6 +53,7 @@ module Socky
 
 # :timeout: 3
 EOF
+      end
 
     end
   end