bitlbee_config 1.0.0

data/lib/bitlbee_config/user.rb

@@ -0,0 +1,115 @@
+module BitlbeeConfig
+  # A BitlBee user account - has channels for control / chat, and accounts with various IM services
+  class User
+    include BitlbeeConfig::XmlBuildable
+
+    attr_accessor :nick, :password, :cleartext_password, :version, :settings, :accounts, :channels
+
+    class << self
+      # Rubocop thinks this method is too long, but I think it's more readable than split up
+      # rubocop:disable MethodLength
+      #
+      # @param [Nokogiri::XML::Element] xml XML element to create user from
+      # @return [BitlbeeConfig::User] The newly created user
+      def from_xml(xml)
+        new_user = {}
+
+        %w(nick password version).each do |att|
+          new_user[att.to_sym] = xml.attributes[att].value
+        end
+
+        xml.xpath("setting").each do |setting|
+          new_user[setting.attributes["name"].value] = setting.text
+        end
+
+        new_user[:channels] = xml.xpath("channel").collect do |item|
+          BitlbeeConfig::Channel.from_xml(item)
+        end
+
+        new_user[:accounts] = xml.xpath("account").collect do |item|
+          BitlbeeConfig::Account.from_xml(item)
+        end
+
+        user = BitlbeeConfig::User.new(new_user)
+
+        user.accounts.each do |account|
+          account.user = user
+        end
+
+        user
+      end
+      # rubocop:enable MethodLength
+
+      # XML configuration files are currently saved with the downcased username and an xml extension
+      #
+      # @param [String] username Username to turn into file name
+      # @return [String] The file name of the this user's configuration file
+      def username_to_filename(username)
+        "#{ username.downcase }.xml"
+      end
+    end
+
+    # @param [Hash] options
+    # @option options [String] :nick Nickname for the user, as it appears in the IRC channel
+    # @option options [String] :password The hashed password of the user, as it appears in the XML document
+    # @option options [String] :cleartext_password Cleartext password for the user, will be hashed before saving to XML
+    # @option options [String] :version I have no idea what this does
+    # @option options [Array<BitlbeeConfig::Channel>] :channels Channels for this user
+    # @option options [Array<BitlbeeConfig::Account|BitlbeeConfig::Accounts::Icq>] :accounts IM accounts for this user
+    # @option options [String] All other entries will be converted to settings
+    def initialize(options = {})
+      @nick = options.delete(:nick)
+      @password = options.delete(:password)
+      @cleartext_password = options.delete(:cleartext_password)
+      @version = options.delete(:version) || "1"
+      @channels = options.delete(:channels) || []
+      @accounts = options.delete(:accounts) || []
+
+      @settings = options || {}
+    end
+
+    # Add an account. If an account with the same id already exists, it will be replaced
+    #
+    # @param [BitlbeeConfig::Account|BitlbeeConfig::Accounts::Icq] new_account Account to be added
+    def add_or_replace_account(new_account)
+      @accounts.reject! { |account| account.id == new_account.id }
+
+      new_account.user = self
+      @accounts << new_account
+    end
+
+    # Remove an account by its id
+    #
+    # @param [String] id_to_remove The account with this ID will be removed
+    def remove_account_by_id(id_to_remove)
+      @accounts.reject! { |account| account.id == id_to_remove }
+    end
+
+    # Remove an account
+    #
+    # @param [BitlbeeConfig::Account|BitlbeeConfig::Accounts::Icq] account_to_remove Account to remove
+    def remove_account(account_to_remove)
+      remove_account_by_id(account_to_remove.id)
+    end
+
+    # If a cleartext password is given, hash it and set password attribute
+    def regenerate_password_if_needed
+      @password = @cleartext_password.to_bitlbee_password_hash if @cleartext_password
+    end
+
+    # @param [Nokogiri::XML::Builder] xml_builder All XML will be added to this builder
+    def build_xml(xml_builder)
+      regenerate_password_if_needed
+
+      to_xml_with_options(xml_builder, nick: @nick, password: @password, version: @version) do |user_xml|
+        @accounts.each do |account|
+          account.build_xml(user_xml)
+        end
+
+        @channels.each do |channel|
+          channel.build_xml(user_xml)
+        end
+      end
+    end
+  end
+end

data/lib/bitlbee_config/version.rb

@@ -0,0 +1,3 @@
+module BitlbeeConfig
+  VERSION = "1.0.0"
+end

data/lib/bitlbee_config.rb

