Class: Github::Repos::Statistics

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/repos/statistics.rb

Overview

The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.

Constant Summary

Constants included from Github::Request

Github::Request::METHODS, Github::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#code_frequency(*args) ⇒ Object

Get the number of additions and deletions per week

Examples

github = Github.new
github.repos.stats.code_frequency user: '...', repo: '...'
github.repos.stats.code_frequency user: '...', repo: '...' { |stat| ... }



54
55
56
57
58
59
 
# File 'lib/github_api/repos/statistics.rb', line 54

def code_frequency(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/stats/code_frequency", params)
end

#commit_activity(*args) ⇒ Object

Get the last year of commit activity data

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday

Examples

github = Github.new
github.repos.stats.commit_activity user: '...', repo: '...'
github.repos.stats.commit_activity user: '...', repo: '...' { |stat| ... }



37
38
39
40
41
42
43
44
 
# File 'lib/github_api/repos/statistics.rb', line 37

def commit_activity(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/stats/commit_activity", params)
  return response unless block_given?
  response.each { |el| yield el }
end

#contributors(*args) ⇒ Object

Get contributors list with additions, deletions, and commit counts

Examples

github = Github.new
github.repos.stats.contributors user: '...', repo: '...'
github.repos.stats.contributors user: '...', repo: '...' { |stat| ... }



17
18
19
20
21
22
23
24
 
# File 'lib/github_api/repos/statistics.rb', line 17

def contributors(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/stats/contributors", params)
  return response unless block_given?
  response.each { |el| yield el }
end

#participation(*args) ⇒ Object

Get the weekly commit count for the repo owner and everyone else

Examples

github = Github.new
github.repos.stats.participation user: '...', repo: '...'
github.repos.stats.participation user: '...', repo: '...' { |stat| ... }



69
70
71
72
73
74
 
# File 'lib/github_api/repos/statistics.rb', line 69

def participation(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/stats/participation", params)
end

#punch_card(*args) ⇒ Object

Get the number of commits per hour in each day

Examples

github = Github.new
github.repos.stats.punch_card user: '...', repo: '...'
github.repos.stats.punch_card user: '...', repo: '...' { |stat| ... }



84
85
86
87
88
89
90
91
 
# File 'lib/github_api/repos/statistics.rb', line 84

def punch_card(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/stats/punch_card", params)
  return response unless block_given?
  response.each { |el| yield el }
end