agile_notifier 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d6da02fafc819c407ab3abf1b53f40ab5c7fcd
+  data.tar.gz: 8248b6c72b97d94581e2142d174fe37fc65b7769
+SHA512:
+  metadata.gz: 401c943e96a5b85e53e95b615bd5128c996f7d026c99561f17e05948cca16baf3af427b48da755d3b94f6bff177ee53c720e5b4cd63efc43af8a0ba7b49f3c1b
+  data.tar.gz: f468cb62a61bc49b88f47f9d46e22540c929732e1fb0c7a0de4cd802bc1282bc128a251c944f4dd1daf8f0620bc905db725c36edb781ea2cbaefeb11bd1aa6f2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+#gemspec
+
+gem 'json'
+gem 'httparty'
+
+group :test do
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    json (1.8.0)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  json
+  mocha

data/README.md

@@ -0,0 +1,43 @@
+AgileNotifier
+=============
+
+Agile Notifier - an easy way of monitoring Agile SW Engineering by auralization change.  It supports most of the popular tools including **CI** (Continuous Integration), **SCM** (Source Control Management), and **ITS** (Issue Tracking System).  Of course you can integrate more tools as you want.  And the simple beautiful DSL syntax gives you a rocket start.
+
+In a modern agile team, members would like to be notified immediately once their Continuous Integration job fails (but building process usually takes quite a while).  That's the initial idea of this tool.
+
+The joy of this tool is that, whenever a build fails, it can blame whoever submitted the commit (or praises the committer who fixed it), in whatever language you want, and even the sentenses can be randomly chosen each time :)
+
+Have fun with it!
+
+## Examples of Usage:
+```ruby
+AgileNotifier::Configuration.set do
+  ci_url 'http://x.x.x.x:8080'
+  ci_job 'your-project-continuous-build'
+  ci_get 'Jenkins'
+
+  scm_url 'https://github.xyzcompany.com'
+  scm_repo user: 'your_user_name', repo: 'your_repository_name'
+  scm_get 'Github', enterprise: true
+
+  # for non-enterprise version
+  # scm_url 'https://api.github.com'
+  # scm_repo user: 'your_user_name', repo: 'your_repository_name'
+  # scm_get 'Github'
+
+  speak 'en'
+  play 'Boing' # Mac OSX TTS voice name(optional field), unnecessary for other OS
+
+  alert_on_fail
+  alert_on_fix
+end
+```
+
+## 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.
+  * 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
+```

data/Rakefile

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), *%w[lib])))
+require 'agile_notifier'
+
+task :default => :test
+
+require 'rake/testtask'
+desc 'Run Unit Test'
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/test*.rb']
+  test.verbose = true
+end

data/agile_notifier.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+$: << File.expand_path('../lib', __FILE__)
+require "agile_notifier"
+
+Gem::Specification.new do |s|
+  s.name        = 'agile_notifier'
+  s.version     = AgileNotifier::VERSION
+  s.license     = 'MIT'
+  s.date        = '2013-05-22'
+  s.summary     = %q{agile_notifier alerts you via making wonderful noises}
+  s.description = %q{agile_notifier alerts you via making wonderful noises, make software development more fun}
+  s.authors     = ['Jing Li']
+  s.email       = ['thyrlian@gmail.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage    = 'https://github.com/thyrlian/AgileNotifier'
+
+  s.add_runtime_dependency('json', '~> 1.8.0')
+  s.add_runtime_dependency('httparty', '~> 0.11.0')
+  s.add_development_dependency('mocha', '~> 0.14.0')
+end

data/lib/agile_notifier/ci.rb

@@ -0,0 +1,89 @@
+require_relative 'servable'
+require_relative 'trackable'
+
+module AgileNotifier
+  class CI
+    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
+
+    def is_available?
+      original_is_available?(@url)
+    end
+
+    def get_all_jobs
+      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
+
+      def initialize(name, url)
+        @name = name
+        @url = url
+        @last_build = get_last_build
+        @penultimate_build = get_penultimate_build
+      end
+
+      def get_last_build
+        raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+      end
+
+      def get_penultimate_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
+
+        attr_accessor :number, :url, :result, :revision
+
+        def initialize(number, url)
+          @number = number
+          @url = url
+          @result = get_result
+          @revision = get_revision
+        end
+
+        def get_result
+          raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+        end
+
+        def get_revision
+          raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+        end
+
+        def get_previous_build
+          raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+        end
+
+        def get_previous_result
+          raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+        end
+      end
+    end
+  end
+end

data/lib/agile_notifier/composer.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+module AgileNotifier
+  class Composer
+    SENTENCES_BLAME = {
+        de: [
+                "%{committer_name} hat den Build kaputt gemacht.",
+                "Schießt %{committer_name} mit der Nerf Gun ab!",
+                "%{committer_name} hat Scheiße gebaut.",
+                "%Hilfe! Hilfe! %{committer_name} versucht mich zu töten!"
+            ],
+        en: [
+                "%{committer_name} has broken the build.",
+                "%{committer_name} fucked up the build.",
+                "What the fucking code has %{committer_name} pushed!"
+            ],
+        es: [
+                "%{committer_name} ha destruido la compilacion",
+                "que clase de codigo esta escribiendo %{committer_name} ? ",
+                "tal vez es mejor que %{committer_name} se dedique a otra cosa..."
+            ],
+        zh: [
+                "%{committer_name}在搞毛啊, 构建失败了!",
+                "%{committer_name}提交的什么烂代码啊?",
+                "请注意, %{committer_name}在搞破坏."
+            ]
+    }
+
+    SENTENCES_PRAISE = {
+        de: [
+                "%{committer_name} hat den Build gefixt!",
+                "%{committer_name} ist ein Genie!",
+                "%{committer_name} hat die Welt gerettet!"
+            ],
+        en: [
+                "%{committer_name} has fixed the build.",
+                "%{committer_name} is super brilliant!",
+                "%{committer_name} saved the world.",
+                "%{committer_name} roundhouse kicked chuck norris' butt"
+            ],
+        es: [
+                "%{committer_name} ha reparado la compilacion",
+                "%{committer_name} es un genio!",
+                "%{committer_name} es el mejor programador de la historia!"
+            ],
+        zh: [
+                "%{committer_name}很厉害啊, 修复了构建.",
+                "%{committer_name}是个好同志, 该涨工资了.",
+                "%{committer_name}是当代活雷锋啊!"
+            ]
+    }
+
+    class << self
+      def blame_committer_of_a_commit(args)
+        committer_name = get_committer_name_of_a_commit(args)
+        blame_committer(committer_name, args[:language])
+      end
+
+      def praise_committer_of_a_commit(args)
+        committer_name = get_committer_name_of_a_commit(args)
+        praise_committer(committer_name, args[:language])
+      end
+
+      def get_committer_name_of_a_commit(args)
+        repo = args[:repo]
+        revision = args[:revision] || args[:build].revision
+        repo.get_committer_name_of_a_commit(revision)
+      end
+
+      def blame_committer(committer_name, language)
+        mention_committer(committer_name, SENTENCES_BLAME[language])
+      end
+
+      def praise_committer(committer_name, language)
+        mention_committer(committer_name, SENTENCES_PRAISE[language])
+      end
+
+      def mention_committer(committer_name, sentences)
+        sentence = random_picker(sentences)
+        sentence.gsub(/%\{committer_name\}/, committer_name)
+      end
+
+      def random_picker(list)
+        random_number = rand(list.size)
+        list[random_number]
+      end
+    end
+
+    private_class_method :get_committer_name_of_a_commit, :blame_committer, :praise_committer, :mention_committer, :random_picker
+  end
+end

data/lib/agile_notifier/configuration.rb

@@ -0,0 +1,82 @@
+require_relative '../agile_notifier'
+
+module AgileNotifier
+  class Configuration
+    def initialize(&blk)
+      @current_module = Object.const_get(self.class.to_s.split('::').first)
+      instance_eval(&blk)
+    end
+
+    class << self
+      def set(&blk)
+        new(&blk)
+      end
+    end
+
+    def ci_url(url)
+      @ci_url = url
+    end
+
+    def ci_job(job)
+      @ci_jobs ||= []
+      @ci_jobs.push(job)
+    end
+
+    def ci_get(ci_type)
+      @ci = @current_module.const_get(ci_type).new(@ci_url, *@ci_jobs)
+    end
+    
+    def scm_url(url)
+      @scm_url = url
+    end
+    
+    def scm_repo(repo)
+      @scm_repos ||= []
+      @scm_repos.push(repo)
+    end
+    
+    def scm_get(scm_type, args = {})
+      enterprise = args.fetch(:enterprise, false)
+      if enterprise
+        @scm = @current_module.const_get(scm_type).new_enterprise_version(@scm_url)
+      else
+        @scm = @current_module.const_get(scm_type).new(@scm_url)
+      end
+      @scm_repos.each do |repo|
+        @scm.add_repository(repo)
+      end
+      return @scm
+    end
+
+    def speak(language)
+      @language = language.to_s.downcase.intern
+    end
+
+    def play(voice)
+      @voice = voice
+    end
+
+    def alert_on_fail
+      alert(:blame, :fail)
+    end
+
+    def alert_on_fix
+      alert(:praise, :fix)
+    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)
+    end
+
+    private_class_method :new
+    private :alert
+  end
+end

data/lib/agile_notifier/git.rb

@@ -0,0 +1,38 @@
+require_relative 'scm'
+
+module AgileNotifier
+  class Git < SCM
+    attr_accessor :repo
+
+    def initialize(dir)
+      @repo = Repository.new(dir)
+    end
+
+    class << self
+      def combine_commands(*commands)
+        separator = ' && '
+        combined_commands = commands.inject('') do |cmds, cmd|
+          cmds += "#{cmd}#{separator}"
+        end
+        combined_commands.gsub!(/#{separator}$/, '')
+      end
+
+      def run_command(command)
+        `#{command}`
+      end
+    end
+
+    class Repository < SCM::Repository
+      def initialize(repo)
+        @repo = repo
+      end
+
+      def get_committer_of_a_commit(revision)
+        go_to_repo = "cd #{@repo}"
+        show_author_name = "git show #{revision} --pretty=format:%an | head -1"
+        cmd = Git.combine_commands(go_to_repo, show_author_name)
+        Git.run_command(cmd).chomp
+      end
+    end
+  end
+end

