roda-message_bus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5732e8b05b673858703a5f5d9b7b11c84b926895
+  data.tar.gz: d7d639e4d26bc51d359850483a393530a95a3a58
+SHA512:
+  metadata.gz: 773e562b49b214ac1453913189a73318600726b2bd4097d2d8bb5a4fbe6d90881f46f496f22284a028a8449d773b8b9bbf14eba7a745221443365a7a9629cd1b
+  data.tar.gz: befafc0678b136fd2d75e9e2ff282ca12434fac937abe28df4715d7db8955da750e37ea305dde694051d4275d7f1513f359887f252d93e3d18d5b8b331c1e9ff

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2016-06-21)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2016 Jeremy Evans
+
+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.rdoc

@@ -0,0 +1,73 @@
+= roda-message_bus
+
+roda-message_bus integrates message_bus into the roda web toolkit,
+allowing you to call message_bus only for specific paths, after
+any access control checks have been made.
+
+= Installation
+
+  gem install roda-message_bus
+
+= Source Code
+
+Source code is available on GitHub at
+https://github.com/jeremyevans/roda-message_bus
+
+= Usage
+
+roda-message_bus is a roda plugin, so you need to load it into your roda
+application similar to other plugins:
+
+  class App < Roda
+    plugin :message_bus
+  end
+
+In your routing block, you can use +r.message_bus+ to pass the routing
+to message bus.  Generally you'll want to do this after making any
+access control checks:
+
+  App.route do |r|
+    r.on "room/:id" do |room_id|
+      room_id = room_id.to_i
+      raise unless current_user.has_access?(room_id)
+  
+      # Allows "/room/#{room_id}" channel by default
+      r.message_bus
+
+      view(:room)
+    end
+  end
+
+Routing will halt in +r.message_bus+ if the request is a message_bus
+request.  If the request is not a message_bus request, execution will
+continue without yielding.
+
+If you want to, you can force a specific message_bus channel (or channels
+by passing an array) when calling r.message_bus:
+
+  # Override channel to use (can also provide array of channels)
+  r.message_bus("/room/#{room_id}/enters")
+
+If you pass a block to +r.message_bus+, it will be yielded to only
+if this is a message_bus request.
+
+  r.message_bus do
+    # executed right before passing control to message_bus
+  end
+
+For roda-message_bus to work, in your MessageBus javascript code, you must
+set the +baseUrl+ to match the routing tree branch where you are calling
++r.message_bus+:
+
+  <script type="text/javascript" src="/message-bus.js"></script>
+  <script type="text/javascript">
+    MessageBus.baseUrl = "<%= request.path_info %>/";
+  </script>
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,36 @@
+require "rake"
+require "rake/clean"
+
+CLEAN.include ["roda-message_bus-*.gem", "rdoc", "coverage"]
+
+desc "Build thamble gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build roda-message_bus.gemspec}
+end
+
+### Specs
+
+desc "Run specs"
+task :spec do
+  sh "#{FileUtils::RUBY} -rubygems -I lib spec/roda-message_bus_spec.rb"
+end
+
+task :default => :spec
+
+### RDoc
+
+RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--main', 'README.rdoc', '--title', 'roda-message_bus: MessageBus integration for Roda']
+
+begin
+  gem 'hanna-nouveau'
+  RDOC_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end

data/lib/roda/plugins/message_bus.rb

