render_sync 0.5.0

data/test/sync/channel_test.rb

@@ -0,0 +1,15 @@
+require_relative '../test_helper'
+
+describe RenderSync::Channel do
+  include TestHelper
+
+  describe '#signature' do
+    before do
+      @channel = RenderSync::Channel.new("testing")
+    end
+
+    it "Creates uniqe HMAC signature" do
+      assert_equal 40, @channel.signature.length
+    end
+  end
+end

data/test/sync/config_test.rb

@@ -0,0 +1,25 @@
+require_relative '../test_helper'
+
+describe RenderSync.config do
+  before do
+    RenderSync.load_config(
+      File.expand_path("../../fixtures/sync_erb.yml", __FILE__),
+      "test"
+    )
+  end
+
+  describe "#load_config" do
+    it "Evaluates ERB from the config file" do
+      assert_equal("erb secret", RenderSync.config[:auth_token])
+    end
+
+    it "raises an exception if auth_token is missing" do
+      assert_raises ArgumentError do
+        RenderSync.load_config(
+          File.expand_path("../../fixtures/sync_auth_token_missing.yml", __FILE__),
+          "test"
+        )
+      end
+    end
+  end
+end

data/test/sync/erb_tracker_test.rb

@@ -0,0 +1,72 @@
+require_relative '../test_helper'
+require 'rails/all'
+require 'active_support/core_ext/array/access'
+require 'render_sync/erb_tracker'
+
+describe RenderSync::ERBTracker do
+  Template = Struct.new(:source)
+  it 'tracks collection partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync partial: 'item', collection: something.things %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks collection instance variable partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync partial: 'item', collection: @something.things %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks resource partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync partial: 'item', resource: thing %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks sync_new partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync_new partial: 'item', resource: thing %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks multiple sync partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync partial: 'item', resource: thing %>
+      <%= sync partial: 'other_item', resource: rock %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item', 'sync/rocks/other_item'], dependencies
+  end
+
+  it 'tracks resource instance variable partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= sync partial: 'item', resource: @thing %>
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks haml resource partials' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      =sync partial: 'item', resource: thing
+    TEMPLATE
+
+    assert_equal ['sync/things/item'], dependencies
+  end
+
+  it 'tracks regular renders too' do
+    dependencies = RenderSync::ERBTracker.call "name", Template.new(<<-TEMPLATE)
+      <%= render partial: 'things/item', collection: things %>
+    TEMPLATE
+
+    assert_equal ['things/item'], dependencies
+  end
+end

data/test/sync/faye_extension_test.rb

@@ -0,0 +1,87 @@
+require_relative '../test_helper'
+
+describe RenderSync::FayeExtension do
+  include TestHelper
+
+  before do
+    @server = RenderSync::FayeExtension.new
+    @message = {
+      "channel" => "/channel",
+      "message" => "HTML",
+      "ext" => {"auth_token" => "secret"}
+    }
+    @unauthed_message = {
+      "channel" => "/channel",
+      "message" => "HTML",
+      "ext" => {"auth_token" => "WRONG"} 
+    }
+    @batched_message = {
+      "data" => [{
+        "channel" => "/channel",
+        "message" => "HTML",
+        "ext" => {"auth_token" => "secret"}
+      },
+      {
+        "channel" => "/channel",
+        "message" => "HTML",
+        "ext" => {"auth_token" => "secret"}
+      }]
+    }
+  end
+
+  describe 'incoming messages' do
+    describe 'message authentication' do
+      describe 'with valid auth_token' do
+        it 'should be valid' do
+          assert @server.message_authenticated?(@message)
+        end
+      end
+
+      describe 'with invalid auth_token' do
+        it 'should be invalid' do
+          refute @server.message_authenticated?(@unauthed_message)
+        end
+
+        it 'should add error to message before callback' do
+          assert @server.incoming(@unauthed_message, Proc.new{|msg| msg["error"]})
+        end
+      end
+    end
+  end
+
+  describe 'outgoing messages' do
+    it 'should strip out message auth_token to prevent auth_token leak' do
+      assert_equal nil, @server.outgoing(
+        {"ext" => {"auth_token" => "secret"}}, 
+        Proc.new{|message| message["ext"]["auth_token"] }
+      )
+    end
+  end
+
+  describe 'batch_incoming' do
+    it 'proccesses all batched messages as single message' do
+      assert @server.batch_incoming(@batched_message, Proc.new{})
+    end
+  end
+
+  describe 'single_incoming(message, callback)' do
+  end
+
+  describe 'batch_publish?' do
+    describe 'with batched messages' do
+      it 'should be true' do
+        assert @server.batch_publish?({
+          'channel' => '/batch_publish'
+        })
+      end
+    end
+
+    describe 'with single message' do
+      it 'should be false' do
+        refute @server.batch_publish?({
+          'channel' => '/some-channel'
+        })
+      end
+    end
+  end
+end

