foreign_office 0.16.2 → 0.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c6e3c9ceacb6bf37e6a7c2b590b0f3057d1851f
-  data.tar.gz: 9b291b3e4b58496af545267d1b03b156ac69f232
+  metadata.gz: 9dcd8f2b90d4074f1ca898d3c1e15119e2524dd1
+  data.tar.gz: 7cc327155c63a6b0a081e9a43e596a56bad97feb
 SHA512:
-  metadata.gz: 1160326d1a4c1e3d9c7ac7535992c307590d3fb13962ac0c83075351a02adb579813001786f07f88274f2d29bce9fb3cd11737f8791cbe4fdb90e5024b6eb084
-  data.tar.gz: 5de38982be1a33749ea591b941d2f778214a23f2c9a1fec99bb043bec8a7a1f641b517b0fda98f5a7572e72797ed633a86d4bd07d1fe2715f6f97a9840f647c6
+  metadata.gz: 79fb12070d6bf97c9c6d2fa31531790459e1cc8ac79d00762da6706b4786edf146e6cfcc3d0ffc60d96c2eb5be1020b9ed9d521930423b1864a0a30e88ecca9a
+  data.tar.gz: 3d197949fcfd7ae17cd27a605364f48a0d63325d881651140a5ce91ccfd1b8f67a2ae6487d281ebb39d9f19d60352f499a0756a866492ef0daf76e4e05ac6609

data/lib/foreign_office/busses/pubnub_bus.rb

@@ -40,9 +40,14 @@ class ForeignOffice::Busses::PubnubBus < ForeignOffice::Busses::GenericBus
   end
 
   def self.publish(message)
-    message.symbolize_keys!
+    channel = message[:channel]
+
+    if browser_tab_id = message[:browser_tab_id]
+      channel += "@#{browser_tab_id}" 
+    end
+
     self.connection.publish(
-      channel:  message[:channel],
+      channel:  channel,
       message:  message,
       http_sync: true
     ) do |envelope|

data/lib/foreign_office/busses/pusher_bus.rb

@@ -35,6 +35,11 @@ class ForeignOffice::Busses::PusherBus < ForeignOffice::Busses::GenericBus
   def self.publish(message)
     message.symbolize_keys!
     channel = sanitize_channel(message[:channel])
+    
+    if browser_tab_id = message[:browser_tab_id]
+      channel += "@#{browser_tab_id}"
+    end
+
     self.connection.trigger(
       channel,
       'publish',

data/lib/foreign_office/foreign_office_helper.rb

@@ -2,8 +2,10 @@ module ForeignOffice
   module ForeignOfficeHelper
     def listener_attrs(resource, key, reveal_hide: false, endpoint: nil, download: nil,
       trigger: nil, delete: nil, href_target: nil, create_modal: nil, mask_me: nil,
-      exclude_value: nil)
-      data_attrs = "data-listener=true data-channel=#{resource.class.name}#{resource.id}"
+      exclude_value: nil, browser_tab_id: nil )
+      channel = "#{resource.class.name}#{resource.id}"
+      channel += "@#{browser_tab_id}" if browser_tab_id
+      data_attrs = "data-listener=true data-channel=#{channel}"
       if delete
         data_attrs += " data-delete-key=#{key}"
       else
@@ -27,7 +29,8 @@ module ForeignOffice
 
     def listener_attrs_raw(channel, key, reveal_hide: false, endpoint: nil, download: nil,
       trigger: nil, delete: nil, href_target: nil, create_modal: nil, mask_me: nil,
-      exclude_value: nil)
+      exclude_value: nil, browser_tab_id: nil)
+      channel += "@#{browser_tab_id}" if browser_tab_id
       data_attrs = "data-listener=true data-channel=#{channel}"
       if delete
         data_attrs += " data-delete-key=#{key}"
@@ -47,8 +50,10 @@ module ForeignOffice
 
     def listener_hash(resource, key, reveal_hide: false, endpoint: nil, download: nil,
       trigger: nil, delete: nil, href_target: nil, create_modal: nil, mask_me: nil,
-      exclude_value: nil)
-      hash = {listener: true, channel: resource.class.name + resource.id.to_s}
+      exclude_value: nil, browser_tab_id: nil)
+      channel = resource.class.name + resource.id
+      channel += "@#{browser_tab_id}" if browser_tab_id
+      hash = {listener: true, channel: channel}
       if delete
         hash[:delete_key] = key
       else
@@ -67,7 +72,8 @@ module ForeignOffice
 
     def listener_hash_raw(channel, key, reveal_hide: false, endpoint: nil, download: nil,
       trigger: nil, delete: nil, href_target: nil, create_modal: nil, mask_me: nil,
-      exclude_value: nil)
+      exclude_value: nil, browser_tab_id: nil)
+      channel += "@#{browser_tab_id}" if browser_tab_id
       hash = {listener: true, channel: channel}
       if delete
         hash[:delete_key] = key

data/lib/foreign_office/version.rb

@@ -1,3 +1,3 @@
 module ForeignOffice
-  VERSION = "0.16.2"
+  VERSION = "0.16.3"
 end

