Class: Github::Client::Users::Followers

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

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!, #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

#follow(*args) ⇒ Object

Follow a user

Examples:

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

96
97
98
99
# File 'lib/github_api/client/users/followers.rb', line 96

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

#following(*args) ⇒ Object

List who a user is following

List who the authenicated user is following

Examples:

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

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

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

Check if one user follows another

Examples:

github = Github.new oauth_token: '...'
github.users.followers.following? 'user-name'
github.users.followers.following? username: 'user-name'
github = Github.new oauth_token: '...'
github.users.followers.following? username: 'user-name',
  target_user: 'target-user-name'

Returns:

  • (Boolean)

75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/github_api/client/users/followers.rb', line 75

def following?(*args)
  arguments(args, required: [:username])
  params = arguments.params
  if target_user = params.delete('target_user')
    get_request("/users/#{arguments.username}/following/#{target_user}", params)
  else
    get_request("/user/following/#{arguments.username}", params)
  end
  true
rescue Github::Error::NotFound
  false
end

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

List a user's followers

List the authenticated user's followers

Examples:

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

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

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 username: 'user-name'

108
109
110
111
# File 'lib/github_api/client/users/followers.rb', line 108

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