message_bus 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46de79e771fac3fb31c3edc55b0866842b6dc108df65c5bcbd7d1062568a6279
-  data.tar.gz: 201cb983ab710b1fe487f69105a13f0291873bf94c8a5e16f1749993a22ddc74
+  metadata.gz: 93e3bc28f1411da6037721acabab32fa504542bb68238afe6671f10bfccfa194
+  data.tar.gz: b25d3013be8f3a0efa180db29de0ac6a55e5ce08ea87f80c912f046b9548c821
 SHA512:
-  metadata.gz: 633808d11a69d4f6e7c8e53f4805c6bff2d5cd5e57b4c38a166af355e8c6cd2e423c6b27cb0f861597cda6b65dedb0c2bf46edfe5b7fada98b79e8f1bed7d38a
-  data.tar.gz: d38cb6e67c791a9e1e3dcaef8764517e47a363fa4045aed35eedff84cdbdf2a7da85bf0e55a2f00c4c877612bf46ce3dbaea430786afb6dd903ae090b4144638
+  metadata.gz: c74493de8f9f2dc5305457696988d7f07dce56642a8796d3757a0e5bf4e14f6e9b011ed8bd9255e0d3dc197c290bbdafedcf47e2519f09ca085ec86f33848508
+  data.tar.gz: e4778edb5d540ef011ad29916dd8e4a374b04fb5dcd57ef80542b9f0b0985f5887609bf67b071455ebd15e59386eb0abc30698d015a4585f66a4d7afd217fc05

data/CHANGELOG

@@ -1,3 +1,9 @@
+26-03-2020
+
+- Version 2.2.4
+
+  - FEATURE: shouldLongPollCallback optional setting which allows overriding decision about long polling
+
 18-10-2019
 
 - Version 2.2.3

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in message_bus.gemspec
@@ -6,6 +7,7 @@ gemspec
 group :test do
   gem 'minitest'
   gem 'minitest-hooks'
+  gem 'minitest-global_expectations'
   gem 'rake'
   gem 'http_parser.rb'
   gem 'thin'

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/README.md

@@ -8,6 +8,8 @@ Since long-polling is implemented using Rack Hijack and Thin::Async, all common
 
 MessageBus is implemented as Rack middleware and can be used by any Rails / Sinatra or pure Rack application.
 
+Read the generated docs: <https://www.rubydoc.info/gems/message_bus>
+
 ## Try it out!
 
 Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tree/master/examples/chat) is at:
@@ -278,6 +280,7 @@ backgroundCallbackInterval|60000|Interval to poll when long polling is disabled
 minPollInterval|100|When polling requests succeed, this is the minimum amount of time to wait before making the next request.
 maxPollInterval|180000|If request to the server start failing, MessageBus will backoff, this is the upper limit of the backoff.
 alwaysLongPoll|false|For debugging you may want to disable the "is browser in background" check and always long-poll
+shouldLongPollCallback|undefined|A callback returning true or false that determines if we should long-poll or not, if unset ignore and simply depend on window visibility.
 baseUrl|/|If message bus is mounted at a sub-path or different domain, you may configure it to perform requests there
 ajax|$.ajax falling back to XMLHttpRequest|MessageBus will first attempt to use jQuery and then fallback to a plain XMLHttpRequest version that's contained in the `message-bus-ajax.js` file. `message-bus-ajax.js` must be loaded after `message-bus.js` for it to be used. You may override this option with a function that implements an ajax request by some other means
 headers|{}|Extra headers to be include with requests. Properties and values of object must be valid values for HTTP Headers, i.e. no spaces or control characters.
