agile_notifier 2.1.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c78f3a5bac969a0cc6f69d75d620318f6bcabedc
-  data.tar.gz: 3adf76eb73e16945b7f12d6f8cdc184aa09cc8b5
+  metadata.gz: c4d765e04744af371120ff8963b4435a5cded507
+  data.tar.gz: 3070c25de18589db4dde7e1154553c7911ebc036
 SHA512:
-  metadata.gz: 561aa816c522b782932f8aea9da5272bb939d2cac33f2b2ef37618b27dedd1e8f3742480dee1b4e6c89c1924d5c56694589a84ac20d7a8d874d07301ad2d29df
-  data.tar.gz: eda22362859b2828cd0e64f3b5e832443ad42da30317862461d7f6a760c47b945f8aec0e3c9365505afe2e74ed8f304cbe812fd0cd60af88892518570a099b5e
+  metadata.gz: 3848b5b30accf802fcd4e8ae8d93431852ffa3a9eeb87e671e04d5cef3af9b42a185bc3dca5d2c590a7e988410b9a7298521ffe1d4369ea15cb99b6588d001a3
+  data.tar.gz: 5570e0b772767c7c74a995b61e36089bb3c906283c6f294a0aa991b63717d988421eacf9c8860d239e5f79d3823e3e9266cfeea9041734f799a75d26bcd35598

data/README.md

@@ -13,7 +13,7 @@ The joy of this tool is that, whenever a build fails, it can blame whoever submi
 
 Have fun with it!
 
-## Examples of Usage:
+## Examples of Usage
 ```ruby
 AgileNotifier::Configuration.set do
   ci_url 'http://x.x.x.x:8080'
@@ -29,7 +29,7 @@ AgileNotifier::Configuration.set do
   scm_get 'Github', enterprise: true
 
   # for non-enterprise version
-  # scm_url 'https://api.github.com'
+  # scm_url 'https://github.com'
   # scm_repo user: 'your_user_name', repo: 'your_repository_name'
   # scm_get 'Github'
   
@@ -49,7 +49,23 @@ AgileNotifier::Configuration.set do
 end
 ```
 
-## Notes:
+## Deploy to CI
+First create a config file based on above DSL syntax.  (let's say the file name is [*your_own_config*].rb)
+### Jenkins
+* The **easy** way:
+  * Create [*The_Notification_Job*]
+    * Configure -> Build -> Execute shell:
+    * ```ruby [your_own_config].rb```
+  * Your Main Job
+    * Configure -> Add post-build action -> Build other projects -> Projects to build -> [*The_Notification_Job*]
+* The **hard** but **precise** way: (imagine there are a few developers pushing all the time, which makes your CI build one after one without rest)
+  * Create [The_Notification_Job]
+    * Configure -> Build -> Execute shell:
+    * ```ruby [your_own_config].rb -b $UPSTREAM_BUILD_NUMBER```
+  * Your Main Job
+    * Configure -> Add post-build action -> Trigger parameterized build on other projects -> Projects to build -> [*The_Notification_Job*] -> Add Parameters -> Predefined parameters -> ```UPSTREAM_BUILD_NUMBER=${BUILD_NUMBER}```
+
+## Notes
 * TTS (Text To Speech) on Linux used here has two dependencies:
 
   * TTS service benefits from online MARY TTS Web Client: http://mary.dfki.de:59125/  While it has limited languages support, please check before use.

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        = '2015-05-01'
+  s.date        = '2015-09-16'
   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.rb

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

data/lib/agile_notifier/ci.rb

@@ -6,12 +6,7 @@ module AgileNotifier
     include Servable
     alias_method :original_is_available?, :is_available?
 
-    attr_accessor :jobs
-
-    def initialize(url, *jobs)
-      @url = url
-      jobs.empty? ? @jobs = get_all_jobs : @jobs = jobs
-    end
+    attr_accessor :job
 
     def is_available?
       original_is_available?(@url)
@@ -21,41 +16,24 @@ module AgileNotifier
       raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
     end
 
-    def job
-      if @jobs.size == 1
-        return @jobs.first
-      else
-        raise('There are more than one job, please use method [jobs] instead of [job]')
-      end
-    end
-
     class Job
       attr_accessor :name, :url
-      attr_reader :last_build, :penultimate_build
+      attr_reader :current_build
 
-      def initialize(name, url)
+      def initialize(name, url, build_number = nil)
         @name = name
         @url = url
-        @last_build = get_last_build
-        @penultimate_build = get_penultimate_build
+        @current_build = build_number.nil? ? get_last_build : get_specific_build(build_number.to_i)
       end
-
-      def get_last_build
+      
+      def get_specific_build(build_number)
         raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
       end
 
-      def get_penultimate_build
+      def get_last_build
         raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
       end
 
-      def update_last_build
-        @last_build = get_last_build
-      end
-
-      def update_penultimate_build
-        @penultimate_build = get_penultimate_build
-      end
-
       class Build
         include Trackable
 
@@ -67,6 +45,10 @@ module AgileNotifier
           @result = get_result
           @revision = get_revision
         end
+        
+        def is_building?
+          raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+        end
 
         def get_result
           raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)

