Contents

# encoding: utf-8

require 'cgi'

require_relative '../../api'

module Github
  class Client::Users::Emails < API

    # List email addresses for the authenticated user
    #
    # @example
    #  github = Github.new oauth_token: '...'
    #  github.users.emails.list
    #  github.users.emails.list { |email| ... }
    #
    # @return [Hash]
    #
    # @api public
    def list(*args)
      arguments(args)
      response = get_request("/user/emails", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias :all :list

    # Add email address(es) for the authenticated user
    #
    # @param [Array[String]] emails
    #   You can include a single email address or an array of addresses
    #
    # @example
    #  github = Github.new oauth_token: '...'
    #  github.users.emails.add "[e-mail]", "[e-mail]"
    #
    # @api public
    def add(*args)
      arguments(args)
      params = arguments.params
      params['data'] = arguments.remaining unless arguments.remaining.empty?

      post_request("/user/emails", params)
    end
    alias :<< :add

    # Delete email address(es) for the authenticated user
    #
    # @param [Array[String]] emails
    #   You can include a single email address or an array of addresses
    #
    # @example
    #  github = Github.new oauth_token: '...'
    #  github.users.emails.delete "[e-mail]", "[e-mail]"
    #
    # @api public
    def delete(*args)
      arguments(args)
      params = arguments.params
      params['data'] = arguments.remaining unless arguments.remaining.empty?

      delete_request("/user/emails", params)
    end
  end # Users::Emails
end # Github

Version data entries

6 entries across 6 versions & 3 rubygems

Version	Path
github_api2-1.0.1	lib/github_api2/client/users/emails.rb
github_api2-1.0.0	lib/github_api2/client/users/emails.rb
github_api-0.19.0	lib/github_api/client/users/emails.rb
lingfennan-github_api-0.18.2	lib/github_api/client/users/emails.rb
github_api-0.18.2	lib/github_api/client/users/emails.rb
github_api-0.18.1	lib/github_api/client/users/emails.rb