contribution-checker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19182ad1d31baf01f0dc6d78e7d3ba7d3f992bcb
+  data.tar.gz: a8f6d7d814d0637a965c93b43a98fe12465fecbe
+SHA512:
+  metadata.gz: ecbddc0756b18773bb5be5ef195f2b96251b30bddd1b8c20b1291749a057a29fa23b9079bc0be43e0123974f2c552caec18432af88681f46a2a17be7fdbf3aee
+  data.tar.gz: dcb17c150028c981d7939ecc53e9f8f1fc8c60512766387577f00aab4b53593b2f8f7486b668d33f5de3c6bb518348c67e8c3c8e99846c3ca237e9a60825b48a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Dennes
+
+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,31 @@
+# GitHub Contribution Checker
+
+People :heart: GitHub Contributions. However, it's not always simple to tell why a commit isn't [counted as a contribution][contributions]. This library lets you check whether a specific commit qualifies as a contribution.
+
+## Usage
+
+```ruby
+checker = ContributionChecker::Checker.new \
+  :access_token => "<Your 40 char GitHub API token>",
+  :commit_url   => "https://github.com/user/repo/commit/sha"
+)
+
+checker.check
+=> {
+  :counted_as_contribution => true,
+  :and_criteria => {
+    :commit_in_valid_branch      => true,
+    :commit_in_last_year         => true,
+    :repo_not_a_fork             => true,
+    :commit_email_linked_to_user => true
+  },
+  :or_criteria => {
+    :user_has_starred_repo   => false,
+    :user_can_push_to_repo   => false,
+    :user_is_repo_org_member => true,
+    :user_has_fork_of_repo   => false
+  }
+}
+```
+
+[contributions]: https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile

data/Rakefile

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

data/contribution-checker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contribution-checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contribution-checker"
+  spec.version       = ContributionChecker::VERSION
+  spec.authors       = ["James Dennes"]
+  spec.email         = ["jdennes@gmail.com"]
+  spec.summary       = %q{Check whether a commit is counted as a contribution.}
+  spec.description   = %q{Check whether a GitHub commit is counted as a \
+    contribution for a specific GitHub user.}
+  spec.homepage      = ""
+  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", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/contribution-checker/checker.rb

