fabriq 0.1.0

data/spec/lib/fabriq/config_spec.rb

@@ -0,0 +1,92 @@
+require_relative "../../helper"
+require_relative "../../../lib/fabriq/logging"
+require_relative "../../../lib/fabriq/config"
+
+describe Fabriq::Config do
+
+  before do
+    @config = Fabriq::Config
+    @config.plugin_port = @plugin_port = mock('PluginPort')
+  end
+
+  describe "#load" do
+    before do
+      @plugin_port.stubs(:require_plugins)
+      @config.stubs(:require)
+    end
+
+    it "fails if a configuration file cannot be found" do
+      @config.expects(:fail_if_configuration_file_not_found)
+      @config.load
+    end
+
+    it "let Fabrig::PluginPort require all plugins" do
+      @plugin_port.expects(:require_plugins)
+      @config.load
+    end
+
+    it "requires the configuration file" do
+      @config.stubs(:configuration_file_path).returns("/path/to/config.rb")
+      @config.expects(:require).with("/path/to/config.rb")
+      @config.load
+    end
+  end
+
+  describe '#fail_if_configuration_file_not_found' do
+    it "throws a RuntimeError if a configuration file is not locatable" do
+      @config.stubs(:configuration_file_available?).returns(false)
+      -> { @config.fail_if_configuration_file_not_found }.must_raise(RuntimeError)
+    end
+
+    it "does not raise an Error if a config file is available" do
+      @config.stubs(:configuration_file_available?).returns(true)
+      @config.fail_if_configuration_file_not_found
+    end
+  end
+
+  describe '#configuration_file_available?' do
+    it "returns true if #configuration_file_path returns a string" do
+      @config.stubs(:configuration_file_path).returns("/path/to/file")
+      @config.configuration_file_available?.must_equal(true)
+    end
+
+    it "returns false if #configuration_file_path is nil" do
+      @config.stubs(:configuration_file_path).returns(nil)
+      @config.configuration_file_available?.must_equal(false)
+    end
+  end
+
+  describe '#configuration_file_path' do
+    before do
+      File.stubs(:expand_path).returns("/home")  
+    end
+
+    it "returns nil if a config file cannot be found in assumed locations" do
+      File.stubs(:exist?).returns(false)
+      @config.configuration_file_path.must_be_nil
+    end
+
+    it "returns a path if a config file is available in the current execution path (pwd)" do
+      Dir.stubs(:pwd).returns("/path/to")
+      File.stubs(:exist?).with("/home/.fabriq/config.rb")
+      File.expects(:exist?).with("/path/to/config.rb").returns(true)
+      @config.configuration_file_path.must_equal("/path/to/config.rb")
+    end
+
+    it "returns a path if a config file is available in the current home (~/.fabriq)" do
+      File.expects(:exist?).with("/home/.fabriq/config.rb").returns(true)
+      @config.configuration_file_path.must_equal("/home/.fabriq/config.rb")
+    end
+  end
+
+  describe '#register_plugin' do
+    it "sends #register_plugin to the PluginPort passing klass and config block" do
+      config_block = -> {}
+      @plugin_port.expects(:register_plugin).with() do |klass, block|
+        klass.must_equal(self.class)
+        block.must_equal(&config_block)
+      end
+      @config.register_plugin(self.class, &config_block)
+    end
+  end
+end

data/spec/lib/fabriq/logging_spec.rb

@@ -0,0 +1,33 @@
+require_relative "../../helper"
+require_relative "../../../lib/fabriq/logging"
+
+describe Fabriq::Logging do
+
+  before do
+    @config = mock('Config')
+    @logging = Object.new
+    @logging.extend(Fabriq::Logging)
+    @logging.stubs(:config).returns(@config)
+  end
+
+  describe '#info' do
+    it "logs a message using the info severity" do
+      @logging.expects(:send_output).with(:info ,"Test")
+      @logging.info("Test")
+    end
+  end
+
+  describe '#error' do
+    it "logs a message using the error severity" do
+      @logging.expects(:send_output).with(:error ,"Test")
+      @logging.error("Test")
+    end
+  end
+
+  describe '#debug' do
+    it "logs a message using the debug severity" do
+      @logging.expects(:send_output).with(:debug ,"Test")
+      @logging.debug("Test")
+    end
+  end
+end

data/spec/lib/fabriq/plugin_port_spec.rb

