agile_notifier 1.1.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41aec86572fd574612c90eeaff7b250a38747428
-  data.tar.gz: ff763fd1bfaddd9ec1e846edcd8d33b1bc8f1822
+  metadata.gz: 381bca60d1cdcef7b0e28496244aa7213c097821
+  data.tar.gz: 7dc6ba3581331d1287e11ef0591d81f74d3e1a72
 SHA512:
-  metadata.gz: a4edb8f07f0afcac32d63b945472b2706db8716a2aa4995c77d7082961a5cc4457d0832dc7fc56e7993bb8c4e80b20870071d5d1aec61e839a420546570441a4
-  data.tar.gz: 2f63fb2a3d1a039de45045b93ba6d75b2d6294785185158d148ac8407bf39bff8006e126e56487316fc7cec031aafc6cc5164830ed62d63b3adf9e4885aed564
+  metadata.gz: 14097412a80312dcfadb891f78e9c24da4105a177f5e5145e84acb5b74aa101945da21f572d1396da69228b55e04783d982fdc25bb678ec35ea0b9a32e2114d8
+  data.tar.gz: 1b12fb78c97282349b18065f615d0924d3f67e5413987bc074d347353b176db1c2883016cef054520d5795c0acd3bb1926a86b1c841c2e426fcbacbbcc1cdded

data/.gitignore

@@ -0,0 +1 @@
+.idea/

data/README.md

@@ -31,6 +31,17 @@ AgileNotifier::Configuration.set do
   alert_on_fail
   alert_on_fix
   alert_on_unstable
