zabbirc 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9709c2587dc9ede55cf578ac23dd8cdab18a0a39
-  data.tar.gz: 384e3abc02e685d19e1db41575ee4343cdd80753
+  metadata.gz: af897ba02297f7617cf59c4e8e3566ad2dcadd1d
+  data.tar.gz: ca9355720c51cc0105dcc535392729a545a5bd78
 SHA512:
-  metadata.gz: ff594056094dd32781b14022e6b87bbd1ff7981b81d73d4989c44ad8bb6018141e2f5521c09286e0dd93e05b87dbb6a3e479cba341e51359743735e3d9f66c4f
-  data.tar.gz: f63c3689718110f00ffde34a5cd2ca244077e4ecb147fdc58cb7acfb56ab80cf83dd3e581c8c9f9f32b4f8cdbe48552a1e79457f6cc575f39b4b96a452f97559
+  metadata.gz: 528f8d9b60be512037ff03aca50c6f0c2424e5ac830230260fb3e332d7d9de8ddbed2f4d8e3ab7137f490494937fe48acae3aecc615e38c38e319e9abb466205
+  data.tar.gz: 46e162cbaaf6d118fcf98cf7880d2fa77e753d6e0120b6ebc16efe5a4c3d634ca160869274424454e2a3c1f8c404f276e468cc16e9c84af9c0ba3934ce4f0690

data/lib/zabbirc/id_shortener.rb

@@ -0,0 +1,73 @@
+module Zabbirc
+  class IdShortener
+    CHAR_SET = ("A".."Z").to_a + (2..9).to_a.collect(&:to_s)
+
+    IdTranslation = Struct.new(:id, :shorten_id, :used_at) do
+      def touch
+        self.used_at = Time.now
+      end
+    end
+
+    def initialize max_cache_size=10_000, shorten_id_length = 3
+      @max_cache_size = max_cache_size
+      @shorten_id_length = shorten_id_length
+      @mutex = Mutex.new
+      @ids = {}
+      @shorten_ids = {}
+    end
+
+    def get_id shorten_id
+      @mutex.synchronize do
+        translation = @shorten_ids[shorten_id.upcase]
+        if translation
+          translation.touch
+          translation.id
+        else
+          nil
+        end
+      end
+    end
+
+    def get_shorten_id id
+      @mutex.synchronize do
+        translation = @ids[id]
+        return translation.shorten_id if translation
+        begin
+          shorten_id = generate_shorten_id
+        end while @shorten_ids.key?(shorten_id)
+        translation = register_translation id, shorten_id
+        translation.shorten_id.upcase
+      end
+    end
+
+    def cache_size
+      @ids.size
+    end
+
+    private
+
+    def register_translation id, shorten_id
+      cleanup_translations
+      translation = IdTranslation.new(id, shorten_id, Time.now)
+      @ids[id] = translation
+      @shorten_ids[shorten_id] = translation
+    end
+
+    def generate_shorten_id
+      shorten_id = ""
+      @shorten_id_length.times do
+        shorten_id << CHAR_SET[rand(CHAR_SET.size)]
+      end
+      shorten_id
+    end
+
+    def cleanup_translations
+      return if cache_size < @max_cache_size
+      translations_to_delete = Array.wrap(@ids.values.sort{|x,y| y.used_at <=> x.used_at }[@max_cache_size-1..-1])
+      translations_to_delete.each do |translation|
+        @ids.delete(translation.id)
+        @shorten_ids.delete(translation.shorten_id)
+      end
+    end
+  end
+end

data/lib/zabbirc/irc/plugin.rb

@@ -33,7 +33,7 @@ module Zabbirc
 
       # ACK
       register_help "ack", "Acknowledges event with message. Usage: !ack <event-id> <ack-message>"
-      match /ack (\d+) (.*)/, method: :acknowledge_event
+      match /ack ([a-zA-Z0-9]+) (.*)/, method: :acknowledge_event
       match /(ack)\s*$/, method: :zabbirc_help_detail
       match /(ack) (?:[^ ]+)\s*$/, method: :zabbirc_help_detail
     end

data/lib/zabbirc/irc/plugin_methods.rb

@@ -220,12 +220,17 @@ module Zabbirc
         false
       end
 
-      def find_event m, eventid
+      def find_event m, short_eventid
         op = get_op m
         begin
