bitlbee_config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23649e6dfedc017442195984c024a994f56918f6
+  data.tar.gz: 58bbf7b3f91899ab5e64ee9973a0c9be493f8254
+SHA512:
+  metadata.gz: b351506aa977419dd3b1a971fea6c537af1f0b0459174f4f9c6b58871fdd7539814d5ae91c26fc3d7e452a6b64a7b592ea7b4811917c9822cd8955ae6109f950
+  data.tar.gz: 04a3e809d005689cce48b060b271e11b424c98d89c6cb003b0e419d2f51021d935cf1769fb7df51d111ec53b2ec94c93fe429ffb7a7c3ac4984c24a3cc60653b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/cache

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Includes:
+    - Guardfile
+  Excludes:
+    - tmp/**
+
+CollectionMethods:
+  PreferredMethods:
+  Enabled: false
+    #collect: 'collect'
+    #collect!: 'collect!'
+    #inject: 'inject'
+    #detect: 'detect'
+    #find_all: 'select'
+
+CommentAnnotation:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+    Max: 20
+
+RegexpLiteral:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script:
+  - bundle exec rake travis

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest do
+  watch(%r{^test/(.*)_test\.rb})
+  watch("lib/bitlbee_config.rb") { "test" }
+  watch(%r{^lib/bitlbee_config/(.*/)?([^/]+)\.rb})     { |m| "test/#{ m[1] }#{ m[2] }_test.rb" }
+  watch(%r{^test/helper\.rb})    { "test" }
+  watch(%r{^test/fixtures/.*\.xml}) { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nils Landt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+Currently only for internal use in the [bitlbee chef cookbook](https://github.com/promisedlandt/cookbook-bitlbee).
+
+Interfaces are bound to change / be removed, you do **not** want to use this yet.

data/Rakefile

@@ -0,0 +1,30 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+require "yard"
+
+
+desc "Start guard for minitest"
+task :guard do
+  sh "guard --no-interactions --notify false --clear"
+end
+
+desc "Run rubocop linter"
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.formatters = %w(simple)
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--no-private"]
+end
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+desc "for travis-ci run"
+task travis: :default
+
+task default: [:test, :rubocop]

data/bitlbee_config.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitlbee_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitlbee_config"
+  spec.version       = BitlbeeConfig::VERSION
+  spec.authors       = ["Nils Landt"]
+  spec.email         = ["nils@promisedlandt.de"]
+  spec.description   = %q{Create, read and modify configuration files for bitlbee}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/promisedlandt/bitlbee_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "mixlib-shellout", "~> 1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "debugger", "~> 1.6"
+  spec.add_development_dependency "rubocop", "~> 0.1"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "guard", "~> 2"
+  spec.add_development_dependency "guard-minitest", "~> 2"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "mocha", "~> 1"
+  spec.add_development_dependency "coveralls"
+end

data/lib/bitlbee_config/account.rb

@@ -0,0 +1,94 @@
+module BitlbeeConfig
+  # An account with an IM service, e.g. an ICQ or Skype account
+  class Account
+    include BitlbeeConfig::XmlBuildable
+
+    attr_accessor :protocol, :handle, :password, :autoconnect, :tag, :server, :cleartext_password, :user, :settings
+
+    class << self
+      # @param [Nokogiri::XML::Element] xml XML element to create account from
+      # @return [BitlbeeConfig::Account|BitlbeeConfig::Accounts::Icq] The newly created account
+      def from_xml(xml)
+        new_account = {}
+
+        # get setting attributes
+        xml.attributes.each do |att_name, att_value|
+          new_account[att_name.to_sym] = att_value.text
+        end
+
+        # get setting children
+        xml.children.select { |node| node.is_a?(Nokogiri::XML::Element) }.each do |setting_element|
+          new_account[setting_element.values.first.to_sym] = setting_element.text
+        end
+
+        create_new_account(new_account)
+      end
+
+      # Creates a new account. The class of the account varies by the attributes.
+      #
+      # @param [Hash] account Attributes for the account the be created
+      # @return [BitlbeeConfig::Account|BitlbeeConfig::Accounts::Icq] The newly created account
+      def create_new_account(account = {})
+        account_class = case
+                        when account[:handle] =~ /#{ BitlbeeConfig::Accounts::Facebook::USERNAME_SUFFIX }$/
+                          BitlbeeConfig::Accounts::Facebook
+                        when account[:server] == BitlbeeConfig::Accounts::Gtalk::DEFAULT_GTALK_SERVER
+                          BitlbeeConfig::Accounts::Gtalk
+                        when account[:protocol].to_s == "jabber"
+                          BitlbeeConfig::Accounts::Jabber
+                        when account[:protocol].to_s == "steam"
+                          BitlbeeConfig::Accounts::Steam
+                        when account[:protocol].to_s == "oscar"
+                          BitlbeeConfig::Accounts::Icq
+                        else
+                          BitlbeeConfig::Account
+                        end
+
+        account_class.new(account)
+      end
+    end
+
+    # @param [Hash] options
+    # @option options [String] :protocol Protocol used for the account
+    # @option options [String] :handle The handle / login for the account, e.g. your ICQ number
+    # @option options [String] :tag A label for easy recognition of your account, e.g. "jabber-work"
+    # @option options [String] :autoconnect Autoconnect to account on identify?
+    # @option options [String] :server Overwrite server to connect to - for example if you use a proxy, or stunnel
+    # @option options [String] :cleartext_password Cleartext password for this account. Will be encrypted before written
+    # @option options [String] :password The encrypted password of the account, as it appears in the XML document (encrypted_password with the users password
+    # @option options [String] :user User this account belongs to. Needed for it's cleartext password
+    def initialize(options = {})
+      @protocol ||= options.delete(:protocol)
+      @handle ||= options.delete(:handle)
+      @tag ||= options.delete(:tag)
+      @autoconnect ||= options.delete(:autoconnect)
+      @server ||= options.delete(:server)
+      @password ||= options.delete(:password)
+      @cleartext_password ||= options.delete(:cleartext_password)
+      @user ||= options.delete(:user)
+      @settings = options || {}
+    end
+
+    # Uniquely identify this account - currently by protocol and handle
+    def id
+      "#{ @protocol }##{ @handle }"
+    end
+
+    # When a cleartext password and the user's cleartext password are given, encrypt the cleartext_password with the user's cleartext password
+    def regenerate_password_if_needed
+      @password = @cleartext_password.encrypt_bitlbee_password(@user.cleartext_password) if @user && @user.cleartext_password && @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
+
+      account_options = [:password, :protocol, :handle, :autoconnect, :tag, :server].each_with_object({}) do |option, options_hash|
+        value = instance_variable_get("@#{ option }")
+        options_hash[option] = value unless value.nil? || value.empty?
+      end
+
+      to_xml_with_options(xml_builder, account_options)
+    end
+  end
+end

data/lib/bitlbee_config/accounts/facebook.rb

@@ -0,0 +1,44 @@
+module BitlbeeConfig
+  module Accounts
+    class Facebook < Accounts::Jabber
+      attr_accessor :auth_strategy
+
+      USERNAME_SUFFIX = "@chat.facebook.com"
+
+      def initialize(options = {})
+        # username needs to be downcased when not using OAuth. Just always downcase it, always works
+        options[:handle] &&= options[:handle].downcase
+
+        # unless otherwise specified, use oauth authentication
+        @auth_strategy = options.delete(:auth_strategy) || :oauth
+
+        options = add_auth_strategy_options(options)
+
+        super({ tag: "fb",
+                nick_format: "%full_name"
+              }.merge(options))
+
+        ensure_handle_is_suffixed if @handle
+      end
+
+      # We don't want the user to have to enter "@chat.facebook.com" with their handle, so we do it for them
+      def ensure_handle_is_suffixed
+        @handle += USERNAME_SUFFIX unless @handle =~ /#{ USERNAME_SUFFIX }$/
+      end
+
+      # Depending on the authentication strategy, we set a few things
+      #
+      # @param [Hash] init_options The options passed to initialize
+      # @return [Hash] The original options, which may be modified now
+      def add_auth_strategy_options(init_options)
+        case @auth_strategy
+        when :oauth
+          init_options[:oauth] = "on"
+          init_options[:cleartext_password] ||= ""
+        end
+
+        init_options
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts/gtalk.rb

@@ -0,0 +1,17 @@
+module BitlbeeConfig
+  module Accounts
+    class Gtalk < Accounts::Jabber
+      DEFAULT_GTALK_SERVER = "talk.google.com"
+
+      def initialize(options = {})
+        # unlike facebook, we don't give support password authentication here, only oauth
+        super({ tag: "gtalk",
+                nick_format: "%full_name",
+                server: DEFAULT_GTALK_SERVER,
+                oauth: "on",
+                cleartext_password: ""
+              }.merge(options))
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts/hipchat.rb

@@ -0,0 +1,20 @@
+module BitlbeeConfig
+  module Accounts
+    class Hipchat < Accounts::Jabber
+      USERNAME_SUFFIX = "@chat.hipchat.com"
+
+      def initialize(options = {})
+        super({ tag: "hipchat",
+                nick_format: "%full_name"
+              }.merge(options))
+
+        ensure_handle_is_suffixed if @handle
+      end
+
+      # We don't want the user to have to enter "@chat.facebook.com" with their handle, so we do it for them
+      def ensure_handle_is_suffixed
+        @handle += USERNAME_SUFFIX unless @handle =~ /#{ USERNAME_SUFFIX }$/
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts/icq.rb

@@ -0,0 +1,10 @@
+module BitlbeeConfig
+  module Accounts
+    class Icq < Account
+      def initialize(options = {})
+        @protocol = :oscar
+        super
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts/jabber.rb

@@ -0,0 +1,10 @@
+module BitlbeeConfig
+  module Accounts
+    class Jabber < Account
+      def initialize(options = {})
+        @protocol = :jabber
+        super
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts/steam.rb

@@ -0,0 +1,11 @@
+module BitlbeeConfig
+  module Accounts
+    class Steam < Account
+      def initialize(options = {})
+        @protocol = :steam
+        @tag = "steam"
+        super
+      end
+    end
+  end
+end

data/lib/bitlbee_config/accounts.rb

@@ -0,0 +1,7 @@
+require "bitlbee_config/accounts/icq"
+require "bitlbee_config/accounts/jabber"
+require "bitlbee_config/accounts/steam"
+
+require "bitlbee_config/accounts/facebook"
+require "bitlbee_config/accounts/gtalk"
+require "bitlbee_config/accounts/hipchat"

data/lib/bitlbee_config/channel.rb

@@ -0,0 +1,43 @@
+module BitlbeeConfig
+  # A channel on the bitlbee server. Can either be a control channel, in which you issue commands to the BitlBee root user, or a chat channel, which is a multi contact conversation
+  class Channel
+    include BitlbeeConfig::XmlBuildable
+
+    attr_accessor :name, :type, :settings
+
+    class << self
+      # @param [Nokogiri::XML::Element] xml XML element to create channel from
+      # @return [BitlbeeConfig::Channel] The newly created channel
+      def from_xml(xml)
+        new_channel = {}
+
+        # get setting attributes
+        xml.attributes.each do |att_name, att_value|
+          new_channel[att_name.to_sym] = att_value.text
+        end
+
+        # get setting children
+        xml.children.select { |node| node.is_a?(Nokogiri::XML::Element) }.each do |setting_element|
+          new_channel[setting_element.values.first.to_sym] = setting_element.text
+        end
+
+        BitlbeeConfig::Channel.new(new_channel)
+      end
+    end
+
+    # @param [Hash] options
+    # @option options [String] :name Channel name. Don't forget # or &
+    # @option options ["control"|"chat"] :type Type of channel
+    # @option options [String] All other entries will be converted to settings
+    def initialize(options = {})
+      @name = options.delete(:name)
+      @type = options.delete(:type)
+      @settings = options || {}
+    end
+
+    # @param [Nokogiri::XML::Builder] xml_builder All XML will be added to this builder
+    def build_xml(xml_builder)
+      to_xml_with_options(xml_builder, name: @name, type: @type)
+    end
+  end
+end

data/lib/bitlbee_config/config.rb

@@ -0,0 +1,81 @@
+module BitlbeeConfig
+  # A configuration file for BitlBee. Has exactly one user
+  class Config
+    attr_accessor :user
+
+    class << self
+      # Create a config for every user XML in the given directory
+      #
+      # @param [String] directory Directory to load from
+      # @return [Array<BitlbeeConfig::User>]
+      def from_directory(directory)
+        Dir.glob(File.join(directory, "*.xml")).each_with_object([]) do |path_to_file, config_collection|
+          config_collection << BitlbeeConfig::Config.from_file(path_to_file)
+        end
+      end
+
+      # Create a config for one specific user, reading the XML from a directory
+      #
+      # @param [String] directory Directory to load from
+      # @param [String] username User to load config for
+      # @return [BitlbeeConfig::User|nil]
+      def from_directory_for_user(directory, username)
+        from_file(File.join(directory, BitlbeeConfig::User.username_to_filename(username)))
+      end
+
+      # Create a config from an XML file
+      #
+      # @param [String] file_path Path to the XML configuration file
+      # @return [BitlbeeConfig::Config] The created configuration object
+      def from_file(file_path)
+        from_xml(File.read(file_path))
+      end
+
+      # @param [String] xml The XML to parse
+      # @return [BitlbeeConfig::Config] The created configuration object
+      def from_xml(xml)
+        doc = Nokogiri::XML(xml)
+
+        # Bitlbee config says there can be only one user per XML file
+        user_xml = doc.xpath("//user").first
+
+        BitlbeeConfig::Config.new(user: BitlbeeConfig::User.from_xml(user_xml))
+      end
+
+      # Deletes file for a specified user name from the given directory
+      #
+      # @param [String] directory Directory to check for user XML files
+      # @param [String] username User to delete config for
+      def delete_from_directory_for_user(directory, username)
+        file_to_delete = File.join(directory, BitlbeeConfig::User.username_to_filename(username))
+        File.delete(file_to_delete) if File.exists?(file_to_delete)
+      end
+    end
+
+    # @param [Hash] options
+    # @option options [Array<BitlbeeConfig::User>] :user User this configuration belongs to
+    def initialize(options = {})
+      @user = options.delete(:user)
+    end
+
+    def to_xml
+      builder = Nokogiri::XML::Builder.new do |xml_builder|
+        @user.build_xml(xml_builder)
+      end
+
+      builder.doc.root.to_xml
+    end
+
+    # Saves the configuration to a specified directory
+    # User files are named <username.downcase>.xml
+    #
+    # @param [String] path_to_dir Directory to save user xml to
+    def save_to_directory(path_to_dir)
+      user_file_path = File.join(path_to_dir, "#{ @user.nick.downcase }.xml")
+
+      File.open(user_file_path, "w") do |file|
+        file.write(to_xml)
+      end
+    end
+  end
+end

data/lib/bitlbee_config/core_extensions/string.rb

@@ -0,0 +1,46 @@
+class String
+  # @see http://wiki.bitlbee.org/DecodingPasswords
+
+  # Get the bitlbee password hash for this string
+  #
+  # @return [String] The bitlbee password hash for this string
+  def to_bitlbee_password_hash
+    cmd = Mixlib::ShellOut.new(" bitlbee -x hash '#{ self }'")
+    cmd.run_command
+    cmd.error!
+    cmd.stdout.chomp
+  end
+
+  # Check whether this string matches a given bitlbee password hash
+  #
+  # @return [Boolean]
+  def matches_bitlbee_password_hash?(hash)
+    cmd = Mixlib::ShellOut.new(" bitlbee -x chkhash '#{ hash }' '#{ self }'")
+    cmd.run_command
+    cmd.exitstatus == 0
+  end
+
+  # Encrypt a bitlbee account password
+  # Used to encrypt passwords for individual IM accounts with the password of the bitlbee user
+  #
+  # @param [String] key Key to encrypt with
+  # @return [String] The encrypted version of this string
+  def encrypt_bitlbee_password(key)
+    cmd = Mixlib::ShellOut.new(" bitlbee -x enc '#{ key }' '#{ self }'")
+    cmd.run_command
+    cmd.error!
+    cmd.stdout.chomp
+  end
+
+  # Decrypt a bitlbee account password
+  # Used to decrypt passwords for individual IM accounts with the password of the bitlbee user
+  #
+  # @param [String] key Key to decrypt with
+  # @return [String] The cleartext version of this string
+  def decrypt_bitlbee_password(key)
+    cmd = Mixlib::ShellOut.new(" bitlbee -x dec '#{ key }' '#{ self }'")
+    cmd.run_command
+    cmd.error!
+    cmd.stdout.chomp
+  end
+end

data/lib/bitlbee_config/core_extensions.rb

@@ -0,0 +1 @@
+require "bitlbee_config/core_extensions/string.rb"

data/lib/bitlbee_config/mixins/xml_buildable.rb

@@ -0,0 +1,25 @@
+module BitlbeeConfig
+  module XmlBuildable
+    def to_xml_with_options(xml_builder, options = {}, &block)
+      # Accounts can have many different classes, but the element is always named "account"
+      element_name = case
+                     when self.is_a?(BitlbeeConfig::Account)
+                       "account"
+                     else
+                       self.class.name.split("::").last.downcase
+                     end
+
+      xml_builder.send(element_name, options) do |xml|
+        if @settings
+          @settings.each do |setting_name, setting_value|
+            xml.setting(name: setting_name) do |setting_xml|
+              setting_xml.text setting_value
+            end
+          end
+        end
+
+        block.call(xml) if block
+      end
+    end
+  end
+end

data/lib/bitlbee_config/mixins.rb

@@ -0,0 +1 @@
+require "bitlbee_config/mixins/xml_buildable"