Class: Github::Users::Emails

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

Constant Summary

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

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

Add email address(es) for the authenticated user

Inputs

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

Examples

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



31
32
33
34
35
36
37
 
# File 'lib/github_api/users/emails.rb', line 31

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

Inputs

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

Examples

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



49
50
51
52
53
54
55
 
# File 'lib/github_api/users/emails.rb', line 49

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

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

#list(*args) ⇒ Object 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| ... }



14
15
16
17
18
19
 
# File 'lib/github_api/users/emails.rb', line 14

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