async-websocket 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b5ea223a245b0c44bef8fe73d22f9b4bade12a497fb5f39a2969aab171c338
-  data.tar.gz: 81a2ec348b10c9df372e0f8f8291456e5b16420faf04ef3df5a50d2029309968
+  metadata.gz: da0bf747ee0c56a69b828547451fc478169ee13b8cf181a15af6ba5b7ab73b03
+  data.tar.gz: 4bb105f0a98f8b4f39020aa0882745d8915b1bec7155a5fb410f3ae985d06503
 SHA512:
-  metadata.gz: 89453fabbcb746b608cfee446ef36ff295fe23f531b502e634c24688c1c30f4b82c1d833f682e9552da37cc7c03d7609aa8cd9f7566b1d3553ff8822a2fb13f8
-  data.tar.gz: '084dd3cd3ada08ec5d46925943ab1d74800306d96c066a4d8cb3f32fd83f89df493b9fed3c50e4a000007b0f7312baf12dfef9dbfab2d4d8a37d9f639a920105'
+  metadata.gz: 8cb039babe87b956995754dbecf8ce5b93924359b86ff5b51676fa5b9bdc1a7f0f88a85b042e04cb52d8aac900991ed3ea49eb936c6ef66760f7a7179e4d077d
+  data.tar.gz: b6fe79b03396ff4b748436cbdaad3e5430b1890ec602c3cb1373e7a1ba04f84d4afdd625007991532aea1fa184275554e97fb4a27d1c6e70ae46c598560257c9

data/.editorconfig

@@ -1,4 +1,6 @@
+root = true
 
 [*]
 indent_style = tab
 indent_size = 2
+

data/README.md

@@ -22,7 +22,44 @@ Or install it yourself as:
 
 ## Usage
 
-Here is how to use within `Rack`:
+There are [examples](examples/) which include:
+
+- [A command line chat client and application server](examples/chat/client.rb) which can read input from `stdin` and send messages to the server.
+- [A utopia-based web application](examples/utopia) which uses a JavaScript client to connect to a web application server.
+
+### Client Side with Async
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/io/stream'
+require 'async/http/url_endpoint'
+require 'async/websocket/client'
+
+USER = ARGV.pop || "anonymous"
+URL = ARGV.pop || "ws://localhost:9292"
+
+Async do |task|
+	endpoint = Async::HTTP::URLEndpoint.parse(URL)
+	headers = {'token' => 'wubalubadubdub'}
+	
+	endpoint.connect do |socket|
+		connection = Async::WebSocket::Client.new(socket, URL, headers)
+		
+		connection.send_message({
+			user: USER,
+			status: "connected",
+		})
+		
+		while message = connection.next_message
+			puts message.inspect
+		end
+	end
+end
+```
+
+### Server Side with Rack & Falcon
 
 ```ruby
 #!/usr/bin/env falcon serve --concurrency 1 -c
@@ -46,8 +83,6 @@ run lambda {|env|
 }
 ```
 
-And [here is a client program](examples/chat/client.rb) which can read input from `stdin` and send messages to the server.
-
 ## Contributing
 
 1. Fork it

data/async-websocket.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 	spec.add_development_dependency "async-rspec"
 	spec.add_development_dependency "falcon", "~> 0.17.0"
 	
-	spec.add_development_dependency "bundler", "~> 1.6"
+	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec", "~> 3.6"
 	spec.add_development_dependency "rake"
 end

data/examples/chat/client.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'async/reactor'
+require 'async'
 require 'async/io/stream'
 require 'async/http/url_endpoint'
 require 'async/websocket/client'
@@ -8,7 +8,7 @@ require 'async/websocket/client'
 USER = ARGV.pop || "anonymous"
 URL = ARGV.pop || "ws://localhost:9292"
 
-Async::Reactor.run do |task|
+Async do |task|
 	stdin = Async::IO::Stream.new(
 		Async::IO::Generic.new($stdin)
 	)

data/examples/middleware/client.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'async/reactor'
+require 'async'
 require 'async/io/stream'
 require 'async/http/url_endpoint'
 require 'async/websocket/client'
@@ -8,7 +8,7 @@ require 'async/websocket/client'
 USER = ARGV.pop || "anonymous"
 URL = ARGV.pop || "ws://localhost:9292"
 
-Async::Reactor.run do |task|
+Async do |task|
 	stdin = Async::IO::Stream.new(
 		Async::IO::Generic.new($stdin)
 	)

data/lib/async/websocket/client.rb

@@ -24,10 +24,18 @@ module Async
 	module WebSocket
 		# This is a basic synchronous websocket client:
 		class Client < Connection
-			def initialize(socket, url = "ws://.")
+			def initialize(socket, url = "ws://.", headers = {})
 				@url = url
-				
-				super socket, ::WebSocket::Driver.client(self)
+
+				super socket, build_client(headers)
+			end
+
+			def build_client(headers)
+				::WebSocket::Driver.client(self).tap do |client|
+					headers.each do |key, value|
+						client.set_header(key, value)
+					end
+				end
 			end
 		end
 	end

data/lib/async/websocket/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module WebSocket
-		VERSION = "0.6.1"
+		VERSION = "0.7.0"
 	end
 end

data/spec/async/websocket/client_spec.rb

@@ -0,0 +1,32 @@
+require "async/websocket/client"
+
+RSpec.describe Async::WebSocket::Client do
+	let(:client_double) {
+		instance_double(WebSocket::Driver::Client, on: nil, start: nil)
+	}
+
+	before do
+		allow(WebSocket::Driver).to receive(:client).and_return(client_double)
+	end
+
+	it "sets headers on the driver" do
+		headers = {
+			"Foo" => "Bar",
+			"Baz" => "Qux"
+		}
+
+		headers.each do |key, value|
+			expect(client_double).to receive(:set_header).with(key, value)
+		end
+
+		described_class.new(double(write: nil), "", headers)
+	end
+
+	context "without passing headers" do
+		it "does not fail" do
+			expect {
+				described_class.new(double(write: nil))
+			}.not_to raise_error
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-websocket
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -70,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - lib/async/websocket/connection.rb
 - lib/async/websocket/server.rb
 - lib/async/websocket/version.rb
+- spec/async/websocket/client_spec.rb
 - spec/async/websocket/connection_spec.rb
 - spec/async/websocket/connection_spec.ru
 - spec/spec_helper.rb
@@ -188,12 +189,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: An async websocket library on top of websocket-driver.
 test_files:
+- spec/async/websocket/client_spec.rb
 - spec/async/websocket/connection_spec.rb
 - spec/async/websocket/connection_spec.ru
 - spec/spec_helper.rb