data/test/sync/message_test.rb

@@ -0,0 +1,159 @@
+require_relative '../test_helper'
+require 'mocha/setup'
+
+
+describe "Faye" do
+  include TestHelperFaye
+
+  before do
+    @message = RenderSync.client.build_message("/my-channel", html: "<p>Some Data</p>")
+  end
+
+  describe "normalize_channel" do
+    it 'converts channel to faye server friendly format with leading forward-slash' do
+      assert_equal "/", RenderSync.client.normalize_channel("alfjalkjfkfjaslkfj2342424")[0]
+    end
+  end
+
+  describe '#to_hash' do
+    before do
+      @message_hash = @message.to_hash
+    end
+
+    it "Converts message to hash for Faye publish" do
+      assert @message_hash.keys.include?(:channel)
+      assert @message_hash.keys.include?(:data)
+      assert @message_hash.keys.include?(:ext)
+    end
+
+    it "Includes auth_token for Faye password security" do
+      assert @message_hash[:ext][:auth_token]
+    end
+  end
+
+  describe '#to_json' do
+    it "Converts message to json for Faye publish" do
+      assert @message.to_json
+    end
+  end
+
+  describe "asynchronous publishing" do
+    include EM::MiniTest::Spec
+
+    before do 
+      RenderSync.stubs(:async?).returns true
+    end
+  
+    describe "batched message publishing" do
+      before do
+        @messages = 10.times.collect{|i| RenderSync.client.build_message("/ch#{i}", {html: ""})}
+      end
+
+      it 'should publish array of messages with single post to faye' do
+        EM.expects(:next_tick).once.returns true
+        assert RenderSync.client.batch_publish(@messages)
+      end
+    end
+
+    describe '#publish' do
+      it 'Publishes a message to Faye' do
+        RenderSync.reactor.expects(:perform).once
+        @message.publish
+      end
+    end
+  end
+
+  describe "synchronous publishing" do
+    before do 
+      Net::HTTP.stubs(:post_form).returns true
+      RenderSync.stubs(:async?).returns false
+    end
+
+    describe "batched message publishing" do
+      before do
+        @messages = 10.times.collect{|i| RenderSync.client.build_message("/ch#{i}", {html: ""})}
+      end
+
+      it 'should publish array of messages with single post to faye' do
+        assert RenderSync.client.batch_publish(@messages)
+      end
+    end
+    describe '#publish' do
+      it 'Publishes a message to Faye' do
+        assert @message.publish
+      end
+    end
+  end
+end
+
+
+
+
+
+describe "Pusher" do
+  include TestHelperPusher
+
+  before do
+    @message = RenderSync.client.build_message("/my-channel", html: "<p>Some Data</p>")
+  end
+
+  describe "normalize_channel" do
+    it 'converts channel to pusher server friendly format without leading forward-slash' do
+      refute RenderSync.client.normalize_channel("alfjalkjfkfjaslkfj2342424")[0] == "/"
+    end
+  end
+
+  describe '#to_json' do
+    it "Converts message to json for Faye publish" do
+      assert @message.to_json
+    end
+  end
+
+  describe "asynchronous publishing" do
+    include EM::MiniTest::Spec
+
+    before do 
+      RenderSync.stubs(:async?).returns true
+    end
+  
+    describe "batched message publishing" do
+      before do
+        @messages = 10.times.collect{|i| RenderSync.client.build_message("/ch#{i}", {html: ""})}
+      end
+
+      it 'should publish array of messages with single post to faye' do
+        assert RenderSync.client.batch_publish(@messages)
+      end
+    end
+
+    describe '#publish' do
+      it 'Publishes a message to Pusher' do
+        RenderSync.reactor.expects(:perform).once
+        @message.publish
+      end
+    end
+  end
+
+  describe "synchronous publishing" do
+    before do 
+      Pusher.stubs(:trigger).returns(true)
+      RenderSync.stubs(:async?).returns false
+    end
+
+    describe "batched message publishing" do
+      before do
+        @messages = 10.times.collect{|i| RenderSync.client.build_message("/ch#{i}", {html: ""})}
+      end
+
+      it 'should publish array of messages with single post to faye' do
+        assert RenderSync.client.batch_publish(@messages)
+      end
+    end
+    describe '#publish' do
+      it 'Publishes a message to Pusher' do
+        assert @message.publish
+      end
+    end
+  end
+end
+