data/lib/agile_notifier/github.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'httparty'
+require_relative 'scm'
+require_relative 'response_helper'
+
+module AgileNotifier
+  class Github < SCM
+    extend ResponseHelper
+
+    ENTERPRISE_API = '/api/v3'
+    USERAGENT = 'AgileNotifier'
+
+    def initialize(url)
+      super
+      if url.include?(ENTERPRISE_API)
+        status_url = url + '/zen'
+        begin
+          status = HTTParty.get(status_url).code
+          availability = ( status == 200 )
+        rescue => e
+          puts e.message
+          availability = false
+        end
+      else
+        status_url = url.gsub(/:\/\/api\./, '://status.') + '/api/status.json'
+        status = self.class.get_value('status', status_url)
+        availability = ( status == 'good' )
+      end
+      raise('Github is not available.') unless availability
+    end
+
+    class << self
+      def new_enterprise_version(url)
+        new(url + ENTERPRISE_API)
+      end
+
+      def get_value(key, url)
+        get_value_of_key(key, url, :headers => {'User-Agent' => USERAGENT})
+      end
+    end
+
+    def add_repository(args)
+      user = args[:user]
+      repo = args[:repo]
+      repository = Repository.new(user: user, repo: repo, url: @url)
+      @repositories.push(repository)
+    end
+
+    class Repository < SCM::Repository
+      def get_committer_name_of_a_commit(revision)
+        url = @url + "/repos/#{@user}/#{@repo}/git/commits/#{revision}"
+        committer = Github.get_value('committer', url)
+        committer['name']
+      end
+    end
+  end
+end

