socky-server 0.4.0 → 0.4.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/
+tmp/
+*.gem
+
+spec/files/socky.log
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,102 @@
+# Changelog
+
+## 0.4.1 / 2011-05-12
+
+- new features:
+  - none
+- bugfixes:
+  - restore compatibility with em-websocket 0.3.x
+
+## 0.4.0 / 2010-10-27
+
+- new features:
+  - rename project to 'socky-server-ruby' for future compatibility
+- bugfixes:
+  - use fund_all in finders instead of collect in finders
+
+## 0.2.1 / 2010-10-09
+
+- new features:
+  - default config should have subscribe url's commented out for starting users
+- bugfixes:
+  - show sent messages in true form instead of "inspect" one
+
+## 0.2.0 / 2010-10-03
+
+- new features:
+  - inline documentation
+- bugfixes:
+  - send authentication after finishing handshake
+  - tests less using stubs and more real cases
+  - fix some tests
+
+## 0.1.3 / 2010-09-23
+
+- new features:
+  - none
+- bugfixes:
+  - fix query :show_connections in ruby 1.9
+  - fix user authentication when url subscribe/unsubscribe is disabled
+
+## 0.1.2 / 2010-09-21
+
+- new features:
+  - none
+- bugfixes:
+  - fix routes to spec_helper in ruby 1.9.2
+  - ruby 1.9 will no longer raise errors on String to_a call
+
+## 0.1.1 / 2010-08-25
+
+- new features:
+  - socky has now support for signed certificates by :tls_options config option
+- bugfixes:
+  - none
+
+## 0.1.0 / 2010-08-03
+
+**IMPORTANT! This version will not work with plugin version lower than 0.1.0**
+
+- new features:
+  - server now send authentication status
+  - new syntax
+  - option to exclude clients/channels
+- bugfixes:
+  - none
+
+## 0.0.9 / 2010-06-20
+
+**IMPORTANT! This version will not work with plugin version lower than 0.0.9**
+
+- new features:
+  - support for next version of em-websocket debug options(based on mloughran branch)
+  - support for websocket draft 76
+  - support for wss/SSL connections
+  - socky can now be started in 'daemon' mode
+  - socky now sending all messages in JSON format
+- bugfixes:
+  - socky will no longer crash when when request query is invalid - i.e. chrome 6.0.*(with websocket draft76) and em-websocket 0.0.6
+
+## 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
+
+## 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
+
+## 0.0.6 / 2010-05-24
+
+- initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -3,25 +3,100 @@ Socky - server in Ruby
 
 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-server-ruby/wiki/install) the gem