@@ -0,0 +1,28 @@
+# Shipped with Ruby
+# Specified in Gemfile
+require "nokogiri"
+require "mixlib/shellout"
+
+# Internal stuff
+require "bitlbee_config/core_extensions"
+require "bitlbee_config/mixins"
+require "bitlbee_config/version"
+require "bitlbee_config/config"
+require "bitlbee_config/account"
+require "bitlbee_config/accounts"
+require "bitlbee_config/channel"
+require "bitlbee_config/user"
+
+# rubocop:disable HandleExceptions
+# Development stuff, can't be loaded in production, but that's fine
+%w(debugger).each do |development_gem|
+  begin
+    require development_gem
+  rescue LoadError
+  end
+end
+# rubocop:enable HandleExceptions
+
+# @author Nils Landt
+module BitlbeeConfig
+end

data/test/account_test.rb

@@ -0,0 +1,135 @@
+require "helper"
+
+describe BitlbeeConfig::Account do
+  it "is uniquely identified by protocol and handle" do
+    account1 = BitlbeeConfig::Account.new(protocol: :oscar, handle: "1234")
+    account2 = BitlbeeConfig::Account.new(protocol: :skype, handle: "1234")
+    account3 = BitlbeeConfig::Account.new(protocol: :oscar, handle: "1234")
+    account4 = BitlbeeConfig::Account.new(protocol: :skype, handle: "12345")
+
+    refute account1.id == account2.id
+    assert account1.id == account3.id
+    refute account2.id == account4.id
+  end
+
+  describe "password regeneration" do
+    before do
+      @cleartext_password = "cleartext_password"
+      @user_cleartext_password = "user_cleartext_password"
+      @user = BitlbeeConfig::User.new(nick: "Nils", cleartext_password: @user_cleartext_password)
+      @encrypted_password = "encrypted_password"
+
+      String.any_instance.stubs(:encrypt_bitlbee_password).returns(@cleartext_password + @user_cleartext_password)
+    end
+
+    it "overwrites password if cleartext password AND user cleartext password are given" do
+      account = BitlbeeConfig::Account.new(cleartext_password: @cleartext_password,
+                                           user: @user,
+                                           password: @encrypted_password)
+
+      assert_buildable_object_attribute_equals(account, :password, @cleartext_password.encrypt_bitlbee_password)
+    end
+
+    it "doesn't touch password if no cleartext password is given" do
+      account = BitlbeeConfig::Account.new(user: @user,
+                                           password: @encrypted_password)
+
+      assert_buildable_object_attribute_equals(account, :password, @encrypted_password)
+    end
+
+    it "doesn't touch password if no user cleartext password is given" do
+      account = BitlbeeConfig::Account.new(cleartext_password: @cleartext_password,
+                                           password: @encrypted_password)
+
+      assert_buildable_object_attribute_equals(account, :password, @encrypted_password)
+    end
+  end
+
+  describe "creating from xml" do
+    before do
+      @account = load_config_from_fixture("nils").user.accounts.first
+    end
+
+    it "reads the handle from attribute" do
+      assert_equal "12345678", @account.handle
+    end
+
+    it "reads the tag from attribute" do
+      assert_equal "icq", @account.tag
+    end
+
+    it "reads the password from attribute" do
+      assert_equal "bbbbbbbbbbbbbbbbbbbbb", @account.password
+    end
+
+    it "reads the server from attribute" do
+      assert_equal "127.0.0.1", @account.server
+    end
+
+    it "reads the autoconnect flag from attribute" do
+      assert_equal "true", @account.autoconnect
+    end
+
+    describe "account creation class based on xml" do
+      it "creates a generic account if nothing special is specified" do
+        account = BitlbeeConfig::Account.create_new_account
+        assert_kind_of BitlbeeConfig::Account, account
+      end
+
+      it "creates an ICQ account when protocol is 'oscar'" do
+        account = BitlbeeConfig::Account.create_new_account(protocol: :oscar)
+        assert_kind_of BitlbeeConfig::Accounts::Icq, account
+      end
+    end
+  end
+
+  describe "building xml" do
+    it "assigns handle as an attribute" do
+      handle = "testhandle"
+
+      account = BitlbeeConfig::Account.new(handle: handle)
+
+      assert_buildable_object_attribute_equals(account, :handle, handle)
+    end
+
+    it "assigns protocol as an attribute" do
+      protocol = "testprotocol"
+
+      account = BitlbeeConfig::Account.new(protocol: protocol)
+
+      assert_buildable_object_attribute_equals(account, :protocol, protocol)
+    end
+
+    it "assigns autoconnect as an attribute" do
+      autoconnect = "testautoconnect"
+
+      account = BitlbeeConfig::Account.new(autoconnect: autoconnect)
+
+      assert_buildable_object_attribute_equals(account, :autoconnect, autoconnect)
+    end
+
+    it "assigns server as an attribute" do
+      server = "testserver"
+
+      account = BitlbeeConfig::Account.new(server: server)
+
+      assert_buildable_object_attribute_equals(account, :server, server)
+    end
+
+    it "assigns tag as an attribute" do
+      tag = "testtag"
+
+      account = BitlbeeConfig::Account.new(tag: tag)
+
+      assert_buildable_object_attribute_equals(account, :tag, tag)
+    end
+
+    it "assigns settings" do
+      settings = { nick_format: "%testformat" }
+
+      account = BitlbeeConfig::Account.new(settings)
+
+      assert_buildable_object_has_settings(account, settings)
+    end
+  end
+end

