open_source_stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c70f2d8e89dc9d029d1929cbfbd784e91bb95a85
+  data.tar.gz: 4b9b9d02d18899a671b999fbe19b1b2455ad42bd
+SHA512:
+  metadata.gz: a958a8d47104f7d21e66b26dcd40b18368bdbd604a22f9fc7c81ed3e90bf5aab6227be44f139c6904bcae78a5acc2dcff91d6577071420c814527d74448dfceb
+  data.tar.gz: 3956f62f8a04c95cf4a046ec7577982261099ad2c5380c0feb865d139ebb75261ed51f665cab4a6858e971e457fd87b5ba7d34283bab2c14080e27654b4f5477

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in open_source_stats.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Balter
+
+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,43 @@
+# Open Source Stats
+
+*A quick script to generate metrics about the contribution your organization makes to the open source community in a 24-hour period*.
+
+## What it looks at
+
+* Public activity across all public repositories from members of a given team
+* Public activity across all users on repositories owned by a given organization or organizations
+
+## How it works
+
+By doing terrible, terrible things to GitHub's events API.
+
+## Setup
+
+1. `gem install open_source_stats`
+2. Create a `.env` file and add the following:
+  * `GITHUB_TOKEN` - A personal access token with `read:org` scope
+  * `GITHUB_TEAM_ID` - The numeric ID of the team to pull users from (e.g., 12345)
+  * `GITHUB_ORGS` - A comma separated list of the orgs to look at (e.g, `github,atom`)
+3. Run `bundle exec oss`
+
+This will spit markdown formatted results into standard out.
+
+## Output
+
+Output might look something like this...
+
+| Metric               | Count |
+|----------------------|-------|
+| Repositories created | 6     |
+| Issue comments       | 309   |
+| Issues opened        | 40    |
+| Issues closed        | 30    |
+| Repos open sourced   | 1     |
+| Pull requests opened | 32    |
+| Pull requests merged | 35    |
+| Versions released    | 3     |
+| Pushes               | 442   |
+| Commits              | 1548  |
+| Total events         | 945   |
+
+Metrics will also be broken down by organization, by user, and by repository

data/Rakefile

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

data/bin/oss

@@ -0,0 +1,38 @@
+#! /usr/bin/env ruby
+
+require_relative "../lib/open_source_stats"
+require 'active_support/core_ext/string/inflections'
+require 'terminal-table'
+
+oss = OpenSourceStats.new
+
+def pretty_print_hash(hash)
+  rows = []
+  hash.each { |key, value| rows << [key.to_s.humanize, value] }
+  table = Terminal::Table.new(:rows => rows, :style => { :border_i => "|" }, :headings => ["Metric", "Count"]).to_s
+  puts table.split("\n")[1...-1].join("\n") + "\n\n"
+end
+
+puts "# Open source actvity for the 24-hour period begining at #{OpenSourceStats.start_time.strftime("%l:%S %p %Z on %B %-d, %Y")}\n\n"
+
+puts "## Overall\n\n"
+pretty_print_hash oss.stats
+
+puts "## By organization\n\n"
+oss.orgs.each do |org|
+  puts "### #{org.name.humanize}\n\n"
+  pretty_print_hash oss.stats(org.events)
+end
+
+puts "## Top users\n\n"
+users = oss.users.reject { |u| u.login == "hubot" }.sort_by { |u| u.events.count }.reverse[0...10]
+users.each_with_index do |user, index|
+  puts "### #{index+1}. @#{user.login}\n\n"
+  pretty_print_hash oss.stats(user.events)
+end
+
+puts "## Most active repositories\n\n"
+repos = oss.events.group_by { |e| e.repo }.map { |k,v| { k => v.count } }.sort_by { |r| r.values.first  }.reverse[0...10]
+repos.each_with_index do |repo, index|
+  puts "#{index + 1}. #{repo.keys.first} - #{repo.values.first} events"
+end

data/lib/open_source_stats.rb

