Class: Github::Users

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

Defined Under Namespace

Classes: Emails, Followers, Keys

Constant Summary collapse

VALID_USER_PARAMS_NAMES = 
%w[
  name
  email
  blog
  company
  location
  hireable
  bio
].freeze

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

#emails(options = {}, &block) ⇒ Object

Access to Users::Emails API



23
24
25
 
# File 'lib/github_api/users.rb', line 23

def emails(options={}, &block)
  @emails ||= ApiFactory.new('Users::Emails', current_options.merge(options), &block)
end

#followers(options = {}, &block) ⇒ Object

Access to Users::Followers API



28
29
30
 
# File 'lib/github_api/users.rb', line 28

def followers(options={}, &block)
  @followers ||= ApiFactory.new('Users::Followers', current_options.merge(options), &block)
end

#get(*args) ⇒ Object Also known as: find

Get a single unauthenticated user

Examples

github = Github.new
github.users.get user: 'user-name'

Get the authenticated user

Examples

github = Github.new oauth_token: '...'
github.users.get



70
71
72
73
74
75
76
77
78
 
# 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

#keys(options = {}, &block) ⇒ Object

Access to Users::Keys API



33
34
35
 
# File 'lib/github_api/users.rb', line 33

def keys(options={}, &block)
  @keys ||= ApiFactory.new('Users::Keys', current_options.merge(options), &block)
end

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

List all users.

This provides a dump of every user, in the order that they signed up for GitHub.

Parameters

  • :since - The integer ID of the last User that you’ve seen.

Examples

users = Github::Users.new
users.list



49
50
51
52
53
54
55
 
# 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(*args) ⇒ Object

Update the authenticated user

Inputs

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

Examples

github = Github.new :oauth_token => '..'
github.users.update
  "name" => "monalisa octocat",
  "email" => "[email protected]",
  "blog" => "https://github.com/blog",
  "company" => "GitHub",
  "location" => "San Francisco",
  "hireable" => true,
  "bio" => "There once..."



103
104
105
106
107
108
109
 
# 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