Repository Starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. # Stars have no effect on notifications or the activity feed.
List stargazers
github = Github.new :user => 'user-name', :repo => 'repo-name' github.activity.starring.list github.activity.starring.list { |star| ... }
# File lib/github_api/activity/starring.rb, line 14 def list(*args) arguments(args, :required => [:user, :repo]) response = get_request("/repos/#{user}/#{repo}/stargazers", arguments.params) return response unless block_given? response.each { |el| yield el } end
Star a repository
You need to be authenticated to star a repository
github = Github.new github.activity.starring.star 'user-name', 'repo-name'
# File lib/github_api/activity/starring.rb, line 72 def star(*args) arguments(args, :required => [:user, :repo]) put_request("/user/starred/#{user}/#{repo}", arguments.params) end
List repos being starred by a user
github = Github.new github.activity.starring.starred :user => 'user-name'
List repos being starred by the authenticated user
github = Github.new :oauth_token => '...' github.activity.starring.starred
# File lib/github_api/activity/starring.rb, line 35 def starred(*args) params = arguments(args).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
Check if you are starring a repository
Returns true if this repo is starred by you,false otherwise
github = Github.new github.activity.starring.starring? 'user-name', 'repo-name'
# File lib/github_api/activity/starring.rb, line 55 def starring?(*args) arguments(args, :required => [:user, :repo]) get_request("/user/starred/#{user}/#{repo}", arguments.params) true rescue Github::Error::NotFound false end
Unstar a repository
You need to be authenticated to unstar a repository.
github = Github.new github.activity.starring.unstar 'user-name', 'repo-name'
# File lib/github_api/activity/starring.rb, line 86 def unstar(*args) arguments(args, :required => [:user, :repo]) delete_request("/user/starred/#{user}/#{repo}", arguments.params) end
Generated with the Darkfish Rdoc Generator 2.