message_bus 2.0.2 → 2.0.3

data/lib/message_bus/rack/middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 # our little message bus, accepts long polling and polling
@@ -48,10 +49,10 @@ class MessageBus::Rack::Middleware
   def self.backlog_to_json(backlog)
     m = backlog.map do |msg|
       {
-        :global_id => msg.global_id,
-        :message_id => msg.message_id,
-        :channel => msg.channel,
-        :data => msg.data
+        global_id: msg.global_id,
+        message_id: msg.message_id,
+        channel: msg.channel,
+        data: msg.data
       }
     end.to_a
     JSON.dump(m)
@@ -62,13 +63,13 @@ class MessageBus::Rack::Middleware
     return @app.call(env) unless env['PATH_INFO'] =~ /^\/message-bus\//
 
     # special debug/test route
-    if @bus.allow_broadcast? && env['PATH_INFO'] == '/message-bus/broadcast'.freeze
-        parsed = Rack::Request.new(env)
-        @bus.publish parsed["channel".freeze], parsed["data".freeze]
-        return [200,{"Content-Type".freeze => "text/html".freeze},["sent"]]
+    if @bus.allow_broadcast? && env['PATH_INFO'] == '/message-bus/broadcast'
+      parsed = Rack::Request.new(env)
+      @bus.publish parsed["channel"], parsed["data"]
+      return [200, { "Content-Type" => "text/html" }, ["sent"]]
     end
 
-    if env['PATH_INFO'].start_with? '/message-bus/_diagnostics'.freeze
+    if env['PATH_INFO'].start_with? '/message-bus/_diagnostics'
       diags = MessageBus::Rack::Diagnostics.new(@app, message_bus: @bus)
       return diags.call(env)
     end
@@ -97,8 +98,8 @@ class MessageBus::Rack::Middleware
       request = Rack::Request.new(env)
       is_json = request.content_type && request.content_type.include?('application/json')
       data = is_json ? JSON.parse(request.body.read) : request.POST
-      data.each do |k,v|
-        if k == "__seq".freeze
+      data.each do |k, v|
+        if k == "__seq"
           client.seq = v.to_i
         else
           client.subscribe(k, v)
@@ -113,7 +114,7 @@ class MessageBus::Rack::Middleware
     headers["Expires"] = "0"
 
     if @bus.extra_response_headers_lookup
-      @bus.extra_response_headers_lookup.call(env).each do |k,v|
+      @bus.extra_response_headers_lookup.call(env).each do |k, v|
         headers[k] = v
       end
     end
@@ -123,11 +124,11 @@ class MessageBus::Rack::Middleware
     end
 
     long_polling = @bus.long_polling_enabled? &&
-                   env['QUERY_STRING'] !~ /dlp=t/.freeze &&
+                   env['QUERY_STRING'] !~ /dlp=t/ &&
                    @connection_manager.client_count < @bus.max_active_clients
 
-    allow_chunked = env['HTTP_VERSION'.freeze] == 'HTTP/1.1'.freeze
-    allow_chunked &&= !env['HTTP_DONT_CHUNK'.freeze]
+    allow_chunked = env['HTTP_VERSION'] == 'HTTP/1.1'
+    allow_chunked &&= !env['HTTP_DONT_CHUNK']
     allow_chunked &&= @bus.chunked_encoding_enabled?
 
     client.use_chunked = allow_chunked
@@ -159,7 +160,7 @@ class MessageBus::Rack::Middleware
         response = Thin::AsyncResponse.new(env)
       end
 
-      headers.each do |k,v|
+      headers.each do |k, v|
         response.headers[k] = v
       end
 
@@ -183,7 +184,7 @@ class MessageBus::Rack::Middleware
     end
 
   rescue => e
-    if @bus.on_middleware_error && result=@bus.on_middleware_error.call(env, e)
+    if @bus.on_middleware_error && result = @bus.on_middleware_error.call(env, e)
       result
     else
       raise
@@ -203,7 +204,7 @@ class MessageBus::Rack::Middleware
   def add_client_with_timeout(client)
     @connection_manager.add_client(client)
 