@@ -0,0 +1,78 @@
+# frozen-string-literal: true
+
+require 'message_bus/rack/middleware'
+
+class Roda
+  module RodaPlugins
+    # The message_bus plugin allows for integrating the message_bus library into
+    # Roda's routing tree.  By default, MessageBus provides a Rack middlware to
+    # work with any rack framework.  However, that doesn't work well if you are
+    # integrating access control into your routing tree.
+    #
+    # With the message_bus plugin, you can specify exactly where to pass control
+    # to message_bus, which can be done after access controls have been checked.
+    # Additionally, this allows to control which message_bus channels are allowed
+    # for which requests, further enhancing security.
+    #
+    # It is still possible to use message_bus's user/group/site filtering when
+    # using this support to filter allowed channels.
+    #
+    #   # Use default MessageBus
+    #   plugin :message_bus
+    #
+    #   # Use specific MessageBus implementation
+    #   plugin :message_bus, :message_bus=>MessageBus::Instance.new
+    #
+    #   route do |r|
+    #     r.on "room/:id" do |room_id|
+    #       room_id = room_id.to_i
+    #       raise unless current_user.has_access?(room_id)
+    #
+    #       # Uses "/room/#{room_id}" channel by default
+    #       r.message_bus
+    #
+    #       # Override channel to use (can also provide array of channels)
+    #       r.message_bus("/room/#{room_id}/enters")
+    #
+    #       # In addition to subscribing to channels,
+    #       # in Javascript on this page, set:
+    #       #
+    #       #   MessageBus.baseUrl = "/room/<%= room_id %>/"
+    #       view('room')
+    #     end
+    #   end
+    module MessageBus
+      APP = proc{[404, {"Content-Type" => "text/html"}, ["Not Found"]]}
+
+      def self.configure(app, config={})
+        app.opts[:message_bus_app] = ::MessageBus::Rack::Middleware.new(APP, config)
+      end
+
+      module ClassMethods
+        def message_bus_app
+          opts[:message_bus_app]
+        end
+      end
+
+      module RequestMethods
+        def message_bus(channels=nil)
+          if remaining_path =~ /\A\/message-bus\//
+            chans = env['message_bus.channels'] = {}
+            post = self.POST
+            channels ||= script_name + path_info.chomp(remaining_path)
+            Array(channels).each do |channel|
+              if val = post[channel]
+                chans[channel] = val
+              end
+            end
+            env['message_bus.seq'] = post['__seq']
+            yield if block_given?
+            run roda_class.message_bus_app
+          end
+        end
+      end
+    end
+
+    register_plugin(:message_bus, MessageBus)
+  end
+end

data/spec/roda-message_bus_spec.rb

@@ -0,0 +1,49 @@
+require 'roda'
+require 'message_bus'
+require 'json'
+require 'minitest/autorun'
+
+MessageBus.configure(:backend => :memory)
+
+describe 'roda message_bus plugin' do
+  def req(path, input={}, env={})
+    env = {"PATH_INFO"=>path, "REQUEST_METHOD" => "GET", "SCRIPT_NAME" => "", 'rack.input'=>true, 'rack.request.form_input'=>true, 'rack.request.form_hash'=>input}.merge(env)
+    @app.call(env)
+  end
+
+  def body(path, input={}, env={})
+    s = String.new
+    b = req(path, input, env)[2]
+    b.each{|x| s << x}
+    b.close if b.respond_to?(:close)
+    s
+  end
+
+  def json_body(path, input={}, env={})
+    JSON.parse(body(path, input, env))
+  end
+
+  before do
+    @app = Class.new(Roda)
+    @app.plugin :message_bus
+    @app
+  end
+
+  it "should handle message bus under a branch" do
+    @app.route do |r|
+      r.on "foo" do
+        r.message_bus
+        'bar'
+      end
+    end
+
+    body('/foo').must_equal 'bar'
+    json_body('/foo/message-bus/1/poll', '/foo'=>'0', '__seq'=>1).must_equal []
+    MessageBus.publish '/foo', 'baz'
+    json_body('/foo/message-bus/1/poll', '/foo'=>'0', '__seq'=>1).must_equal [{"global_id"=>1, "message_id"=>1, "channel"=>"/foo", "data"=>"baz"}]
+    MessageBus.publish '/foo', 'baz1'
+    json_body('/foo/message-bus/1/poll', '/foo'=>'0', '__seq'=>1).must_equal [{"global_id"=>1, "message_id"=>1, "channel"=>"/foo", "data"=>"baz"}, {"global_id"=>2, "message_id"=>2, "channel"=>"/foo", "data"=>"baz1"}]
+    json_body('/foo/message-bus/1/poll', '/foo'=>'1', '__seq'=>1).must_equal [{"global_id"=>2, "message_id"=>2, "channel"=>"/foo", "data"=>"baz1"}]
+    json_body('/foo/message-bus/1/poll', '/foo'=>'1').must_equal [{"global_id"=>2, "message_id"=>2, "channel"=>"/foo", "data"=>"baz1"}]
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: roda-message_bus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: message_bus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: |
+  roda-message_bus integrates message_bus into the roda web toolkit,
+  allowing you to call message_bus only for specific paths, after
+  any access control checks have been made.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/roda/plugins/message_bus.rb
+- spec/roda-message_bus_spec.rb
+homepage: https://github.com/jeremyevans/roda-message_bus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- 'roda-message_bus: MessageBus integration for Roda'
+- "--main"
+- README.rdoc
+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.5.1
+signing_key: 
+specification_version: 4
+summary: MessageBus integration for Roda
+test_files: []