Class: CircleCi::User

Inherits:

ApiResource

• Object
• ApiResource
• CircleCi::User

Defined in:

lib/circleci/user.rb

Overview

User class to access user details for a specific API key

Instance Attribute Summary

Attributes inherited from ApiResource

#conf, #project, #username

Instance Method Summary

• #heroku_key(apikey) ⇒ CircleCi::Response

  Add a Heroku API key to CircleCI.

• #initialize(conf = nil) ⇒ CircleCi::User constructor

  Initialize a new User API interaction.

• #me ⇒ CircleCi::Response

  Get user account details.

Methods inherited from ApiResource

default_config, #default_config

Constructor Details

#initialize(conf = nil) ⇒ CircleCi::User

Initialize a new User API interaction

Parameters:

• conf (CircleCi::Config) (defaults to: nil) —

  • Optional config to use for request

# File 'lib/circleci/user.rb', line 13

def initialize(conf = nil)
  super(nil, nil, conf)
end

Instance Method Details

#heroku_key(apikey) ⇒ CircleCi::Response

Add a Heroku API key to CircleCI

Parameters:

• apikey (String) —

  • The Heroku API key

Returns:

• (CircleCi::Response) —

  • Response object

# File 'lib/circleci/user.rb', line 32

def heroku_key(apikey)
  CircleCi.request(conf, '/user/heroku-key').post(apikey: apikey)
end

#me ⇒ CircleCi::Response

Get user account details

Returns:

• (CircleCi::Response) —

  • Response object

# File 'lib/circleci/user.rb', line 22

def me
  CircleCi.request(conf, '/me').get
end