@@ -0,0 +1,106 @@
+require_relative "../../helper"
+require_relative "../../../lib/fabriq/logging"
+require_relative "../../../lib/fabriq/plugin_port"
+
+describe Fabriq::PluginPort do
+
+  before do
+    @port = Fabriq::PluginPort
+  end
+
+  describe '#plugin_load_paths' do
+    before do
+      Dir.stubs(:glob)
+      File.stubs(:expand_path).returns("/home")
+    end
+
+    it "returns all plugins in HOME/.fabriq/plugins" do
+      Dir.expects(:glob).with("/home/.fabriq/plugins/*").returns( ["plugin_dir"] )
+      @port.plugin_load_paths.must_include("plugin_dir")
+    end
+
+    it "returns all plugins in current run path/plugins" do
+      Dir.stubs(:pwd).returns("/path/pwd")
+      Dir.expects(:glob).with("/path/pwd/plugins/*").returns( ["plugin_dir"] )
+      @port.plugin_load_paths.must_include("plugin_dir")
+    end
+  end
+
+  describe '#require_plugins' do
+    before do
+      File.stubs(:exist?).returns(true)
+    end
+
+    it "requires all plugins from path" do
+      @port.stubs(:plugin_load_paths).returns(["plugin/path"])
+      @port.expects(:require_plugin_from_path).with("plugin/path")
+      @port.require_plugins
+    end
+
+    it "skips plugin paths that doesn't exist" do
+      File.stubs(:exist?).returns(false)
+      @port.stubs(:plugin_load_paths).returns(["plugin/path"])
+      @port.expects(:require_plugin_from_path).never
+      @port.require_plugins      
+    end
+  end
+
+  describe '#require_plugin_from_path' do
+    before do
+      File.stubs(:exist?).returns(true)
+    end
+
+    it "requires the plugins main file" do
+      @port.expects(:require).with("/plugin/maja_calendar/lib/maja_calendar.rb")
+      @port.require_plugin_from_path("/plugin/maja_calendar")
+    end
+
+    it "logs an error message if the plugin's main file could not be found" do
+      File.stubs(:exist?).returns(false)
+      @port.expects(:error)
+      @port.require_plugin_from_path("/plugin/maja_calendar")      
+    end
+  end
+
+  describe '#register_plugin' do
+    before do
+      @plugin_klass = mock('Plugin Klass')
+      @plugin_instance = mock('Plugin Instance')
+      @plugin_klass.stubs(:init).returns(@plugin_instance)
+      @port.stubs(:invoke_plugin_callback)
+    end
+
+    it "inits the plugin" do
+      @plugin_klass.expects(:init)
+      @port.register_plugin(@plugin_klass)
+    end
+
+    it "appends the initialized plugin to the plugins collection" do
+      @port.register_plugin(@plugin_klass)
+      @port.plugins.must_include(@plugin_instance)
+    end
+
+    it "invokes the plugin configuration, passing the plugins configurator object" do
+      configurator = mock('configurator')
+      config_proc = -> {}
+      @plugin_instance.stubs(:configurator).returns(configurator)
+      config_proc.expects(:call).with(configurator)
+      @port.register_plugin(@plugin_klass, &config_proc)
+    end
+
+    it "sends the 'registered' event to the plugin" do
+      @port.expects(:invoke_plugin_callback).with(@plugin_instance, :registered)
+      @port.register_plugin(@plugin_klass)
+    end
+  end
+
+  describe '#initialize_plugins' do
+    it "sends the 'initialized' event to each registered plugin" do
+      plugin = mock('Plugin')
+      @port.plugins = [ plugin ]
+      @port.expects(:invoke_plugin_callback).with(plugin, :initialized)
+      @port.initialize_plugins
+    end
+  end
+
+end

data/spec/lib/fabriq/skype/message_spec.rb

@@ -0,0 +1,49 @@
+require_relative "../../../helper"
+require_relative "../../../../lib/fabriq/skype/message"
+
+describe Fabriq::Skype::Message do
+
+  before do
+    @room = mock('Room')
+    @message = Fabriq::Skype::Message.new(@room, "Lorem Ipsum")
+    @message.config = @config = mock('Config')
+  end
+
+  describe "#private_session?" do
+    it "returns false" do
+      @room.stubs(:private_session?).returns(false)
+      @message.private_session?.must_equal(false)
+    end
+
+    it "returns true if the room is a private session" do
+      @room.stubs(:private_session?).returns(true)
+      @message.private_session?.must_equal(true)
+    end
+  end
+
+  describe '#direct?' do
+    it "returns false if no Config#skype_name is set" do
+      @config.stubs(:skype_name).returns(nil)
+      @message.direct?.must_equal(false)
+    end
+
+    it "returns false if beginning of message does not contain the configured skype name" do
+      @message.body = "@peter Hallo"
+      @config.stubs(:skype_name).returns("Maja")
+      @message.direct?.must_equal(false)
+    end
+
+    it "returns true if the beginning of the message contains the configured skype name" do
+      @message.body = "@Maja Hallo"
+      @config.stubs(:skype_name).returns("Maja")
+      @message.direct?.must_equal(true)
+    end
+
+    it "returns true if the beginning of the message contains the configured skype name, ignoring case" do
+      @message.body = "@Maja Hallo"
+      @config.stubs(:skype_name).returns("maja")
+      @message.direct?.must_equal(true)
+    end
+  end
+
+end

