artaius 0.2.0 → 0.2.1

data/.gitignore

@@ -1,2 +1,3 @@
-.rake_tasks~
+*~
+*.gem
 Gemfile.lock

data/README.md

@@ -2,6 +2,7 @@
 ================
 
 * [https://github.com/kyrylo/artaius/][rkag]
+* [Wiki][wiki]
 
 Description
 -----------
@@ -9,6 +10,11 @@ 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.
 
+Credits
+-------
+
+* Thanks to [dnmr][dnmr] for testing the bot
+
 License
 -------
 
@@ -17,3 +23,5 @@ 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/
+[dnmr]: https://forum.kag2d.com/members/dnmr.23/
+[wiki]: https://github.com/kyrylo/artaius/wiki

data/artaius.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   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_runtime_dependency     'sequel',       '>=3.34.1'
+  s.add_runtime_dependency     'sqlite3',      '>=1.3.6'
+  s.add_runtime_dependency     'mechanize',    '>=2.4'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest',     '>=2.12.1'

data/config/locales/en.yml

@@ -38,3 +38,33 @@ archivarius:
   success: "Yay, registration complete! Enjoy KAG ;-)"
   m:
     reg: "reg"
+
+scraper:
+  broken_link: "Uh oh! The link you just posted is broken."
+  title: "Title: %1"
+  h:
+    kag_forum: "KAG's forum: %1"
+
+news_fetcher:
+  news: "News! %1 writes: \"%2\" → %3"
+  latest_news: "On %1 %2 wrote a post: \"%3\"."
+  read_post: "Read post: %1"
+  m:
+    news: "news"
+
+informator:
+  kag_site: "https://www.kag2d.com/"
+  kag_wiki: "https://wiki.kag2d.com/"
+  kag_forum: "https://forum.kag2d.com/"
+  kag_manual: "https://kag2d.com/en/manual/"
+  kag_blog: "http://devlog.kag2d.com/"
+  kag_download: "https://kag2d.com/en/download/"
+  kag_bug_tracker: "https://bugs.kag2d.com/"
+  m:
+    site: "site"
+    wiki: "wiki"
+    forum: "forums"
+    manual: "manual"
+    blog: "blog"
+    download: "download"
+    bug_tracker: "bugs"

data/config/locales/ru.yml

@@ -39,9 +39,39 @@ mixer:
     slots: "слоты"
 
 archivarius:
-  exists: "%1, вы уже привязали свой аккаунт в КАГ-е к вашему логину в ИРЦ (%2)."
+  exists: "%1, вы уже привязали свой аккаунт в КАГ’е к вашему логину в ИРЦ (%2)."
   not_found: "Игрок %1 не существует. Опечатались?"
-  authname_required: "Чтобы связать ваш аккаунт в КАГ-е и ИРЦ логин, вы должны авторизироваться на этом сервере или зарегистрировать свой ник."
-  success: "Ура, регистрация завершена! Наслаждайтеь КАГ-ом ;-)"
+  authname_required: "Чтобы связать ваш аккаунт в КАГ’е и ИРЦ логин, вы должны авторизироваться на этом сервере или зарегистрировать свой ник."
+  success: "Ура, регистрация завершена! Наслаждайтеь КАГ’ом ;-)"
   m:
     reg: "регь"
+
+scraper:
+  broken_link: "Опаньки! А вот эта ссылка не работает."
+  title: "Заголовок: %1"
+  h:
+    kag_forum: "Форум КАГ’а: %1"
+
+news_fetcher:
+  news: "Новость! %1 пишет: \"%2\" → %3"
+  latest_news: "%1 %2 написал запись: \"%3\"."
+  read_post: "Читать запись: %1"
+  m:
+    news: "новости"
+
+informator:
+  kag_site: "https://www.kag2d.com/"
+  kag_wiki: "https://wiki.kag2d.com/"
+  kag_forum: "https://forum.kag2d.com/"
+  kag_manual: "https://kag2d.com/en/manual/"
+  kag_blog: "http://devlog.kag2d.com/"
+  kag_download: "https://kag2d.com/en/download/"
+  kag_bug_tracker: "https://bugs.kag2d.com/"
+  m:
+    site: "сайт"
+    wiki: "вики"
+    forum: "форум"
+    manual: "справочник"
+    blog: "блог"
+    download: "скачать"
+    bug_tracker: "баги"

data/db/migrations/002_create_news_table.rb

@@ -0,0 +1,25 @@
+# Create initial schema for the table of news (tiles) from KAG development blog.
+#
+# +--------------+----------------------------+
+# | Field        | Description                |
+# +--------------+----------------------------+
+# | id           | News id number.            |
+# | title        | News title.                |
+# | date         | Date, when news were added.|
+# | author       | Author of the news.        |
+# | link         | Link to post on the web.   |
+# +--------------+----------------------------+
+#
+Sequel.migration do
+  change do
+    create_table :news do
+      primary_key :id
+      String      :title,     :size => 255,  :null => false
+      DateTime    :date
+      String      :author,    :size => 32,   :null => false
+      String      :link,                     :null => false
+      DateTime    :created_at
+      DateTime    :updated_at
+    end
+  end
+end

data/lib/artaius.rb

@@ -10,7 +10,13 @@ require_relative 'artaius/version'
 
 require_relative 'artaius/database'
 require_relative 'artaius/models/player'
+require_relative 'artaius/models/news'
 
 require_relative 'artaius/plugins/identify'
 require_relative 'artaius/plugins/mixer'
 require_relative 'artaius/plugins/archivarius'
+require_relative 'artaius/plugins/autovoicer'
+require_relative 'artaius/plugins/autoopper'
+require_relative 'artaius/plugins/scraper'
+require_relative 'artaius/plugins/news_fetcher'
+require_relative 'artaius/plugins/informator'

data/lib/artaius/bot.rb

@@ -34,7 +34,12 @@ module Artaius
         c.plugins.plugins = [
           Artaius::Plugins::Identify,
           Artaius::Plugins::Mixer,
-          Artaius::Plugins::Archivarius
+          Artaius::Plugins::Archivarius,
+          Artaius::Plugins::Autovoicer,
+          Artaius::Plugins::Autoopper,
+          Artaius::Plugins::Scraper,
+          Artaius::Plugins::NewsFetcher,
+          Artaius::Plugins::Informator
         ]
 
         # Set up plugins to be used.

data/lib/artaius/models/news.rb

@@ -0,0 +1,5 @@
+module Artaius
+  class News < Sequel::Model(:news)
+    plugin :timestamps, :update_on_create => true
+  end
+end

data/lib/artaius/models/player.rb

@@ -2,15 +2,5 @@ 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

@@ -50,11 +50,13 @@ module Artaius
 
       protected
 
-      # Internal: Ask database for whether the IRC authname is in it or not.
+      # Internal: Check database for given authname.
       #
-      # Returns true, if the IRC authname is there of false otherwise.
+      # irc_authname - The String, represents IRC authname of the player.
+      #
+      # Returns true if the given authname is in database or false otherwise.
       def already_exists?(irc_authname)
-        Player.exists?(irc_authname)
+        Player.filter(:irc_authname => irc_authname).select(:irc_authname).any?
       end
 
     end

data/lib/artaius/plugins/autoopper.rb

@@ -0,0 +1,22 @@
+module Artaius
+  module Plugins
+    class Autoopper
+      # Gives an op for everyone, who has a Guard role in King Arthur's Gold
+      # and registered.
+      include Cinch::Plugin
+
+      listen_to :join
+
+      def listen(m)
+        return if m.user.nick == bot.nick
+
+        m.channel.op(m.user) if guard?(m.user.authname)
+      end
+
+      def guard?(irc_authname)
+        Player.filter(:irc_authname => irc_authname).select_map(:role).first == 2
+      end
+
+    end
+  end
+end

data/lib/artaius/plugins/autovoicer.rb

@@ -0,0 +1,22 @@
+module Artaius
+  module Plugins
+    # Gives a voice for everyone, who has a premium account in King Arthur's
+    # Gold and registered.
+    class Autovoicer
+      include Cinch::Plugin
+
+      listen_to :join
+
+      def listen(m)
+        return if m.user.nick == bot.nick
+
+        m.channel.voice(m.user) if premium?(m.user.authname)
+      end
+
+      def premium?(irc_authname)
+        Player.filter(:irc_authname => irc_authname).select_map(:premium).first
+      end
+
+    end
+  end
+end

data/lib/artaius/plugins/informator.rb

@@ -0,0 +1,31 @@
+module Artaius
+  module Plugins
+    # Provides useful links to KAG resources and maybe some other related
+    # information.
+    class Informator
+      include Cinch::Plugin
+
+      set react_on: :channel
+
+      methods = [:site, :wiki, :forum, :manual, :blog, :download, :bug_tracker]
+
+      methods.each do |method|
+        pattern = I18n.informator.m.send(method)
+        instance_eval <<-EVAL
+          match /#{pattern}$/,
+                method:     :#{method},
+                use_suffix:  false
+        EVAL
+      end
+
+      methods.each do |method|
+        class_eval <<-EVAL
+          def #{method}(m)
+            m.reply I18n.informator.kag_#{method}
+          end
+        EVAL
+      end
+
+    end
+  end
+end

data/lib/artaius/plugins/mixer.rb

@@ -35,7 +35,6 @@ module Artaius
       # seconds).
       PENDING_DELAY = 300
 
-
       set react_on: :channel
 
       match /#{I18n.mixer.m.game}(\s([2-9]|[1-9][0-9]))?$/,
@@ -50,7 +49,7 @@ module Artaius
       #
       # Returns nothing.
       def start_game(m, limit)
-        return if @game or !Player.exists?(m.user.authname)
+        return if @game or !already_exists?(m.user.authname)
 
         @limit = if limit && !limit.empty?
           limit.to_i
@@ -73,7 +72,7 @@ module Artaius
       #
       # Returns nothing.
       def add_player(m)
-        return if !@game or !Player.exists?(m.user.authname)
+        return if !@game or !already_exists?(m.user.authname)
 
         unless @game.players.map(&:irc_authname).include?(m.user.authname)
           @game.players << create_gamer(m)
@@ -86,15 +85,16 @@ module Artaius
             m.reply I18n.mixer.players(show_players)
             m.reply I18n.mixer.need_players(need_players)
           end
-
         end
 
         @timer.stop if @timer
 
-        @timer = Timer(PENDING_DELAY, :shots => 1) do
+        @timer ||= Timer(PENDING_DELAY, shots: 1, start_automatically: false) do
           @game = nil
           Channel(m.channel.name).send I18n.mixer.game_cancelled
         end
+
+        @timer.start
       end
 
       match /#{I18n.mixer.m.cancel}$/,
@@ -330,6 +330,15 @@ module Artaius
         )
       end
 
