Class: CircleCIReporter::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/circleci_reporter/client.rb

Overview

CircleCI API client

Constant Summary collapse

CIRCLECI_ENDPOINT = 
'https://circleci.com/api/v1.1'

Instance Method Summary collapse

Instance Method Details

#artifacts(build_number) ⇒ Array<Artifact>

Retrieve artifacts for the build.

Parameters:

  • build_number (Integer)

Returns:

Raises:

See Also:



37
38
39
40
41
42
43
 
# File 'lib/circleci_reporter/client.rb', line 37

def artifacts(build_number)
  resp = get(artifacts_url(build_number))
  body = JSON.parse(resp.body)
  raise RequestError.new(body['message'], resp) unless resp.success?

  body.map{ |hash| create_artifact(hash) }
end

#build_number_by_revision(revision, branch: nil) ⇒ Integer?

Find the latest build number for the given vcs revision.

Parameters:

  • revision (String)
  • branch (String, nil) (defaults to: nil)

Returns:

  • (Integer, nil) 


50
51
52
53
 
# File 'lib/circleci_reporter/client.rb', line 50

def build_number_by_revision(revision, branch: nil)
  build = recent_builds(branch).find { |recent_build| recent_build.match?(revision) }
  build ? build.build_number : nil
end

#get(url, params = {}) ⇒ Faraday::Response

Raw entry point for GET APIs.

Parameters:

  • url (String)
  • params (Hash) (defaults to: {})

Returns:

  • (Faraday::Response) 


60
61
62
63
64
65
66
67
 
# File 'lib/circleci_reporter/client.rb', line 60

def get(url, params = {})
  params['circle-token'] = configuration.circleci_token
  query_string = params.map { |key, value| "#{key}=#{value}" }.join('&')
  connection = Faraday.new do |faraday|
    faraday.use FaradayMiddleware::FollowRedirects
  end
  connection.get("#{url}?#{query_string}")
end

#single_build(build_number) ⇒ Build?

Fetch a build data from API and create a Build object for it.

Parameters:

  • build_number (Integer, nil)

Returns:

Raises:

See Also:



21
22
23
24
25
26
27
28
29
 
# File 'lib/circleci_reporter/client.rb', line 21

def single_build(build_number)
  return unless build_number

  resp = get(single_build_url(build_number))
  body = JSON.parse(resp.body)
  raise RequestError.new(body['message'], resp) unless resp.success?

  create_build(body)
end