Class: Github::Client::Users::Emails

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/users/emails.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

#add(*args) ⇒ Object Also known as: <<

Add email address(es) for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.emails.add "[email protected]", "[email protected]"

Parameters:

  • emails (Array[String])

    You can include a single email address or an array of addresses


35
36
37
38
39
40
41
# File 'lib/github_api/client/users/emails.rb', line 35

def add(*args)
  arguments(args)
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  post_request("/user/emails", params)
end

#delete(*args) ⇒ Object

Delete email address(es) for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.emails.delete "[email protected]", "[email protected]"

Parameters:

  • emails (Array[String])

    You can include a single email address or an array of addresses


54
55
56
57
58
59
60
# File 'lib/github_api/client/users/emails.rb', line 54

def delete(*args)
  arguments(args)
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  delete_request("/user/emails", params)
end

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

List email addresses for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.emails.list
github.users.emails.list { |email| ... }

Returns:


17
18
19
20
21
22
# File 'lib/github_api/client/users/emails.rb', line 17

def list(*args)
  arguments(args)
  response = get_request("/user/emails", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end