data/lib/agile_notifier/its.rb

@@ -0,0 +1,19 @@
+module AgileNotifier
+  class ITS
+    def initialize(url)
+      @url = url
+    end
+
+    class Project
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    class Issue
+      def initialize(id)
+        @id = id
+      end
+    end
+  end
+end

data/lib/agile_notifier/jenkins.rb

@@ -0,0 +1,99 @@
+require 'uri'
+require 'json'
+require 'httparty'
+require_relative 'ci'
+require_relative 'response_helper'
+
+module AgileNotifier
+  class Jenkins < CI
+    extend ResponseHelper
+
+    JSON_API = '/api/json'
+
+    def self.get_value(key, url)
+      get_value_of_key(key, url.gsub(/\/$/, '') + JSON_API)
+    end
+
+    def initialize(url, *names)
+      @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
+    end
+
+    def get_all_jobs
+      jobs = self.class.get_value('jobs', @url)
+      if jobs.nil?
+        return nil
+      else
+        jobs.inject([]) do |all_jobs, job|
+          all_jobs.push(Job.new(job['name'], job['url']))
+        end
+      end
+    end
+
+    class Job < CI::Job
+      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 get_result
+          result = Jenkins.get_value('result', @url)
+          result.nil? ? nil : result
+        end
+
+        def get_revision
+          revision = Jenkins.get_value('lastBuiltRevision', @url)
+          revision.nil? ? nil : revision['SHA1']
+        end
+
+        def get_previous_build
+          previous_number = @number - 1
+          while previous_number > 0
+            previous_url = @url.gsub(/\/#{@number}\//, "/#{previous_number}/")
+            if is_available?(previous_url)
+              return Build.new(previous_number, previous_url)
+            else
+              previous_number -= 1
+            end
+          end
+          return nil
+        end
+
+        def get_previous_result
+          get_previous_build.get_result
+        end
+
+        def passed?
+          @result == 'SUCCESS'
+        end
+
+        def failed?
+          @result == 'FAILURE'
+        end
+
+        def fixed?
+          if get_previous_result == 'FAILURE'
+            return passed?
+          else
+            return nil # if previous result is SUCCESS, doesn't make sense, then return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/agile_notifier/jira.rb

@@ -0,0 +1,7 @@
+require_relative 'its'
+
+module AgileNotifier
+  class Jira < ITS
+    
+  end
+end

data/lib/agile_notifier/judger.rb

@@ -0,0 +1,30 @@
+require_relative 'tts'
+
+module AgileNotifier
+  class Judger
+    class << self
+      def on_fail(trackable, text, args)
+        on_condition(trackable.failed?, text, args)
+      end
+
+      def on_pass(trackable, text, args)
+        on_condition(trackable.passed?, text, args)
+      end
+
+      def on_fix(trackable, text, args)
+        on_condition(trackable.fixed?, text, args)
+      end
+
+      def on_condition(condition, text, args)
+        if condition
+          TTS.speak(text, args)
+          true
+        else
+          false
+        end
+      end
+    end
+
+    private_class_method :on_condition
+  end
+end

data/lib/agile_notifier/operating_system.rb

@@ -0,0 +1,37 @@
+module AgileNotifier
+  class OperatingSystem
+    TYPE = {
+        lin: 'linux',
+        mac: 'osx',
+        win: 'windows',
+        unknown: 'UNKNOWN'
+    }
+
+    class << self
+      def is_linux?
+        match_os(/linux/)
+      end
+
+      def is_mac?
+        match_os(/darwin/)
+      end
+
+      def is_windows?
+        match_os(/mswin|mingw|cygwin|bccwin|wince|emx/)
+      end
+
+      def match_os(regex)
+        !!RUBY_PLATFORM.match(regex)
+      end
+
+      def what
+        return TYPE[:lin] if is_linux?
+        return TYPE[:mac] if is_mac?
+        return TYPE[:win] if is_windows?
+        return TYPE[:unknown]
+      end
+    end
+
+    private_class_method :new, :match_os
+  end
+end

data/lib/agile_notifier/player.rb

@@ -0,0 +1,20 @@
+module AgileNotifier
+  class Player
+    class << self
+      def play_on_linux(file)
+        # play command comes from sox package, not pre-installed
+        system("play #{file}")
+      end
+
+      def play_on_osx(file)
+        system("afplay #{file}")
+      end
+
+      def play_on_windows(file)
+        raise(NotImplementedError, "Method [#{__method__}] is empty, please implement", caller)
+      end
+    end
+
+    private_class_method :new
+  end
+end

data/lib/agile_notifier/response_helper.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'httparty'
+
+module AgileNotifier
+  class ResponseError < StandardError
+  end
+
+  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))
+    end
+
+    class PrivateMethods
+      def get_json_response(*args)
+        response = HTTParty.get(*args)
+        if response.code == 200
+          return JSON.parse(response.body)
+        else
+          raise(ResponseError, "HTTP Status Code: #{response.code} - #{response.parsed_response}", caller)
+        end
+      end
+
+      def get_value_of_key_from_json(key, collection) # only returns the first match if duplicated keys exist
+        if collection.respond_to?(:each_pair) # behaves like Hash
+          return collection[key] if collection.has_key?(key)
+          collection.keys.each do |k|
+            value = send(__method__, key, collection[k]) # recursive call
+            return value if !value.nil?
+          end
+        elsif collection.respond_to?(:each_index) # behaves like Array
+          collection.each do |x|
+            value = send(__method__, key, x) # recursive call
+            return value if !value.nil?
+          end
+        end
+        return nil
+      end
+    end
+  end
+end

