Class: CIRunner::Client::CircleCI

Inherits:

Base

• Object
• Base
• CIRunner::Client::CircleCI

Defined in:

lib/ci_runner/client/circle_ci.rb

Constant Summary

API_ENDPOINT =

"circleci.com"

Instance Method Summary

• #job(repository, build_number) ⇒ Object
• #me ⇒ Hash

  Make an API request to get the authenticated user.

Methods inherited from Base

default_client, #initialize

Constructor Details

This class inherits a constructor from CIRunner::Client::Base

Instance Method Details

#job(repository, build_number) ⇒ Object

Parameters:

• repository (String) —

  The full repository name including the owner (rails/rails).

• build_number (Integer) —

  The CircleCI build number.

See Also:

• https://circleci.com/docs/api/v1/index.html#single-job

# File 'lib/ci_runner/client/circle_ci.rb', line 24

def job(repository, build_number)
  get("/api/v1.1/project/github/#{repository}/#{build_number}")
rescue Error => e
  reraise_with_reason(e)
end

#me ⇒ Hash

Make an API request to get the authenticated user. Used to verify if the access token the user has stored in its config is valid.

Returns:

• (Hash) —

  See Circle CI documentation.

See Also:

• https://circleci.com/docs/api/v1/index.html#user

# File 'lib/ci_runner/client/circle_ci.rb', line 16

def me
  get("/api/v1.1/me")
end