data/test/accounts/facebook_test.rb

@@ -0,0 +1,82 @@
+require "helper"
+
+describe BitlbeeConfig::Accounts::Facebook do
+  describe "default settings" do
+    before do
+      @account = BitlbeeConfig::Accounts::Facebook.new
+    end
+
+    it "sets a tag" do
+      assert @account.tag
+    end
+
+    it "sets a nick format" do
+      assert @account.settings[:nick_format]
+    end
+  end
+
+  describe "username mangling" do
+    it "adds the facebook chat name suffix to the username it's not already there" do
+      handle = "nilslandt"
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: handle)
+
+      assert_equal handle + BitlbeeConfig::Accounts::Facebook::USERNAME_SUFFIX, acc.handle
+    end
+
+    it "does not add the facebook chat name suffix if it's already there" do
+      handle = "nilslandt" + BitlbeeConfig::Accounts::Facebook::USERNAME_SUFFIX
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: handle)
+
+      assert_equal handle, acc.handle
+    end
+
+    it "lowercases the username" do
+      handle = "NilsLandt" + BitlbeeConfig::Accounts::Facebook::USERNAME_SUFFIX
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: handle)
+
+      assert_equal handle.downcase, acc.handle
+    end
+  end
+
+  describe "authentication strategies" do
+    before do
+      @oauth_settings = { oauth: "on" }
+    end
+
+    it "uses oauth as default" do
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: "nils")
+
+      assert_equal :oauth, acc.auth_strategy
+    end
+
+    it "has a password when oauth is used" do
+      user = BitlbeeConfig::User.new(nick: "Nils", cleartext_password: "testpwd")
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: "nils", user: user)
+      String.any_instance.stubs(:encrypt_bitlbee_password).returns("dontcare")
+
+      acc.regenerate_password_if_needed
+
+      assert acc.password.length > 0
+    end
+
+    it "has an oauth setting when oauth strategy is used" do
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: "nils")
+
+      assert_buildable_object_has_settings acc, @oauth_settings
+    end
+
+    it "has no oauth setting when password strategy is used" do
+      acc = BitlbeeConfig::Accounts::Facebook.new(handle: "nils",
+                                                  auth_strategy: :password)
+
+      refute_buildable_object_has_settings acc, @oauth_settings
+    end
+
+    it "should not create an 'auth_strategy' setting" do
+      auth_strategy_settings = { auth_strategy: :password }
+      acc = BitlbeeConfig::Accounts::Facebook.new(auth_strategy_settings.merge(handle: "nils"))
+
+      refute_buildable_object_has_settings acc, auth_strategy_settings
+    end
+  end
+end

data/test/accounts/gtalk_test.rb

@@ -0,0 +1,25 @@
+require "helper"
+
+describe BitlbeeConfig::Accounts::Gtalk do
+  describe "default settings" do
+    before do
+      @account = BitlbeeConfig::Accounts::Gtalk.new
+    end
+
+    it "sets a tag" do
+      assert @account.tag
+    end
+
+    it "sets a nick format" do
+      assert @account.settings[:nick_format]
+    end
+
+    it "sets a server" do
+      assert @account.server
+    end
+
+    it "enables oauth" do
+      assert @account.settings[:oauth]
+    end
+  end
+end

data/test/accounts/hipchat_test.rb

