octo_ranker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56903e716a82093411c13569ed05470410800ab3
+  data.tar.gz: 0f6e20d96db40a0219015c0b31cf8a26fe2d8866
+SHA512:
+  metadata.gz: 230a8e1208cc653d3a90653836548ba5a32ced5f3ac7cf15822c2c9a76740394b856d659d3f47af27be9a9513dd691f2828f4577246c2032817a144fb9ef1c3c
+  data.tar.gz: aa08f1bf80cfe97d1eb0eb2db949260e0c76cea13ea2fab4f7ea0e7fc14fd7063859e8061d1133313447bf0b267b15e7469058568dac92d213a3490e49546559

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Mason
+
+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,95 @@
+# OctoRanker
+
+Git ranked.
+
+OctoRanker can rank the members of an organization based on their contributions
+to the organization's public repositories. You should probably read the whole
+README, but at the very least, please read the
+[organizational usage](#organizational).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octo_ranker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octo_ranker
+
+## Usage
+
+### Programmatic
+
+Using OctoRanker is very straightforward. It goes like this:
+```ruby
+require 'octo_ranker'
+OctoRanker.rank_members('name-of-my-org')
+```
+This will give you an array of [`OctoRanker::User`](lib/octo_ranker/user.rb)
+objects. You can read the docs to find out how the rankings are calculated.
+
+#### Rate Limiting
+GitHub uses rate limiting. You can read about their policies
+[here](https://developer.github.com/v3/rate_limit/). Depending on the size of
+your organization, this may cause some errors to be thrown once GitHub starts
+responding with 429s.
+
+To increase your rate limit, you can configure
+[octokit](https://github.com/octokit/octokit.rb) (which is what OctoRanker 
+uses to get data from GitHub) to authorize with your GitHub credentials like so:
+```ruby
+require 'octo_ranker'
+Octokit.configure do |c|
+  c.login = 'ajm188'
+  c.password = 'password' # Obviously not my real password (or is it?), but you get the idea.
+end
+# Now make your queries as normal
+OctoRanker.rank_members('name-of-my-org')
+```
+
+If your organization is so large that you're maxing out the authenticated rate
+limit (wow, good for you!), create an issue in here, and I'll try to come up
+with a good batch processing solution.
+
+### Organizational
+
+OctoRanker is intended to be a fun way to encourage members of your organization
+to contribute to your repos. The rankings should provide **friendly** competition
+and motivation to get more involved with your organization's open source software.
+
+Things you **should not do** if your organization uses rankings:
+* "Dood, you suck. You have, like, the worst ranking in our org."
+* Make a bunch of really small commits to boost your ranking. That's not the point.
+
+Things you should do instead:
+* Be kind and encouraging to your fellow teammates. You're on the same team after all.
+* Focus on making contributions to your organization, and not on your ranking. After all,
+the more you focus on making contributions, the better your ranking will be as a result.
+
+## Contributing
+
+1. Fork it ( https://github.com/ajm188/octo_ranker/fork )
+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 a new Pull Request
+
+## Potential Features
+These are some things I'm considering adding to the project. If you want to
+work on one (or any) of them, feel free. Just let me know so I don't
+duplicate your effort (duplicated effort is lame). Also see
+[contributing](#contributing) for the workflow.
+
+1. Batch processing of org repos. See [rate limiting](#rate-limiting).
+1. Option to count private repos. Note that this will require authentication
+from a member of the organization.
+1. Add some tests. I've seen the code work, but why should you trust me?
+  1. This isn't a "feature" per se, but I might as well stick this here and hope
+  someone else does it for me.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octo_ranker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/octo_ranker.rb

@@ -0,0 +1,32 @@
+require 'octo_ranker/version'
+require 'octo_ranker/user'
+require 'octo_ranker/repository'
+
+require 'octokit'
+
+module OctoRanker
+  class << self
+    # Rank the members of +organization+ according to their scores.
+    # The score for a user on a repo is computed by some function of
+    # the number of commits the user has on the repo and the number of
+    # stars the repo has (contributions to more popular repos should be
+    # significant). See OctoRanker::User#add_repo for how this function
+    # is defined. The user's total score is the sum of the user's score
+    # on each repo owned by +organization+.
+    #
+    # Returns an array of OctoRanker::User objects.
+    def rank_members(organization)
+      users = Hash.new { |h, k| h[k] = OctoRanker::User.new }
+      Octokit.organization_repositories(organization).each do |repo|
+        stars = Octokit.stargazers(repo.full_name).size
+        ranker_repo = OctoRanker::Repository.new(stars)
+        Octokit.contributor_stats(repo.full_name).each do |contributor_stat|
+          user = users[contributor_stat.author.id]
+          user.login = contributor_stat.author.login
+          user.add_repo(contributor_stat.total, ranker_repo)
+        end
+      end
+      users.values.sort_by { |u| -u.score }
+    end
+  end
+end

data/lib/octo_ranker/repository.rb

@@ -0,0 +1,15 @@
+module OctoRanker
+  class Repository
+    def initialize(stars)
+      @stars = stars
+    end
+
+    # Defines how heavily a repository should be counted when determining
+    # scores for a user. Currently defined to be the number of stars on the
+    # repository (plus 1, because users should still get points for
+    # contributing, even if the repo has no stars).
+    def weight
+      @stars + 1
+    end
+  end
+end

data/lib/octo_ranker/user.rb

@@ -0,0 +1,19 @@
+module OctoRanker
+  class User
+    attr_reader :score
+    attr_writer :login
+
+    def initialize(login = nil)
+      @login, @score = login, 0
+    end
+
+    # Add the score for +repo+ to the score for this user.
+    # Currently, the score for a repo is defined as the product
+    # of the number of commits the user has on the repo and the
+    # weight of that repo. See OctoRanker::Repository for how
+    # the weight is defined.
+    def add_repo(commits, repo)
+      @score += commits * repo.weight
+    end
+  end
+end

data/lib/octo_ranker/version.rb

@@ -0,0 +1,3 @@
+module OctoRanker
+  VERSION = "0.1.0"
+end

data/octo_ranker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octo_ranker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "octo_ranker"
+  spec.version       = OctoRanker::VERSION
+  spec.authors       = ["Andrew Mason"]
+  spec.email         = ["mason@case.edu"]
+
+  spec.summary       = %q{Rank your organization members by their contributions to your public repositories on GitHub}
+  spec.homepage      = "https://github.com/ajm188/octo_ranker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "octokit"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: octo_ranker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !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: 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'
+description: 
+email:
+- mason@case.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/octo_ranker.rb
+- lib/octo_ranker/repository.rb
+- lib/octo_ranker/user.rb
+- lib/octo_ranker/version.rb
+- octo_ranker.gemspec
+homepage: https://github.com/ajm188/octo_ranker
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rank your organization members by their contributions to your public repositories
+  on GitHub
+test_files: []