data/lib/agile_notifier/scm.rb

@@ -0,0 +1,40 @@
+module AgileNotifier
+  class SCM
+    attr_accessor :url, :repositories
+
+    def initialize(url)
+      @url = url
+      @repositories = []
+    end
+
+    def add_repository(repository)
+      @repositories.push(repository)
+    end
+
+    def repository
+      if @repositories.size == 1
+        return @repositories.first
+      else
+        raise('There are more than one repository, please use method [repositories] instead of [repository]')
+      end
+    end
+
+    class Repository
+      attr_accessor :user, :repo, :url
+
+      def initialize(args)
+        @user = args[:user]
+        @repo = args[:repo]
+        @url = args[:url]
+      end
+
+      def get_commit(revision)
+        raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+      end
+
+      def get_committer_of_a_commit(revision)
+        raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+      end
+    end
+  end
+end

data/lib/agile_notifier/servable.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+
+module AgileNotifier
+  module Servable
+    class PrivateMethods
+      def is_https_request?(url)
+        regex = /https:\/\//
+        regex.match(url) ? true : false
+      end
+
+      def is_http_server_available?(url)
+        uri = URI(url)
+        begin
+          res = Net::HTTP.get_response(uri)
+        rescue Errno::ECONNREFUSED # server shutdown
+          return false
+        end
+        return is_response_ok?(res)
+      end
+
+      def is_https_server_available?(url)
+        uri = URI(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        req = Net::HTTP::Get.new(uri.request_uri)
+        begin
+          res = http.request(req)
+        rescue
+          return false
+        end
+        return is_response_ok?(res)
+      end
+
+      def is_response_ok?(res)
+        status_code = res.code.to_i
+        if status_code == 200
+          return true
+        else # e.g. 503 (Service Unavailable)
+          return false
+        end
+      end
+    end
+
+    def is_available?(url)
+      pm = PrivateMethods.new
+      pm.instance_eval do
+        if is_https_request?(url)
+          return is_https_server_available?(url)
+        else
+          return is_http_server_available?(url)
+        end
+      end
+    end
+  end
+end

data/lib/agile_notifier/trackable.rb

@@ -0,0 +1,15 @@
+module AgileNotifier
+  module Trackable
+    def failed?
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+    end
+
+    def passed?
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+    end
+
+    def fixed?
+      raise(NotImplementedError, "Abstract method [#{__method__}] is called, please implement", caller)
+    end
+  end
+end

data/lib/agile_notifier/tts.rb

@@ -0,0 +1,112 @@
+require 'uri'
+require 'open-uri'
+require_relative 'operating_system'
+require_relative 'player'
+
+module AgileNotifier
+  class TTS
+    class << self
+      def speak(text, args)
+        os_type = get_os_type
+        service = "speak_on_#{os_type}"
+        language = args[:language]
+        voice = args[:voice]
+        Service.send(service.intern, text, language, voice)
+      end
+
+      def get_os_type
+        OperatingSystem.what
+      end
+    end
+
+    class Service
+      @@temp_file = File.dirname(__FILE__) + '/temp_tts'
+
+      class << self
+        def download_file(url, file = @@temp_file)
+          open(url) do |remote_file|
+            data = remote_file.read
+            File.open(file, 'wb') do |local_file|
+              local_file.write(data)
+            end
+          end
+        end
+
+        def remove_file(file = @@temp_file)
+          File.delete(file)
+        end
+
+        def play(url)
+          download_file(url)
+          os_type = get_os_type
+          player = "play_on_#{os_type}"
+          Player.send(player.intern, @@temp_file)
+          remove_file
+        end
+
+        def replace_punctuation_by_space(text)
+          text.gsub(/[[:punct:]](\s+)*/, ' ').gsub(/\s$/, '')
+        end
+
+        def encode_www_form(text)
+          URI.encode_www_form('' => text)[1..-1]
+        end
+
+        def encode_www_form_and_remove_punctuation(text)
+          encode_www_form(replace_punctuation_by_space(text))
+        end
+
+        def speak_on_linux(text, language, voice = nil)
+          # TODO: should check service availability first, if not raise exception
+          mary_tts(text, language)
+        end
+
+        def speak_on_osx(text, language, voice)
+          if voice
+            unless osx_speech(voice, text)
+              raise("No available voice found, please check if you have downloaded voice [#{voice}] in System Preferences -> Speech")
+            end
+          else
+            list_of_available_voices = `say -v '?'`.split("\n")
+            voices = list_of_available_voices.inject({}) do |collection, record|
+              matched_results = record.match(/^(.*[^\s])\s+([a-z]{2})_[A-Z]{2}\s+/)
+              available_language = matched_results[2].downcase.intern
+              available_voice = matched_results[1]
+              if collection.has_key?(available_language)
+                collection[available_language] << available_voice
+              else
+                collection[available_language] = [available_voice]
+              end
+              collection
+            end
+            osx_speech(voices[language].first, text)
+          end
+        end
+
+        def speak_on_windows(text, language, voice = nil)
+          raise(NotImplementedError, "Method [#{__method__}] is empty, please implement", caller)
+        end
+
+        def osx_speech(voice, text)
+          system("say -v #{voice} #{text} > /dev/null 2>&1")
+        end
+
+        def tts_api(text)
+          url = 'http://tts-api.com/tts.mp3?q='
+          play(url + encode_www_form_and_remove_punctuation(text))
+        end
+
+        def mary_tts(text, language)
+          url = 'http://mary.dfki.de:59125/'
+          text = encode_www_form_and_remove_punctuation(text)
+          audio_format = 'WAVE_FILE'
+          play(url + "process?INPUT_TEXT=#{text}&INPUT_TYPE=TEXT&OUTPUT_TYPE=AUDIO&LOCALE=#{language}&AUDIO=#{audio_format}")
+        end
+      end
+
+      private_class_method :download_file, :remove_file, :play, :replace_punctuation_by_space, :encode_www_form, :encode_www_form_and_remove_punctuation, :osx_speech
+    end
+
+    private_class_method :new, :get_os_type
+  end
+end

data/lib/agile_notifier.rb

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

data/test/ext/module.rb

@@ -0,0 +1,22 @@
+class Module
+  def backup_const(name)
+    redef_const(:TEMP_BACKUP, const_get(name))
+  end
+
+  def restore_const(name)
+    redef_const(name, const_get(:TEMP_BACKUP))
+    remove_const(:TEMP_BACKUP)
+  end
+
+  def redef_const(name, value)
+    remove_const(name) if const_defined?(name)
+    const_set(name, value)
+  end
+
+  def stub_const_and_test(const_name, const_value, &test_blk)
+    backup_const(const_name)
+    redef_const(const_name, const_value)
+    test_blk.call
+    restore_const(const_name)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), *%w[.. lib agile_notifier])))
+require 'agile_notifier'
+require 'test/unit'
+require 'mocha/setup'
+
+include AgileNotifier