@@ -0,0 +1,33 @@
+require "helper"
+
+describe BitlbeeConfig::Accounts::Hipchat do
+  describe "default settings" do
+    before do
+      @account = BitlbeeConfig::Accounts::Hipchat.new
+    end
+
+    it "sets a tag" do
+      assert @account.tag
+    end
+
+    it "sets a nick format" do
+      assert @account.settings[:nick_format]
+    end
+  end
+
+  describe "username mangling" do
+    it "adds the hipchat chat name suffix to the username it's not already there" do
+      handle = "nilslandt"
+      acc = BitlbeeConfig::Accounts::Hipchat.new(handle: handle)
+
+      assert_equal handle + BitlbeeConfig::Accounts::Hipchat::USERNAME_SUFFIX, acc.handle
+    end
+
+    it "does not add the hipchat chat name suffix if it's already there" do
+      handle = "nilslandt" + BitlbeeConfig::Accounts::Hipchat::USERNAME_SUFFIX
+      acc = BitlbeeConfig::Accounts::Hipchat.new(handle: handle)
+
+      assert_equal handle, acc.handle
+    end
+  end
+end

data/test/channel_test.rb

@@ -0,0 +1,55 @@
+require "helper"
+
+describe BitlbeeConfig::Channel do
+  it "turns all unrecognized options into settings" do
+    settings = { testsetting: "testvalue", settingtwo: "valuetwo" }
+
+    channel = BitlbeeConfig::Channel.new(settings)
+
+    assert_equal settings, channel.settings
+  end
+
+  describe "creating from xml" do
+    before do
+      @channel = load_config_from_fixture("nils").user.channels.first
+    end
+
+    it "reads the name from attribute" do
+      assert_equal "&bitlbee", @channel.name
+    end
+
+    it "reads the type from attribute" do
+      assert_equal "control", @channel.type
+    end
+
+    it "reads settings from sub elements" do
+      assert_equal({ auto_join: "true" }, @channel.settings)
+    end
+  end
+
+  describe "building xml" do
+    it "assigns name as an attribute" do
+      name = "testchannel"
+
+      channel = BitlbeeConfig::Channel.new(name: name)
+
+      assert_buildable_object_attribute_equals(channel, :name, name)
+    end
+
+    it "assigns type as an attribute" do
+      type = "local"
+
+      channel = BitlbeeConfig::Channel.new(type: type)
+
+      assert_buildable_object_attribute_equals(channel, :type, type)
+    end
+
+    it "assigns settings as sub elements" do
+      settings = { testsetting: "testvalue" }
+
+      channel = BitlbeeConfig::Channel.new(settings)
+
+      assert_buildable_object_has_settings(channel, settings)
+    end
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,118 @@
+require "helper"
+
+describe BitlbeeConfig::Config do
+  it "initializes with a single given user" do
+    new_user = BitlbeeConfig::User.new(nick: "test")
+    config = BitlbeeConfig::Config.new(user: new_user)
+
+    assert_kind_of BitlbeeConfig::User, config.user
+    assert_equal config.user, new_user
+  end
+
+  describe "deleting user configuration files" do
+    before do
+      @config_dir = get_tmp_dir
+      FileUtils.cp([get_fixture_by_name("nils"), get_fixture_by_name("malte")], @config_dir)
+    end
+
+    it "deletes a user configuration file from a given directory" do
+      assert File.exists?(File.join(@config_dir, "nils.xml"))
+
+      BitlbeeConfig::Config.delete_from_directory_for_user(@config_dir, "Nils")
+
+      refute File.exists?(File.join(@config_dir, "nils.xml"))
+      assert File.exists?(File.join(@config_dir, "malte.xml"))
+    end
+
+    after do
+      FileUtils.rm_rf @config_dir
+    end
+  end
+
+  describe "saving to file system" do
+    before do
+      @output_dir = get_tmp_dir
+    end
+
+    it "creates a file for every user" do
+      user_names = %w(user_one user_two)
+
+      configs = user_names.collect do |user_name|
+        BitlbeeConfig::Config.new(user: BitlbeeConfig::User.new(nick: user_name))
+      end
+
+      configs.each { |config| config.save_to_directory(@output_dir) }
+
+      user_names.each do |user_name|
+        assert File.exists?(File.join(@output_dir, "#{ user_name }.xml"))
+      end
+    end
+
+    it "downcases all filenames" do
+      user_name = "Nils"
+
+      config = BitlbeeConfig::Config.new(user: BitlbeeConfig::User.new(nick: user_name))
+      config.save_to_directory(@output_dir)
+
+      assert File.exists?(File.join(@output_dir, "#{ user_name.downcase }.xml"))
+    end
+
+    after do
+      FileUtils.rm_rf @output_dir
+    end
+  end
+
+  describe "conversion to string" do
+    it "delegates building each user to the user object" do
+      user = BitlbeeConfig::User.new(nick: "Nils")
+      user.expects(:build_xml).once
+
+      config = BitlbeeConfig::Config.new(user: user)
+
+      # rubocop:disable HandleExceptions
+      # since "build_xml" is stubbed, nothing will be built, resulting in an error. That's fine for this test
+      begin
+        config.to_xml
+      rescue NoMethodError
+      end
+      # rubocop:enable HandleExceptions
+    end
+  end
+
+  describe "creating from xml" do
+    describe "reading multiple xml files from directory" do
+      before do
+        @config_dir = get_tmp_dir
+        FileUtils.cp([get_fixture_by_name("nils"), get_fixture_by_name("malte")], @config_dir)
+      end
+
+      it "creates multiple configs for multiple files in a directory" do
+        configs = BitlbeeConfig::Config.from_directory(@config_dir)
+
+        assert_equal 2, configs.count
+        assert configs.all? { |config| config.is_a?(BitlbeeConfig::Config) }
+      end
+
+      it "loads config for a specific user from a given directory" do
+        config = BitlbeeConfig::Config.from_directory_for_user(@config_dir, "nils")
+
+        assert_kind_of BitlbeeConfig::User, config.user
+        assert_equal "Nils", config.user.nick
+      end
+
+      after do
+        FileUtils.rm_rf @config_dir
+      end
+    end
+
+    it "finds a user in an xml config" do
+      config = load_config_from_fixture "nils"
+      assert_equal config.user.nick, "Nils"
+    end
+
+    it "delegates the user to a new user object" do
+      BitlbeeConfig::User.expects(:from_xml).once
+      load_config_from_fixture "nils"
+    end
+  end
+end