data/spec/lib/fabriq/skype/room_spec.rb

@@ -0,0 +1,67 @@
+require_relative "../../../helper"
+require_relative "../../../../lib/fabriq/skype/message"
+require_relative "../../../../lib/fabriq/skype/room"
+
+describe Fabriq::Skype::Room do
+
+  before do
+    @adapter = mock('Adapter')
+    @members = []
+    @room = Fabriq::Skype::Room.new(@adapter, "ab-99", @members, "raw")
+  end
+
+  describe '#private_session?' do
+    it "returns true if 2 members are in the room" do
+      @room.members = ["a", "b"]
+      @room.private_session?.must_equal(true)
+    end
+
+    it "returns false if more than 2 members are in the room" do
+      @room.members = ["a", "b", "c"]
+      @room.private_session?.must_equal(false)
+    end
+  end
+
+  describe '#send_message' do
+    before do
+      @adapter.stubs(:enqueue_outgoing_message)
+    end
+
+    it "builds a message from the passed string" do
+      opts = {}
+      @room.expects(:build_message_from_string).with("test", opts)
+      @room.send_message("test", opts)
+    end
+
+    it "enqueues the message in the outgoing channel" do
+      message = mock('Message')
+      @room.stubs(:build_message_from_string).returns(message)
+      @adapter.expects(:enqueue_outgoing_message).with(message)
+      @room.send_message("test")
+    end
+  end
+
+  describe '#build_message_from_string' do
+    it "creates a message object" do
+      @room.build_message_from_string("text").must_be_kind_of(Fabriq::Skype::Message)
+    end
+
+    it "assigns itself as room to the new message" do
+      @room.build_message_from_string("text").room.must_equal(@room)
+    end
+
+    it "assigns the passed body to the new message" do
+      @room.build_message_from_string("text").body.must_equal("text")
+    end
+
+    it "adds @name to the message if opts[to] is passed" do
+      @room.build_message_from_string("text", to: "treas").body.must_match(/@treas:/)
+    end
+
+    it "does not add @name if its a private session" do
+      @room.stubs(:private_session?).returns(true)
+      @room.build_message_from_string("text", to: "treas").body.wont_match(/@treas:/)
+    end
+  end
+
+end

data/spec/lib/fabriq/skype_proxy_spec.rb

@@ -0,0 +1,167 @@
+require_relative "../../helper"
+require_relative "../../../lib/fabriq/skype_proxy"
+
+describe Fabriq::SkypeProxy do
+  before do
+    @adapter = mock('Adapter')
+    @skype_proxy = Fabriq::SkypeProxy.new(@adapter)
+  end
+
+  describe '#initialize' do
+    it "assigns the passed adapter" do
+      @skype_proxy.adapter.must_equal(@adapter)
+    end
+
+    it "initializes the outgoing message collection" do
+      @skype_proxy.outgoing_messages.must_equal([])      
+    end
+  end
+
+  describe '#on_incoming_message' do
+    it "stores the passed block" do
+      proc = -> {}
+      @skype_proxy.on_incoming_message(&proc)
+      @skype_proxy.instance_variable_get(:@incoming_message_callbacks).must_include(proc)
+    end
+  end
+
+  describe '#subscribe_adapter_message_received' do
+    before do
+      @adapter.stubs(:message_received)
+    end
+
+    it "prepares the collection for received messages" do
+      @skype_proxy.subscribe_adapter_message_received
+      @skype_proxy.instance_variable_get(:@received_messages).must_equal([])
+    end
+
+    it "subscribes the #adapter's message_received event" do
+      @adapter.expects(:message_received)
+      @skype_proxy.subscribe_adapter_message_received
+    end
+
+    it "appends messages coming from #adapter#message_received" do
+      message = mock('Message')
+      @adapter.stubs(:message_received).yields(message)
+      @skype_proxy.subscribe_adapter_message_received
+      @skype_proxy.instance_variable_get(:@received_messages).must_include(message)
+    end
+  end
+
+  describe '#start' do
+    before do
+      @skype_proxy.stubs(:subscribe_adapter_message_received)
+      @skype_proxy.stubs(:start_queue_worker_threads)
+    end
+
+    it "hooks into the #adapters message_received callback" do
+      @skype_proxy.expects(:subscribe_adapter_message_received)
+      @skype_proxy.start
+    end
+
+    it "starts the queue worker threads" do
+      @skype_proxy.expects(:start_queue_worker_threads)
+      @skype_proxy.start
+    end
+  end
+
+  describe '#start_queue_worker_threads' do
+    before do
+      @skype_proxy.stubs(:run_in_thread).yields
+      @skype_proxy.stubs(:start_incoming_queue_worker)
+      @skype_proxy.stubs(:start_outgoing_queue_worker)
+    end
+
+    it "invokes #start_incoming_queue_worker in its own thread" do  
+      @skype_proxy.expects(:start_incoming_queue_worker)
+      @skype_proxy.start_queue_worker_threads
+    end
+
+    it "invokes #start_outgoing_queue_worker in its own thread" do
+      @skype_proxy.expects(:start_outgoing_queue_worker)
+      @skype_proxy.start_queue_worker_threads
+    end
+  end
+
+  describe '#start_incoming_queue_worker' do
+    it "instruments a throttled run loop" do
+      @skype_proxy.expects(:run_in_throttled_loop)
+      @skype_proxy.start_incoming_queue_worker
+    end
+
+    it "calls #handle_incoming_messages_synchronized on every run loop round" do
+      @skype_proxy.stubs(:run_in_throttled_loop).yields
+      @skype_proxy.expects(:handle_incoming_messages_synchronized)
+      @skype_proxy.start_incoming_queue_worker
+    end
+  end
+
+  describe '#start_outgoing_queue_worker' do
+    it "instruments a throttled run loop" do
+      @skype_proxy.expects(:run_in_throttled_loop)
+      @skype_proxy.start_outgoing_queue_worker
+    end
+
+    it "calls #handle_outgoing_messages_synchronized on every run loop round" do
+      @skype_proxy.stubs(:run_in_throttled_loop).yields
+      @skype_proxy.expects(:handle_outgoing_messages_synchronized)
+      @skype_proxy.start_outgoing_queue_worker
+    end
+  end
+
+  describe '#handle_incoming_messages_synchronized' do
+    before do
+      @skype_proxy.instance_variable_get(:@incoming_mutex).stubs(:synchronize).yields
+    end
+
+    it "synchronizes processing using a mutex" do
+      @skype_proxy.instance_variable_get(:@incoming_mutex).expects(:synchronize)
+      @skype_proxy.handle_incoming_messages_synchronized
+    end
+
+    it "passes the oldest received message to all subscribed callbacks" do
+      message = mock('Message')
+      @skype_proxy.instance_variable_set(:@received_messages, [message])
+      @skype_proxy.expects(:invoke_incoming_message_subscribers).with(message)
+      @skype_proxy.handle_incoming_messages_synchronized
+    end
+  end
+
+  describe '#handle_outgoing_messages_synchronized' do
+    before do
+      @skype_proxy.instance_variable_get(:@outgoing_mutex).stubs(:synchronize).yields
+    end
+
+    it "synchronizes processing using a mutex" do
+      @skype_proxy.instance_variable_get(:@outgoing_mutex).expects(:synchronize)
+      @skype_proxy.handle_outgoing_messages_synchronized
+    end
+
+    it "sends outgoing messages using the adapter" do
+      message = mock('Message')
+      @adapter.expects(:send_message).with(message)
+      @skype_proxy.instance_variable_set(:@outgoing_messages, [message])
+      @skype_proxy.handle_outgoing_messages_synchronized
+    end    
+  end
+
+  describe '#invoke_incoming_message_subscribers' do
+    before do
+      @message = mock("Message")
+      @callback = -> {}
+      @skype_proxy.instance_variable_set(:@incoming_message_callbacks, [@callback])
+    end
+
+    it "invokes each subscribed callback in its own thread" do
+      @skype_proxy.expects(:run_in_thread)
+      @skype_proxy.invoke_incoming_message_subscribers(@message)      
+    end
+
+    it "invokes each subscribed callback passing the passed message" do
+      @callback.expects(:call).with(@message)
+      @skype_proxy.stubs(:run_in_thread).yields
+      @skype_proxy.invoke_incoming_message_subscribers(@message)
+    end
+  end
+
+end