@@ -0,0 +1,102 @@
+require_relative "./open_source_stats/version.rb"
+require_relative "./open_source_stats/user"
+require_relative "./open_source_stats/organization"
+require_relative "./open_source_stats/event"
+require 'active_support'
+require 'active_support/core_ext/numeric/time'
+require 'octokit'
+require 'dotenv'
+
+Dotenv.load
+
+class OpenSourceStats
+
+  # Authenticated Octokit client instance
+  def self.client
+    @client ||= Octokit::Client.new :access_token => ENV["GITHUB_TOKEN"]
+  end
+
+  # Returns a Ruby Time instance coresponding to the earliest possible event timestamp
+  def self.start_time
+    @start_time ||= Time.now - 24.hours
+  end
+
+  # Helper method to overide the timestamp
+  def self.start_time=(time)
+    @start_time = time
+  end
+
+  def team
+    @team ||= client.team ENV["GITHUB_TEAM_ID"]
+  end
+
+  # Returns an array of Users from the given team
+  def users
+    @users ||= begin
+      users = client.team_members ENV["GITHUB_TEAM_ID"], :per_page => 100
+      while client.last_response.rels[:next] && client.rate_limit.remaining > 0
+        users.concat client.get client.last_response.rels[:next].href
+      end
+      users.map { |u| User.new u[:login] }
+    end
+  end
+
+  # Returns an array of Events across all Users
+  def user_events
+    @user_events ||= users.map { |u| u.events }.flatten
+  end
+
+  # Returns an array of Organizations from the specified list of organizations
+  def orgs
+    @orgs ||= ENV["GITHUB_ORGS"].split(/, ?/).map { |o| Organization.new(o) }
+  end
+
+  # Returns an array of Events across all Organziations
+  def org_events
+    @org_events ||= orgs.map { |o| o.events }.flatten
+  end
+
+  # Returns an array of unique Events accross all Users and Organizations
+  def events
+    @events ||= user_events.concat(org_events).uniq
+  end
+
+  # Returns the calculated stats hash
+  def stats(events=events)
+    {
+      :repositories_created => event_count(events, :type =>"CreateEvent"),
+      :issue_comments => event_count(events, :type =>"IssueCommentEvent"),
+      :issues_opened => event_count(events, :type =>"IssuesEvent", :action => "opened"),
+      :issues_closed => event_count(events, :type =>"IssuesEvent", :action => "closed"),
+      :repos_open_sourced => event_count(events, :type =>"PublicEvent"),
+      :pull_requests_opened => event_count(events, :type =>"PullRequestEvent", :action => "opened"),
+      :pull_requests_merged => event_count(events, :type =>"PullRequestEvent", :action => "closed", :merged => true),
+      :versions_released => event_count(events, :type =>"ReleaseEvent", :action => "published"),
+      :pushes => event_count(events, :type =>"PushEvent"),
+      :commits => events.map { |e| e.commits }.flatten.inject{|sum,x| sum + x },
+      :total_events => event_count(events)
+    }
+  end
+
+  private
+
+  # Helper method to count events by set conditions
+  #
+  # Options:
+  #   :type - the type of event to filter by
+  #   :action - the payload action to filter by
+  #   :merged - whether the pull request has been merged
+  #
+  # Returns an integer reflecting the resulting event count
+  def event_count(events, options={})
+    events = events.select { |e| e.type == options[:type] } if options[:type]
+    events = events.select { |e| e.payload[:action] == options[:action] } if options[:action]
+    events = events.select { |e| e.payload[:pull_request][:merged] == options[:merged] } if options[:merged]
+    events.count
+  end
+
+  # Helper method to reference the client stored on the class and DRY things up a bit
+  def client
+    OpenSourceStats.client
+  end
+end

data/lib/open_source_stats/event.rb