@@ -561,6 +564,18 @@ MessageBus.configure(on_middleware_error: proc do |env, e|
 end)
 ```
 
+### Adding extra response headers
+
+In e.g. `config/initializers/message_bus.rb`:
+
+```ruby
+MessageBus.extra_response_headers_lookup do |env|
+  [
+      ["Access-Control-Allow-Origin", "http://example.com:3000"],
+  ]
+end
+```
+
 ## How it works
 
 MessageBus provides durable messaging following the publish-subscribe (pubsub) pattern to subscribers who track their own subscriptions. Durability is by virtue of the persistence of messages in backlogs stored in the selected backend implementation (Redis, Postgres, etc) which can be queried up until a configurable expiry. Subscribers must keep track of the ID of the last message they processed, and request only more-recent messages in subsequent connections.

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'rake/testtask'
 require 'bundler'

data/assets/message-bus.js

@@ -99,7 +99,10 @@
   };
 
   shouldLongPoll = function() {
-    return me.alwaysLongPoll || !isHidden();
+    return (
+      me.alwaysLongPoll ||
+      (me.shouldLongPollCallback ? me.shouldLongPollCallback() : !isHidden())
+    );
   };
 
   var totalAjaxFailures = 0;
@@ -377,6 +380,7 @@
     callbacks: callbacks,
     clientId: clientId,
     alwaysLongPoll: false,
+    shouldLongPollCallback: undefined,
     baseUrl: baseUrl,
     headers: {},
     ajax: jQuery && jQuery.ajax,

data/examples/bench/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 
 require 'message_bus'

data/examples/bench/puma.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 on_worker_boot do
   MessageBus.after_fork

data/examples/bench/unicorn.conf.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 after_fork do |_server, _worker|
   MessageBus.after_fork

data/examples/chat/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 gem 'puma'
 gem 'redis'
 gem 'sinatra'

data/examples/chat/chat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 require 'message_bus'
 require 'sinatra'

data/examples/chat/config.ru

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require './chat'
 run Chat

data/examples/diagnostics/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus', path: '../..'

data/examples/diagnostics/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 MessageBus.configure(backend: :redis, url: ENV['REDISURL'])

data/examples/minimal/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus'

data/examples/minimal/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 # MessageBus.long_polling_interval = 1000 * 2

data/lib/message_bus/diagnostics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # MessageBus diagnostics are used for troubleshooting the bus and optimising its configuration
 # @see MessageBus::Rack::Diagnostics
 class MessageBus::Diagnostics

data/lib/message_bus/em_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EM
   def self.reactor_pid
     @reactor_pid

data/lib/message_bus/http_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'securerandom'
 require 'net/http'
 require 'json'
@@ -245,7 +246,7 @@ module MessageBus
       request.body = poll_payload
 
       if @enable_long_polling
-        buffer = ''
+        buffer = +""
 
         http.request(request) do |response|
           response.read_body do |chunk|

data/lib/message_bus/http_client/channel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MessageBus
   class HTTPClient
     # @private

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "2.2.3"
+  VERSION = "2.2.4"
 end

data/spec/assets/support/jasmine_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Jasmine.configure do |_config|
   # patch for travis
   if ENV['TRAVIS']

data/spec/fixtures/test/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus'

data/spec/fixtures/test/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 MessageBus.config[:backend] = :memory

data/spec/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def wait_for(timeout_milliseconds = 2000)
   timeout = (timeout_milliseconds + 0.0) / 1000
   finish = Time.now + timeout

data/spec/integration/http_client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'message_bus/http_client'
 

data/spec/lib/fake_async_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'http/parser'
 class FakeAsyncMiddleware
   def initialize(app, config = {})
@@ -53,7 +54,7 @@ class FakeAsyncMiddleware
 
   def translate_io_result(io)
     data = io.string
-    body = ""
+    body = +""
 
     parser = Http::Parser.new
     parser.on_body = proc { |chunk| body << chunk }
@@ -112,7 +113,7 @@ class FakeAsyncMiddleware
         # more judo with deferrable body, at this point we just have headers
         r[2].callback do
           # even more judo cause rack test does not call each like the spec says
-          body = ""
+          body = +""
           r[2].each do |m|
             body << m
           end

data/spec/lib/message_bus/assets/asset_encoding_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../../../spec_helper'
 asset_directory = File.expand_path('../../../../../assets', __FILE__)
 asset_file_paths = Dir.glob(File.join(asset_directory, 'message-bus.js'))

data/spec/lib/message_bus/backend_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 

data/spec/lib/message_bus/client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 
@@ -83,7 +85,7 @@ describe MessageBus::Client do
 
       data[-5..-1].must_equal "0\r\n\r\n"
 
-      _, _, chunks = http_parse("HTTP/1.1 200 OK\r\n\r\n" << data)
+      _, _, chunks = http_parse(+"HTTP/1.1 200 OK\r\n\r\n" << data)
 
       chunks.length.must_equal 2
 

data/spec/lib/message_bus/connection_manager_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 
@@ -6,7 +8,7 @@ class FakeAsync
 
   def <<(val)
     sleep 0.01 # simulate IO
-    @sent ||= ""
+    @sent ||= +""
     @sent << val
   end
 

data/spec/lib/message_bus/distributed_cache_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'minitest/hooks/default'
 require 'message_bus'

data/spec/lib/message_bus/multi_process_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # coding: utf-8
 
 require_relative '../../../spec_helper'

data/spec/lib/message_bus/timer_thread_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus/timer_thread'
 

data/spec/lib/message_bus_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'message_bus'
 require 'redis'

data/spec/performance/publish.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
 require 'logger'
 require 'benchmark'

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $: << File.dirname(__FILE__)
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'thin'
@@ -5,7 +7,7 @@ require 'lib/fake_async_middleware'
 require 'message_bus'
 
 require 'minitest/autorun'
-require 'minitest/spec'
+require 'minitest/global_expectations'
 
 require_relative "helpers"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack