class Github::Client::Users::Followers
Public Instance Methods
follow(*args)
click to toggle source
Follow a user
@example
github = Github.new oauth_token: '...' github.users.followers.follow 'user-name' github.users.followers.follow username: 'user-name'
@api public
# File lib/github_api/client/users/followers.rb, line 98 def follow(*args) arguments(args, required: [:username]) put_request("/user/following/#{arguments.username}", arguments.params) end
following(*args) { |el| ... }
click to toggle source
List who a user is following
@example
github = Github.new github.users.followers.following 'user-name' github.users.followers.following 'user-name' { |user| ... }
List who the authenicated user is following
@example
github = Github.new oauth_token: '...' github.users.followers.following
@api public
# File lib/github_api/client/users/followers.rb, line 50 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)
click to toggle source
Check if you are following a user
@example
github = Github.new oauth_token: '...' github.users.followers.following? 'user-name' github.users.followers.following? username: 'user-name'
Check if one user follows another
@example
github = Github.new oauth_token: '...' github.users.followers.following? username: 'user-name', target_user: 'target-user-name'
@api public
# File lib/github_api/client/users/followers.rb, line 77 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) { |el| ... }
click to toggle source
List a user's followers
@example
github = Github.new github.users.followers.list 'user-name' github.users.followers.list 'user-name' { |user| ... }
List the authenticated user's followers
@example
github = Github.new oauth_token: '...' github.users.followers github.users.followers { |user| ... }
@api public
# File lib/github_api/client/users/followers.rb, line 23 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
Also aliased as: all
unfollow(*args)
click to toggle source
Unfollow a user
@example
github = Github.new oauth_token: '...' github.users.followers.unfollow 'user-name' github.users.followers.unfollow username: 'user-name'
# File lib/github_api/client/users/followers.rb, line 110 def unfollow(*args) arguments(args, required: [:username]) delete_request("/user/following/#{arguments.username}", arguments.params) end