+          eventid = Zabbirc.events_id_shortener.get_id short_eventid
+          unless eventid
+            m.reply "#{op.nick}: Bad event id `#{short_eventid}`"
+            return false
+          end
           event = Zabbix::Event.find(eventid, {selectHosts: :extend, selectRelatedObject: :extend})
           if event.nil?
-            m.reply "#{op.nick} Could not find event with id `#{eventid}`"
+            m.reply "#{op.nick} Could not find event with id `#{short_eventid}`"
             return false
           end
           event

data/lib/zabbirc/zabbix/event.rb

@@ -55,6 +55,10 @@ module Zabbirc
         end
       end
 
+      def shorten_id
+        @shorten_id ||= Zabbirc.events_id_shortener.get_shorten_id id
+      end
+
       alias_method :state, :value
 
       def message
@@ -67,7 +71,7 @@ module Zabbirc
       end
 
       def label
-        format_label "|%id| %time [%priority-code] %msg - %state"
+        format_label "|%sid| %time [%priority-code] %msg - %state"
       end
 
       def format_label fmt
@@ -76,6 +80,7 @@ module Zabbirc
             gsub("%time", "#{created_at.to_formatted_s(:short)}").
             gsub("%msg", "#{message}").
             gsub("%id", "#{id}").
+            gsub("%sid", "#{shorten_id}").
             gsub("%state", "#{state}")
       end
 

data/lib/zabbirc.rb

@@ -17,6 +17,10 @@ module Zabbirc
     @mutex ||= Mutex.new
     @mutex.synchronize &block
   end
+
+  def self.events_id_shortener
+    @events_id_shortener ||= IdShortener.new
+  end
 end
 
 require 'zabbirc/configuration'

data/spec/bot_spec.rb

@@ -20,8 +20,9 @@ describe Zabbirc::Irc::PluginMethods do
     end
 
     it "should acknowledge event" do
+      shorten_id = Zabbirc.events_id_shortener.get_shorten_id event.id
       expect(mock_message).to receive(:reply).with("#{mock_nick}: Event `#{event.label}` acknowledged with message: #{message}")
-      bot.acknowledge_event mock_message, event.id, message
+      bot.acknowledge_event mock_message, shorten_id, message
     end
   end
 

data/spec/id_shortener_spec.rb

@@ -0,0 +1,37 @@
+describe Zabbirc::IdShortener do
+  let(:cache_size) { 5 }
+  let(:shorten_id_length) { 3 }
+  let(:id_shortener) { Zabbirc::IdShortener.new(cache_size, shorten_id_length) }
+
+  it "should generate shorten id" do
+    shorten_id = id_shortener.get_shorten_id(1234)
+    expect(shorten_id).to be_instance_of(String)
+    expect(shorten_id.length).to eq(shorten_id_length)
+  end
+
+  let(:original_id) { 1234 }
+  context "retrieving original id" do
+    it "should retrieve original id" do
+      shorten_id = id_shortener.get_shorten_id(original_id)
+      id = id_shortener.get_id(shorten_id)
+      expect(id).to eq(original_id)
+    end
+
+    it "should be case insensitive" do
+      shorten_id = id_shortener.get_shorten_id(original_id)
+      id = id_shortener.get_id(shorten_id.downcase)
+      expect(id).to eq(original_id)
+    end
+  end
+
+
+  it "should clean cache" do
+    (cache_size*2).times do |i|
+      id_shortener.get_shorten_id(i)
+    end
+    expect(id_shortener.cache_size).to be <= cache_size
+    # ensures that cache is being cleand from the end (oldest used records)
+    ids = id_shortener.instance_variable_get(:@ids).keys
+    expect(ids).not_to include(1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbirc
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Filip Zachar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,6 +117,7 @@ files:
 - config/config.rb
 - lib/zabbirc.rb
 - lib/zabbirc/configuration.rb
+- lib/zabbirc/id_shortener.rb
 - lib/zabbirc/irc/help.rb
 - lib/zabbirc/irc/plugin.rb
 - lib/zabbirc/irc/plugin_methods.rb
@@ -139,6 +140,7 @@ files:
 - lib/zabbirc/zabbix/trigger.rb
 - lib/zabbirc/zabbix/user.rb
 - spec/bot_spec.rb
+- spec/id_shortener_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_bot.rb
 - templates/zabbirc_config.rb