Class: Github::Users::Followers

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/users/followers.rb

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

#follow(*args) ⇒ Object

Follow a user

Examples

github = Github.new oauth_token: '...'
github.users.followers.follow 'user-name'
github.users.followers.follow user: 'user-name'



81
82
83
84
 
# File 'lib/github_api/users/followers.rb', line 81

def follow(*args)
  arguments(args, :required => [:user])
  put_request("/user/following/#{user}", arguments.params)
end

#following(*args) ⇒ Object

List who a user is following

Examples

github = Github.new
github.users.followers.following 'user-name'
github.users.followers.following 'user-name' { |user| ... }

List who the authenicated user is following

Examples

github = Github.new oauth_token: '...'
github.users.followers.following



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/github_api/users/followers.rb', line 47

def following(*args)
  params = arguments(args).params

  response = if user_name = arguments.remaining.first
    get_request("/users/#{user_name}/following", params)
  else
    get_request("/user/following", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end

#following?(*args) ⇒ Boolean

Check if you are following a user

Examples

github = Github.new oauth_token: '...'
github.users.followers.following? 'user-name'
github.users.followers.following? user: 'user-name'

Returns:

  • (Boolean) 


66
67
68
69
70
71
72
 
# File 'lib/github_api/users/followers.rb', line 66

def following?(*args)
  arguments(args, :required => [:user])
  get_request("/user/following/#{user}", arguments.params)
  true
rescue Github::Error::NotFound
  false
end

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

List a user’s followers

Examples

github = Github.new
github.users.followers.list 'user-name'
github.users.followers.list 'user-name' { |user| ... }

List the authenticated user’s followers

Examples

github = Github.new oauth_token: '...'
github.users.followers
github.users.followers { |user| ... }



20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/github_api/users/followers.rb', line 20

def list(*args)
  params = arguments(args).params

  response = if user_name = arguments.remaining.first
    get_request("/users/#{user_name}/followers", params)
  else
    get_request("/user/followers", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end

#unfollow(*args) ⇒ Object

Unfollow a user

Examples

github = Github.new oauth_token: '...'
github.users.followers.unfollow 'user-name'
github.users.followers.unfollow user: 'user-name'



93
94
95
96
 
# File 'lib/github_api/users/followers.rb', line 93

def unfollow(*args)
  arguments(args, :required => [:user])
  delete_request("/user/following/#{user}", arguments.params)
end