Contents

# encoding: utf-8

module Github
  class Users::Emails < API

    # List email addresses for the authenticated user
    #
    # = Examples
    #  github = Github.new :oauth_token => '...'
    #  github.users.emails.list
    #  github.users.emails.list { |email| ... }
    #
    def list(params={})
      _normalize_params_keys(params)
      response = get_request("/user/emails", params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias :all :list

    # 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 "[e-mail]", "[e-mail]"
    #
    def add(*args)
      params = _extract_parameters(args)
      _normalize_params_keys(params)
      params['data'] = [args].flatten if args
      post_request("/user/emails", params)
    end
    alias :<< :add

    # 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 "[e-mail]", "[e-mail]"
    #
    def delete(*args)
      params = _extract_parameters(args)
      _normalize_params_keys(params)
      params['data'] = [args].flatten
      delete_request("/user/emails", params)
    end

  end # Users::Emails
end # Github

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
github_api-0.5.1	lib/github_api/users/emails.rb
github_api-0.5.0	lib/github_api/users/emails.rb
github_api-0.5.0.rc1	lib/github_api/users/emails.rb