class Github::Activity::Starring
Stars are shown next to repositories to show an approximate level of interest. # Stars have no effect on notifications or the activity feed.
Repository Starring is a feature that lets users bookmark repositories.
def list(user_name, repo_name, params={})
github.activity.starring.list { |star| ... }
github.activity.starring.list
github = Github.new :user => 'user-name', :repo => 'repo-name'
= Examples
List stargazers
def list(user_name, repo_name, params={}) set :user => user_name, :repo => repo_name assert_presence_of user, repo normalize! params response = get_request("/repos/#{user}/#{repo}/stargazers", params) return response unless block_given? response.each { |el| yield el } end
def star(user_name, repo_name, params={})
github.activity.starring.star 'user-name', 'repo-name'
github = Github.new
= Examples
You need to be authenticated to star a repository
Star a repository
def star(user_name, repo_name, params={}) set :user => user_name, :repo => repo_name assert_presence_of user_name, repo_name normalize! params put_request("/user/starred/#{user_name}/#{repo_name}", params) end
def starred(*args)
github.activity.starring.starred
github = Github.new :oauth_token => '...'
= Examples
List repos being starred by the authenticated user
github.activity.starring.starred :user => 'user-name'
github = Github.new
= Examples
List repos being starred by a user
def starred(*args) params = args.extract_options! normalize! params response = if (user_name = params.delete('user')) get_request("/users/#{user_name}/starred", params) else get_request("/user/starred", params) end return response unless block_given? response.each { |el| yield el } end
def starring?(user_name, repo_name, params={})
github.activity.starring.starring? 'user-name', 'repo-name'
github = Github.new
= Examples
Returns true if this repo is starred by you,false otherwise
Check if you are starring a repository
def starring?(user_name, repo_name, params={}) assert_presence_of user_name, repo_name normalize! params get_request("/user/starred/#{user_name}/#{repo_name}", params) true rescue Github::Error::NotFound false end
def unstar(user_name, repo_name, params={})
github.activity.starring.unstar 'user-name', 'repo-name'
github = Github.new
= Examples
You need to be authenticated to unstar a repository.
Unstar a repository
def unstar(user_name, repo_name, params={}) set :user => user_name, :repo => repo_name assert_presence_of user_name, repo_name normalize! params delete_request("/user/starred/#{user_name}/#{repo_name}", params) end