Module: CircleCi

Extended by:
CircleCi
Included in:
CircleCi
Defined in:
lib/circleci.rb,
lib/circleci/http.rb,
lib/circleci/user.rb,
lib/circleci/build.rb,
lib/circleci/config.rb,
lib/circleci/project.rb,
lib/circleci/response.rb,
lib/circleci/request_error.rb

Defined Under Namespace

Classes: Build, Config, Http, Project, RequestError, Response, User

Instance Method Summary collapse

Instance Method Details

#config ⇒ CircleCi::Config

Returns:



35
36
37
 
# File 'lib/circleci.rb', line 35

def config
  @config ||= Config.new
end

#configure {|config| ... } ⇒ Object

Examples:

Configure CircleCi with your token

CircleCi.configure do |config|
  config.token = 'my-token'
end

Yields:



28
29
30
 
# File 'lib/circleci.rb', line 28

def configure
  yield config
end

#http ⇒ Object 



39
40
41
 
# File 'lib/circleci.rb', line 39

def http # @private
  Http.new(config)
end

#organization(name, params = {}) ⇒ CircleCi::Response

Get recent builds for an organization

Parameters:

  • name (String) —

    Name of the organization. Currently CircleCi treats the name case sensetive so make sure the spelling is the same as the github organisation.

  • params (Hash) (defaults to: {}) —

    Additional query params.

Returns:



53
54
55
 
# File 'lib/circleci.rb', line 53

def organization(name, params = {})
  http.get "/organization/#{name}", params
end