data/test/test_operating_system.rb

@@ -0,0 +1,16 @@
+require_relative 'helper'
+require_relative 'ext/module'
+
+class TestOperatingSystem < Test::Unit::TestCase
+  def test_is_mac?
+    Object.stub_const_and_test(:RUBY_PLATFORM, 'x86_64-darwin11.2.0') { assert_equal(true, OperatingSystem.is_mac?) }
+  end
+
+  def test_is_linux?
+    Object.stub_const_and_test(:RUBY_PLATFORM, 'x86_64-linux') { assert_equal(true, OperatingSystem.is_linux?) }
+  end
+
+  def test_is_windows?
+    Object.stub_const_and_test(:RUBY_PLATFORM, 'i386-mingw32') { assert_equal(true, OperatingSystem.is_windows?) }
+  end
+end

data/test/test_response_helper.rb

@@ -0,0 +1,17 @@
+require_relative 'helper'
+
+class TestResponseHelper < Test::Unit::TestCase
+  def setup
+    @pm = ResponseHelper::PrivateMethods.new
+  end
+  
+  def test_get_value_of_key_from_json
+    json = {'actions' => [{}, {}, {'buildsByBranchName' => {'origin/master' => {'buildNumber' => 3, 'revision' => {'SHA1' => '08a2be82ba83c1e89e01f698a30203fb0284aa33', 'branch' => [{'SHA1' => '4eac3c2c5b8f2daddeaa37926e7c1f55cd756f1f', 'name' => 'origin/master'}, {'SHA1' => '08a2be82ba83c1e89e01f698a30203fb0284aa33', 'name' => 'origin/HEAD'}]}}}}], 'description' => 'just a test', 'displayName' => 'Test Project', 'url' => 'http://localhost:8080/job/Test%20Project/', 'builds' => [{'number' => 3, 'url' => 'http://localhost:8080/job/Test%20Project/3/'}, {'number' => 2, 'url' => 'http://localhost:8080/job/Test%20Project/2/'}, {'number' => 1, 'url' => 'http://localhost:8080/job/Test%20Project/1/'}], 'lastFailedBuild' => {'number' => 2, 'url' => 'http://localhost:8080/job/Test%20Project/2/'}, 'lastSuccessfulBuild' => {'number' => 3, 'url' => 'http://localhost:8080/job/Test%20Project/3/'}}
+    assert_equal('origin/master', @pm.get_value_of_key_from_json('name', json)) # find first occurrence
+    assert_equal('08a2be82ba83c1e89e01f698a30203fb0284aa33', @pm.get_value_of_key_from_json('SHA1', json)) # find first occurrence
+    assert_equal(3, @pm.get_value_of_key_from_json('number', json)) # find first occurrence
+    assert_equal('Test Project', @pm.get_value_of_key_from_json('displayName', json))
+    assert_equal('http://localhost:8080/job/Test%20Project/3/', @pm.get_value_of_key_from_json('lastSuccessfulBuild', json)['url'])
+    assert_equal(nil, @pm.get_value_of_key_from_json('sexyGirl', json)) # nonexistent key should return nil
+  end
+end

