git-check-ci 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    git-check-ci (0.1.0)
+      daemons
+      httparty
+      json
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    daemons (1.1.8)
+    diff-lcs (1.1.3)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    json (1.7.3)
+    method_source (0.7.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    pry-doc (0.4.2)
+      pry (>= 0.9.0)
+      yard (~> 0.8.1)
+    pry-nav (0.2.1)
+      pry (~> 0.9.9)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    ruby-prof (0.10.8)
+    slop (2.4.4)
+    thor (0.15.3)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  git-check-ci!
+  pry
+  pry-doc
+  pry-nav
+  rake
+  rspec
+  ruby-prof

data/README.md

@@ -0,0 +1,83 @@
+## git-check-ci
+
+Display your continuous integration status in your prompt!
+This tool helps you decorate your command line with `✗` for failed builds and `✔` for successful builds.
+
+It assumes you're running a CI server that responds to a `/:project/ping` endpoint with status 200 on build successes.
+
+### Installing
+
+As simple as it gets:
+
+    gem install git-check-ci
+
+
+### Configuring
+
+Go to a Git clone of the project you've placed under CI:
+
+    $ cd <my-repository>
+
+Run the setup command:
+    
+    $ git check-ci setup
+    
+    What is the URL of your CI server? [currently unset]
+    > http://my-integrity-server:port
+    
+    What is the name of the project you're checking? [currently unset] 
+    > integrity-project-name
+    
+    If the server requires a login, what should I use? [currently unset]
+    > john.mcfoo
+    
+    with which passphrase? [currently unset]
+    
+    Setup is now complete. Doing a test run.
+    All good! Now the 'check' and 'fast-check' commands should work.
+
+Add it to your prompt:
+    
+    --- add me to e.g. ~/.profile ---
+    eval "$(git check-ci init)"
+    export PS1="\$(GitCheckCI) \u\$"
+
+Reload your shell:
+
+    $ exec $SHELL -l
+
+You're done! You should see the following while it's starting up:
+
+    ? mezis$
+
+And after hitting return a few times, assuming your build is broken:
+
+    ✗ mezis$
+
+It's red... Time to make it green and refactor!
+Happy coding!
+
+
+### Status icons
+
+This tool will show:
+
+- nothing when not in a Git repository.
+- `✗` for failed builds.
+- `✔` for successful builds.
+- `●` when the latest build is pending or in progress.
+- `?` if the configuration is incomplete, or the check service is starting up.
+- `!` on failures (properly configured but checking failed).
+
+
+### Behind the scenes
+
+The `GitCheckCI` shell helper does two things:
+
+- it spawns a checking service with `git check-ci server_start`
+- it returns the contents of the `ci.status` Git configuration variable
+
+The spawned server check the CI status over HTTP every minute and stores the response in the Git configuration (used as an IPC of sorts).
+
+It's done that way because `GitCheckCI` needs to be really, really fast---anything slower than 30ms will make your prompt feel unresponsive.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/git-check-ci

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#
+# Check the status of the CI server, and print a block coloured accordingly.
+# Add me to your prompt!
+#
+require 'git-check-ci/shell'
+GitCheckCI::Shell.start

data/git-check-ci.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/git-check-ci/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "git-check-ci"
+  s.version       = GitCheckCI::VERSION
+  s.platform      = Gem::Platform::RUBY
+
+  s.authors       = ["Julien Letessier"]
+  s.email         = ["julien.letessier@gmail.com"]
+  s.description   = %q{Check CI status of the local project}
+  s.summary       = %q{
+    Provides git-check-ci, which can display textual or graphic status
+    feedback based on a CI server's results.
+  }
+  s.homepage      = "http://github.com/mezis/git-check-ci"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+  s.add_development_dependency "pry-doc"
+  s.add_development_dependency "ruby-prof"
+
+  s.add_dependency "httparty"
+  s.add_dependency "daemons"
+  s.add_dependency "json"
+  s.add_dependency "thor"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^spec})
+  s.require_paths = ["lib"]
+end

