utopia-websocket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad16603ab4f1a0acf1fea4afe634779c9a9b66a5
+  data.tar.gz: ef3d22a74c985d782a23e08a2663a80d6916e706
+SHA512:
+  metadata.gz: 4fbb381b547523cf738df4e10f23abf021ba38bdbb23a9dd1b768cd0bfde6952c40b6288edfc0d37f223e3b77ec4649e97ff51c2ee4e92bc25f342d4a1da1411
+  data.tar.gz: 0e831028b1ca73a9764934820c50b143e0cfa6340ec32e2d0284b8c8033312713a28337751f3609a188ab007541ccac783eaab52c138705cec656f90ed7f4aff

data/.simplecov

@@ -0,0 +1,9 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+env: COVERAGE=true

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in utopia-websocket.gemspec
+gemspec
+
+group :test do
+	gem 'puma'
+	gem 'utopia'
+	
+	gem 'rack-test'
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,100 @@
+# Utopia::Websocket
+
+A simple synchronous websocket server implementation. Designed for short term connections and best on thread-per-request application servers (e.g. puma).
+
+[![Build Status](https://secure.travis-ci.org/ioquatix/utopia-websocket.png)](http://travis-ci.org/ioquatix/utopia-websocket)
+[![Code Climate](https://codeclimate.com/github/ioquatix/utopia-websocket.png)](https://codeclimate.com/github/ioquatix/utopia-websocket)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/utopia-websocket/badge.svg)](https://coveralls.io/r/ioquatix/utopia-websocket)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+		gem 'utopia-websocket'
+
+And then execute:
+
+		$ bundle
+
+Or install it yourself as:
+
+		$ gem install utopia-websocket
+
+## Usage
+
+Here is how to use within `Utopia::Controller`:
+
+	on 'list' do |request|
+		fail! unless Utopia::WebSocket?(request.env)
+		
+		Utopia::WebSocket.open(request.env) do |connection|
+			read, write = IO.pipe
+
+			Process.spawn("ls -lah", :out => write)
+			write.close
+
+			read.each_line do |line|
+				connection.text(line)
+			end
+
+			connection.close
+		end
+		
+		success!
+	end
+
+`connection` is an instance of [`WebSocket::Driver`][1].
+
+[1]: https://github.com/faye/websocket-driver-ruby
+
+If you want to handle incoming messages, you must listen for these and then handle them:
+
+	on 'echo' do |request|
+		fail! unless Utopia::WebSocket?(request.env)
+		
+		Utopia::WebSocket.open(request.env) do |connection|
+			connection.on(:message) do |event|
+				connection.text(event.data)
+				connection.close
+			end
+		end
+		
+		success!
+	end
+
+This implementation is currently not designed for many long-term connections as it will 'use' one request for the duration of the websocket life. However, this model is rather simple and easy to reason about. For more complex client/server interactions, a dedicated server using [Celluloid][2] might be more appropriate.
+
+[2]: https://github.com/celluloid/celluloid
+
+## 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
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
+end
+
+task :default => :spec

data/lib/utopia/websocket.rb

@@ -0,0 +1,87 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require "utopia/websocket/version"
+require 'websocket/driver'
+
+module Utopia
+	def self.WebSocket?(env)
+		::WebSocket::Driver.websocket?(env)
+	end
+	
+	module WebSocket
+		class Connection
+			READ_BUFFER_SIZE = 1024*8
+			
+			attr_reader :env, :url
+			
+			def initialize(env, io)
+				@env = env
+				@io = io
+				
+				scheme = Rack::Request.new(env).ssl? ? 'wss:' : 'ws:'
+				@url = scheme + '//' + env['HTTP_HOST'] + env['REQUEST_URI']
+				
+				@driver = ::WebSocket::Driver.rack(self)
+				@running = false
+			end
+			
+			def write(string)
+				@io.write(string)
+			end
+			
+			def read
+				@driver.parse(@io.readpartial(READ_BUFFER_SIZE))
+			end
+			
+			def run(&handler)
+				@running = true
+				
+				@driver.on(:close) do
+					@running = false
+				end
+				
+				@driver.on(:open) do
+					yield @driver if block_given?
+				end
+				
+				@driver.start
+				
+				while @running
+					self.read
+				end
+			ensure
+				@io.close
+			end
+		end
+		
+		def self.open(env)
+			if ::WebSocket::Driver.websocket?(env)
+				env['rack.hijack'].call
+				
+				connection = Connection.new(env, env['rack.hijack_io'])
+				
+				connection.run do |driver|
+					yield driver
+				end
+			end
+		end
+	end
+end

data/lib/utopia/websocket/client.rb

@@ -0,0 +1,54 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require "utopia/websocket/version"
+require 'websocket/driver'
+
+module Utopia
+	module WebSocket
+		# This is a basic synchronous websocket client:
+		class Client
+			attr :url
+			attr :driver
+			
+			def initialize(url, socket)
+				@url = url
+				@socket = socket
+				
+				@driver = ::WebSocket::Driver.client(self)
+				
+				@driver.start
+			end
+			
+			def write(data)
+				@socket.write(data)
+			end
+			
+			def read
+				while true
+					data = @socket.readpartial(1024)
+					@driver.parse(data)
+				end
+			rescue EOFError
+				nil
+			end
+		end
+	end
+end

data/lib/utopia/websocket/version.rb

@@ -0,0 +1,5 @@
+module Utopia
+  module WebSocket
+    VERSION = "0.1.0"
+  end
+end

data/spec/utopia/websocket/connection_spec.rb

@@ -0,0 +1,65 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'utopia/websocket'
+require 'utopia/websocket/client'
+
+require 'rack/test'
+require 'puma'
+
+module Utopia::WebSocket::ConnectionSpec
+	describe Utopia::WebSocket::Connection do
+		include Rack::Test::Methods
+		
+		before(:all) do
+			@app = Rack::Builder.parse_file(File.expand_path('../connection_spec.ru', __FILE__)).first
+			
+			@server = Puma::Server.new(@app)
+			
+			@server.add_tcp_listener('localhost', 8085)
+			
+			@server.run
+			
+			trap(:SIGINT) do
+				@server.stop if @server
+				exit
+			end
+		end
+		
+		after(:all) do
+			@server.stop
+			@server = nil
+		end
+		
+		it "should connect to the websocket server" do
+			client = Utopia::WebSocket::Client.new("ws://localhost:8085/list", TCPSocket.new('localhost', 8085))
+			
+			events = []
+			
+			client.driver.on(:message) do |event|
+				events << event
+			end
+			
+			client.read
+			
+			expect(events.size).to be > 0
+		end
+	end
+end

data/spec/utopia/websocket/connection_spec.ru

@@ -0,0 +1,7 @@
+
+require 'utopia'
+require 'utopia/websocket'
+
+use Utopia::Controller, root: File.expand_path('../pages', __FILE__)
+
+run lambda {|env| [404, {}, []]}

data/spec/utopia/websocket/pages/controller.rb

@@ -0,0 +1,19 @@
+
+on 'list' do |request|
+	if Utopia::WebSocket?(request.env)
+		Utopia::WebSocket.open(request.env) do |connection|
+			read, write = IO.pipe
+			
+			Process.spawn("ls -lah", :out => write)
+			write.close
+			
+			read.each_line do |line|
+				connection.text(line)
+			end
+			
+			connection.close
+		end
+		
+		success!
+	end
+end

data/utopia-websocket.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utopia/websocket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "utopia-websocket"
+  spec.version       = Utopia::WebSocket::VERSION
+  spec.authors       = ["Samuel Williams"]
+  spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+  spec.summary       = %q{A basic rack.hijack websocket implementation with synchronous execution within rack.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "websocket-driver", "~> 0.5.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "puma"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: utopia-websocket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/utopia/websocket.rb
+- lib/utopia/websocket/client.rb
+- lib/utopia/websocket/version.rb
+- spec/utopia/websocket/connection_spec.rb
+- spec/utopia/websocket/connection_spec.ru
+- spec/utopia/websocket/pages/controller.rb
+- utopia-websocket.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A basic rack.hijack websocket implementation with synchronous execution within
+  rack.
+test_files:
+- spec/utopia/websocket/connection_spec.rb
+- spec/utopia/websocket/connection_spec.ru
+- spec/utopia/websocket/pages/controller.rb