roda-websockets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb6a87a9451e3df76498a2bb082b0db0905b72e1f4415ead9b86ce96b98decbc
+  data.tar.gz: 9838604a59b67df2b16a90c8ab7b78a91ffac5b3c82ee5ef88f609bf05225129
+SHA512:
+  metadata.gz: c5c08c73ffbf235a15645f2472cf4ac50cbfc567f12ecb41a05612c21f4c370f9fbbe6f4b3e0f8560fdb0fb2209eb7af13f46270c0e5cd3d5b6412862da04bba
+  data.tar.gz: db4e90ad932846bbff3c4e6e74f26c25c648ab2a921f926a3f2722411bf8314e5289b0367f3a272de05fdfbf80a73166fd9ed389b113e46e54f95abd42e05f15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (2019-06-26)
+
+* Initial Public Release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2019 Shannon Skipper
+
+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 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,40 @@
+# roda-websockets
+
+The roda-websockets gem integrates [async-websockets](https://github.com/socketry/async-websocket) into the [roda](http://roda.jeremyevans.net/) web toolkit. Use this plugin for asynchronous websockets alongside roda and falcon.
+
+## Installation
+
+```sh
+gem install roda-websockets
+```
+
+## Source Code
+
+Source code is available on GitHub at
+https://github.com/havenwood/roda-websockets
+
+## Usage
+
+roda-websockets requires that you use [Falcon](https://github.com/socketry/falcon) as your web server in order to establish asynchronous websocket connections.
+
+```ruby
+falcon serve --bind http://localhost:3000 --count 1 --config config.ru
+```
+
+roda-websockets is a roda plugin, so you need to load it into your roda
+application similar to other plugins:
+
+```ruby
+class App < Roda
+  plugin :websockets
+end
+```
+
+In your routing block, you can use `r.websocket` to pass the routing
+to a websocket connection.
+
+```ruby
+r.websocket do |connection|
+  # ...
+end
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include %w[pkg/roda-websockets-*.gem].freeze
+
+task default: :test
+
+Rake::TestTask.new do |test|
+  test.pattern = 'spec/**/*_spec.rb'
+  test.warning = false
+end

data/lib/roda/plugins/websockets.rb

@@ -0,0 +1,64 @@
+# frozen-string-literal: true
+
+require 'async/websocket/adapters/rack'
+
+class Roda
+  module RodaPlugins
+    # The websockets plugin integrates the async-websocket gem into Roda's
+    # routing tree. See the
+    # {async-websocket docs}[https://github.com/socketry/async-websocket]
+    # for usage details.
+    #
+    # The following example is an echo server that sleeps one second after
+    # receiving a message before echoing that same message back to the client
+    # and closing the connection:
+    #
+    #   plugin :websockets
+    #
+    #   def messages(connection)
+    #     Enumerator.new do |yielder|
+    #       while (message = connection.read)
+    #         yielder << message
+    #       end
+    #     end
+    #   end
+    #
+    #   def on_message(connection, message:)
+    #     Async do |task|
+    #       task.sleep(1)
+    #       connection.write(message)
+    #       connection.flush
+    #       connection.close
+    #     end
+    #   end
+    #
+    #   route do |r|
+    #     r.root do
+    #       r.websocket do |connection|
+    #         messages(connection).each do |message|
+    #           on_message(connection, message: message)
+    #         end
+    #       end
+    #     end
+    #   end
+    module WebSockets
+      module RequestMethods
+        ARGS = {}.freeze
+
+        def websocket?
+          Async::WebSocket::Adapters::Rack.websocket?(env)
+        end
+
+        def websocket(args = ARGS, &block)
+          return unless websocket?
+
+          always do
+            halt Async::WebSocket::Adapters::Rack.open(env, *args, &block)
+          end
+        end
+      end
+    end
+
+    register_plugin(:websockets, WebSockets)
+  end
+end

data/spec/roda-websockets_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'async'
+require 'async/debug/selector'
+require 'async/http/endpoint'
+require 'async/websocket/client'
+require 'falcon/adapters/rack'
+require 'falcon/server'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'roda'
+
+describe 'roda-websockets plugin' do
+  prove_it!
+
+  let :reactor do
+    Async::Reactor.new(selector: Async::Debug::Selector.new)
+  end
+
+  let :endpoint do
+    Async::HTTP::Endpoint.parse('http://localhost:7050')
+  end
+
+  let :app do
+    app = Class.new(Roda)
+    app.plugin :websockets
+    app.route do |r|
+      r.root do
+        r.websocket do |connection|
+          %w[zxc spqr wombat].each do |message|
+            connection.write(message)
+            connection.flush
+          end
+
+          connection.close
+        end
+
+        'bar'
+      end
+    end
+
+    app
+  end
+
+  let :server do
+    Falcon::Server.new(Falcon::Server.middleware(app), endpoint)
+  end
+
+  let :client do
+    Async::HTTP::Client.new(endpoint)
+  end
+
+  before do
+    @server_task = reactor.async do
+      server.run
+    end
+  end
+
+  after do
+    @server_task.stop
+  end
+
+  it 'supports regular requests' do
+    reactor.run do
+      response = client.get('/')
+      assert_equal response.read, 'bar'
+
+      client.close
+      reactor.stop
+    end
+  end
+
+  it 'supports websocket requests' do
+    reactor.run do
+      Async::WebSocket::Client.connect(endpoint) do |connection|
+        assert_equal(connection.read, 'zxc')
+        assert_equal(connection.read, 'spqr')
+        assert_equal(connection.read, 'wombat')
+      end
+
+      reactor.stop
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: roda-websockets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shannon Skipper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: falcon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The roda-websockets gem integrates async-websockets into the roda web
+  toolkit.
+email: shannonskipper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/roda/plugins/websockets.rb
+- spec/roda-websockets_spec.rb
+homepage: https://github.com/havenwood/roda-websockets
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: WebSocket integration for Roda
+test_files: []