data/lib/git-check-ci.rb

@@ -0,0 +1,4 @@
+require 'git-check-ci/version'
+require 'git-check-ci/server'
+require 'git-check-ci/checker'
+require 'git-check-ci/formatter'

data/lib/git-check-ci/checker.rb

@@ -0,0 +1,61 @@
+require 'git-check-ci/config'
+require 'git-check-ci/formatter'
+require 'singleton'
+require 'sha1'
+
+require 'rubygems'
+require 'httparty'
+
+module GitCheckCI
+  class Checker
+
+    attr_reader :config
+
+    # pass a :dir (defaults to current directory)
+    def initialize(options = {})
+      @directory = options[:dir] || Dir.pwd
+      @config = Config.new(:dir => @directory)
+    end
+
+
+    def check_and_save
+      save(check)
+    end
+
+    def uid
+      @config.ci.project
+    end
+
+
+    private
+
+
+    def check
+      return {:code => 400} if @config.ci.url.empty? || @config.ci.project.empty?
+
+      login    = @config.ci.login
+      password = @config.ci.password
+      options  = {}
+      unless login.empty? && password.empty?
+        options[:basic_auth] = { :username => login.to_s, :password => password.to_s }
+      end
+      url = "#{@config.ci.url}/#{@config.ci.project}/ping"
+      response = HTTParty.get(url, options)
+      return {:code => response.code, :body => response.to_s}
+
+    rescue HTTParty::UnsupportedURIScheme, SocketError
+      {:code => 400}
+    end
+
+
+
+    # save the CI result to the Git config
+    def save(code_and_response)
+      @config.ci.last_checked = Time.now.strftime('%s')
+      @config.ci.response     = code_and_response.to_json
+      @config.ci.status       = Formatter.handle_response(code_and_response)
+      nil
+    end
+
+  end
+end

data/lib/git-check-ci/config.rb