data/test/sync/model_test.rb

@@ -0,0 +1,315 @@
+require_relative '../test_helper'
+require 'mocha/setup'
+require 'rails/all'
+
+setup_database
+
+describe RenderSync::Model do
+
+  it 'can is disabled by default' do
+    refute RenderSync::Model.enabled?
+  end
+
+  it 'can be enabled and disabled' do
+    RenderSync::Model.enable!
+    assert RenderSync::Model.enabled?
+
+    RenderSync::Model.disable!
+    refute RenderSync::Model.enabled?
+  end
+
+  it 'can be given a block to have things enabled in' do
+    RenderSync::Model.enable do
+      assert RenderSync::Model.enabled?
+    end
+
+    refute RenderSync::Model.enabled?
+  end
+
+  describe 'syncing of model changes to all listening channels' do
+    it 'publishes record (create/update/destroy) to main new channel' do
+      RenderSync::Model.enable do
+        user = UserWithoutScopes.new
+
+        # Create
+        user.save!
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/user_without_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Update
+        user.update_attributes!(name: "Foo")
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_without_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Destroy
+        user.destroy
+        assert user.destroyed?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :destroy, user.sync_actions[0].name
+        assert_equal "/user_without_scopes/#{user.id}", user.sync_actions[0].test_path
+      end
+    end
+
+    it 'publishes record with default scope to scope channel and parent channel' do
+      RenderSync::Model.enable do
+
+        # Create
+        group = Group.create!
+        user = UserWithDefaultScope.new(group: group)
+        user.save!
+
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/groups/#{group.id}/user_with_default_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Update
+        user.update_attributes!(name: "Foo")
+
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_with_default_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Destroy
+        user.destroy
+
+        assert user.destroyed?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :destroy, user.sync_actions[0].name
+        assert_equal "/groups/#{group.id}/user_with_default_scopes/#{user.id}", user.sync_actions[0].test_path
+
+      end
+    end
+
+    it 'publishes record with simple named sync scope' do
+      RenderSync::Model.enable do
+
+        # Create user not in scope 'old' (age > 90)
+        user = UserWithSimpleScope.create!(age: 85)
+
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Create user in scope 'old' (age >= 90)
+        user = UserWithSimpleScope.new(age: 95)
+        user.save!
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :new, user.sync_actions[1].name
+        assert_equal "/old/user_with_simple_scopes/#{user.id}", user.sync_actions[1].test_path
+
+        # Update of independent attribute name (user still in scope 'old')
+        user.update_attributes!(name: "Foo")
+        assert !user.changed?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Update of dependent attribute age, so that the user no longer falls into scope 'old'
+        # and has to be destroyed on the scoped channel
+        user.update_attributes!(age: 80)
+        assert !user.changed?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :destroy, user.sync_actions[1].name
+        assert_equal "/old/user_with_simple_scopes/#{user.id}", user.sync_actions[1].test_path
+
+        # Update of dependent attribute age, so that the record will fall into scope 'old'
+        # and has to be published as new on that scoped channel
+        user.update_attributes(age: 100)
+
+        assert !user.changed?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :new, user.sync_actions[1].name
+        assert_equal "/old/user_with_simple_scopes/#{user.id}", user.sync_actions[1].test_path
+
+        # Destroy user currently in scoped by 'old'
+        user.destroy
+
+        assert user.destroyed?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :destroy, user.sync_actions[0].name
+        assert_equal "/user_with_simple_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :destroy, user.sync_actions[1].name
+        assert_equal "/old/user_with_simple_scopes/#{user.id}", user.sync_actions[1].test_path
+
+      end
+    end
+
+    it 'publishes record with a named sync scope that takes arguments' do
+      RenderSync::Model.enable do
+
+        # Create user not in scope 'in_group'
+        group1 = Group.create
+        group2 = Group.create
+        user = UserWithAdvancedScope.create!
+
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/user_with_advanced_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        # Create user in scope 'in_group'
+        user = UserWithAdvancedScope.create!(group: group1)
+
+        assert user.persisted?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :new, user.sync_actions[0].name
+        assert_equal "/user_with_advanced_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :new, user.sync_actions[1].name
+        assert_equal "/in_group/group/#{group1.id}/user_with_advanced_scopes/#{user.id}", user.sync_actions[1].test_path
+
+        # Change group
+        user.update_attributes(group: group2)
+
+        assert user.persisted?
+        assert_equal 3, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/user_with_advanced_scopes/#{user.id}", user.sync_actions[0].test_path
+
+        assert_equal :destroy, user.sync_actions[1].name
+        assert_equal "/in_group/group/#{group1.id}/user_with_advanced_scopes/#{user.id}", user.sync_actions[1].test_path
+
+        assert_equal :new, user.sync_actions[2].name
+        assert_equal "/in_group/group/#{group2.id}/user_with_advanced_scopes/#{user.id}", user.sync_actions[2].test_path
+
+      end
+    end
+
+  end
+
+  describe "touching associated records explicitly" do
+    it 'unsyncd user touches single association if configured' do
+      RenderSync::Model.enable do
+        group1 = Group.create
+        group2 = Group.create
+        user = UserJustTouchingGroup.create!(group: group1)
+
+        assert user.persisted?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/groups/#{group1.id}", user.sync_actions[0].test_path
+
+        user.group = group2
+        user.save!
+
+        assert !user.changed?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/groups/#{group2.id}", user.sync_actions[0].test_path
+
+        assert_equal :update, user.sync_actions[1].name
+        assert_equal "/groups/#{group1.id}", user.sync_actions[1].test_path
+
+        user.group = nil
+        user.save!
+
+        assert !user.changed?
+        assert_equal 1, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[0].name
+        assert_equal "/groups/#{group2.id}", user.sync_actions[0].test_path
+      end
+    end
+
+    it 'syncd user touches single association if configured' do
+      RenderSync::Model.enable do
+        group1 = Group.create
+        group2 = Group.create
+        user = UserTouchingGroup.create!(group: group1)
+
+        assert user.persisted?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[1].name
+        assert_equal "/groups/#{group1.id}", user.sync_actions[1].test_path
+
+        user.group = group2
+        user.save!
+
+        assert !user.changed?
+        assert_equal 3, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[1].name
+        assert_equal "/groups/#{group2.id}", user.sync_actions[1].test_path
+
+        assert_equal :update, user.sync_actions[2].name
+        assert_equal "/groups/#{group1.id}", user.sync_actions[2].test_path
+
+        user.group = nil
+        user.save!
+
+        assert !user.changed?
+        assert_equal 2, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[1].name
+        assert_equal "/groups/#{group2.id}", user.sync_actions[1].test_path
+      end
+    end
+
+    it 'touches multiple associations if configured' do
+      RenderSync::Model.enable do
+        group = Group.create
+        project = Project.create
+        user = UserTouchingGroupAndProject.create!(group: group, project: project)
+
+        assert user.persisted?
+        assert_equal 3, user.sync_actions.size
+
+        assert_equal :update, user.sync_actions[1].name
+        assert_equal "/groups/#{group.id}", user.sync_actions[1].test_path
+
+        assert_equal :update, user.sync_actions[2].name
+        assert_equal "/projects/#{project.id}", user.sync_actions[2].test_path
+
+      end
+    end
+  end
+
+
+  it 'does not have a sync default scope if it is not specified' do
+    user = User.new name: "Foo"
+    assert user.sync_default_scope.nil?
+  end
+
+  it 'does not sync if sync is not enabled' do
+    user = UserWithSimpleScope.new name: "Foo"
+    user.stubs(:publish_actions)
+
+    user.expects(:publish_actions).never
+    user.save!
+  end
+
+end