data/lib/agile_notifier/commander.rb

@@ -0,0 +1,21 @@
+require 'optparse'
+
+module AgileNotifier
+  class Commander
+    class << self
+      def order(args)
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{caller[-1].match(/\S+\.rb/)} [options]"
+          
+          opts.on('-b', '--build-number [BUILD_NUMBER]', OptionParser::DecimalInteger, 'Trigger by specific build') do |build_number|
+            options[:build_number] = build_number
+          end
+        end.parse!
+        options
+      end
+    end
+    
+    private_class_method :new
+  end
+end

data/lib/agile_notifier/configuration.rb

@@ -5,6 +5,8 @@ module AgileNotifier
     def initialize(&blk)
       @current_module = Object.const_get(self.class.to_s.split('::').first)
       @its_args = Hash.new
+      options = Commander.order(ARGV)
+      @build_number = options[:build_number]
       instance_eval(&blk)
     end
 
@@ -19,12 +21,11 @@ module AgileNotifier
     end
 
     def ci_job(job)
-      @ci_jobs ||= []
-      @ci_jobs.push(job)
+      @ci_job = job
     end
 
     def ci_get(ci_type)
-      @ci = @current_module.const_get(ci_type).new(@ci_url, *@ci_jobs)
+      @ci = @current_module.const_get(ci_type).new(@ci_url, @ci_job, @build_number)
     end
     
     def scm_url(url)
@@ -100,8 +101,9 @@ module AgileNotifier
       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, organize_args)
+      build = @ci.job.current_build
+      text = Composer.send(composer_method, repo: @scm.repository, revision: build.revision, language: @language)
+      Judger.send(judger_method, build, text, organize_args)
     end
 
     def alert_on_wip

data/lib/agile_notifier/github.rb

@@ -15,6 +15,7 @@ module AgileNotifier
 
     def initialize(url, args = {})
       super
+      @url.gsub!(/github\./, 'api.github.')
       basic_auth = args.fetch(:basic_auth, nil)
       access_token = args.fetch(:Authorization, nil)
       if basic_auth

data/lib/agile_notifier/jenkins.rb

@@ -14,18 +14,11 @@ module AgileNotifier
     def self.get_value(key, url)
       get_value_of_key(key, url.gsub(/\/$/, '') + JSON_API)
     end
-
-    def initialize(url, *names)
+    
+    def initialize(url, job_name, build_number = nil)
       @url = url
-      if names.empty?
-        @jobs = get_all_jobs
-      else
-        @jobs = []
-        names.each do |name|
-          job_url = URI.encode("#{@url}/job/#{name}/")
-          @jobs.push(Job.new(name, job_url))
-        end
-      end
+      job_url = URI.encode("#{@url}/job/#{job_name}/")
+      @job = Job.new(job_name, job_url, build_number)
     end
 
     def get_all_jobs
@@ -40,17 +33,21 @@ module AgileNotifier
     end
 
     class Job < CI::Job
+      def get_specific_build(build_number)
+        Build.new(build_number, @url + build_number.to_s + '/')
+      end
+      
       def get_last_build
         last_build = Jenkins.get_value('lastBuild', @url)
         last_build.nil? ? nil : Build.new(last_build['number'], last_build['url'])
       end
 
-      def get_penultimate_build
-        last_build.get_previous_build
-      end
-
       class Build < CI::Job::Build
         include Servable
+        
+        def is_building?
+          Jenkins.get_value('building', @url)
+        end
 
         def get_result
           result = Jenkins.get_value('result', @url)

data/lib/agile_notifier/judger.rb

@@ -30,6 +30,9 @@ module AgileNotifier
       def on_condition(condition, text, args)
         if condition
           TTS.speak(text, args)
+          puts '=' * 70
+          puts text
+          puts '=' * 70
           true
         else
           false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agile_notifier
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Jing Li
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -87,6 +87,7 @@ files:
 - agile_notifier.gemspec
 - lib/agile_notifier.rb
 - lib/agile_notifier/ci.rb
+- lib/agile_notifier/commander.rb
 - lib/agile_notifier/composer.rb
 - lib/agile_notifier/configuration.rb
 - lib/agile_notifier/git.rb