module GithubContributionsApi

A ruby interface to the GitHub Contributions Archive API (githubcontributions.io). To the author’s knowlege, this API is undocumented.

Constants

URL_BASE: The prexix for all GitHub Contributions API endpoints.
VERSION: The current version of this library. Follows semantic versioning (semver.org/).

Public Class Methods

user(github_username) click to toggle source

Get information about a given github user. @param [String] github_username The username of the github user. @example GithubContributionsApi.user(“octocat”) @return [Hash]

# File lib/github_contributions_api.rb, line 14
def self.user(github_username)
  request_url = "#{URL_BASE}/user/#{github_username}"
  response = HTTParty.get(request_url)
  JSON.parse(response.body)
end

user_events(github_username, options = {}) click to toggle source

Get events for a given github user. @param [String] github_username The username of the github user. @param [Hash] options @option options [Integer] :page (1) The requested page number. @example GithubContributionsApi.user_events(“octocat”) @example GithubContributionsApi.user_events(“octocat”, :page => 1) @example GithubContributionsApi.user_events(“s2t2”, :page => 2) @return [Hash]

# File lib/github_contributions_api.rb, line 28
def self.user_events(github_username, options = {})
  page_number = options[:page] || 1
  request_url = "#{URL_BASE}/user/#{github_username}/events/#{page_number}"
  response = HTTParty.get(request_url)
  JSON.parse(response.body)
end