-- Read up about its [Usage](http://github.com/socky/socky-server-ruby/wiki/usage) and [Configuration](http://github.com/socky/socky-server-ruby/wiki/configuration)
-- 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 server is via RubyGems:
+
+    gem install socky-server
+
+Socky ruby server requires the gems em-websocket and em-http-request. These are automatically installed by the gem install command.
+
+Alternative method is to clone repo and run it manually:
+
+    git clone git://github.com/socky/socky-server-ruby.git
+    cd socky-server-ruby
+    ./bin/socky
+
+You can also build it after clonning(this will require Jeweler gem)
+
+    rake gemspec
+    rake build
 
 ## Runtime Dependencies
 
 - EM-WebSocket: Backend for WebSocket server
 - EM-HTTP-Client: Sending authorize requests
 
+## Usage
+
+After installing gem you will have binary available:
+
+    socky [OPTIONS]
+
+First of all you will need to generate config file:
+
+    socky -g config.yml
+
+After that you can tweak this file, or just run server with default values:
+
+    socky -c config.yml
+
+## Configuration
+
+The following is a list of the currently supported configuration options. These can all be specified by creating a config file. There are also flags for the `socky` executable which are described below next to their respective configuration options.
+
+### Configuration Settings
+
+| *Setting*       | *Config*                 | *Flag*                  | *Description* |
+| --------------- | ------------------------ | ----------------------- | ------------- |
+| Generate config |                          | `-g, --generate [path]` | Generate default config file
+| Read config     |                          | `-c, --config [path]`   | Path to configuration file
+| Port            | `port: [integer]`        | `-p, --port PORT`       | Set the port for server to listen
+| Secure          | `secure: [boolean]`      | `-s, --secure`          | Set wss/SSL model on
+| TLS Options     | `tls_options: [hash]`    |                         | Paths to private key file and certificate chain file for secure connection
+| Daemon          | `daemon: [boolean]`      | `-d, --daemon`          | Run in daemon(background) mode
+| Pid path        | `pid_path: [path]`       | `-P, --pid`             | Path to store pid path
+| Kill            |                          | `-k, --kill`            | Kill daemonized server described by file in pid path
+| Use log         | `log_path: [path]`       | `-l, --log [path]`      | Path to print debugging information
+| Debug           | `debug: [boolean]`       | `--debug`               | Run in debug mode
+| Deep debug      | `deep_debug: [boolean]`  | `--deep-debug`          | Run in debug mode that is even more verbose
+| Subscribe URL   | `subscribe_url: [url]`   |                         | Url to with send authentication request
+| Unsubscribe URL | `unsubscribe_url: [url]` |                         | Url to with send logout request
+| Timeout         | `timeout: [integer]`     |                         | Time after with authentication request will timeout
+| Secret          | `secret: [string]`       |                         | Key that will be used by to authorize as admin user
+
+### Default Configuration
+
+    :port: 8080
+    :debug: false
+
+    :subscribe_url: http://localhost:3000/socky/subscribe
+    :unsubscribe_url: http://localhost:3000/socky/unsubscribe
+
+    :secret: my_secret_key
+
+    :secure: false
+
+    # :timeout: 3
+
+    # :log_path: /var/log/socky.log
+    # :pid_path: /var/run/socky.pid
+
+    # :tls_options:
+    #   :private_key_file: /private/key
+    #   :cert_chain_file: /ssl/certificate
+
 ## 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/Rakefile

@@ -1,3 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 require 'rake'
 require 'rake/clean'
 CLEAN.include %w(**/*.{log,rbc})
@@ -8,24 +11,3 @@ task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec) do |t|
 end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "socky-server"
-    gemspec.summary = "Socky is a WebSocket server and client for Ruby"
-    gemspec.description = "Socky is a WebSocket server and client for Ruby"
-    gemspec.email = "bernard.potocki@imanel.org"
-    gemspec.homepage = "http://imanel.org/projects/socky"
-    gemspec.authors = ["Bernard Potocki"]
-    gemspec.add_dependency 'em-websocket', '>= 0.1.4'
-    gemspec.add_dependency 'em-http-request'
-    gemspec.add_dependency 'json'
-    gemspec.add_development_dependency 'rspec', '~> 2.0'
-    gemspec.add_development_dependency 'rack'
-    gemspec.add_development_dependency 'mongrel'
-    gemspec.files.exclude ".gitignore"
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end

data/lib/socky.rb

@@ -13,7 +13,7 @@ module Socky
   class SockyError < StandardError; end #:nodoc:
 
   # server version
-  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip
+  VERSION = '0.4.1'
 
   class << self
     # read server-wide options

data/lib/socky/connection.rb

@@ -29,7 +29,7 @@ module Socky
     # read query data from socket request
     # @return [Hash] hash of query data
     def query
-      socket.request["Query"] || {}
+      socket.request["query"] || {}
     end
 
     # return if user appear to be admin

data/socky-server.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "socky"
+
+Gem::Specification.new do |s|
+  s.name        = "socky-server"
+  s.version     = Socky::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernard Potocki"]
+  s.email       = ["bernard.potocki@imanel.org"]
+  s.homepage    = "http://socky.org"
+  s.summary     = %q{Socky is a WebSocket server and client for Ruby}
+  s.description = %q{Socky is a WebSocket server and client for Ruby}
+  
+  s.add_runtime_dependency 'em-websocket', '~> 0.3.0'
+  s.add_runtime_dependency 'em-http-request'
+  s.add_runtime_dependency 'json'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'mongrel'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/socky/connection_spec.rb

@@ -20,34 +20,34 @@ describe Socky::Connection do
   context "instance" do
     before(:each) do
       described_class.connections.clear
-      socket = mock(:socket, :request => { "Query" => {}})
+      socket = mock(:socket, :request => { "query" => {}})
       @connection = described_class.new(socket)
     end
     
     context "#admin" do
       it "should return true for socket request data admin equal to '1' and 'true'" do
         ["1","true"].each do |value|
-          @connection.socket.request["Query"]["admin"] = value
+          @connection.socket.request["query"]["admin"] = value
           @connection.admin.should be_true
         end
       end
       it "should return false for socket request data admin equal to anything except '1' and 'true'" do
         [nil,"0","false","abstract"].each do |value|
-          @connection.socket.request["Query"]["admin"] = value
+          @connection.socket.request["query"]["admin"] = value
           @connection.admin.should be_false
         end
       end
       it "should return false if socket request data is nil" do
-        @connection.socket.request["Query"] = nil
+        @connection.socket.request["query"] = nil
         @connection.admin.should be_false
       end
     end
     it "#client should return client_id from socket request data" do
-      @connection.socket.request["Query"]["client_id"] = "abstract"
+      @connection.socket.request["query"]["client_id"] = "abstract"
       @connection.client.should eql("abstract")
     end
     it "#secret should return client_secret from socket request data" do
-      @connection.socket.request["Query"]["client_secret"] = "abstract"
+      @connection.socket.request["query"]["client_secret"] = "abstract"
       @connection.secret.should eql("abstract")
     end
     context "#channels" do
@@ -56,19 +56,19 @@ describe Socky::Connection do
         @connection.channels.class.should eql(Array)
       end
       it "should return table with nil if socket request data 'channels' is nil" do
-        @connection.socket.request["Query"]["channels"] = nil
+        @connection.socket.request["query"]["channels"] = nil
         @connection.channels.should eql([nil])
       end
       it "should return table of channels if provided and separated by comma" do
-        @connection.socket.request["Query"]["channels"] = "aaa,bbb,ccc"
+        @connection.socket.request["query"]["channels"] = "aaa,bbb,ccc"
         @connection.channels.should eql(["aaa","bbb","ccc"])
       end
       it "should not allow empty names of channels" do
-        @connection.socket.request["Query"]["channels"] = "aaa,,ccc"
+        @connection.socket.request["query"]["channels"] = "aaa,,ccc"
         @connection.channels.should eql(["aaa","ccc"])
       end
       it "should strip trailing spaces in channel names" do
-        @connection.socket.request["Query"]["channels"] = "  aaa\n  , \n , ccc  "
+        @connection.socket.request["query"]["channels"] = "  aaa\n  , \n , ccc  "
         @connection.channels.should eql(["aaa","ccc"])
       end
     end
@@ -139,8 +139,8 @@ describe Socky::Connection do
       described_class.connections.should have(0).items
     end
     it "#to_json should return self as hash of object_id, client_id and channels" do
-      @connection.socket.request["Query"]["client_id"] = "abstract"
-      @connection.socket.request["Query"]["channels"] = "first,second,third"
+      @connection.socket.request["query"]["client_id"] = "abstract"
+      @connection.socket.request["query"]["channels"] = "first,second,third"
       json = @connection.to_json
       JSON.parse(json).should eql({ "id" => @connection.object_id,
                                     "client_id" => @connection.client,

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: socky-server
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
+  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors: 
 - Bernard Potocki
@@ -15,8 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 +02:00
-default_executable: socky
+date: 2011-05-12 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-websocket
@@ -24,14 +19,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 1
-        - 4
-        version: 0.1.4
+        version: 0.3.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -42,9 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -56,9 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -70,10 +54,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
         version: "2.0"
   type: :development
   version_requirements: *id004
@@ -85,9 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -99,25 +76,24 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id006
 description: Socky is a WebSocket server and client for Ruby
-email: bernard.potocki@imanel.org
+email: 
+- bernard.potocki@imanel.org
 executables: 
 - socky
 extensions: []
 
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files: []
+
 files: 
-- CHANGELOG.textile
+- .gitignore
+- CHANGELOG.md
+- Gemfile
 - README.md
 - Rakefile
-- VERSION
 - bin/socky
 - lib/em-websocket_hacks.rb
 - lib/socky.rb
@@ -131,6 +107,7 @@ files:
 - lib/socky/options/config.rb
 - lib/socky/options/parser.rb
 - lib/socky/runner.rb
+- socky-server.gemspec
 - spec/em-websocket_spec.rb
 - spec/files/default.yml
 - spec/files/invalid.yml
@@ -148,12 +125,12 @@ files:
 - spec/spec_helper.rb
 - spec/support/stallion.rb
 has_rdoc: true
-homepage: http://imanel.org/projects/socky
+homepage: http://socky.org
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -161,28 +138,24 @@ 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/em-websocket_spec.rb
+- spec/files/default.yml
+- spec/files/invalid.yml
 - spec/socky/connection/authentication_spec.rb
 - spec/socky/connection/finders_spec.rb
 - spec/socky/connection_spec.rb

data/CHANGELOG.textile

@@ -1,95 +0,0 @@
-h1. Changelog
-
-h2. 0.4.0 / 2010-10-27
-
-* new features:
-** rename project to 'socky-server-ruby' for future compatibility
-* bugfixes:
-** use fund_all in finders instead of collect in finders
-
-h2. 0.2.1 / 2010-10-09
-
-* new features:
-** default config should have subscribe url's commented out for starting users
-* bugfixes:
-** show sent messages in true form instead of "inspect" one
-
-h2. 0.2.0 / 2010-10-03
-
-* new features:
-** inline documentation
-* bugfixes:
-** send authentication after finishing handshake
-** tests less using stubs and more real cases
-** fix some tests
-
-h2. 0.1.3 / 2010-09-23
-
-* new features:
-** none
-* bugfixes:
-** fix query :show_connections in ruby 1.9
-** fix user authentication when url subscribe/unsubscribe is disabled
-
-h2. 0.1.2 / 2010-09-21
-
-* new features:
-** none
-* bugfixes:
-** fix routes to spec_helper in ruby 1.9.2
-** ruby 1.9 will no longer raise errors on String to_a call
-
-h2. 0.1.1 / 2010-08-25
-
-* new features:
-** socky has now support for signed certificates by :tls_options config option
-* bugfixes:
-** none
-
-h2. 0.1.0 / 2010-08-03
-
-*IMPORTANT! This version will not work with plugin version lower than 0.1.0*
-
-* new features:
-** server now send authentication status
-** new syntax
-** option to exclude clients/channels
-* bugfixes:
-** none
-
-h2. 0.0.9 / 2010-06-20
-
-*IMPORTANT! This version will not work with plugin version lower than 0.0.9*
-
-* new features:
-** support for next version of em-websocket debug options(based on mloughran branch)
-** support for websocket draft 76
-** support for wss/SSL connections
-** socky can now be started in 'daemon' mode
-** socky now sending all messages in JSON format
-* bugfixes:
-** socky will no longer crash when when request query is invalid - i.e. chrome 6.0.*(with websocket draft76) and em-websocket 0.0.6
-
-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/VERSION

@@ -1 +0,0 @@
-0.4.0