API
Access to Users::Emails API
# File lib/github_api/users.rb, line 23 def emails(options={}, &block) @emails ||= ApiFactory.new('Users::Emails', current_options.merge(options), &block) end
Access to Users::Followers API
# File lib/github_api/users.rb, line 28 def followers(options={}, &block) @followers ||= ApiFactory.new('Users::Followers', current_options.merge(options), &block) end
Get a single unauthenticated user
github = Github.new github.users.get user: 'user-name'
Get the authenticated user
github = Github.new oauth_token: '...' github.users.get
# File lib/github_api/users.rb, line 70 def get(*args) params = arguments(args).params if user_name = params.delete('user') get_request("/users/#{user_name}", params) else get_request("/user", params) end end
Access to Users::Keys API
# File lib/github_api/users.rb, line 33 def keys(options={}, &block) @keys ||= ApiFactory.new('Users::Keys', current_options.merge(options), &block) end
List all users.
This provides a dump of every user, in the order that they signed up for GitHub.
:since - The integer ID of the last User that you’ve seen.
users = Github::Users.new users.list
# File lib/github_api/users.rb, line 49 def list(*args) arguments(args) response = get_request("/users", arguments.params) return response unless block_given? response.each { |el| yield el } end
Update the authenticated user
:name - Optional string
:email - Optional string - publically visible email address
:blog - Optional string
:company - Optional string
:location - Optional string
:hireable - Optional boolean
:bio - Optional string
github = Github.new :oauth_token => '..' github.users.update "name" => "monalisa octocat", "email" => "octocat@github.com", "blog" => "https://github.com/blog", "company" => "GitHub", "location" => "San Francisco", "hireable" => true, "bio" => "There once..."
# File lib/github_api/users.rb, line 103 def update(*args) arguments(args) do sift VALID_USER_PARAMS_NAMES end patch_request("/user", arguments.params) end
Generated with the Darkfish Rdoc Generator 2.