data/test/foreign_office_test.rb

@@ -2,12 +2,10 @@ require 'test_helper'
 
 class ForeignOfficeTest < MiniTest::Unit::TestCase
   describe "ForeignOffice" do
-    before do
-      @bus = Minitest::Mock.new
-      ForeignOffice.bus = @bus
-    end
     describe "caches messages when asked" do
       before do
+        @bus = Minitest::Mock.new
+        ForeignOffice.bus = @bus
         ForeignOffice.cache_messages
       end
       it "caches multiple messages" do
@@ -30,6 +28,10 @@ class ForeignOfficeTest < MiniTest::Unit::TestCase
       end
     end
     describe "doesn't have to cache" do
+      before do
+        @bus = Minitest::Mock.new
+        ForeignOffice.bus = @bus
+      end
       it "publishes messages directly when not caching" do
         ForeignOffice.publish_directly
         @bus.expect :publish, nil, [{channel: 'TestMe', object: {this: 'is a test'}}]
@@ -38,6 +40,10 @@ class ForeignOfficeTest < MiniTest::Unit::TestCase
       end
     end
     describe "offers custom publishing" do
+      before do
+        @bus = Minitest::Mock.new
+        ForeignOffice.bus = @bus
+      end
       it "publishes with a custom method if provided" do
         ForeignOffice.publish_directly
         @bus.expect :custom_publish, nil, [{channel: 'TestMe', object: {this: 'is a test'}}]
@@ -47,5 +53,58 @@ class ForeignOfficeTest < MiniTest::Unit::TestCase
         ForeignOffice.unset_publish_method
       end
     end
+    describe "passing browser tab id to pusher" do
+      before do
+        ForeignOffice.unset_publish_method
+        ForeignOffice.publish_directly
+      end
+
+      it "publishes with browser id appended" do
+        ForeignOffice.config({bus: {klass: ForeignOffice::Busses::PusherBus}})
+        resp = ForeignOffice.publish({channel: "TestMe", object: {this: 'is a test'}, browser_tab_id: 'tab-id-123'})
+        resp[:channel].must_equal("TestMe@tab-id-123")
+      end
+
+      it "published without browser id appended" do
+        ForeignOffice.config({bus: {klass: ForeignOffice::Busses::PusherBus}})
+        resp = ForeignOffice.publish({channel: "TestMe", object: {this: 'is a test'}})
+        resp[:channel].must_equal("TestMe")
+      end
+    end
+    describe "passing browser tab id to pubnub" do
+      before do
+        ForeignOffice.unset_publish_method
+        ForeignOffice.publish_directly
+      end
+
+      it "published with browser id appended" do
+        ForeignOffice.config(
+          {
+            bus: {
+              klass: ForeignOffice::Busses::PubnubBus, 
+              publish_key: "1234", 
+              subscribe_key: '5678', 
+              secret_key: '91011'
+            }
+          }
+        )
+        resp = ForeignOffice.publish({channel: "TestMe", object: {this: 'is a test'}, browser_tab_id: 'tab-id-123'})
+        resp[:channel].must_equal "TestMe@tab-id-123"
+      end
+      it "published without browser id appended" do
+        ForeignOffice.config(
+          {
+            bus: {
+              klass: ForeignOffice::Busses::PubnubBus, 
+              publish_key: "1234", 
+              subscribe_key: '5678', 
+              secret_key: '91011'
+            }
+          }
+        )
+        resp = ForeignOffice.publish({channel: "TestMe", object: {this: 'is a test'}})
+        resp[:channel].must_equal "TestMe"
+      end
+    end
   end
 end

data/test/support/pubnub.rb

@@ -0,0 +1,15 @@
+class Pubnub
+  def initialize(hash)
+    @publish_key   = hash[:publish_key]
+    @subscribe_key = hash[:subscribe_key]
+    @secret_key    = hash[:secret_key]
+    @ssl           = true
+  end
+
+  def publish(message)
+    return {
+      channel: message[:channel],
+      message: message[:message]
+    }
+  end
+end

data/test/support/pusher.rb

@@ -0,0 +1,17 @@
+class Pusher
+  def self.encrypted=(bool)
+    @encrypt = bool
+  end
+
+  def self.encrypted
+    @encrypt
+  end
+
+  def self.trigger(channel, command, message)
+    return {
+      channel: channel,
+      command: command,
+      message: message,
+    }
+  end
+end

data/test/test_helper.rb

@@ -12,6 +12,7 @@ Rails.backtrace_cleaner.remove_silencers!
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
+Dir[Rails.root.join("test/support/*.rb")].each {|f| require f}
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreign_office
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.16.3
 platform: ruby
 authors:
 - Eric Draut
@@ -136,6 +136,8 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/foreign_office_test.rb
+- test/support/pubnub.rb
+- test/support/pusher.rb
 - test/test_helper.rb
 homepage: http://edraut.github.io/foreign-office
 licenses:
@@ -200,4 +202,6 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/foreign_office_test.rb
+- test/support/pubnub.rb
+- test/support/pusher.rb
 - test/test_helper.rb