async-websocket 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8954f1e1bb06c1e4188f6b248f2c78ee7b79ced5
+  data.tar.gz: 3dc3b81c1c475d07cab9281ace55bc7c4ec265f1
+SHA512:
+  metadata.gz: d452579efb8559353825d4e4771112ed5a25cc0d0abac7e3f508431a2c65795250767dddc824d1c9cd297e0e1bbff20d9d5ccc5d119be50657cb6386ce717b7e
+  data.tar.gz: 67d57f3cb2202e527ddd35493700612db4e166692cc7f880f2dbcaa908766bb4c711a47b0c3fa281fb463f89280c40486c54680be0179c3538957ed014a9f69b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+sudo: false
+dist: trusty
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.0
+    - rvm: 2.1
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

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

data/README.md

@@ -0,0 +1,95 @@
+# Async::WebSocket
+
+A simple asynchronous websocket client/server implementation.
+
+[![Build Status](https://secure.travis-ci.org/socketry/async-websocket.svg)](http://travis-ci.org/socketry/async-websocket)
+[![Code Climate](https://codeclimate.com/github/socketry/async-websocket.svg)](https://codeclimate.com/github/socketry/async-websocket)
+[![Coverage Status](https://coveralls.io/repos/socketry/async-websocket/badge.svg)](https://coveralls.io/r/socketry/async-websocket)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'async-websocket'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install async-websocket
+
+## Usage
+
+Here is how to use within `Utopia::Controller`:
+
+	on 'list' do |request|
+		fail! unless Async::WebSocket?(request.env)
+		
+		Async::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
+		
+		succeed!
+	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 Async::WebSocket?(request.env)
+		
+		Async::WebSocket.open(request.env) do |connection|
+			connection.on(:message) do |event|
+				connection.text(event.data)
+				connection.close
+			end
+		end
+		
+		succeed!
+	end
+
+## 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/async-websocket.gemspec

@@ -0,0 +1,28 @@
+
+require_relative 'lib/async/websocket/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "async-websocket"
+	spec.version       = Async::WebSocket::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.summary       = %q{An async websocket library on top of websocket-driver.}
+	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.7.0"
+
+	spec.add_dependency "async-io"
+	
+	spec.add_development_dependency "async-rspec"
+
+	spec.add_development_dependency "bundler", "~> 1.6"
+	spec.add_development_dependency "rspec", "~> 3.6"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "falcon"
+end

data/lib/async/websocket.rb

@@ -0,0 +1,85 @@
+# 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_relative 'websocket/version'
+require 'websocket/driver'
+
+module Async
+	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.read(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
+			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/async/websocket/client.rb

@@ -0,0 +1,89 @@
+# 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 'websocket/driver'
+require 'json'
+
+module Async
+	module WebSocket
+		# This is a basic synchronous websocket client:
+		class Client
+			EVENTS = [:open, :message, :close]
+			
+			def initialize(socket, url: "ws://.")
+				@socket = socket
+				@url = url
+				
+				@driver = ::WebSocket::Driver.client(self)
+				
+				@queue = []
+				
+				@driver.on(:error) do |error|
+					raise error
+				end
+				
+				EVENTS.each do |event|
+					@driver.on(event) do |data|
+						@queue.push(data)
+					end
+				end
+				
+				@driver.start
+			end
+			
+			attr :driver
+			attr :url
+			
+			def next_event
+				while @queue.empty?
+					data = @socket.read(1024)
+					
+					if data and !data.empty?
+						@driver.parse(data)
+					else
+						return nil
+					end
+				end
+				
+				@queue.shift
+			rescue EOFError
+				return nil
+			end
+			
+			def next_message
+				while event = next_event
+					if event.is_a? ::WebSocket::Driver::MessageEvent
+						return JSON.parse(event.data)
+					elsif event.is_a? ::WebSocket::Driver::CloseEvent
+						return nil
+					end
+				end
+			end
+			
+			def write(data)
+				@socket.write(data)
+			end
+			
+			def close
+				@driver.close
+			end
+		end
+	end
+end

data/lib/async/websocket/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2018, 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.
+
+module Async
+	module WebSocket
+		VERSION = "0.2.0"
+	end
+end

data/spec/async/websocket/connection_spec.rb

@@ -0,0 +1,54 @@
+# 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 'async/websocket'
+require 'async/websocket/client'
+
+require 'rack/test'
+require 'falcon/server'
+
+RSpec.describe Async::WebSocket::Connection do
+	include_context Async::RSpec::Reactor
+	let(:server_address) {Async::IO::Endpoint.tcp('0.0.0.0', 9000)}
+	let(:app) {Rack::Builder.parse_file(File.expand_path('../connection_spec.ru', __FILE__)).first}
+	let(:server) {Falcon::Server.new(app, [server_address])}
+
+	it "should connect to the websocket server" do
+		server_task = Async::Reactor.run do
+			server.run
+		end
+		
+		events = []
+		
+		server_address.connect do |socket|
+			client = Async::WebSocket::Client.new(socket)
+			
+			while event = client.next_event
+				events << event
+			end
+			
+			client.close # optional
+		end
+		
+		expect(events.size).to be > 0
+		
+		server_task.stop
+	end
+end

data/spec/async/websocket/connection_spec.ru

@@ -0,0 +1,31 @@
+
+require 'async/websocket'
+
+class Upgrade
+	def initialize(app)
+		@app = app
+	end
+	
+	def call(env)
+		if Async::WebSocket?(env)
+			Async::WebSocket.open(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
+		else
+			@app.call(env)
+		end
+	end
+end
+
+use Upgrade
+
+run lambda {|env| [404, {}, []]}

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "async/websocket"
+
+# Shared rspec helpers:
+require "async/rspec"
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: async-websocket
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 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.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  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: 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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: falcon
+  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:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- async-websocket.gemspec
+- lib/async/websocket.rb
+- lib/async/websocket/client.rb
+- lib/async/websocket/version.rb
+- spec/async/websocket/connection_spec.rb
+- spec/async/websocket/connection_spec.ru
+- spec/spec_helper.rb
+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.6.12
+signing_key: 
+specification_version: 4
+summary: An async websocket library on top of websocket-driver.
+test_files:
+- spec/async/websocket/connection_spec.rb
+- spec/async/websocket/connection_spec.ru
+- spec/spec_helper.rb