+      # 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 already_exists?(irc_authname)
+        Player.filter(:irc_authname => irc_authname).select(:irc_authname).any?
+      end
+
     end
   end
 end

data/lib/artaius/plugins/news_fetcher.rb

@@ -0,0 +1,92 @@
+require 'rss'
+require 'open-uri'
+
+module Artaius
+  module Plugins
+    class NewsFetcher
+      include Cinch::Plugin
+
+      # Internal: RSS address of KAG development blog.
+      KAGDEV_RSS = 'http://devlog.kag2d.com/rss'
+
+      # Internal: Time lapse between checking RSS feed for new posts.
+      CHECK_TIME_LAPSE = 1800
+
+      set react_on: :channel
+
+      timer CHECK_TIME_LAPSE,
+            method: :send_news
+
+      # Internal: Send latest news on channels.
+      #
+      # Returns nothing.
+      def send_news
+        feed = RSS::Parser.parse open(KAGDEV_RSS).read
+        last_post_title = feed.channel.item.title
+
+        # Check, whether the latest title of the post at KAG development
+        # blog is still the same, as it was, when the fetcher checked it last
+        # time.
+        return if unchanged?(last_post_title)
+
+        item = feed.channel.item
+
+        last_post_date   = item.pubDate
+        last_post_author = item.dc_creator
+        last_post_link   = item.link
+
+        News.create(
+          :title  => last_post_title,
+          :date   => last_post_date,
+          :author => last_post_author,
+          :link   => last_post_link
+        )
+
+        real_author = reveal_author(last_post_author)
+        short_link = open("http://clck.ru/--?url=#{last_post_link}").read
+
+        Bot::CHANNELS.each do |chan|
+          Channel(chan).send I18n.news_fetcher.news(real_author, last_post_title, short_link)
+        end
+      rescue SocketError
+        nil
+      end
+
+      match /#{I18n.news_fetcher.m.news}$/,
+            method:     :latest_news,
+            use_suffix:  false
+
+      # Internal: Send on the channel information about the latest post at KAG
+      # development blog and give a link to it.
+      #
+      # Returns nothing.
+      def latest_news(m)
+        news = News.order(:date).last
+
+        author = reveal_author(news.author)
+        date   = I18n.localize(news.date, :full)
+
+        m.reply I18n.news_fetcher.latest_news(date, author, news.title)
+        m.reply I18n.news_fetcher.read_post(news.link)
+      end
+
+      protected
+
+      def unchanged?(title)
+        last = News.select(:title).order(:date).last
+        last and last.title == title
+      end
+
+      # Internal: Transform aliases of a blog author to his/her real nickname.
+      #
+      # Returns the transformed String.
+      def reveal_author(nick)
+        case nick
+        when 'lddev'      then 'MM'
+        when '1bardesign' then 'Geti'
+        end
+      end
+
+    end
+  end
+end