data/test/test_servable.rb

@@ -0,0 +1,15 @@
+require_relative 'helper'
+
+class TestServable < Test::Unit::TestCase
+  def setup
+    @obj = Servable::PrivateMethods.new
+  end
+  
+  def test_is_https_request
+    assert_equal(true, @obj.is_https_request?('https://example.com/'))
+  end
+  
+  def test_is_not_https_request
+    assert_equal(false, @obj.is_https_request?('http://example.com/'))
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: agile_notifier
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Jing Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: agile_notifier alerts you via making wonderful noises, make software
+  development more fun
+email:
+- thyrlian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- agile_notifier.gemspec
+- lib/agile_notifier.rb
+- lib/agile_notifier/ci.rb
+- lib/agile_notifier/composer.rb
+- lib/agile_notifier/configuration.rb
+- lib/agile_notifier/git.rb
+- lib/agile_notifier/github.rb
+- lib/agile_notifier/its.rb
+- lib/agile_notifier/jenkins.rb
+- lib/agile_notifier/jira.rb
+- lib/agile_notifier/judger.rb
+- lib/agile_notifier/operating_system.rb
+- lib/agile_notifier/player.rb
+- lib/agile_notifier/response_helper.rb
+- lib/agile_notifier/scm.rb
+- lib/agile_notifier/servable.rb
+- lib/agile_notifier/trackable.rb
+- lib/agile_notifier/tts.rb
+- test/ext/module.rb
+- test/helper.rb
+- test/test_operating_system.rb
+- test/test_response_helper.rb
+- test/test_servable.rb
+homepage: https://github.com/thyrlian/AgileNotifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.4
+signing_key: 
+specification_version: 4
+summary: agile_notifier alerts you via making wonderful noises
+test_files:
+- test/ext/module.rb
+- test/helper.rb
+- test/test_operating_system.rb
+- test/test_response_helper.rb
+- test/test_servable.rb