websocket-controller 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3573329d7220dca3f64720c2f42dea31daa81e09
+  data.tar.gz: 49a76faaba3b1cd38830b0b08c4a019687711858
+SHA512:
+  metadata.gz: 9a1e65487785c4260315d72fec9e5b913aa391f71f776f6a348c1e1a840d146d3d77df48b945cab96d7415f6465dd176a2b283ae9b11a37ba658d54b6324a89f
+  data.tar.gz: ab40bfab40c785722c8307bd7ad47dbef5576e13c692c4db5c9eca17cc0aa049960e1a42320d9732ba7df4b92aaef1d3e6d71fa985ec9b56ebb4ed0c20d09032

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in websocket-controller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 goshan
+
+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.md

@@ -0,0 +1,41 @@
+# Websocket::Controller
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/websocket/controller`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'websocket-controller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install websocket-controller
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/websocket-controller.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tasks/socket.rake

@@ -0,0 +1,32 @@
+namespace :socket do
+	desc "start web socket server"
+	task :start => :environment do
+		EM.run do 
+			puts "Begin listen 0.0.0.0:4040"
+			EM::WebSocket.start(:host => "0.0.0.0", :port => 4040) do |ws|
+				ws.onopen do |handshake|
+					puts "user with signature #{ws.signature} connected"
+				end
+
+				ws.onmessage do |msg|
+					puts "user with signature #{ws.signature} sent message #{msg}"
+					begin
+						WebSocket::Parser.parse_message msg, ws
+					rescue Exception => e
+						puts "============>> Exception <<============"
+						puts e.inspect
+						puts e.backtrace
+						response = JSON.generate({:status => "error", :error => "invalid request"})
+						ws.send(response)
+						puts "===============>> End <<==============="
+					end
+				end
+
+				ws.onclose do 
+					WebSocket::Parser.close_socket ws
+					puts "user with signature #{ws.signature} disconnected"
+				end
+			end
+		end
+	end
+end

data/lib/websocket/controller.rb

@@ -0,0 +1,37 @@
+module WebSocket
+	class Controller
+		attr_accessor :params
+
+		def initialize(params)
+			@params = params
+		end
+
+		def before_filter
+			return true
+		end
+		
+		def current_user
+			User.find_by_id @params[:user_id]
+		end
+
+		def send_message(json, user_id=nil)
+			msg = JSON.generate json
+			user_id = @params[:user_id] unless user_id
+			ws = WebSocket::Manager.socket_by_user user_id
+			if ws
+				ws.send msg
+				puts "send message to user: #{user_id} with signature: #{ws.signature}: #{json}"
+			else
+				puts "send message failed for no socket found. user: #{user_id}, json: #{json}"
+			end
+		end
+
+		def broadcast_message(json)
+			msg = JSON.generate json
+			WebSocket::Manager.all_sockets.each do |ws|
+				ws.send msg
+			end
+			puts "broadcast to all sockets: #{json}"
+		end
+	end
+end

data/lib/websocket/manager.rb

@@ -0,0 +1,38 @@
+module WebSocket
+	class Manager
+		@@player_socket = {}
+		@@signature_player = {}
+
+		class << self
+			def bind_socket(user_id, ws)
+				@@player_socket[user_id] = ws
+				@@signature_player[ws.signature] = user_id
+			end
+
+			def unbind_socket(ws)
+				user_id = @@signature_player[ws.signature]
+				@@player_socket.delete user_id
+				@@signature_player.delete ws.signature
+			end
+
+			def unbind_user(user_id)
+				@@signature = @@player_socket[user_id].signature
+				@@player_socket.delete user_id
+				@@signature_player.delete signature
+			end
+
+			def all_sockets
+				@@player_socket.values
+			end
+
+			# transport between user and socket
+			def socket_by_user(user_id)
+				@@player_socket[user_id]
+			end
+
+			def user_by_socket(ws)
+				@@signature_player[ws.signature]
+			end
+		end
+	end
+end

data/lib/websocket/parser.rb

@@ -0,0 +1,43 @@
+module WebSocket
+	class Parser
+		def self.parse_message(msg, ws)
+			# parse json
+			begin
+				json = JSON.parse msg, {:symbolize_names => true}
+			rescue JSON::ParserError
+				response = JSON.generate({:status => 'error', :error => "json format error"})
+				ws.send(response)
+				return
+			end
+
+			# check engin and action params
+			unless json[:engin] && json[:action]
+				response = JSON.generate({:status => 'error', :error => "engin or action missing"})
+				ws.send(response)
+				return
+			end
+			engin = json[:engin].to_sym
+			action = json[:action]
+
+			if json[:engin] == "socket" && json[:action] == "register"
+				# register user with ws
+				WebSocket::Manager.bind_socket json[:user_id].to_i, ws
+			elsif WebSocket::Routes.include_engin?(engin) && WebSocket::Routes.include_action?(engin, action)
+				# run engin controller
+				json[:user_id] = WebSocket::Manager.user_by_socket ws
+				controller = "#{json[:engin].capitalize}Controller".constantize.send('new', json)
+				if controller.before_filter
+					controller.send(json[:action])
+				end
+			else
+				# 404 error
+				response = JSON.generate({:status => 'error', :error => "unsupport engin or action"})
+				ws.send(response)
+			end
+		end
+
+		def self.close_socket(ws)
+			WebSocket::Manager.unbind_socket ws
+		end
+	end
+end

data/lib/websocket/routes.rb

@@ -0,0 +1,24 @@
+module WebSocket
+	class Routes
+		@@routes = {}
+
+		class << self
+			def init
+				@@routes = {}
+			end
+
+			def setup
+				@@routes = yield
+			end
+
+			def include_engin?(engin)
+				@@routes.keys.include? engin
+			end
+
+			def include_action?(engin, action)
+				@@routes[engin].include? action
+			end
+		end
+		 
+	end
+end

data/lib/websocket/version.rb

@@ -0,0 +1,3 @@
+module WebsocketController
+  VERSION = "1.0.1"
+end

data/lib/websocket-controller.rb

@@ -0,0 +1,18 @@
+require "websocket/version"
+require "websocket/routes"
+require "websocket/manager"
+require "websocket/parser"
+require "websocket/controller"
+
+
+module WebSocket
+	class Railtie < ::Rails::Railtie
+		rake_tasks do 
+			load 'tasks/socket.rake'
+		end
+	end
+end
+
+module WebSocket
+	Routes.init
+end

data/websocket-controller.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'websocket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "websocket-controller"
+  spec.version       = WebsocketController::VERSION
+  spec.authors       = ["goshan"]
+  spec.email         = ["goshan.hanqiu@gmail.com"]
+
+  spec.summary       = %q{a web socket engin just like rails controllers}
+  spec.description   = %q{a rails controller class make you can write web-socket code}
+  spec.homepage      = "https://github.com/goshan/websocket-controller"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "eventmachine", ">= 0.12.9"
+  spec.add_runtime_dependency "http_parser.rb", "~> 0.6.0"
+  spec.add_runtime_dependency "em-websocket", "~> 0.5"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: websocket-controller
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- goshan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.9
+- !ruby/object:Gem::Dependency
+  name: http_parser.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: a rails controller class make you can write web-socket code
+email:
+- goshan.hanqiu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tasks/socket.rake
+- lib/websocket-controller.rb
+- lib/websocket/controller.rb
+- lib/websocket/manager.rb
+- lib/websocket/parser.rb
+- lib/websocket/routes.rb
+- lib/websocket/version.rb
+- websocket-controller.gemspec
+homepage: https://github.com/goshan/websocket-controller
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: a web socket engin just like rails controllers
+test_files: []