Module: Octokit::Client::Users
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/users.rb
Instance Method Summary collapse
- #add_email(email, options = {}) ⇒ Object
- #add_key(title, key, options = {}) ⇒ Object
- #emails(options = {}) ⇒ Object
- #follow(user, options = {}) ⇒ Object
- #followers(user = login, options = {}) ⇒ Object
- #following(user = login, options = {}) ⇒ Object
- #follows?(*args) ⇒ Boolean
-
#keys(options = {}) ⇒ Object
Not yet supported: get a single key, update an existing key.
- #remove_email(email, options = {}) ⇒ Object
- #remove_key(id, options = {}) ⇒ Object
- #search_users(search, options = {}) ⇒ Object
- #unfollow(user, options = {}) ⇒ Object
-
#update_user(options) ⇒ Hashie::Mash
Update the authenticated user.
-
#user(user = nil) ⇒ Hashie::Mash
Get a single user.
- #watched(user = login, options = {}) ⇒ Object
Instance Method Details
#add_email(email, options = {}) ⇒ Object
88 89 90 |
# File 'lib/octokit/client/users.rb', line 88 def add_email(email, ={}) post("user/emails", .merge({:email => email}), 3) end |
#add_key(title, key, options = {}) ⇒ Object
76 77 78 |
# File 'lib/octokit/client/users.rb', line 76 def add_key(title, key, ={}) post("user/keys", .merge({:title => title, :key => key}), 3) end |
#emails(options = {}) ⇒ Object
84 85 86 |
# File 'lib/octokit/client/users.rb', line 84 def emails(={}) get("user/emails", , 3) end |
#follow(user, options = {}) ⇒ Object
58 59 60 |
# File 'lib/octokit/client/users.rb', line 58 def follow(user, ={}) put("user/following/#{user}", , 3, true, raw=true).status == 204 end |
#followers(user = login, options = {}) ⇒ Object
40 41 42 |
# File 'lib/octokit/client/users.rb', line 40 def followers(user=login, ={}) get("users/#{user}/followers", , 3) end |
#following(user = login, options = {}) ⇒ Object
44 45 46 |
# File 'lib/octokit/client/users.rb', line 44 def following(user=login, ={}) get("users/#{user}/following", , 3) end |
#follows?(*args) ⇒ Boolean
48 49 50 51 52 53 54 55 56 |
# File 'lib/octokit/client/users.rb', line 48 def follows?(*args) target = args.pop user = args.first user ||= login return if user.nil? get("user/following/#{target}", {}, 3, true, raw=true).status == 204 rescue Octokit::NotFound false end |
#keys(options = {}) ⇒ Object
Not yet supported: get a single key, update an existing key
72 73 74 |
# File 'lib/octokit/client/users.rb', line 72 def keys(={}) get("user/keys", , 3) end |
#remove_email(email, options = {}) ⇒ Object
92 93 94 |
# File 'lib/octokit/client/users.rb', line 92 def remove_email(email, ={}) delete("user/emails", .merge({:email => email}), 3, true, raw=true).status == 204 end |
#remove_key(id, options = {}) ⇒ Object
80 81 82 |
# File 'lib/octokit/client/users.rb', line 80 def remove_key(id, ={}) delete("user/keys/#{id}", , 3, true, raw=true) end |
#search_users(search, options = {}) ⇒ Object
5 6 7 |
# File 'lib/octokit/client/users.rb', line 5 def search_users(search, ={}) get("legacy/user/search/#{search}", , 3)['users'] end |
#unfollow(user, options = {}) ⇒ Object
62 63 64 |
# File 'lib/octokit/client/users.rb', line 62 def unfollow(user, ={}) delete("user/following/#{user}", , 3, true, raw=true).status == 204 end |
#update_user(options) ⇒ Hashie::Mash
Update the authenticated user
36 37 38 |
# File 'lib/octokit/client/users.rb', line 36 def update_user() patch("user", , 3) end |
#user(user = nil) ⇒ Hashie::Mash
Get a single user
15 16 17 18 19 20 21 |
# File 'lib/octokit/client/users.rb', line 15 def user(user=nil) if user get("users/#{user}", {}, 3) else get("user", {}, 3) end end |
#watched(user = login, options = {}) ⇒ Object
66 67 68 |
# File 'lib/octokit/client/users.rb', line 66 def watched(user=login, ={}) get("users/#{user}/watched", , 3) end |