Class: CircleCi::Projects

Inherits:

ApiResource

• Object
• ApiResource
• CircleCi::Projects

Defined in:

lib/circleci/projects.rb

Overview

Class for getting all your Projects on CircleCI

Instance Attribute Summary

Attributes inherited from ApiResource

#conf, #project, #username

Instance Method Summary

• #get ⇒ CircleCi::Response

  Get all projects for your API key.

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

  Initialize a Projects resource to get all projects.

Methods inherited from ApiResource

default_config, #default_config

Constructor Details

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

Initialize a Projects resource to get all projects

Parameters:

• config (CircleCi::Config) —

  • Defaults to [default_config] if not provided

# File 'lib/circleci/projects.rb', line 14

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

Instance Method Details

#get ⇒ CircleCi::Response

Get all projects for your API key

Returns:

• (CircleCi::Response) —

  • Response object

# File 'lib/circleci/projects.rb', line 23

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