Class: CircleCi::ApiResource

Inherits:
Object
  • Object
show all
Defined in:
lib/circleci/api_resource.rb

Overview

ApiResource is a parent class for rest resources for the CircleCI API. It allows for request conifugration to be set per request if needed, otherwise the default global CircleCi.config is used

Direct Known Subclasses

ApiProjectResource, Projects, RecentBuilds, User

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username = nil, project = nil, conf = nil) ⇒ ApiResource

Returns a new instance of ApiResource.



13
14
15
16
17
 
# File 'lib/circleci/api_resource.rb', line 13

def initialize(username = nil, project = nil, conf = nil)
  @username = username
  @project = project
  @conf = conf || default_config
end

Instance Attribute Details

#conf ⇒ Object (readonly)

Returns the value of attribute conf.



11
12
13
 
# File 'lib/circleci/api_resource.rb', line 11

def conf
  @conf
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



11
12
13
 
# File 'lib/circleci/api_resource.rb', line 11

def project
  @project
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



11
12
13
 
# File 'lib/circleci/api_resource.rb', line 11

def username
  @username
end

Class Method Details

.default_config ⇒ Object 



19
20
21
 
# File 'lib/circleci/api_resource.rb', line 19

def self.default_config
  CircleCi.config
end

Instance Method Details

#default_config ⇒ Object 



23
24
25
 
# File 'lib/circleci/api_resource.rb', line 23

def default_config
  self.class.default_config
end