Circle CI API Wrapper. Requires ruby >= 2.0.0.
gem install circlecior with Bundler
gem 'circleci'Configure using an API token from Circle
CircleCi.configure do |config|
config.token = 'my-token'
endOptionally you can configure your own host and/or port if using an enterprise
CircleCi host. The port will default to 80 if not set.
CircleCi.configure do |config|
config.token = 'my-token'
config.host = 'https://ci.mycompany.com'
config.port = 1234
endOverriding request settings such as not verifying SSL
CircleCi.configure do |config|
config.token = ENV['CIRCLECI_TOKEN']
config.host = 'http://ci.mycompany.com'
config.port = 80
config.request_overrides = {
use_ssl: false,
verify_ssl: false
}
endSetup for proxying requests
require 'circleci'
CircleCi.configure do |config|
config.token = ENV['CIRCLECI_TOKEN']
config.proxy_host = 'http://ciproxy.mycompany.com'
config.proxy_port = 8000
config.proxy_user = 'myci'
config.proxy_pass = 'supersecret'
config.proxy = true
endEndpoint: /user/heroku-key
Adds your Heroku API key to CircleCI.
res = CircleCi::User.heroku_key 'your-api-key'
res.success? # True
res.bodyExample response
Empty body response with a 200 OK response code
""Endpoint: /me
Provides information about the signed in user.
res = CircleCi::User.me
res.success? # True
res.bodyExample response
{
"basic_email_prefs" : "smart", // can be "smart", "none" or "all"
"login" : "pbiggar" // your github username
}Endpoint: /projects
List of all the repos you have access to on Github, with build information organized by branch.
res = CircleCi::Project.all
res.success?
res.bodyExample response
[ {
"vcs_url": "https://github.com/circleci/mongofinil"
"followed": true // true if you follow this project in Circle
"branches" : {
"master" : {
"pusher_logins" : [ "pbiggar", "arohner" ], // users who have pushed
"last_non_success" : { // last failed build on this branch
"pushed_at" : "2013-02-12T21:33:14Z",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"build_num" : 22,
"outcome" : "failed",
},
"last_success" : { // last successful build on this branch
"pushed_at" : "2012-08-09T03:59:53Z",
"vcs_revision" : "384211bbe72b2a22997116a78788117b3922d570",
"build_num" : 15,
"outcome" : "success",
},
"recent_builds" : [ { // last 5 builds, ordered by pushed_at (decreasing)
"pushed_at" : "2013-02-12T21:33:14Z",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"build_num" : 22,
"outcome" : "failed",
}, {
"pushed_at" : "2013-02-11T03:09:54Z",
"vcs_revision" : "0553ba86b35a97e22ead78b0d568f6a7c79b838d",
"build_num" : 21,
"outcome" : "failed",
}, ... ],
"running_builds" : [ ] // currently running builds
}
}
} ]Endpoint: /project/:username/:repository/tree/:branch
Build a specific branch of a project
res = CircleCi::Project.build_branch 'username', 'reponame', 'branch'
res.body['status'] # Not running
res.body['build_url'] # Get url of build
# Passing build parameters in the post body
build_params = { build_parameters: { 'MY_TOKEN' => '123asd123asd' } }
res = CircleCi::Project.build_branch 'username', 'reponame', 'branch', {}, build_params
res.body['status'] # Not running
res.body['build_url'] # Get url of build
# Adding URL params for revision or parallel
params = { revision: 'fda12345asdf', parallel: 2 }
res = CircleCi::Project.build_branch 'username', 'reponame', 'branch', params
res.body['status'] # Not running
res.body['build_url'] # Get url of buildExample response
{
"compare" : null,
"previous_successful_build" : {
"build_time_millis" : 40479,
"status" : "success",
"build_num" : 76
},
"build_parameters" : { },
"committer_date" : "2014-07-27T14:40:15Z",
"body" : "",
"usage_queued_at" : "2014-07-29T14:05:36.373Z",
"retry_of" : null,
"reponame" : "soapy_cake",
"build_url" : "https://circleci.com/gh/ad2games/soapy_cake/77",
"parallel" : 1,
"failed" : null,
"branch" : "master",
"username" : "ad2games",
"author_date" : "2014-07-27T14:40:15Z",
"why" : "edit",
"user" : {
"is_user" : true,
"login" : "hwartig",
"name" : "Harald Wartig",
"email" : "hw@ad2games.com"
},
"vcs_revision" : "f932ea1b564ceaaa8cdba06b1bb93e1869a9a905",
"build_num" : 77,
"infrastructure_fail" : false,
"ssh_enabled" : null,
"committer_email" : "hwartig@gmail.com",
"previous" : {
"build_time_millis" : 40479,
"status" : "success",
"build_num" : 76
},
"status" : "not_running",
"committer_name" : "Harald Wartig",
"retries" : null,
"subject" : "Fix link to api_versions.yml",
"timedout" : false,
"dont_build" : null,
"feature_flags" : { },
"lifecycle" : "not_running",
"stop_time" : null,
"build_time_millis" : null,
"circle_yml" : null,
"messages" : [ ],
"is_first_green_build" : false,
"job_name" : null,
"start_time" : null,
"all_commit_details" : [ {
"committer_date" : "2014-07-27T14:40:15Z",
"body" : "",
"author_date" : "2014-07-27T14:40:15Z",
"committer_email" : "hwartig@gmail.com",
"commit" : "f932ea1b564ceaaa8cdba06b1bb93e1869a9a905",
"committer_login" : "hwartig",
"committer_name" : "Harald Wartig",
"subject" : "Fix link to api_versions.yml",
"commit_url" : "https://github.com/ad2games/soapy_cake/commit/f932ea1b564ceaaa8cdba06b1bb93e1869a9a905",
"author_login" : "hwartig",
"author_name" : "Harald Wartig",
"author_email" : "hwartig@gmail.com"
} ],
"outcome" : null,
"vcs_url" : "https://github.com/ad2games/soapy_cake",
"author_name" : "Harald Wartig",
"node" : null,
"canceled" : false,
"author_email" : "hwartig@gmail.com"
}It also supports the Experimental Parameterized Builds
build_environment_variables = {"ENV_VAR1" => "VALUE1", "ENV_VAR2" => "VALUE2"}
res = CircleCi::Project.build_branch 'username', 'reponame', 'branch', build_environment_variables
Endpoint: /project/:username/:repository/:build_num/ssh-users
Adds a user to the build's SSH permissions.
res = CircleCi::Project.build_ssh_key 'username', 'repo', 'RSA private key', 'hostname'
res.success?Example response
Empty response body with a 200 OK successful response code
""Endpoint: /project/:username/:repository/build-cache
Clears the cache for a project
res = CircleCi::Project.clear_cache
res.body['status']Example response
{
"status" : "build caches deleted"
}Endpoint: /project/:username/:repository/checkout-key/:fingerprint
Delete a checkout key for a project by supplying the fingerprint of the key.
res = CircleCi::Project.delete_checkout_key 'username', 'reponame', 'fingerprint'
res.success?
res.bodyExample response
{"message":"ok"}Endpoint: /project/:username/:repository/enable
Enable a project in CircleCI. Causes a CircleCI SSH key to be added to the GitHub. Requires admin privilege to the repository.
res = CircleCi::Project.enable 'username', 'reponame'
res.success?Example response
{
"hall_notify_prefs": nil,
"irc_password": nil,
"default_branch": "master",
"hipchat_notify": nil,
"campfire_notify_prefs": nil,
"campfire_room": nil,
"irc_keyword": nil,
"slack_api_token": nil,
"parallel": 1,
"github_user": nil,
"github_permissions": {
"admin": true,
"push": true,
"pull": true
},
"irc_server": nil,
"heroku_deploy_user": nil,
"dependencies": "",
"slack_notify_prefs": nil,
"ssh_keys": [
],
"extra": "",
"followed": false,
"branches": {
"master": {
"last_non_success": {
"added_at": "2014-06-05T17:23:25.352Z",
"pushed_at": "2014-06-05T17:22:52.518Z",
"vcs_revision": "66d398cb635c5f4dd666dd1526bda5894d1246e4",
"build_num": 6,
"status": "no_tests",
"outcome": "no_tests"
},
"recent_builds": [
{
"added_at": "2014-06-05T17:23:25.352Z",
"pushed_at": "2014-06-05T17:22:52.518Z",
"vcs_revision": "66d398cb635c5f4dd666dd1526bda5894d1246e4",
"build_num": 6,
"status": "no_tests",
"outcome": "no_tests"
}
],
"running_builds": [
]
}
},
"campfire_token": nil,
"hipchat_notify_prefs": nil,
"test": "",
"compile": "",
"hipchat_room": nil,
"slack_channel": nil,
"slack_subdomain": nil,
"vcs_url": "https://github.com/Shopify/google_auth",
"flowdock_api_token": nil,
"hall_room_api_token": nil,
"slack_webhook_url": nil,
"irc_username": nil,
"hipchat_api_token": nil,
"campfire_subdomain": nil,
"has_usable_key": true,
"setup": "",
"irc_channel": nil,
"feature_flags": {
"build_GH1157_container_oriented_ui": nil,
"set-github-status": true
},
"irc_notify_prefs": nil
}Endpoint: /project/:username/:project/envvar
Get a list of environment variables for a project
res = CircleCi::Project.envvar 'username', 'repo'
res.success?Example response
[{"name":"foo","value":"xxxx"}]Endpoint: /project/:username/:repository/follow
Follow a project
res = CircleCi::Build.follow 'username', 'repo'
res.success?Example response
{
"followed": true,
"first_build": nil
}Endpoint: /project/:username/:repository/checkout-key/:fingerprint
Get a checkout key for a project by supplying the fingerprint of the key.
res = CircleCi::Project.get_checkout_key 'username', 'reponame', 'fingerprint'
res.success?
res.bodyExample response
{
"public_key": "ssh-rsa...",
"type": "deploy-key", // can be "deploy-key" or "user-key"
"fingerprint": "c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f",
"preferred": true,
"time" : "2015-09-21T17:29:21.042Z" // when the key was issued
}Endpoint: /project/#{username}/#{project}/checkout-key
List checkout keys
res = CircleCi::Project.checkout_keys 'username', 'repo'
res.success?Example response
[
{
"public_key": "ssh-rsa...",
"type": "deploy-key", // can be "deploy-key" or "user-key"
"fingerprint": "c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f",
"preferred": true,
"time" : "2015-09-21T17:29:21.042Z" // when the key was issued
}
]Endpoint: /project/:username/:repository/checkout-key
Create an ssh key used to access external systems that require SSH key-based authentication.
Takes a type of key to create which an be deploy-key or github-user-key.
res = CircleCi::Project.new_checkout_key 'username', 'reponame', 'deploy-key'
res.success?
res.bodyExample response
{
"public_key": "ssh-rsa...",
"type": "deploy-key", // can be "deploy-key" or "user-key"
"fingerprint": "c9:0b:1c:4f:d5:65:56:b9:ad:88:f9:81:2b:37:74:2f",
"preferred": true,
"time" : "2015-09-21T17:29:21.042Z" // when the key was issued
}Endpoint: /project/:username/:repository
Build summary for each of the last 30 recent builds, ordered by build_num.
res = CircleCi::Project.recent_builds 'username', 'reponame'
# Use params to filter by status
# res = CircleCi::Project.recent_builds 'username', 'reponame', filter: 'failed'
# Use params to limit and give an offset
# res = CircleCi::Project.recent_builds 'username', 'reponame', limit: 10, offset: 50
res.success?
res.bodyExample response
[ {
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
"build_num" : 22,
"branch" : "master",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"committer_name" : "Allen Rohner",
"committer_email" : "arohner@gmail.com",
"subject" : "Don't explode when the system clock shifts backwards",
"body" : "", // commit message body
"why" : "github", // short string explaining the reason we built
"dont_build" : null, // reason why we didn't build, if we didn't build
"queued_at" : "2013-02-12T21:33:30Z" // time build was queued
"start_time" : "2013-02-12T21:33:38Z", // time build started running
"stop_time" : "2013-02-12T21:34:01Z", // time build finished running
"build_time_millis" : 23505,
"lifecycle" : "finished",
"outcome" : "failed",
"status" : "failed",
"retry_of" : null, // build_num of the build this is a retry of
"previous" : { // previous build
"status" : "failed",
"build_num" : 21
} ]Endpoint: /project/:username/:repository/tree/:branch
Build summary for each of the last 30 recent builds for a specific branch, ordered by build_num.
res = CircleCi::Project.recent_builds_branch 'username', 'reponame', 'branch'
res.success?
res.bodyExample response
[ {
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
"build_num" : 22,
"branch" : "new_feature",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"committer_name" : "Allen Rohner",
"committer_email" : "arohner@gmail.com",
"subject" : "Don't explode when the system clock shifts backwards",
"body" : "", // commit message body
"why" : "github", // short string explaining the reason we built
"dont_build" : null, // reason why we didn't build, if we didn't build
"queued_at" : "2013-02-12T21:33:30Z" // time build was queued
"start_time" : "2013-02-12T21:33:38Z", // time build started running
"stop_time" : "2013-02-12T21:34:01Z", // time build finished running
"build_time_millis" : 23505,
"lifecycle" : "finished",
"outcome" : "failed",
"status" : "failed",
"retry_of" : null, // build_num of the build this is a retry of
"previous" : { // previous build
"status" : "failed",
"build_num" : 21
} ]Endpoint: /project/:username/:repository/settings
Get project settings
res = CircleCi::Project.settings 'username', 'repo'
res.success?Example response
{
"hall_notify_prefs": nil,
"irc_password": nil,
"default_branch": "master",
"hipchat_notify": nil,
"campfire_notify_prefs": nil,
"campfire_room": nil,
"irc_keyword": nil,
"slack_api_token": nil,
"parallel": 1,
"github_user": nil,
"github_permissions": {
"admin": true,
"push": true,
"pull": true
},
"irc_server": nil,
"heroku_deploy_user": nil,
"dependencies": "",
"slack_notify_prefs": nil,
"ssh_keys": [
],
"extra": "",
"followed": true,
"branches": {
"master": {
"running_builds": [
{
"added_at": "2014-06-05T17:22:52.779Z",
"pushed_at": "2014-06-05T17:22:52.518Z",
"vcs_revision": "66d398cb635c5f4dd666dd1526bda5894d1246e4",
"build_num": 6,
"status": "not_running",
"outcome": nil
}
]
}
},
"campfire_token": nil,
"hipchat_notify_prefs": nil,
"test": "",
"compile": "",
"hipchat_room": nil,
"slack_channel": nil,
"slack_subdomain": nil,
"vcs_url": "https://github.com/Shopify/google_auth",
"flowdock_api_token": nil,
"hall_room_api_token": nil,
"slack_webhook_url": nil,
"irc_username": nil,
"hipchat_api_token": nil,
"campfire_subdomain": nil,
"has_usable_key": true,
"setup": "",
"irc_channel": nil,
"feature_flags": {
"build_GH1157_container_oriented_ui": nil,
"set-github-status": true
},
"irc_notify_prefs": nil
}Endpoint: /project/:username/:project/envvar
Creates a new environment variable for a project
environment = { name: 'foo', value: 'bar' }
res = CircleCi::Project.envvar 'username', 'repo', environment
res.success?Example response
{"name":"foo","value":"xxxx"}Endpoint: /project/:username/:repository/ssh-key
Creates an ssh key that will be used to access the external system identified by the hostname parameter for SSH key-based authentication.
res = CircleCi::Project.ssh_key 'username', 'repo', 'RSA private key', 'hostname'
res.success?Example response
Empty response body with a 200 OK successful response code
""Endpoint: /project/:username/:repository/unfollow
Unfollow a project
res = CircleCi::Build.unfollow 'username', 'repo'
res.success?Example response
{
"followed": false
}Endpoint: /project/:username/:repository/:build/artifacts
Artifacts produced by the build, returns an array of artifact details
res = CircleCi::Build.artifacts 'username', 'repo', 'build #'
res.success?
res.body[
{
node_index: 0,
path: "/tmp/circle-artifacts.NHQxLku/cherry-pie.png",
pretty_path: "$CIRCLE_ARTIFACTS/cherry-pie.png",
url: "https://circleci.com/gh/circleci/mongofinil/22/artifacts/0/tmp/circle-artifacts.NHQxLku/cherry-pie.png"
},
{
node_index: 0,
path: "/tmp/circle-artifacts.NHQxLku/rhubarb-pie.png",
pretty_path: "$CIRCLE_ARTIFACTS/rhubarb-pie.png",
url: "https://circleci.com/gh/circleci/mongofinil/22/artifacts/0/tmp/circle-artifacts.NHQxLku/rhubarb-pie.png"
}
]Endpoint: /project/:username/:repository/:build/cancel
Cancels the build, returns a summary of the build.
res = CircleCi::Build.cancel 'username', 'repo', 'build #'
res.success?
res.body['status'] # 'canceled'
res.body['outcome'] # 'canceled'
res.body['canceled'] # trueExample response
{
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/26",
"build_num" : 26,
"branch" : "master",
"vcs_revision" : "59c9c5ea3e289f2f3b0c94e128267cc0ce2d65c6",
"committer_name" : "Allen Rohner",
"committer_email" : "arohner@gmail.com",
"subject" : "Merge pull request #6 from dlowe/master"
"body" : "le bump", // commit message body
"why" : "retry", // short string explaining the reason we built
"dont_build" : null, // reason why we didn't build, if we didn't build
"queued_at" : "2013-05-24T19:37:59.095Z" // time build was queued
"start_time" : null, // time build started running
"stop_time" : null, // time build finished running
"build_time_millis" : null,
"username" : "circleci",
"reponame" : "mongofinil",
"lifecycle" : "queued",
"outcome" : "canceled",
"status" : "canceled",
"canceled" : true,
"retry_of" : 25, // build_num of the build this is a retry of
"previous" : { // previous build
"status" : "success",
"build_num" : 25
}
}Endpoint: /project/:username/:repository/:build
Full details for a single build, including the output for all actions. The response includes all of the fields from the build summary.
res = CircleCi::Build.get 'username', 'repo', 'build #'
res.success?
res.bodyExample response
{
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
"build_num" : 22,
"steps" : [ {
"name" : "configure the build",
"actions" : [ {
"bash_command" : null,
"run_time_millis" : 1646,
"start_time" : "2013-02-12T21:33:38Z",
"end_time" : "2013-02-12T21:33:39Z",
"name" : "configure the build",
"command" : "configure the build",
"exit_code" : null,
"out" : [ ],
"type" : "infrastructure",
"index" : 0,
"status" : "success",
} ] },
"name" : "lein2 deps",
"actions" : [ {
"bash_command" : "lein2 deps",
"run_time_millis" : 7555,
"start_time" : "2013-02-12T21:33:47Z",
"command" : "((lein2 :deps))",
"messages" : [ ],
"step" : 1,
"exit_code" : 0,
"out" : [ {
"type" : "out",
"time" : "2013-02-12T21:33:54Z",
"message" : "Retrieving org/clojure ... from clojars\r\n"
} ],
"end_time" : "2013-02-12T21:33:54Z",
"index" : 0,
"status" : "success",
"type" : "dependencies",
"source" : "inference",
"failed" : null
} ] },
"name" : "lein2 trampoline midje",
"actions" : [ {
"bash_command" : "lein2 trampoline midje",
"run_time_millis" : 2310,
"continue" : null,
"parallel" : true,
"start_time" : "2013-02-12T21:33:59Z",
"name" : "lein2 trampoline midje",
"command" : "((lein2 :trampoline :midje))",
"messages" : [ ],
"step" : 6,
"exit_code" : 1,
"out" : [ {
"type" : "out",
"time" : "2013-02-12T21:34:01Z",
"message" : "'midje' is not a task. See 'lein help'.\r\n\r\nDid you mean this?\r\n do\r\n"
}, {
"type" : "err",
"time" : "2013-02-12T21:34:01Z",
"message" : "((lein2 :trampoline :midje)) returned exit code 1"
} ],
"end_time" : "2013-02-12T21:34:01Z",
"index" : 0,
"status" : "failed",
"timedout" : null,
"infrastructure_fail" : null,
"type" : "test",
"source" : "inference",
"failed" : true
} ]
} ],
}Endpoint: /project/:username/:repository/:build/retry
Retries the build, returns a summary of the new build.
res = CircleCi::Build.retry 'username', 'repo', 'build #'
res.success?
res.body['status'] # 'queued'
res.bodyExample response
{
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/23",
"build_num" : 23,
"branch" : "master",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"committer_name" : "Allen Rohner",
"committer_email" : "arohner@gmail.com",
"subject" : "Don't explode when the system clock shifts backwards",
"body" : "", // commit message body
"why" : "retry", // short string explaining the reason we built
"dont_build" : null, // reason why we didn't build, if we didn't build
"queued_at" : "2013-04-12T21:33:30Z" // time build was queued
"start_time" : "2013-04-12T21:33:38Z", // time build started running
"stop_time" : "2013-04-12T21:34:01Z", // time build finished running
"build_time_millis" : 23505,
"lifecycle" : "queued",
"outcome" : null,
"status" : "queued",
"retry_of" : 22, // build_num of the build this is a retry of
"previous" : { // previous build
"status" : "failed",
"build_num" : 22
}Endpoint: /project/:username/:repository/:build/tests
Tests endpoint to get the recorded tests for a build. Will return an array of the tests ran and some details.
res = CircleCi::Build.tests 'username', 'repo', 'build #'
res.success?
res.body[
{
"message" => nil,
"file" => "spec/unit/user_spec.rb",
"source" => "rspec",
"run_time" => 0.240912,
"result" => "success",
"name" => "user creation",
"classname"=> "spec.unit.user_spec"
},
{
"message" => "Unable to update user",
"file" => "spec/unit/user_spec.rb",
"source"=>"rspec",
"run_time"=>5.58533,
"result"=>"failure",
"name"=>"user update",
"classname"=>"spec.unit.user_spec"
}
]Endpoint: /recent-builds
Build summary for each of the last 30 recent builds, ordered by build_num.
res = CircleCi::RecentBuilds.get
# Params of limit and offset can be passed in
# res = CircleCi::RecentBuilds.get limit: 10, offset: 50
res.success?
res.body[ {
"vcs_url" : "https://github.com/circleci/mongofinil",
"build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
"build_num" : 22,
"branch" : "master",
"vcs_revision" : "1d231626ba1d2838e599c5c598d28e2306ad4e48",
"committer_name" : "Allen Rohner",
"committer_email" : "arohner@gmail.com",
"subject" : "Don't explode when the system clock shifts backwards",
"body" : "", // commit message body
"why" : "github", // short string explaining the reason we built
"dont_build" : null, // reason why we didn't build, if we didn't build
"queued_at" : "2013-02-12T21:33:30Z" // time build was queued
"start_time" : "2013-02-12T21:33:38Z", // time build started
"stop_time" : "2013-02-12T21:34:01Z", // time build finished
"build_time_millis" : 23505,
"username" : "circleci",
"reponame" : "mongofinil",
"lifecycle" : "finished", // :queued, :scheduled, :not_run, :not_running, :running or :finished
"outcome" : "failed", // :canceled, :infrastructure_fail, :timedout, :failed, :no_tests or :success
"status" : "failed", // :retried, :canceled, :infrastructure_fail, :timedout, :not_run, :running, :failed, :queued, :scheduled, :not_running, :no_tests, :fixed, :success
"retry_of" : null, // build_num of the build this is a retry of
"previous" : { // previous build
"status" : "failed",
"build_num" : 21
}, ... ]Tests are ran using Rspec and VCR for API interaction recording.
Run using rake or rspec. Please add tests for any new features or
endpoints added if you are contributing. Code styling is enforced with RuboCop
and uses a checked in .rubocop.yml for this project.
Tests are using a live CircleCi API token for this repository. Any tests
should be using this key, which is in the .env file. You should not have
to do anything outside of writing the tests against this repository.