Class: Github::Activity::Starring

Inherits:
Github::API show all
Defined in:
lib/github_api/activity/starring.rb

Overview

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.

Constant Summary

Constants included from Request

Request::METHODS, 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 Github::API

#current_options

Attributes included from Github::Authorization

#scopes

Instance Method Summary collapse

Methods inherited from Github::API

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

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from 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 Github::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

#list(*args) ⇒ Object Also known as: all

List stargazers

Examples

github = Github.new :user => 'user-name', :repo => 'repo-name'
github.activity.starring.list
github.activity.starring.list { |star| ... }



15
16
17
18
19
20
21
 
# File 'lib/github_api/activity/starring.rb', line 15

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(*args) ⇒ Object

Star a repository

You need to be authenticated to star a repository

Examples

github = Github.new
github.activity.starring.star 'user-name', 'repo-name'



73
74
75
76
77
 
# File 'lib/github_api/activity/starring.rb', line 73

def star(*args)
  arguments(args, :required => [:user, :repo])

  put_request("/user/starred/#{user}/#{repo}", arguments.params)
end

#starred(*args) ⇒ Object

List repos being starred by a user

Examples

github = Github.new
github.activity.starring.starred :user => 'user-name'

List repos being starred by the authenticated user

Examples

github = Github.new :oauth_token => '...'
github.activity.starring.starred



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/github_api/activity/starring.rb', line 36

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

#starring?(*args) ⇒ Boolean

Check if you are starring a repository

Returns true if this repo is starred by you,false otherwise

Examples

github = Github.new
github.activity.starring.starring? 'user-name', 'repo-name'

Returns:

  • (Boolean) 


56
57
58
59
60
61
62
63
 
# File 'lib/github_api/activity/starring.rb', line 56

def starring?(*args)
  arguments(args, :required => [:user, :repo])

  get_request("/user/starred/#{user}/#{repo}", arguments.params)
  true
rescue Github::Error::NotFound
  false
end

#unstar(*args) ⇒ Object

Unstar a repository

You need to be authenticated to unstar a repository.

Examples

github = Github.new
github.activity.starring.unstar 'user-name', 'repo-name'



87
88
89
90
91
 
# File 'lib/github_api/activity/starring.rb', line 87

def unstar(*args)
  arguments(args, :required => [:user, :repo])

  delete_request("/user/starred/#{user}/#{repo}", arguments.params)
end