@@ -0,0 +1,67 @@
+class OpenSourceStats
+  class Event
+
+    # Hash of event types to count as an event
+    #
+    # The top-level key should be the event type
+    # The top-level value should be a hash used to filter acceptable key/value pairs
+    #
+    # For the sub-hash, keys are keys to look for in the event,
+    # and the value is an array of acceptable values
+    #
+    # Events that don't match an event type and key/value pair with fail the in_scope? check
+    TYPES = {
+      "CreateEvent" => { :ref_type => ["repository"] },
+      "IssueCommentEvent" => {:action => ["created"] },
+      "IssuesEvent" => { :action => ["opened", "closed"] },
+      "PublicEvent" => {},
+      "PullRequestEvent" => { :action => ["opened", "closed"]},
+      "PullRequestReviewCommentEvent" => { :action => ["created"] },
+      "PushEvent" => {},
+      "ReleaseEvent" => { :action => "published" },
+    }
+
+    attr_reader :type, :repo, :actor, :time, :payload, :id
+
+    # Takes the raw event object from Octokit
+    def initialize(event)
+      @type = event[:type]
+      @repo = event[:repo][:name]
+      @actor = User.new(event[:actor][:login])
+      @time = event[:created_at]
+      @payload = event[:payload]
+      @id = event[:id]
+    end
+
+    # Is this event type within our timeframe AND an acceptable event type?
+    def in_scope?
+      return false unless time >= OpenSourceStats.start_time
+      return false unless TYPES.keys.include?(type)
+      TYPES[type].each do |key, values|
+        return false unless values.include? payload[key]
+      end
+      true
+    end
+
+    # Use event IDs to compare uniquness via Array#uniq
+    def ==(other_event)
+      id == other_event.id
+    end
+    alias_method :eql?, :==
+
+    # How many commmits does this event involve?
+    #
+    # For push events, this is the number of commits pushed
+    # For pull request events, this is the number of commits contained in the PR
+    def commits
+      case type
+      when "PushEvent"
+        payload[:commits].count
+      when "PullRequestEvent"
+        payload[:pull_request][:commits]
+      else
+        0
+      end
+    end
+  end
+end

data/lib/open_source_stats/organization.rb

@@ -0,0 +1,9 @@
+class OpenSourceStats
+  class Organization < OpenSourceStats::User
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+  end
+end

data/lib/open_source_stats/user.rb

@@ -0,0 +1,41 @@
+class OpenSourceStats
+  class User
+
+    attr_accessor :login
+
+    def initialize(login)
+      @login = login
+    end
+
+    # Returns an array of in-scope Events from the user's public activity feed
+    def events
+      @events ||= begin
+        if self.class == OpenSourceStats::User
+          events = client.user_public_events login, :per_page => 100
+        else
+          events = client.organization_public_events name, :per_page => 100
+        end
+
+        events.concat client.get client.last_response.rels[:next].href while next_page?
+        events = events.map { |e| Event.new(e) }
+        events.select { |e| e.in_scope? }
+      end
+    end
+
+    private
+
+    # Helper method to access the shared Octokit instance
+    def client
+      OpenSourceStats.client
+    end
+
+    # Helper method to improve readability.
+    # Asks is there another page to the results?
+    # Looks at both pagination and if we've gone past our allowed timeframe
+    def next_page?
+      client.last_response.rels[:next] &&
+      client.rate_limit.remaining > 0 &&
+      client.last_response.data.last[:created_at] >= OpenSourceStats.start_time
+    end
+  end
+end

data/lib/open_source_stats/version.rb

@@ -0,0 +1,3 @@
+class OpenSourceStats
+  VERSION = "0.0.1"
+end

data/open_source_stats.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_source_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_source_stats"
+  spec.version       = OpenSourceStats::VERSION
+  spec.authors       = ["Ben Balter"]
+  spec.email         = ["ben.balter@github.com"]
+  spec.summary       = %q{A quick script to generate metrics about the contribution your organization makes to the open source community in a 24-hour period}
+  spec.homepage      = "https://github.com/benbalter/open_source_stats"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "activesupport"
+  spec.add_dependency "terminal-table"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec gem build open_source_stats.gemspec

data/script/console

@@ -0,0 +1 @@
+bundle exec pry -r "./lib/open_source_stats.rb"

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf open_source_stats-*.gem
+gem build -q open_source_stats.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls open_source_stats-*.gem | sed 's/^open_source_stats-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push open_source_stats-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: open_source_stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-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: 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: terminal-table
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- ben.balter@github.com
+executables:
+- oss
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/oss
+- lib/open_source_stats.rb
+- lib/open_source_stats/event.rb
+- lib/open_source_stats/organization.rb
+- lib/open_source_stats/user.rb
+- lib/open_source_stats/version.rb
+- open_source_stats.gemspec
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+homepage: https://github.com/benbalter/open_source_stats
+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.2.0
+signing_key: 
+specification_version: 4
+summary: A quick script to generate metrics about the contribution your organization
+  makes to the open source community in a 24-hour period
+test_files: []