-    client.cleanup_timer = MessageBus.timer.queue( @bus.long_polling_interval.to_f / 1000) {
+    client.cleanup_timer = MessageBus.timer.queue(@bus.long_polling_interval.to_f / 1000) {
       begin
         client.cleanup_timer = nil
         client.ensure_closed!

data/lib/message_bus/rack/thin_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # there is also another in cramp this is from https://github.com/macournoyer/thin_async/blob/master/lib/thin/async.rb
 module Thin
   unless defined?(DeferrableBody)
@@ -40,7 +41,7 @@ module Thin
     attr_reader :headers, :callback, :closed
     attr_accessor :status
 
-    def initialize(env, status=200, headers={})
+    def initialize(env, status = 200, headers = {})
       @callback = env['async.callback']
       @body = DeferrableBody.new
       @status = status

data/lib/message_bus/rails/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MessageBus; module Rails; end; end
 
 # rails engine for asset pipeline
@@ -11,12 +12,24 @@ class MessageBus::Rails::Railtie < ::Rails::Railtie
     #
     # To handle either case, we insert it before ActionDispatch::Flash.
     #
-    begin
-      app.middleware.insert_before(ActionDispatch::Flash, MessageBus::Rack::Middleware)
-    rescue
+    # For APIs or apps that have ActionDispatch::Flash deleted from the middleware
+    # stack we just push MessageBus to the bottom.
+    if api_only?(app.config) || flash_middleware_deleted?(app.middleware)
       app.middleware.use(MessageBus::Rack::Middleware)
+    else
+      app.middleware.insert_before(ActionDispatch::Flash, MessageBus::Rack::Middleware)
     end
 
     MessageBus.logger = Rails.logger
   end
+
+  def api_only?(config)
+    return false unless config.respond_to?(:api_only)
+    config.api_only
+  end
+
+  def flash_middleware_deleted?(middleware)
+    ops = middleware.instance_variable_get(:@operations)
+    ops.any? { |m| m[0] == :delete && m[1].include?(ActionDispatch::Flash) }
+  end
 end

data/lib/message_bus/timer_thread.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 class MessageBus::TimerThread
 
   attr_reader :jobs
 
   class Cancelable
-    NOOP = proc{}
+    NOOP = proc {}
 
     def initialize(job)
       @job = job
@@ -26,8 +27,8 @@ class MessageBus::TimerThread
     @jobs = []
     @mutex = Mutex.new
     @next = nil
-    @thread = Thread.new{do_work}
-    @on_error = lambda{|e| STDERR.puts "Exception while processing Timer:\n #{e.backtrace.join("\n")}"}
+    @thread = Thread.new { do_work }
+    @on_error = lambda { |e| STDERR.puts "Exception while processing Timer:\n #{e.backtrace.join("\n")}" }
   end
 
   def stop
@@ -51,12 +52,12 @@ class MessageBus::TimerThread
         result.current = queue(delay, &do_work)
       end
     end
-    result.current = queue(delay,&do_work)
+    result.current = queue(delay, &do_work)
     result
   end
 
   # queue a block to run after a certain delay (in seconds)
-  def queue(delay=0, &block)
+  def queue(delay = 0, &block)
     queue_time = Time.new.to_f + delay
     job = [queue_time, block]
 
@@ -64,20 +65,23 @@ class MessageBus::TimerThread
       i = @jobs.length
       while i > 0
         i -= 1
-        current,_ = @jobs[i]
-        i+=1 and break if current < queue_time
+        current, _ = @jobs[i]
+        if current < queue_time
+          i += 1
+          break
+        end
       end
       @jobs.insert(i, job)
-      @next = queue_time if i==0
+      @next = queue_time if i == 0
     end
 
     unless @thread.alive?
       @mutex.synchronize do
-        @thread = Thread.new{do_work} unless @thread.alive?
+        @thread = Thread.new { do_work } unless @thread.alive?
       end
     end
 
-    if @thread.status == "sleep".freeze
+    if @thread.status == "sleep"
       @thread.wakeup
     end
 
@@ -93,22 +97,22 @@ class MessageBus::TimerThread
   def do_work
     while !@stopped
       if @next && @next <= Time.new.to_f
-        _,blk = @mutex.synchronize { @jobs.shift }
+        _, blk = @mutex.synchronize { @jobs.shift }
         begin
           blk.call
         rescue => e
           @on_error.call(e) if @on_error
         end
         @mutex.synchronize do
-          @next,_ = @jobs[0]
+          @next, _ = @jobs[0]
         end
       end
       unless @next && @next <= Time.new.to_f
         sleep_time = 1000
         @mutex.synchronize do
-          sleep_time = @next-Time.new.to_f if @next
+          sleep_time = @next - Time.new.to_f if @next
         end
-        sleep [0,sleep_time].max
+        sleep [0, sleep_time].max
       end
     end
   end

data/lib/message_bus/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MessageBus
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/message_bus.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/message_bus/version', __FILE__)
 
@@ -10,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "message_bus"
   gem.require_paths = ["lib"]

data/spec/lib/message_bus/backends/postgres_spec.rb

@@ -28,7 +28,7 @@ describe PUB_SUB_CLASS do
 
       3.times do
         result = @bus.publish "/foo", "bar"
-        result.must_equal nil
+        assert_nil result
       end
 
       @bus.pub_redis.slaveof "no", "one"

data/spec/lib/message_bus/backends/redis_spec.rb

@@ -31,7 +31,7 @@ describe PUB_SUB_CLASS do
 
       3.times do
         result = @bus.publish "/foo", "bar"
-        result.must_equal nil
+        assert_nil result
         Thread.list.length.must_equal (current_threads_length + 1)
       end
 

data/spec/lib/message_bus/client_spec.rb

@@ -5,10 +5,14 @@ describe MessageBus::Client do
 
   describe "subscriptions" do
 
+    def setup_client(client_id)
+      MessageBus::Client.new client_id: client_id, message_bus: @bus
+    end
+
     before do
       @bus = MessageBus::Instance.new
       @bus.configure(MESSAGE_BUS_CONFIG)
-      @client = MessageBus::Client.new client_id: 'abc', message_bus: @bus
+      @client = setup_client('abc')
     end
 
     after do
@@ -119,6 +123,25 @@ describe MessageBus::Client do
       log[0].data.must_equal("/hello" => 0)
     end
 
+    it 'provides status updates to clients that are not allowed to a message' do
+      another_client = setup_client('def')
+      clients = [@client, another_client]
+
+      clients.each { |client| client.subscribe('/hello', nil) }
+
+      @bus.publish("/hello", "world", client_ids: ['abc'])
+
+      log = @client.backlog
+      log.length.must_equal 1
+      log[0].channel.must_equal '/hello'
+      log[0].data.must_equal 'world'
+
+      log = another_client.backlog
+      log.length.must_equal 1
+      log[0].channel.must_equal '/__status'
+      log[0].data.must_equal({ '/hello' => 1 })
+    end
+
     it "should provide a list of subscriptions" do
       @client.subscribe('/hello', nil)
       @client.subscriptions['/hello'].wont_equal nil

data/spec/lib/message_bus/connection_manager_spec.rb

@@ -53,7 +53,7 @@ describe MessageBus::ConnectionManager do
     m = MessageBus::Message.new(1,1,"test","data")
     m.site_id = 9
     @manager.notify_clients(m)
-    @resp.sent.must_equal nil
+    assert_nil @resp.sent
   end
 
   it "should notify clients on the correct site" do
@@ -69,8 +69,8 @@ describe MessageBus::ConnectionManager do
     m.site_id = 10
     @manager.notify_clients(m)
     parsed = JSON.parse(@resp.sent)
-    parsed[0]["site_id"].must_equal nil
-    parsed[0]["user_id"].must_equal nil
+    assert_nil parsed[0]["site_id"]
+    assert_nil parsed[0]["user_id"]
   end
 
   it "should not deliver unselected" do
@@ -78,7 +78,7 @@ describe MessageBus::ConnectionManager do
     m.user_ids = [5]
     m.site_id = 10
     @manager.notify_clients(m)
-    @resp.sent.must_equal nil
+    assert_nil @resp.sent
   end
 end
 

data/spec/lib/message_bus/rack/middleware_spec.rb

@@ -260,7 +260,12 @@ describe MessageBus::Rack::Middleware do
       }
 
       parsed = JSON.parse(last_response.body)
-      parsed.length.must_equal 0
+      parsed.length.must_equal 1
+
+      message = parsed.first
+
+      message["channel"].must_equal "/__status"
+      message["data"].must_equal("/foo" => 1)
 
       @bus.user_id_lookup do |env|
         1
@@ -286,7 +291,10 @@ describe MessageBus::Rack::Middleware do
       }
 
       parsed = JSON.parse(last_response.body)
-      parsed.length.must_equal 0
+      message = parsed.first
+
+      message["channel"].must_equal "/__status"
+      message["data"].must_equal("/foo" => 1)
 
       @bus.group_ids_lookup do |env|
         [1,7,4,100]

data/spec/lib/message_bus_spec.rb

@@ -159,7 +159,7 @@ describe MessageBus do
     @bus.publish("/bob", "dylan")
     @bus.publish("/bob", "marley")
     @bus.last_message("/bob").data.must_equal "marley"
-    @bus.last_message("/nothing").must_equal nil
+    assert_nil @bus.last_message("/nothing")
   end
 
   describe "global subscriptions" do

data/vendor/assets/javascripts/message-bus-ajax.js

@@ -0,0 +1 @@
+../../../assets/message-bus-ajax.js

data/vendor/assets/javascripts/message-bus.js

@@ -0,0 +1 @@
+../../../assets/message-bus.js

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: redis
   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: pg
   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: A message bus for rack
@@ -59,8 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - Guardfile
@@ -130,17 +131,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: ''