Class: Github::Client::Repos::Statistics

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/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 MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

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

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

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| ... }


51
52
53
54
55
 
# File 'lib/github_api/client/repos/statistics.rb', line 51

def code_frequency(*args)
  arguments(args, required: [:user, :repo])

  get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/code_frequency", arguments.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| ... }


35
36
37
38
39
40
41
 
# File 'lib/github_api/client/repos/statistics.rb', line 35

def commit_activity(*args)
  arguments(args, required: [:user, :repo])

  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/commit_activity", arguments.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| ... }


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

def contributors(*args)
  arguments(args, required: [:user, :repo])

  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/contributors", arguments.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| ... }


65
66
67
68
69
 
# File 'lib/github_api/client/repos/statistics.rb', line 65

def participation(*args)
  arguments(args, required: [:user, :repo])

  get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/participation", arguments.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| ... }


79
80
81
82
83
84
85
 
# File 'lib/github_api/client/repos/statistics.rb', line 79

def punch_card(*args)
  arguments(args, required: [:user, :repo])

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