@@ -0,0 +1,110 @@
+# 
+# Access Git settings by calling +git config+.
+# 
+# config.foo.bar returns the "bar" setting in section "foo".
+#
+require 'pathname'
+
+module GitCheckCI
+  class Config
+    Error = Class.new(RuntimeError)
+
+    
+    # configs are directory (well, repo) specific
+    def initialize(options = {})
+      @directory = options.delete(:dir) || Dir.pwd
+      @chain     = options.delete(:chain) || []
+      @default   = options.delete(:default)
+      raise Error.new("Bad options #{options.inspect}") if options.any?
+    end
+
+    def to_s
+      @to_s ||= get
+    end
+
+
+    # return true when ci.url, ci.project, ci.status exist
+    def valid?
+      self.ci.url.to_s
+      self.ci.project.to_s
+      self.ci.status.to_s
+      true
+    rescue Error
+      false
+    end
+
+
+    def method_missing(method_name, *args)
+      if "string".respond_to?(method_name)
+        # puts "passing #{method_name} to #{key}"
+        to_s.send(method_name, *args)
+      elsif method_name.to_s =~ /(.*)=$/
+        # puts "passing #{method_name} to #{key}"
+        self.class.new(:dir => @directory, :chain => @chain + [$1]).send(:set,*args)
+      else
+        options = args.first || {}
+        self.class.new(options.merge :dir => @directory, :chain => @chain + [method_name])
+      end
+    end
+
+
+    def is_git_dir?
+      in_dir do
+        %x(git status 2>/dev/null)
+        ($? == 0)
+      end
+    end
+
+
+    def self.method_missing(method_name, *args)
+      new :chain => [method_name]
+    end
+
+
+    def self.valid?
+      new.valid?
+    end
+
+
+    def set(value)
+      # puts "writing config (#{key} -> #{value})"
+      in_dir do
+        if value.nil?
+          %x(git config --unset #{key} || true)
+          success =  ($? == 0)
+        else
+          success = system("git", "config", key, value)
+        end
+        raise Error.new("writing config failed (#{key} -> #{value})") unless success
+      end
+    end
+
+    def get
+      in_dir do
+        value = %x(git config #{key}).strip
+        # raise Error.new("reading git config failed (#{key})") unless ($? == 0)
+        value.empty? ? (@default || "") : value
+      end
+    end
+
+
+    private
+
+
+    def key
+      @chain.join('.').gsub(/_/,'-')
+    end
+
+
+    def in_dir
+      old_dir = Dir.pwd
+      begin
+        Dir.chdir(@directory)
+        yield
+      ensure
+        Dir.chdir(old_dir)
+      end
+    end
+
+  end
+end

data/lib/git-check-ci/formatter.rb

@@ -0,0 +1,35 @@
+
+
+module GitCheckCI
+  module Formatter
+    extend self
+
+    def handle_response(data)
+      case data[:body]
+        when /failed/              then build_string(:red,    '✗')
+        when /(pending|building)/  then build_string(:gray,   '●')
+        when /[0-9a-f]{40}/        then build_string(:green,  '✔')
+        else build_string(:yellow, '!')
+      end
+    end
+
+
+    private
+
+
+    def build_string(color, symbol)
+      reset  = "\033[0m"
+      color_code = case color
+        when :red    then "\033[31m"
+        when :green  then "\033[32m"
+        when :yellow then "\033[33m"
+        when :gray   then "\033[37m"
+        else ""
+      end
+
+      "#{color_code}#{symbol}#{reset}"
+    end
+
+
+  end
+end

data/lib/git-check-ci/server.rb

@@ -0,0 +1,87 @@
+require 'git-check-ci/checker'
+require 'git-check-ci/silencer'
+require 'pathname'
+
+require 'rubygems'
+require 'daemons'
+require 'json'
+
+module GitCheckCI
+  class Server
+    include Silencer
+
+    # path where the results are stored
+    attr_reader :outfile
+
+    def initialize(options = {})
+      @dir      = options[:dir] || Dir.pwd
+      @interval = options[:interval] || 60.0
+      @checker  = Checker.new(:dir => @dir)
+      @config   = @checker.config
+
+      @appgroup = Daemons::ApplicationGroup.new(
+        app_name,
+        :multiple => false, :dir => tmpdir.to_s, :dir_mode => :normal
+      )
+      @app = @appgroup.new_application(:mode => :proc, :proc => method(:worker))
+    end
+
+
+    def start(options = {})
+      return unless @config.is_git_dir?
+      return if @app.running?
+      work # once manually so we're pretty sure the server loop will work
+      @app.start
+      sleep 0.1 until @app.pid.pid
+      unless options[:quiet]
+        @app.started
+        puts "project #{@config.ci.project}"
+      end
+      nil
+    end
+
+
+    def stop(options = {})
+      return unless @config.is_git_dir?
+      return unless @app.running?
+      if options[:quiet]
+        silencing($stdout) { @app.stop }
+      else
+        @app.stop
+      end
+      nil
+    end
+   
+
+    def running?
+      @app.running?
+    end
+
+
+    private
+
+
+    def app_name
+      "git-check-ci:#{@checker.uid}"
+    end
+
+
+    def worker
+      $0 = app_name
+      loop do
+        work
+        sleep @interval
+      end
+    end
+
+    def work
+      @checker.check_and_save
+    end
+
+
+    def tmpdir
+      Pathname.new '/var/tmp'
+    end
+
+  end
+end

data/lib/git-check-ci/shell.rb

@@ -0,0 +1,101 @@
+require 'git-check-ci/config'
+require 'git-check-ci/server'
+require 'git-check-ci/formatter'
+
+require 'rubygems'
+require 'thor'
+
+module GitCheckCI
+  class Shell < Thor
+    include Thor::Actions
+
+    desc "check", "Fetch and print the current CI status."
+    def check
+      Checker.new.check_and_save
+      $stdout.puts Config.ci.response.to_s
+    end
+
+    desc "setup", "Interactively setup #{File.basename $0}."
+    def setup
+      Server.new.stop
+      @config = Config.new
+
+      ask_for @config.ci.url,      "What is the URL of your CI server?"
+      ask_for @config.ci.project,  "What is the name of the project you're checking?"
+      ask_for @config.ci.login,    "If the server requires a login, what should I use?"
+      unless @config.ci.login.empty?
+        ask_for @config.ci.password, "with which passphrase?"
+      end
+
+      puts
+      say "Setup is now complete. Doing a test run."
+      @config.ci.status = nil
+      Checker.new.check_and_save
+      if @config.ci.status.empty?
+        say "Sorry, but something went wrong. Try checking connectivity and your setup.", :yellow
+      else
+        say "All good! Now the 'check' and 'fast-check' commands should work.", :green
+      end
+      @config.ci.last_checked = nil
+    end
+
+
+    desc "server_start", "Start the checking daemon. Will store the build status in your git config."
+    method_option :quiet, :type => :boolean, :aliases => "-q"
+    def server_start
+      Server.new.start options
+    end
+
+    desc "server_stop", "Stop the checking daemon."
+    method_option :quiet, :type => :boolean, :aliases => "-q"
+    def server_stop
+      Server.new.stop options
+    end
+
+    desc "server_status", "Displays the server status."
+    def server_status
+      if Server.new.running?
+        say "Server is running"
+      else
+        say "Server is not running"
+      end
+    end
+
+
+    desc "init", "Output shell config."
+    def init
+      puts %q[
+        GitCheckCI() {
+          # exit early if not in a git repository
+          git status > /dev/null 2>&1 || return
+
+          # exit early if no project is configured
+          git config ci.project > /dev/null 2>&1 || { echo '?' ; return ; }
+
+          # spawn a server if no recent updates
+          last_checked=$(git config ci.last-checked || echo 0)
+          now=$(date +%s)
+          let "delta = $now - $last_checked"
+          test $delta -gt 120 && { git check-ci server_start & }
+
+          # try to return a status
+          git config ci.status 2> /dev/null || echo '?'
+        }
+      ]
+    end
+
+
+
+    private
+
+
+    def ask_for(setting, message)
+      current_value = setting.get
+      current_value = 'currently unset' if current_value.empty?
+      puts
+      value = ask("#{message} [#{current_value}]\n> ", :cyan)
+      setting.set(value) unless value.empty?
+    end
+
+  end
+end

data/lib/git-check-ci/silencer.rb

@@ -0,0 +1,14 @@
+module GitCheckCI
+  module Silencer
+    
+    def silencing(stream)
+      old_stream = stream.dup
+      stream.reopen('/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
+
+  end
+end

data/lib/git-check-ci/version.rb

@@ -0,0 +1,3 @@
+module GitCheckCI
+  VERSION = '0.1.0' unless defined?(GitCheckCI::VERSION)
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification 
+name: git-check-ci
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Julien Letessier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: rake
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: pry
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: pry-nav
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: pry-doc
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: ruby-prof
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: httparty
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: daemons
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: json
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: thor
+  type: :runtime
+  version_requirements: *id011
+description: Check CI status of the local project
+email: 
+- julien.letessier@gmail.com
+executables: 
+- git-check-ci
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/git-check-ci
+- git-check-ci.gemspec
+- lib/git-check-ci.rb
+- lib/git-check-ci/checker.rb
+- lib/git-check-ci/config.rb
+- lib/git-check-ci/formatter.rb
+- lib/git-check-ci/server.rb
+- lib/git-check-ci/shell.rb
+- lib/git-check-ci/silencer.rb
+- lib/git-check-ci/version.rb
+has_rdoc: true
+homepage: http://github.com/mezis/git-check-ci
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.9.5
+signing_key: 
+specification_version: 3
+summary: Provides git-check-ci, which can display textual or graphic status feedback based on a CI server's results.
+test_files: []
+