git-heroes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddda5088666b7d915f39ca283765839033d28e0a
+  data.tar.gz: 62f5ebea3d678988928f60902acb1711e2e00a45
+SHA512:
+  metadata.gz: 7d2303a8aea29cb9b06fe92becffd36a8950ffbac98bda9a5cc11d70cebe55d1f6898912bdf1843d34c88524c89e6984da823bf0ea5311dcbde4b28278f15882
+  data.tar.gz: 30a5a723b9877ebf60a9feebad39df26148da913ee4d92f1cd5e1402e8698a71a410fd247e515ea8cd820b810999ef2cda1eafa008bbef306e535e23888f9c5b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source ENV.fetch('GEM_SOURCE', 'https://rubygems.org')
+
+# Specify your gem's dependencies in githeroes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julien Letessier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Git Heroes
+
+Ever wanted to know your your team's top contributors are?
+
+`git heroes` will tell you, based on their Github activity (pull requests,
+comments, and merges).
+
+**Caveat Emptor**: no hard metric that measures individuals is reliable. Please do
+not use this to estimate someone's productivity. In combination with other
+tools, it can be effectivee to detect trends, though.
+
+## Installation
+
+    $ gem install git-heroes
+
+To preserve your Github API usage limit, the tool requires locally running
+Redis instance for caching.
+
+## Usage
+
+    $ git heroes -r <your-organization> -t <github-token>
+
+Details:
+
+    Usage: bin/git-heroes [options]
+        -r, --organization ORG   Progress organization ORG (required)
+        -o, --output FILE        Save report to FILE
+        -t, --token TOKEN        A Github authentication token (defaults to GITHUB_TOKEN)
+        -w, --weeks WEEKS        Report on the last WEEKS weeks (default 12).
+        -v, --verbose            Run verbosely
+        -h, --help               Show this message
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/git-heroes

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# 
+# TODO: 10 points for deploys !
+# 
+require 'rubygems'
+require 'bundler/setup'
+require 'dotenv'
+require 'optparse'
+
+require 'git_heroes/connection'
+require 'git_heroes/engine'
+require 'git_heroes/logger'
+
+Dotenv.load
+
+OPTIONS = {
+  path:    'report.csv',
+  verbose: false,
+  token:   ENV['GITHUB_TOKEN'],
+  weeks:   12
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.on("-r", "--organization ORG", "Progress organization ORG (required)") do |org|
+    OPTIONS[:org] = org
+  end
+
+  opts.on("-o", "--output FILE", "Save report to FILE") do |path|
+    OPTIONS[:path] = path
+  end
+
+  opts.on("-t", "--token TOKEN", "A Github authentication token (defaults to GITHUB_TOKEN)") do |token|
+    OPTIONS[:token] = token
+  end
+
+  opts.on("-w", "--weeks WEEKS", Integer, "Report on the last WEEKS weeks (default #{OPTIONS[:weeks]}).") do |weeks|
+    OPTIONS[:weeks] = weeks
+  end
+
+  opts.on("-v", "--verbose", "Run verbosely") do |v|
+    OPTIONS[:verbose] = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    $stderr.puts opts
+    exit 0
+  end
+end.parse!
+
+
+if OPTIONS[:org].nil?
+  $stderr.puts "No organization specified, aborting."
+  exit 1
+end
+
+if !OPTIONS[:verbose]
+  GitHeroes::Logger.instance.level = Logger::WARN
+end
+
+client = GitHeroes::Connection.new(token: OPTIONS[:token])
+engine = GitHeroes::Engine.new(client:client, org:OPTIONS[:org], weeks:OPTIONS[:weeks])
+engine.run
+engine.export(OPTIONS[:path])

data/githeroes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_heroes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-heroes"
+  spec.version       = GitHeroes::VERSION
+  spec.authors       = ["Julien Letessier"]
+  spec.email         = ["julien.letessier@gmail.com"]
+  spec.description   = %q{Leaderboard of your team's Github activity}
+  spec.summary       = %q{Leaderboard of your team's Github activity}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "octokit"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "redis-activesupport"
+  spec.add_dependency "faraday-http-cache"
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/git_heroes/cache.rb

@@ -0,0 +1,16 @@
+require 'git_heroes'
+require 'faraday'
+
+class GitHeroes::Cache < Faraday::Middleware
+  def call(env, *args)
+    # do something with the request
+    force_cache = !! env[:request_headers]['X-Force-Cache']
+
+    @app.call(env).on_complete do |response|
+      # do something with the response
+      if force_cache
+        response[:response_headers]['cache-control'] = 'public, max-age=31536000'
+      end
+    end
+  end
+end

data/lib/git_heroes/connection.rb

@@ -0,0 +1,28 @@
+require 'delegate'
+require 'octokit'
+require 'git_heroes'
+require 'git_heroes/cache'
+require 'git_heroes/logger'
+require 'git_heroes/serializer'
+require 'git_heroes/ext/faraday'
+
+class GitHeroes::Connection < SimpleDelegator
+  def initialize(token:nil)
+    stack = Faraday::Builder.new do |builder|
+      builder.use(:http_cache,
+        store:         :redis_store,
+        store_options: %w(localhost/0/githeroes),
+        serializer:    GitHeroes::Serializer,
+        logger:        GitHeroes::Logger.instance)
+      builder.use     GitHeroes::Cache
+      builder.use     Octokit::Response::RaiseError
+      builder.adapter Faraday.default_adapter
+    end
+
+    client = Octokit::Client.new(
+      access_token: token,
+      middleware:   stack)
+
+    super(client)
+  end
+end

data/lib/git_heroes/engine.rb

@@ -0,0 +1,129 @@
+require 'set'
+require 'git_heroes/ext/time'
+require 'git_heroes/ext/octokit'
+require 'active_support/all' # for #beginning_of_week
+require 'csv'
+
+class GitHeroes::Engine
+  POINTS = { pull: 5, comment: 1, merge: 2 }
+  
+  def initialize(client:nil, org:nil, weeks:nil)
+    @client       = client
+    @organisation = org
+    @data         = {}
+    @users        = Set.new
+
+    @end_time     = Time.now.beginning_of_week
+    week_count    = weeks
+    @weeks        = (1..week_count).map { |idx| @end_time - idx.weeks }
+    @start_time   = @weeks.last
+  end
+
+
+  def run
+    repositories = @client.organization_repositories(@organisation)
+    repositories.each do |repository|
+      each_pull_request(repository) do |pull_request, get_options|
+        process_pull_request(pull_request, get_options)
+      end
+    end
+  end
+
+
+  def export(path)
+    CSV.open(path, 'w') do |csv|
+      weeks = @weeks.sort
+      weeks_keys = weeks.map { |w| w.week_key }
+      header = %w(login) + weeks.map { |w| w.strftime('%Y.%W (%b %d)') }
+      csv << header
+      @users.each do |user|
+        row = [user]
+        weeks_keys.each do |weeks_keys|
+          row << @data[user][weeks_keys]
+        end
+        csv << row
+      end
+    end
+  end
+
+
+  private
+
+
+  def process_pull_request(pull_request, get_options)
+    non_self_comments = 0
+    ttl = pull_request.merged_at? ? nil : 1.day
+
+    each_comment(pull_request, get_options) do |comment|
+      next if comment.user.login == pull_request.user.login
+      give_points(:comment, comment.user.login, comment.created_at)
+      non_self_comments += 1
+    end
+
+    merger = pull_request.merged_by
+    self_merge = (merger && merger.login == pull_request.user.login)
+
+    if (non_self_comments > 0) || !self_merge
+      give_points(:pull,  pull_request.user.login, pull_request.created_at) 
+    end
+
+    if pull_request.merged_by
+      give_points(:merge, pull_request.merged_by.login, pull_request.merged_at)
+    end
+  end
+
+
+  def give_points(kind, user, timestamp)
+    return unless @start_time < timestamp && timestamp < @end_time
+    week_key = timestamp.week_key
+    @users.add user
+    @data[user] ||= {}
+    @data[user][week_key] ||= 0
+    @data[user][week_key] += POINTS[kind]
+  end
+
+
+  def each_comment(pull_request, get_options)
+    # comments on PR itself
+    uri = pull_request.rels[:comments].href
+    @client.request(:get, uri, get_options).each do |comment|
+      yield comment
+    end
+
+    # comments on diff (unsupported by Octokit)
+    uri = "https://api.github.com/repos/#{pull_request.base.repo.full_name}/pulls/#{pull_request.number}/comments"
+    @client.request(:get, uri, get_options).each do |comment|
+      yield comment
+    end
+  end
+
+
+  def each_pull_request(repository)
+    [:open, :closed].each do |status|
+      page = 1
+      while true
+        pull_requests = @client.pull_requests(repository.full_name, status, per_page: 20, page: page)
+        break if pull_requests.empty?
+        break if pull_requests.all? { |pr| pr.created_at < @start_time }
+        page += 1
+
+        pull_requests.each do |pull_request|
+          # skip unmerged closed PRs
+          next if pull_request.closed_at? && !pull_request.merged_at?
+          # skip too old PRs
+          next if pull_request.created_at < @start_time
+
+          get_options = {}
+          if pull_request.merged_at? || pull_request.closed_at?
+            # old, cacheable forever
+            get_options[:headers] = { 'X-Force-Cache' => '1' }
+          end
+
+          pull_request = @client.request(:get, pull_request.rels[:self].href, get_options)
+
+          yield pull_request, get_options
+        end
+      end
+    end
+  end
+end

data/lib/git_heroes/ext/faraday.rb

@@ -0,0 +1,13 @@
+require 'faraday-http-cache'
+
+# Monkey-patch Faraday cache
+# Forces long caching, even for private resources
+Faraday::HttpCache::CacheControl.class_eval do
+  def private?
+    false
+  end
+
+  def shared_max_age
+    36000
+  end
+end

data/lib/git_heroes/ext/octokit.rb

@@ -0,0 +1,5 @@
+# We need to access #request, since #get is borken
+# (passes headers in the query string)
+class Octokit::Client
+  public :request
+end

data/lib/git_heroes/ext/time.rb

@@ -0,0 +1,11 @@
+# Provides #Time.wnum
+
+class Time
+  def wnum
+    strftime('%W').to_i
+  end
+
+  def week_key
+    strftime('%Y.%W')
+  end
+end

data/lib/git_heroes/logger.rb

@@ -0,0 +1,13 @@
+require 'git_heroes'
+require 'logger'
+require 'delegate'
+require 'singleton'
+
+class GitHeroes::Logger < SimpleDelegator
+  include Singleton
+
+  def initialize
+    logger = ::Logger.new($stderr)
+    super(logger)
+  end
+end

data/lib/git_heroes/serializer.rb

@@ -0,0 +1,13 @@
+require 'git_heroes'
+
+module GitHeroes::Serializer
+  extend self
+
+  def load(data)
+    Marshal.load(Zlib::Inflate.inflate(data))
+  end
+
+  def dump(data)
+    Zlib::Deflate.deflate(Marshal.dump(data))
+  end
+end

data/lib/git_heroes/version.rb

@@ -0,0 +1,3 @@
+module GitHeroes
+  VERSION = "0.0.1"
+end

data/lib/git_heroes.rb

@@ -0,0 +1,5 @@
+require 'git_heroes/version'
+
+module GitHeroes
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: git-heroes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julien Letessier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Leaderboard of your team's Github activity
+email:
+- julien.letessier@gmail.com
+executables:
+- git-heroes
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/git-heroes
+- githeroes.gemspec
+- lib/git_heroes.rb
+- lib/git_heroes/cache.rb
+- lib/git_heroes/connection.rb
+- lib/git_heroes/engine.rb
+- lib/git_heroes/ext/faraday.rb
+- lib/git_heroes/ext/octokit.rb
+- lib/git_heroes/ext/time.rb
+- lib/git_heroes/logger.rb
+- lib/git_heroes/serializer.rb
+- lib/git_heroes/version.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Leaderboard of your team's Github activity
+test_files: []