data/test/core_extensions/string_test.rb

@@ -0,0 +1,43 @@
+require "helper"
+
+describe String do
+  describe "#to_bitlbee_password_hash" do
+    it "shells out to bitlbee" do
+      shellout = mocked_shellout
+      Mixlib::ShellOut.stubs(:new).returns(shellout)
+      shellout.expects(:run_command)
+
+      "test".to_bitlbee_password_hash
+    end
+  end
+
+  describe "#matches_bitlbee_password_hash?" do
+    it "shells out to bitlbee" do
+      shellout = mocked_shellout
+      Mixlib::ShellOut.stubs(:new).returns(shellout)
+      shellout.expects(:run_command)
+
+      "test".matches_bitlbee_password_hash?("123456")
+    end
+  end
+
+  describe "#encrypt_bitlbee_password" do
+    it "shells out to bitlbee" do
+      shellout = mocked_shellout
+      Mixlib::ShellOut.stubs(:new).returns(shellout)
+      shellout.expects(:run_command)
+
+      "test".encrypt_bitlbee_password("key")
+    end
+  end
+
+  describe "#decrypt_bitlbee_password" do
+    it "shells out to bitlbee" do
+      shellout = mocked_shellout
+      Mixlib::ShellOut.stubs(:new).returns(shellout)
+      shellout.expects(:run_command)
+
+      "test".decrypt_bitlbee_password("key")
+    end
+  end
+end

data/test/fixtures/malte.xml

@@ -0,0 +1,8 @@
+<user nick="Malte" password="cccccccccccccccccccccccccccc" version="1">
+	<setting name="away">I&apos;m busy</setting>
+	<setting name="last_version">197120</setting>
+	<account protocol="oscar" handle="87654321" password="ddddddddddddddddddddd" autoconnect="true" tag="icq"/>
+	<channel name="&amp;bitlbee" type="control">
+		<setting name="auto_join">true</setting>
+	</channel>
+</user>

data/test/fixtures/nils.xml

@@ -0,0 +1,8 @@
+<user nick="Nils" password="aaaaaaaaaaaaaaaaaaaaaaaaaaaa" version="1">
+	<setting name="away">I&apos;m busy</setting>
+	<setting name="last_version">197120</setting>
+	<account protocol="oscar" handle="12345678" password="bbbbbbbbbbbbbbbbbbbbb" autoconnect="true" tag="icq" server="127.0.0.1"/>
+	<channel name="&amp;bitlbee" type="control">
+		<setting name="auto_join">true</setting>
+	</channel>
+</user>