@@ -0,0 +1,206 @@
+require "octokit"
+
+# Check whether a GitHub commit is counted as a contribution for a specific
+# GitHub user.
+#
+# @see https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile
+module ContributionChecker
+
+  # The Checker.
+  class Checker
+
+    # Initialise a new Checker instance with an API access token and commit URL.
+    #
+    # @param options [Hash] Options which should take the form:
+    # {
+    #   :access_token => "<Your 40 char GitHub API token>",
+    #   :commit_url   => "https://github.com/user/repo/commit/sha"
+    # }
+    #
+    # @return [ContributionChecker::Checker] Contribution checker initialised
+    # for an authenticated user and a specific commit
+    def initialize(options = {})
+      options.each do |key, val|
+        instance_variable_set :"@#{key}", val
+      end
+      @client = Octokit::Client.new(:access_token => @access_token)
+    end
+
+    # Checks whether the commit is counted as a contribution for the
+    # authenticated user.
+    #
+    # @return [Hash] The return value takes the following form:
+    # {
+    #   :counted_as_contribution => true,
+    #   :and_criteria => {
+    #     :commit_in_valid_branch      => true,
+    #     :commit_in_last_year         => true,
+    #     :repo_not_a_fork             => true,
+    #     :commit_email_linked_to_user => true
+    #   },
+    #   :or_criteria => {
+    #     :user_has_starred_repo   => false,
+    #     :user_can_push_to_repo   => false,
+    #     :user_is_repo_org_member => true,
+    #     :user_has_fork_of_repo   => false
+    #   }
+    # }
+    def check
+      parts = URI.parse(@commit_url).path.split("/")
+      @nwo = "#{parts[1]}/#{parts[2]}"
+      @sha = parts[4]
+      @user = @client.user
+      @repo = @client.repository @nwo
+      @commit = @client.commit @nwo, @sha
+
+      @commit_in_valid_branch = commit_in_valid_branch?
+      @commit_in_last_year = commit_in_last_year?
+      @repo_not_a_fork = !repository_is_fork?
+      @commit_email_linked_to_user = commit_email_linked_to_user?
+      @user_has_starred_repo = user_has_starred_repo?
+      @user_can_push_to_repo = user_can_push_to_repo?
+      @user_is_repo_org_member = user_is_repo_org_member?
+      @user_has_fork_of_repo = user_has_fork_of_repo?
+
+      {
+        :contribution => and_criteria_met? && or_criteria_met?,
+        :and_criteria => {
+          :commit_in_valid_branch      => @commit_in_valid_branch,
+          :commit_in_last_year         => @commit_in_last_year,
+          :repo_not_a_fork             => @repo_not_a_fork,
+          :commit_email_linked_to_user => @commit_email_linked_to_user,
+        },
+        :or_criteria => {
+          :user_has_starred_repo   => @user_has_starred_repo,
+          :user_can_push_to_repo   => @user_can_push_to_repo,
+          :user_is_repo_org_member => @user_is_repo_org_member,
+          :user_has_fork_of_repo   => @user_has_fork_of_repo,
+        }
+      }
+    end
+
+    # Checks whether the commit is in a valid branch. A valid branch is defined
+    # as either the default branch of the repository, or the gh-pages branch.
+    #
+    # @return [Boolean]
+    def commit_in_valid_branch?
+      # If two refs are entirely different commit histories, the API responds
+      # with a 404. Rescue Octokit::NotFound in this case.
+      begin
+        default_compare = @client.compare @repo[:full_name],
+          @repo[:default_branch], @commit[:sha]
+      rescue Octokit::NotFound
+        default_compare = nil
+      end
+
+      # The compare status should be "identical" or "behind" if the commit is in
+      # the default branch
+      unless default_compare &&
+        %w(identical behind).include?(default_compare[:status])
+
+        # If the commit is not in the default branch, check the gh-pages branch
+        begin
+          gh_pages_compare = @client.compare @repo[:full_name], "gh-pages",
+            @commit[:sha]
+        rescue Octokit::NotFound
+          gh_pages_compare = nil
+        end
+        return false if !gh_pages_compare
+        return false if !%w(identical behind).include? gh_pages_compare [:status]
+      end
+
+      true
+    end
+
+    # Checks whether the commit was authored in the last year.
+    #
+    # @return [Boolean]
+    def commit_in_last_year?
+      a_year_ago = Time.now - (365.25 * 86400)
+      commit_time = @commit[:commit][:author][:date]
+      (commit_time <=> a_year_ago) == 1
+    end
+
+    # Checks whether the repository is a fork.
+    #
+    # @return [Boolean]
+    def repository_is_fork?
+      @repo[:fork]
+    end
+
+    # Checks whether the commit email is linked to the authenticated user's
+    # GitHub account.
+    #
+    # @return [Boolean]
+    def commit_email_linked_to_user?
+      @emails = @client.emails
+      @emails.map { |e| e[:email] }.include? @commit[:commit][:author][:email]
+    end
+
+    # Checks whether the authenticated user has starred the repository in which
+    # the commit exists.
+    #
+    # @return [Boolean]
+    def user_has_starred_repo?
+      @client.starred?(@nwo)
+    end
+
+    # Checks whether the authenticated user is a member of the organization
+    # that owns the repository (if the repository is owned by an organization
+    # account).
+    #
+    # @return [Boolean]
+    def user_is_repo_org_member?
+      false if @repo[:owner] != "Organization"
+      @client.organization_member? @repo[:owner][:login], @user[:login]
+    end
+
+    # Checks whether the authenticated user has push access to the repository in
+    # which the commit exists.
+    #
+    # @return [Boolean]
+    def user_can_push_to_repo?
+      @repo[:permissions][:push]
+    end
+
+    # Checks whether the authenticated user has forked the repository in which
+    # the commit exists.
+    #
+    # @return [Boolean]
+    def user_has_fork_of_repo?
+      # The API doesn't provide a simple means of checking whether a user has
+      # forked a repository. Here we need to get the user's forks and check the
+      # `parent` field of each fork to see whether it matches @repo.
+      @client.auto_paginate = true
+      @user_repos = @client.repos
+      @user_forks = @user_repos.select { |r| r[:fork] }
+      @user_forks.each do |f|
+        r = @client.repository f[:full_name]
+        return true if r[:parent][:full_name] == @repo[:full_name]
+      end
+      false
+    end
+
+    # Checks whether the "and" criteria for counting a commit as a contribution
+    # are correctly met.
+    #
+    # @return [Boolean]
+    def and_criteria_met?
+      @commit_in_valid_branch &&
+      @commit_in_last_year &&
+      @repo_not_a_fork &&
+      @commit_email_linked_to_user
+    end
+
+    # Checks whether the "or" criteria for counting a commit as a contribution
+    # are correctly met.
+    #
+    # @return [Boolean]
+    def or_criteria_met?
+      @user_has_starred_repo ||
+      @user_can_push_to_repo ||
+      @user_is_repo_org_member ||
+      @user_has_fork_of_repo
+    end
+  end
+end

data/lib/contribution-checker/version.rb

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

data/lib/contribution-checker.rb

@@ -0,0 +1,2 @@
+require "contribution-checker/version"
+require "contribution-checker/checker"

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: contribution-checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Dennes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Check whether a GitHub commit is counted as a \
+      contribution for a specific GitHub user.
+email:
+- jdennes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- contribution-checker.gemspec
+- lib/contribution-checker.rb
+- lib/contribution-checker/checker.rb
+- lib/contribution-checker/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: Check whether a commit is counted as a contribution.
+test_files: []