+  
+  its_url 'https://jira.atlassian.com'
+  its_auth 'jira_username', 'jira_password'
+  its_get 'Jira'
+  its_set_wip 'BAM', 'project = BAM AND status = Resolved AND resolution = Unresolved', 3
+  its_set_wip 'XXX', 'project = XXX AND status = Resolved AND resolution = Unresolved', 5
+  
+  speak 'en'
+  play 'Alex'
+  
+  alert_on_wip
 end
 ```
 
@@ -39,6 +50,4 @@ end
 
   * TTS service benefits from online MARY TTS Web Client: http://mary.dfki.de:59125/  While it has limited languages support, please check before use.
   * play command comes from package sox which is not pre-installed, you have to install manually beforehand by:
-  * ```
-sudo apt-get install sox libsox-fmt-all
-```
+  * ```sudo apt-get install sox libsox-fmt-all```

data/agile_notifier.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = 'agile_notifier'
   s.version     = AgileNotifier::VERSION
   s.license     = 'MIT'
-  s.date        = '2014-05-06'
+  s.date        = '2014-08-25'
   s.summary     = %q{agile_notifier alerts you via making wonderful noises when your Continuous Integration status changes.}
   s.description = %q{agile_notifier alerts you via making wonderful noises when your Continuous Integration status changes.  It totally makes software development more agile and more fun.}
   s.authors     = ['Jing Li']

data/lib/agile_notifier/composer.rb

@@ -2,7 +2,7 @@
 
 module AgileNotifier
   class Composer
-    SENTENCES_BLAME = {
+    SENTENCES_BLAME_COMMITTER = {
       de: [
         "%{committer_name} hat den Build kaputt gemacht.",
         "Schießt %{committer_name} mit der Nerf Gun ab!",
@@ -26,7 +26,7 @@ module AgileNotifier
       ]
     }
     
-    SENTENCES_WARN = {
+    SENTENCES_WARN_COMMITTER = {
       de: [
         "%{committer_name} hat den Build krank gemacht.",
         "%{committer_name} hat etwas nicht gut genug gemacht."
@@ -45,7 +45,7 @@ module AgileNotifier
       ]
     }
 
-    SENTENCES_PRAISE = {
+    SENTENCES_PRAISE_COMMITTER = {
       de: [
         "%{committer_name} hat den Build gefixt!",
         "%{committer_name} ist ein Genie!",
@@ -69,7 +69,34 @@ module AgileNotifier
       ]
     }
 
+    SENTENCES_WARN_WIP_LIMIT = {
+        de: [
+            "Kanban WIP übersteigt das Limit.",
+            "Kanban hat einen Flaschenhals.",
+            "Kanban hat zu viele Tickets, arbeitet jemand schon daran?"
+        ],
+        en: [
+            "Kanban WIP exceeds limit.",
+            "Kanban has hit a bottleneck.",
+            "Kanban has stacked too many items, is anyone working on it?"
+        ],
+        es: [
+            "El limite de WIP ha sido excedido.",
+            "El Kanban se esta llenando mucho.",
+            "Hay demasiados elementos Kanban, alguien esta trabajando en el?"
+        ],
+        zh: [
+            "看板瓶颈上限超出",
+            "搞什么呢? 看板堆积太多工作了, 想被炒鱿鱼吗?",
+            "看板, 嘟嘟, 请注意. 看板, 嘟嘟, 请注意."
+        ]
+    }
+
     class << self
+      def warn_wip_limit(args)
+        random_picker(SENTENCES_WARN_WIP_LIMIT[args[:language]])
+      end
+
       def blame_committer_of_a_commit(args)
         committer_name = get_committer_name_of_a_commit(args)
         blame_committer(committer_name, args[:language])
@@ -92,15 +119,15 @@ module AgileNotifier
       end
 
       def blame_committer(committer_name, language)
-        mention_committer(committer_name, SENTENCES_BLAME[language])
+        mention_committer(committer_name, SENTENCES_BLAME_COMMITTER[language])
       end
       
       def warn_committer(committer_name, language)
-        mention_committer(committer_name, SENTENCES_WARN[language])
+        mention_committer(committer_name, SENTENCES_WARN_COMMITTER[language])
       end
 
       def praise_committer(committer_name, language)
-        mention_committer(committer_name, SENTENCES_PRAISE[language])
+        mention_committer(committer_name, SENTENCES_PRAISE_COMMITTER[language])
       end
 
       def mention_committer(committer_name, sentences)
@@ -114,6 +141,6 @@ module AgileNotifier
       end
     end
 
-    private_class_method :get_committer_name_of_a_commit, :blame_committer, :praise_committer, :mention_committer, :random_picker
+    private_class_method :get_committer_name_of_a_commit, :blame_committer, :warn_committer, :praise_committer, :mention_committer, :random_picker
   end
 end

data/lib/agile_notifier/configuration.rb

@@ -4,6 +4,7 @@ module AgileNotifier
   class Configuration
     def initialize(&blk)
       @current_module = Object.const_get(self.class.to_s.split('::').first)
+      @its_args = Hash.new
       instance_eval(&blk)
     end
 
@@ -48,6 +49,22 @@ module AgileNotifier
       return @scm
     end
 
+    def its_url(url)
+      @its_args[:url] = url
+    end
+
+    def its_auth(username, password)
+      @its_args.merge!(:username => username, :password => password)
+    end
+
+    def its_get(its_type)
+      @its = @current_module.const_get(its_type).new(@its_args)
+    end
+
+    def its_set_wip(project, query, limit)
+      @its.set_limit(project, query, limit)
+    end
+
     def speak(language)
       @language = language.to_s.downcase.intern
     end
@@ -69,18 +86,26 @@ module AgileNotifier
     end
 
     def alert(composer_type, judger_type)
-      args = Hash.new
-      args[:language] = @language
-      args[:voice] = @voice if @voice
       composer_type = composer_type.to_s.downcase
       judger_type = judger_type.to_s.downcase
       composer_method = "#{composer_type}_committer_of_a_commit".intern
       judger_method = "on_#{judger_type}".intern
       text = Composer.send(composer_method, repo: @scm.repository, revision: @ci.job.last_build.revision, language: @language)
-      Judger.send(judger_method, @ci.job.last_build, text, args)
+      Judger.send(judger_method, @ci.job.last_build, text, organize_args)
+    end
+
+    def alert_on_wip
+      Judger.on_limit(@its, organize_args)
+    end
+
+    def organize_args
+      args = Hash.new
+      args[:language] = @language
+      args[:voice] = @voice if @voice
+      args
     end
 
     private_class_method :new
-    private :alert
+    private :alert, :organize_args
   end
 end

data/lib/agile_notifier/its.rb

@@ -1,19 +1,21 @@
 module AgileNotifier
   class ITS
-    def initialize(url)
-      @url = url
+    include Servable
+
+    def initialize(args)
+      @url = args.fetch(:url)
+    end
+
+    def query_amount_of_tickets(query)
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
     end
 
-    class Project
-      def initialize(name)
-        @name = name
-      end
+    def set_limit(project, query, limit)
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
     end
 
-    class Issue
-      def initialize(id)
-        @id = id
-      end
+    def exceeds_limit?
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
     end
   end
 end

data/lib/agile_notifier/jira.rb

@@ -1,7 +1,49 @@
 require_relative 'its'
+require_relative 'response_helper'
 
 module AgileNotifier
   class Jira < ITS
-    
+    include ResponseHelper
+
+    alias_method :original_is_available?, :is_available?
+
+    API_VERSION_URL = '/rest/api/latest/'
+    USERAGENT = 'AgileNotifier'
+
+    def initialize(args)
+      @url = args.fetch(:url).gsub(/\/$/, '') + API_VERSION_URL
+      @username = args.fetch(:username)
+      @password = args.fetch(:password)
+      @wip = Hash.new
+    end
+
+    def is_available?
+      original_is_available?(@url + 'serverInfo')
+    end
+
+    def query_amount_of_tickets(jql)
+      get_value('total', jql)
+    end
+
+    def set_limit(project, query, limit)
+      @wip[project] = {:query => query, :limit => limit}
+    end
+
+    def exceeds_limit?
+      @wip.inject({}) do |result, (key, value)|
+        result.merge({key => query_amount_of_tickets(value[:query]) > value[:limit]})
+      end
+    end
+
+    def get_value(key, jql, max = 1)
+      get_value_of_key(key,
+                       @url + 'search',
+                       :method => :post,
+                       :headers => {'Content-Type' => 'application/json', 'User-Agent' => USERAGENT},
+                       :basic_auth => {:username => @username, :password => @password},
+                       :body => {'jql' => jql, 'maxResults' => max}.to_json)
+    end
+
+    private :get_value
   end
 end

data/lib/agile_notifier/judger.rb

@@ -1,4 +1,5 @@
 require_relative 'tts'
+require_relative 'composer'
 
 module AgileNotifier
   class Judger
@@ -19,6 +20,13 @@ module AgileNotifier
         on_condition(trackable.fixed?, text, args)
       end
 
+      def on_limit(its, args)
+        its.exceeds_limit?.each do |key, value|
+          on_condition(value, "#{key} #{Composer.warn_wip_limit(args)}", args)
+          sleep 1.5 if value
+        end
+      end
+
       def on_condition(condition, text, args)
         if condition
           TTS.speak(text, args)

data/lib/agile_notifier/response_helper.rb

@@ -8,16 +8,22 @@ module AgileNotifier
   module ResponseHelper
     def get_value_of_key(key, *args)
       pm = PrivateMethods.new
-      pm.get_value_of_key_from_json(key, pm.get_json_response(*args))
+      pm.get_value_of_key_from_json(key, pm.request_json_response(*args))
     end
 
     class PrivateMethods
-      def get_json_response(*args)
-        response = HTTParty.get(*args)
-        if response.code == 200
-          return JSON.parse(response.body)
+      def request_json_response(*args)
+        method = ((args[1].respond_to?(:delete) ? args[1].delete(:method) : false) || :get).to_sym
+        supported_methods = [:get, :post, :put, :delete, :head, :options]
+        unless supported_methods.include?(method)
+          raise(RuntimeError, "Unsupported HTTP Method: #{method.to_s}", caller)
         else
-          raise(ResponseError, "HTTP Status Code: #{response.code} - #{response.parsed_response}", caller)
+          response = HTTParty.send(method, *args)
+          if response.code.to_s.match(/^2\d{2}$/)
+            return JSON.parse(response.body)
+          else
+            raise(ResponseError, "HTTP Status Code: #{response.code} - #{response.parsed_response}", caller)
+          end
         end
       end
 

data/lib/agile_notifier.rb

@@ -1,5 +1,5 @@
 Dir[(File.expand_path(File.dirname(__FILE__)) + "/agile_notifier/*.rb")].each { |file| require file }
 
 module AgileNotifier
-  VERSION = '1.1.1'
+  VERSION = '2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agile_notifier
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '2.0'
 platform: ruby
 authors:
 - Jing Li
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -79,6 +79,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - README.md