artaius 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rake_tasks~
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Kyrylo Silin
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.

data/README.md

@@ -0,0 +1,19 @@
+![Artaius][logo]
+================
+
+* [https://github.com/kyrylo/artaius/][rkag]
+
+Description
+-----------
+
+Artaius is a [King Arthur's Gold][kag] (KAG) IRC bot. Currently it's not
+suitable for a public use. Artaius dwells at #kag2d.ru@irc.quakenet.org.
+
+License
+-------
+
+The project uses Zlib License. See LICENSE file for more information.
+
+[logo]: http://img-fotki.yandex.ru/get/6210/98991937.9/0_7735e_6d44a25d_orig "Artaius logo"
+[rkag]: https://github.com/kyrylo/artaius/ "Home page"
+[kag]: http://kag2d.com/

data/Rakefile

@@ -0,0 +1,3 @@
+FileList['tasks/*.rake'].each { |t| import t }
+
+task :default => :test

data/artaius.gemspec

@@ -0,0 +1,36 @@
+require './lib/artaius/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'artaius'
+  s.version      = Artaius::VERSION
+  s.date         = Time.now.strftime('%Y-%m-%d')
+  s.summary      = "IRC bot serving King Arthur's Gold players."
+  s.author       = 'Kyrylo Silin'
+  s.email        = 'kyrylosilin@gmail.com'
+  s.homepage     = 'https://github.com/kyrylo/artaius'
+  s.license      = 'zlib'
+
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split "\n"
+  s.test_files   = `git ls-files -- spec`.split "\n"
+
+  s.extra_rdoc_files = %W{README.md LICENSE}
+  s.rdoc_options     = ["--charset=UTF-8"]
+
+  s.add_runtime_dependency     'cinch',        '~>2.0'
+  s.add_runtime_dependency     'kag',          '0.0.1'
+  s.add_runtime_dependency     'r18n-desktop', '>=0.4.14'
+	s.add_runtime_dependency     'sequel',       '>=3.34.1'
+	s.add_runtime_dependency     'sqlite3',      '>=1.3.6'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest',     '>=2.12.1'
+  s.add_development_dependency 'fivemat',      '>=1.0.0'
+
+  s.required_ruby_version = '~>1.9'
+
+  s.description  = <<description
+    Artaius is an IRC (Internet Relay Chat) bot for KAG (King Arthur's Gold)
+    game. It cannot everything for the time being.
+description
+end

data/bin/artaius

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/artaius'
+
+Artaius::Bot.new.start

data/config/locales/en.yml

@@ -0,0 +1,40 @@
+---
+identify:
+  send_challenge: "Identifying with Q, using CHALLENGEAUTH"
+  challenge: "[CHALLENGE received] Challenge: %1"
+
+mixer:
+  players: "Players: %1."
+  need_players: !!pl
+    1: "Need 1 more player to start the game."
+    n: "Need %1 more players to start the game"
+  cancel: "%1, you are not in the game anymore."
+  last_left: "The last player has left the game. The game is cancelled."
+  new_initiator: "New game inititator is %1."
+  roster: "Roster: %1."
+  n_slots_added: "%1 slots have been added. %2"
+  slot_added: "Slot added. %1"
+  n_slots_removed: "%1 slots have been removed. %2"
+  slot_removed: "Slot removed. %1"
+  slot_stats: "Slots: %1/%2."
+  blue_team: "Blue team: %1."
+  red_team: "Red team: %1."
+  glhf: "Good luck & have a good fun!"
+  slots_overall: "Total number of slots are %1."
+  game_cancelled: "The game has been cancelled due to shortage of players."
+  m:
+    game: "game"
+    play: "play"
+    cancel: "cancel"
+    roster: "roster"
+    start: "start"
+    slot: "slot"
+    slots: "slots"
+
+archivarius:
+  exists: "%1, you are already registered and bonded your KAG account and IRC authname (%2)."
+  not_found: "Player %1 does not exist. Did you make a typing error?"
+  authname_required: "In order to bond your KAG account and IRC authname, you need to authorize on this server or register your nickname"
+  success: "Yay, registration complete! Enjoy KAG ;-)"
+  m:
+    reg: "reg"

data/config/locales/ru.yml

@@ -0,0 +1,47 @@
+---
+identify:
+  send_challenge: "Идентифицируюсь с помощью Q, используя CHALLENGEAUTH"
+  challenge: "[CHALLENGE получен] Challenge: %1"
+
+mixer:
+  players: "Игроки: %1."
+  need_players: !!pl
+    1: "Для начала игры нужен еще 1 игрок."
+    2: "Для начала игры нужно еще %1 игрока."
+    n: "Для начала игры нужно еще %1 игроков."
+  cancel: "%1, вы вышли из игры."
+  last_left: "Последний игрок покинул игру. Игра отменена."
+  new_initiator: "%1 - новый инициатор игры."
+  roster: "Состав: %1."
+  n_slots_added: !!pl
+    1: "Добавлен 1 слот. %2"
+    2: "Добавлено %1 слота. %2"
+    n: "Добавлено %1 слотов. %2"
+  slot_added: "Слот добавлен. %1"
+  n_slots_removed: !!pl
+    1: "Убран 1 слот. %2"
+    2: "Убрано %1 слота. %2"
+    n: "Убрано %1 слотов. %2"
+  slot_removed: "Слот убран. %1"
+  slot_stats: "Слоты: %1/%2."
+  blue_team: "Команда синих: %1."
+  red_team: "Команда красных: %1."
+  glhf: "Удачи. Победит сильнейший!"
+  slots_overall: "Общее количество слотов: %1."
+  game_cancelled: "Игра была отменена из-за нехватки игроков."
+  m:
+    game: "игра"
+    play: "играть"
+    cancel: "отмена"
+    roster: "состав"
+    start: "старт"
+    slot: "слот"
+    slots: "слоты"
+
+archivarius:
+  exists: "%1, вы уже привязали свой аккаунт в КАГ-е к вашему логину в ИРЦ (%2)."
+  not_found: "Игрок %1 не существует. Опечатались?"
+  authname_required: "Чтобы связать ваш аккаунт в КАГ-е и ИРЦ логин, вы должны авторизироваться на этом сервере или зарегистрировать свой ник."
+  success: "Ура, регистрация завершена! Наслаждайтеь КАГ-ом ;-)"
+  m:
+    reg: "регь"

data/config/plugins/.gitignore

@@ -0,0 +1 @@
+identify.yml

data/db/.gitignore

@@ -0,0 +1 @@
+*.db

data/db/migrations/001_create_players.rb

@@ -0,0 +1,35 @@
+# Create initial schema for the table of registered players.
+#
+# Note, that while KAG's maximum length of nicknames is equal to 20,
+# QuakeNet allows only 15 letters (NICKLEN field in the ISUPPORT message).
+#
+# +--------------+--------------------------------------+
+# | Field        | Description                          |
+# +--------------+--------------------------------------+
+# | id           | Player id number.                    |
+# | irc_authname | IRC authname of player.              |
+# | kag_nick     | King Arthur's Gold in-game nickname. |
+# | role         | Role of the player [1]               |
+# | premium      | Account type (true if premium).      |
+# +--------------+--------------------------------------+
+#
+# [1] Roles:
+#   0: Normal player account
+#   1: KAG dev/team member
+#   2: KAG Guard.
+#   4: KAG team member ("admin" level, more or less the same as type 1)
+#   5: Possibly a tester, but most testers are not currently flagged
+#
+Sequel.migration do
+  change do
+    create_table :players do
+      primary_key :id
+      String      :irc_authname, :unique  => true, :size => 15, :null => false
+      String      :kag_nick,     :unique  => true, :size => 20, :null => false
+      Fixnum      :role,         :null    => false
+      FalseClass  :premium,      :null    => false
+      DateTime    :created_at
+      DateTime    :updated_at
+    end
+  end
+end

data/lib/artaius.rb

@@ -0,0 +1,16 @@
+require 'cinch'
+require 'kag'
+require 'yaml'
+require 'r18n-desktop'
+require 'sequel'
+require 'sequel/extensions/migration'
+
+require_relative 'artaius/bot'
+require_relative 'artaius/version'
+
+require_relative 'artaius/database'
+require_relative 'artaius/models/player'
+
+require_relative 'artaius/plugins/identify'
+require_relative 'artaius/plugins/mixer'
+require_relative 'artaius/plugins/archivarius'

data/lib/artaius/bot.rb

@@ -0,0 +1,50 @@
+module Artaius
+
+  # Internal: Turn the bot into a polyglot.
+  I18n = R18n.from_env('config/locales/', :ru)
+
+  class Bot < Cinch::Bot
+
+    # Internal: Name.
+    FIRST_NAME  = 'Artaius'
+
+    # Internal: Surname.
+    SECOND_NAME = 'Lucius'
+
+    # Internal: IRC server to join.
+    SERVER      = 'irc.quakenet.org'
+
+    # Internal: Port of IRC server.
+    PORT        = 6667
+
+    # Internal: Channels, that bot should be present on..
+    CHANNELS    = ['#kag2d.ru']
+
+    def initialize
+      super
+
+      # Bot configuration.
+      configure do |c|
+        c.nick     = FIRST_NAME
+        c.realname = "#{FIRST_NAME} #{SECOND_NAME}"
+        c.user     = "#{FIRST_NAME} #{SECOND_NAME}"
+        c.server   = SERVER
+        c.port     = PORT
+        c.channels = CHANNELS
+        c.plugins.plugins = [
+          Artaius::Plugins::Identify,
+          Artaius::Plugins::Mixer,
+          Artaius::Plugins::Archivarius
+        ]
+
+        # Set up plugins to be used.
+        c.plugins.options[Artaius::Plugins::Identify] = {
+          :username => FIRST_NAME,
+          :password => Psych.load_file('config/plugins/identify.yml')[:password]
+        }
+      end
+
+    end
+
+  end
+end

data/lib/artaius/database.rb

@@ -0,0 +1,36 @@
+module Artaius
+  # Internal: Connect Artaius to the database via Sequel interface.
+  Database = Sequel.sqlite(File.join(File.expand_path('db'), 'artaius.db'))
+
+  class << Database
+
+    # Internal: Migrate database from older version to the new one or vice
+    # versa. Without given arguments, migrate database to the latest version
+    # available.
+    #
+    # to   - The Integer, describes version, to version till which migrations
+    #        should be applied (default: nil).
+    # from - The Integer, describes version, from which migration should start
+    #        its work (default: nil).
+    #
+    # Returns nothing.
+    def migrate(to = nil, from = nil)
+      migrations = File.join(File.expand_path('db'), 'migrations')
+      if to == 0 && from == 0
+        Sequel::Migrator.apply(self, migrations)
+      else
+        Sequel::Migrator.apply(self, migrations, to, from)
+      end
+    end
+
+    # Internal: Rollback current version of database to the previous one. This
+    # method returns database exactly one step back.
+    #
+    # Returns nothing
+    def rollback
+      current_version = self[:schema_info].first[:version]
+      migrate(current_version.pred)
+    end
+
+  end
+end

data/lib/artaius/models/player.rb

@@ -0,0 +1,16 @@
+module Artaius
+  # Internal: Represents KAG player.
+  class Player < Sequel::Model(:players)
+    plugin :timestamps, :update_on_create => true
+
+    # Internal: Check database for given authname.
+    #
+    # irc_authname - The String, represents IRC authname of the player.
+    #
+    # Returns true if the given authname is in database or false otherwise.
+    def self.exists?(irc_authname)
+      filter(:irc_authname => irc_authname).select(:irc_authname).any?
+    end
+
+  end
+end

data/lib/artaius/plugins/archivarius.rb

@@ -0,0 +1,62 @@
+module Artaius
+  module Plugins
+    # The plugin handles registration of users. The aim of the plugin is to
+    # associate KAG account and IRC authname together.
+    class Archivarius
+      include Cinch::Plugin
+
+      set react_on: :private
+
+      match /#{I18n.archivarius.m.reg} (\w{3,20})$/,
+            method:     :sign_up,
+            use_suffix:  false
+
+      # Internal: Sign up a new player with some restrictions: it won't sign up
+      # neither already registered players, nor players, that doesn't have IRC
+      # autname, nor nonexistent KAG players.
+      #
+      # m        - The recieved message.
+      # kag_nick - The String, represents KAG nickname to be associated with
+      #            caller's IRC authanme.
+      #
+      # Returns nothing.
+      def sign_up(m, kag_nick)
+        authname = m.user.authname
+        nick     = m.user.nick
+
+        if authname.nil?
+          m.reply I18n.archivarius.authname_required and return
+        end
+
+        if already_exists?(authname)
+          m.reply I18n.archivarius.exists(nick, authname) and return
+        end
+
+        player = KAG::Player.new(kag_nick)
+
+        if player.info['statusMessage'] == 'Player not found'
+          m.reply I18n.archivarius.not_found(kag_nick) and return
+        end
+
+        Player.create(
+          :irc_authname => authname,
+          :kag_nick     => player.username,
+          :role         => player.role,
+          :premium      => player.gold?
+        )
+
+        m.reply I18n.archivarius.success
+      end
+
+      protected
+
+      # Internal: Ask database for whether the IRC authname is in it or not.
+      #
+      # Returns true, if the IRC authname is there of false otherwise.
+      def already_exists?(irc_authname)
+        Player.exists?(irc_authname)
+      end
+
+    end
+  end
+end

data/lib/artaius/plugins/identify.rb

@@ -0,0 +1,56 @@
+require 'openssl'
+
+module Artaius
+  module Plugins
+    # The plugin handles authentication via CHALLENGEAUTH. It requires two
+    # parameters: username and password of the bot. For details go here:
+    # http://www.quakenet.org/development/challengeauth/
+    class Identify
+      include Cinch::Plugin
+
+      set :required_options, [:username, :password]
+
+      # Internal: Q bot of QuakeNet. Nine times out of ten you write him a PM.
+      Q = 'Q@CServe.quakenet.org'
+
+
+      listen_to :connect,
+                 method: :send_challenge
+
+      # Internal: Identify a bot with Q.
+      #
+      # Returns nothing.
+      def send_challenge(m)
+        debug I18n.identify.send_challenge
+        User(Q).privmsg('CHALLENGE')
+      end
+
+      match /^CHALLENGE (.+?) (.+)$/,
+            method:     :challengeauth,
+            use_prefix:  false,
+            use_suffix:  false,
+            react_on:   :notice
+
+      # Internal: Authenticate bot with safe CHALLENGEAUTH method.
+      #
+      # m         - The recieved message.
+      # challenge - The CHALLENGE parameter, given by Q bot.
+      #
+      # Returns nothing.
+      def challengeauth(m, challenge)
+        # Q is the only trusted user.
+        return unless m.user && m.user.nick == 'Q'
+
+        debug I18n.identify.challenge(challenge)
+
+        username = config[:username].irc_downcase(:rfc1459)
+        password = config[:password][0, 10]
+
+        sha256 = OpenSSL::Digest::SHA256.new
+        key = sha256.hexdigest("#{ username }:#{ sha256.hexdigest(password) }")
+        response = OpenSSL::HMAC.hexdigest('SHA256', key, challenge)
+        User(Q).privmsg("CHALLENGEAUTH #{ username } #{ response } HMAC-SHA-256")
+      end
+    end
+  end
+end