data/lib/artaius/plugins/scraper.rb

@@ -0,0 +1,43 @@
+require 'mechanize'
+
+module Artaius
+  module Plugins
+    # Scraps web pages, that have <title> attribute.
+    class Scraper
+      include Cinch::Plugin
+
+      listen_to :channel,
+                 method: :scrap_links
+
+      def scrap_links(m)
+        unless @agent
+          @agent = Mechanize.new
+          @agent.user_agent_alias = 'Linux Firefox'
+        end
+
+        URI.extract(m.message, %w[http https]) do |link|
+          begin
+            page = @agent.get(link)
+            uri = URI.parse(link)
+          rescue Mechanize::ResponseCodeError
+            m.reply I18n.scraper.broken_link and next
+          end
+
+          title = page.title.gsub(/[\x00-\x1f]*/, "").gsub(/[ ]{2,}/, " ").strip rescue nil
+
+          if title
+            case uri.host
+            when 'forum.kag2d.com'
+              pattern = / \| Page \d{1,4} \| King Arthur's Gold Forum$/
+              title.sub!(pattern, '')
+              m.reply I18n.scraper.h.kag_forum(title)
+            else
+              m.reply I18n.scraper.title(title)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/artaius/version.rb

@@ -1,3 +1,3 @@
 module Artaius
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artaius
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cinch
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -160,13 +176,20 @@ files:
 - config/plugins/.gitignore
 - db/.gitignore
 - db/migrations/001_create_players.rb
+- db/migrations/002_create_news_table.rb
 - lib/artaius.rb
 - lib/artaius/bot.rb
 - lib/artaius/database.rb
+- lib/artaius/models/news.rb
 - lib/artaius/models/player.rb
 - lib/artaius/plugins/archivarius.rb
+- lib/artaius/plugins/autoopper.rb
+- lib/artaius/plugins/autovoicer.rb
 - lib/artaius/plugins/identify.rb
+- lib/artaius/plugins/informator.rb
 - lib/artaius/plugins/mixer.rb
+- lib/artaius/plugins/news_fetcher.rb
+- lib/artaius/plugins/scraper.rb
 - lib/artaius/version.rb
 - spec/lib/artaius/bot_spec.rb
 - spec/lib/artaius/plugins/archivarius_spec.rb