message_bus 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce14b8278c7817109ad5bbfaa4074aea98c16f48
-  data.tar.gz: 13ebcc84003602fd4472aa962e1c213492856c2f
+  metadata.gz: 80297cfac62f4fc79e8d16a425762576757aab5d
+  data.tar.gz: be8b74aed2b678c858de6a2941f74bcbaad455c2
 SHA512:
-  metadata.gz: 2ed7d150b899fdd94f19696dff09e333ac4ce51cc9b4438c57514cc671f0ac4cb38092cf8a1202d8025e7c3e506a1f7d5869831ab072a5edb6ae94797238a24e
-  data.tar.gz: 5604f489628fb9885bec1c2dc5eac3cb209e077dcbc6677745a8c3a4a8dd43955692272675fc807e29f309dec88edb52689df98cbb7dd60774a213cd16db1d78
+  metadata.gz: 32fafd6d57c0176cc356724246909d430753428b375449b8c12a181dd8b2f50ab51404a6fd0c02a089cc7fbe2bf90e6071df6b5a24324fa0b0430e3c6f163460
+  data.tar.gz: e977e8bc61bdd4c74be64fe755ad413e036ae96fc149ccb26cbae05fb1bca53dcb45cf82b0ea6ae5e77e13ee3e3fc7a87a5068d6cbe98e5994f440c9668e43ca

data/CHANGELOG

@@ -1,3 +1,14 @@
+25-08-2016
+
+- Version 2.0.2
+- Feature: Add on_middleware_error callback for remapping middleware errors to HTTP results
+
+
+25-07-2016
+
+- Feature: Add JavaScript MessageBus.status() function
+
+
 21-06-2016
 
 - Version 2.0.1

data/README.md

@@ -83,6 +83,12 @@ MessageBus.configure(group_ids_lookup: proc do |env|
   # can be nil or []
 end)
 
+MessageBus.configure(on_middleware_error: proc do |env, e|
+   # If you wish to add special handling based on error
+   # return a rack result array: [status, headers, body]
+   # If you just want to pass it on return nil
+end)
+
 # example of message bus to set user_ids from an initializer in Rails and Devise:
 # config/inializers/message_bus.rb
 MessageBus.user_id_lookup do |env|
@@ -212,7 +218,9 @@ headers|{}|Extra headers to be include with request.  Properties and values of o
 
 `MessageBus.start()` : Must be called to startup the MessageBus poller
 
-`MessageBus.subscribe(channel,func,lastId)` : Subscribe to a channel, optionally you may specify the id of the last message you received in the channel.
+`MessageBus.status()` : Return status (started, paused, stopped)
+
+`MessageBus.subscribe(channel,func,lastId)` : Subscribe to a channel, optionally you may specify the id of the last message you received in the channel. The callback accepts three arguments: `func(payload, globalId, messageId)`. You may save globalId or messageId of received messages and use then at a later time when client needs to subscribe, receiving the backlog just after that Id.
 
 `MessageBus.unsubscribe(channel,func)` : Unsubscribe callback from a particular channel
 
@@ -299,7 +307,7 @@ For more information see [Passenger documentation](https://www.phusionpassenger.
 #### Puma
 ```ruby
 # path/to/your/config/puma.rb
-require 'message_bus'
+require 'message_bus' # omit this line for Rails 5
 on_worker_boot do
   MessageBus.after_fork
 end

data/assets/message-bus.js

@@ -73,7 +73,7 @@
         if (callback.channel === message.channel) {
           callback.last_id = message.message_id;
           try {
-            callback.func(message.data);
+            callback.func(message.data, message.global_id, message.message_id);
           }
           catch(e){
             if(console.log) {
@@ -352,6 +352,18 @@
       poll();
     },
 
+    "status": function() {
+      if (paused) {
+         return "paused";
+      } else if (started) {
+         return "started";
+      } else if (stopped) {
+        return "stopped";
+      } else {
+        throw "Cannot determine current status";
+      }
+    },
+
     // Subscribe to a channel
     subscribe: function(channel, func, lastId) {
 

data/lib/message_bus.rb

@@ -154,6 +154,11 @@ module MessageBus::Implementation
     @config[:is_admin_lookup]
   end
 
+  def on_middleware_error(&blk)
+    configure(on_middleware_error: blk) if blk
+    @config[:on_middleware_error]
+  end
+
   def extra_response_headers_lookup(&blk)
     configure(extra_response_headers_lookup: blk) if blk
     @config[:extra_response_headers_lookup]

data/lib/message_bus/rack/middleware.rb

@@ -181,6 +181,13 @@ class MessageBus::Rack::Middleware
     else
       [200, headers, ["[]"]]
     end
+
+  rescue => e
+    if @bus.on_middleware_error && result=@bus.on_middleware_error.call(env, e)
+      result
+    else
+      raise
+    end
   end
 
   def close_db_connection!

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/spec/assets/message-bus.spec.js

@@ -20,6 +20,16 @@ describe("Messagebus", function() {
     });
   });
 
+  it('returns status', function(done){
+    MessageBus.pause();
+    expect(MessageBus.status()).toMatch("paused");
+    MessageBus.resume();
+    expect(MessageBus.status()).toMatch("started");
+    MessageBus.stop();
+    expect(MessageBus.status()).toMatch("stopped");
+    done();
+  });
+
   it('stores messages when paused, then delivers them when resumed', function(done){
     MessageBus.pause()
     spyOn(this.MockedXMLHttpRequest.prototype, 'send').and.callThrough();

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

@@ -309,6 +309,28 @@ describe MessageBus::Rack::Middleware do
       JSON.parse(last_response.body).first["data"].must_equal({'json' => true})
     end
 
+    describe "on_middleware_error handling" do
+      it "allows error handling of middleware failures" do
+
+        @bus.on_middleware_error do |env, err|
+          if ArgumentError === err
+            [407,{},[]]
+          end
+        end
+
+        @bus.group_ids_lookup do |env|
+          raise ArgumentError
+        end
+
+        post( "/message-bus/1234",
+            JSON.generate({'/foo' => 1}),
+            { "CONTENT_TYPE" => "application/json" })
+
+        last_response.status.must_equal 407
+
+      end
+    end
+
     describe "messagebus.channels env support" do
       let(:extra_middleware) do
         Class.new do

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

@@ -73,7 +73,7 @@
         if (callback.channel === message.channel) {
           callback.last_id = message.message_id;
           try {
-            callback.func(message.data);
+            callback.func(message.data, message.global_id, message.message_id);
           }
           catch(e){
             if(console.log) {
@@ -352,6 +352,18 @@
       poll();
     },
 
+    "status": function() {
+      if (paused) {
+         return "paused";
+      } else if (started) {
+         return "started";
+      } else if (stopped) {
+        return "stopped";
+      } else {
+        throw "Cannot determine current status";
+      }
+    },
+
     // Subscribe to a channel
     subscribe: function(channel, func, lastId) {
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack