circleci 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccc6a34355c2cc6539e8050009d22ae0f9ac45a8
-  data.tar.gz: 6a65e6d98c32e2d2d5bb07d9b5df5d533ea9af1e
+  metadata.gz: 7583f51aa12b390fe9e5e62dfb29b245f634255a
+  data.tar.gz: a7146773d7108609340b72f6336b7ab228e5b9a5
 SHA512:
-  metadata.gz: d3ba12ab6e97fddd383a4854f678363123faea599a9336346a6bb52f6e7ab8168ad8a927af76fd0c6aea8f27c4701e5d36ffdc7bf405939881e7709f617bdfdd
-  data.tar.gz: 7e1a6d428e5b9a1700330a4b88d56e5b63706c904f40170032a230c38b5151ab1af37b979fa253c49e0a4ecdd5da5f5ec88ec878734b3ed72bb3430615dc6788
+  metadata.gz: 6d101bd724b7f387f6d7ea2b64d47394df9aa948becb0bed148fde4ad8658b772cd222f46e36d4cbe87ede3a79ba2f9e70e39a2a84059e213693d81a6b43c253
+  data.tar.gz: 04c36196b1e4c3c19b01b7cf0b0a4428a016de587e6d48f6fb20126e4abe38ae8dd4ea46ac325b58321bf41ae19e16a1653466a68ba2b7a0d6a4441e0acb7e61

data/README.md

@@ -11,7 +11,7 @@ Circle CI API Wrapper
 ## Install
 
 ```ruby
-gem install 'circleci'
+gem install circleci
 ```
 
 or with Bundler
@@ -32,30 +32,81 @@ CircleCi.configure do |config|
 end
 ```
 
-### User
+## API Endpoints
+
+* [User](#user)
+  * [Heroku Key](#heroku_key)
+  * [Me](#me)
+* [Project](#project)
+  * [All](#all)
+  * [Build Branch](#build_branch)
+  * [Build SSH Key](#build_ssh_key)
+  * [Clear Cache](#clear_cache)
+  * [Enable](#enable)
+  * [Follow](#follow)
+  * [Delete Checkout Key](#delete_checkout_key)
+  * [Get Checkout Key](#get_checkout_key)
+  * [List Checkout Keys](#list_checkout_keys)
+  * [New Checkout Key](#new_checkout_key)
+  * [Recent Builds](#recent_builds)
+  * [Recent Builds Branch](#recent_builds_branch)
+  * [Settings](#settings)
+  * [SSH Key](#ssh_key)
+  * [Unfollow](#unfollow)
+* [Build](#build)
+  * [Artifacts](#artifacts)
+  * [Cancel](#cancel)
+  * [Get](#get)
+  * [Retry](#retry)
+  * [Tests](#tests)
+* [Organization](#organization)
+
+### [User](#user)
+
+#### [heroku_key](#heroku_key)
+
+Endpoint: `/user/heroku-key`
+
+Adds your Heroku API key to CircleCI.
+```ruby
+res = CircleCi::User.heroku_key 'your-api-key'
+res.success? # True
+res.body
+```
+
+Example response
+
+Empty body response with a `200 OK` response code
+```javascript
+""
+```
 
-#### CircleCi::User.me
+#### [me](#me)
+
+Endpoint: `/me`
 
 Provides information about the signed in user.
 
 ```ruby
 res = CircleCi::User.me
-res.succes? # True
+res.success? # True
 res.body
 ```
 
 Example response
 
-```json
+```javascript
 {
   "basic_email_prefs" : "smart", // can be "smart", "none" or "all"
   "login" : "pbiggar" // your github username
 }
 ```
 
-### Project
+### [Project](#project)
+
+#### [all](#all)
 
-#### CircleCi::Project.all
+Endpoint: `/projects`
 
 List of all the repos you have access to on Github, with build information organized by branch.
 
@@ -67,7 +118,7 @@ res.body
 
 Example response
 
-```json
+```javascript
 [ {
   "vcs_url": "https://github.com/circleci/mongofinil"
   "followed": true // true if you follow this project in Circle
@@ -103,7 +154,340 @@ Example response
 } ]
 ```
 
-#### CircleCi::Project.recent_builds
+#### [build_branch](#build_branch)
+
+Endpoint: `/project/:username/:repository/tree/:branch`
+
+Build a specific branch of a project
+
+```ruby
+res = CircleCi::Project.build_branch 'username', 'reponame', 'branch'
+res.body['status'] # Not running
+res.body['build_url'] # Get url of build
+```
+
+Example response
+
+```javascript
+{
+  "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
+```
+
+#### [build_ssh_key](#build_ssh_key)
+
+Endpoint: `/project/:username/:repository/:build_num/ssh-users`
+
+Adds a user to the build's SSH permissions.
+
+```ruby
+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
+```javascript
+""
+```
+
+#### [clear_cache](#clear_cache)
+
+Endpoint: `/project/:username/:repository/build-cache`
+
+Clears the cache for a project
+
+```ruby
+res = CircleCi::Project.clear_cache
+res.body['status']
+```
+
+Example response
+
+```javascript
+{
+  "status" : "build caches deleted"
+}
+```
+
+#### [delete_checkout_key](#delete_checkout_key)
+
+Endpoint: `/project/:username/:repository/checkout-key/:fingerprint`
+
+Delete a checkout key for a project by supplying the fingerprint of the key.
+```ruby
+res = CircleCi::Project.delete_checkout_key 'username', 'reponame', 'fingerprint'
+res.success?
+res.body
+```
+
+Example response
+
+```javascript
+{"message":"ok"}
+```
+
+#### [enable](#enable)
+
+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.
+
+```ruby
+res = CircleCi::Project.enable 'username', 'reponame'
+res.success?
+```
+
+Example response
+```javascript
+{
+    "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
+}
+```
+
+#### [follow](#follow)
+
+Endpoint: `/project/:username/:repository/follow`
+
+Follow a project
+
+```ruby
+res = CircleCi::Build.follow 'username', 'repo'
+res.success?
+```
+
+Example response
+
+```javascript
+{
+    "followed": true,
+    "first_build": nil
+}
+```
+
+#### [get_checkout_key](#get_checkout_key)
+
+Endpoint: `/project/:username/:repository/checkout-key/:fingerprint`
+
+Get a checkout key for a project by supplying the fingerprint of the key.
+```ruby
+res = CircleCi::Project.get_checkout_key 'username', 'reponame', 'fingerprint'
+res.success?
+res.body
+```
+
+Example response
+
+```javascript
+{
+    "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
+}
+```
+
+#### [list_checkout_keys](#list_checkout_keys)
+
+Endpoint: `/project/#{username}/#{project}/checkout-key`
+
+List checkout keys
+
+```ruby
+res = CircleCi::Project.checkout_keys 'username', 'repo'
+res.success?
+```
+
+Example response
+
+```javascript
+[
+    {
+        "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
+    }
+]
+```
+
+#### [new_checkout_key](#new_checkout_key)
+
+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`.
+```ruby
+res = CircleCi::Project.new_checkout_key 'username', 'reponame', 'deploy-key'
+res.success?
+res.body
+```
+
+Example response
+
+```javascript
+{
+    "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
+}
+```
+
+#### [recent_builds](#recent_builds)
+
+Endpoint: `/project/:username/:repository`
 
 Build summary for each of the last 30 recent builds, ordered by build_num.
 
@@ -115,7 +499,7 @@ res.body
 
 Example response
 
-```json
+```javascript
 [ {
   "vcs_url" : "https://github.com/circleci/mongofinil",
   "build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
@@ -142,7 +526,9 @@ Example response
   } ]
 ```
 
-#### CircleCi::Project.recent_builds_branch
+#### [recent_builds_branch](#recent_builds_branch)
+
+Endpoint: `/project/:username/:repository/tree/:branch`
 
 Build summary for each of the last 30 recent builds for a specific branch, ordered by build_num.
 
@@ -154,7 +540,7 @@ res.body
 
 Example response
 
-```json
+```javascript
 [ {
   "vcs_url" : "https://github.com/circleci/mongofinil",
   "build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
@@ -181,120 +567,203 @@ Example response
   } ]
 ```
 
-#### CircleCi::Project.clear_cache
+#### [settings](#settings)
 
-Clears the cache for a project
+Endpoint: `/project/:username/:repository/settings`
+
+Get project settings
 
 ```ruby
-res = CircleCi::Project.clear_cache
-res.body['status']
+res = CircleCi::Project.settings 'username', 'repo'
+res.success?
 ```
 
 Example response
 
-```json
+```javascript
 {
-  "status" : "build caches deleted"
+    "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
 }
 ```
 
-#### CircleCI::Project.build_branch
+#### [ssh_key](#ssh_key)
 
-Build a specific branch of a project
+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.
 
 ```ruby
-res = CircleCi::Project.build_branch 'username', 'reponame', 'branch'
-res.body['status'] # Not running
-res.body['build_url'] # Get url of build
+res = CircleCi::Project.ssh_key 'username', 'repo', 'RSA private key', 'hostname'
+res.success?
 ```
 
 Example response
 
-```json
+Empty response body with a `200 OK` successful response code
+```javascript
+""
+```
+
+#### [unfollow](#unfollow)
+
+Endpoint: `/project/:username/:repository/unfollow`
+
+Unfollow a project
+
+```ruby
+res = CircleCi::Build.unfollow 'username', 'repo'
+res.success?
+```
+
+Example response
+
+```javascript
 {
-  "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"
+    "followed": false
 }
 ```
 
-It also supports the Experimental Parameterized Builds
+### [Build](#build)
+
+#### [artifacts](#artifacts)
 
+Endpoint: `/project/:username/:repository/:build/artifacts`
+
+Artifacts produced by the build, returns an array of artifact details
+
+```ruby
+res = CircleCi::Build.artifacts 'username', 'repo', 'build #'
+res.success?
+res.body
 ```
-  build_environment_variables = {"ENV_VAR1" => "VALUE1", "ENV_VAR2" => "VALUE2"}
-  res = CircleCi::Project.build_branch 'username', 'reponame', 'branch', build_environment_variables
+
+```javascript
+[
+  {
+    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"
+  }
+]
 ```
 
-### Build
+#### [cancel](#cancel)
 
-#### CircleCi::Build.get
+Endpoint: `/project/:username/:repository/:build/cancel`
+
+Cancels the build, returns a summary of the build.
+
+```ruby
+res = CircleCi::Build.cancel 'username', 'repo', 'build #'
+res.success?
+res.body['status'] # 'canceled'
+res.body['outcome'] # 'canceled'
+res.body['canceled'] # true
+```
+
+Example response
+
+```javascript
+{
+  "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
+  }
+}
+```
+
+#### [get](#get)
+
+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.
 
@@ -306,7 +775,7 @@ res.body
 
 Example response
 
-```json
+```javascript
 {
   "vcs_url" : "https://github.com/circleci/mongofinil",
   "build_url" : "https://circleci.com/gh/circleci/mongofinil/22",
@@ -381,7 +850,9 @@ Example response
 }
 ```
 
-#### CircleCi::Build.retry
+#### [retry](#retry)
+
+Endpoint: `/project/:username/:repository/:build/retry`
 
 Retries the build, returns a summary of the new build.
 
@@ -394,7 +865,7 @@ res.body
 
 Example response
 
-```json
+```javascript
 {
   "vcs_url" : "https://github.com/circleci/mongofinil",
   "build_url" : "https://circleci.com/gh/circleci/mongofinil/23",
@@ -419,80 +890,11 @@ Example response
     "status" : "failed",
     "build_num" : 22
   }
-
-#### CircleCi::Build.cancel
-
-Cancels the build, returns a summary of the build.
-
-```ruby
-res = CircleCi::Build.cancel 'username', 'repo', 'build #'
-res.success?
-res.body['status'] # 'canceled'
-res.body['outcome'] # 'canceled'
-res.body['canceled'] # true
 ```
 
-Example response
+#### [tests](#tests)
 
-```json
-{
-  "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
-  }
-}
-```
-
-#### CircleCi::Build.artifacts
-
-Artifacts produced by the build, returns an array of artifact details
-
-```ruby
-res = CircleCi::Build.artifacts 'username', 'repo', 'build #'
-res.success?
-res.body
-```
-
-```json
-[
-  {
-    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"
-  }
-]
-```
-
-#### CircleCi::Build.tests
+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.
@@ -503,7 +905,7 @@ res.success?
 res.body
 ```
 
-```json
+```javascript
 [
   {
     "message" => nil,
@@ -526,7 +928,9 @@ res.body
 ]
 ```
 
-#### CircleCi.organization
+### [organization](#organization)
+
+Endpoint: `/organization/:name`
 
 Recent builds for an entire organization
 
@@ -536,7 +940,7 @@ res.succes?
 res.body
 ```
 
-```json
+```javascript
 [
    {
       "dont_build":null,

data/lib/circleci/http.rb

@@ -57,8 +57,14 @@ module CircleCi
 
     def handle_response(body, code, path)
       parsed = JSON.parse(body) rescue nil
-      if parsed && (200..299).include?(code)
-        self.response = parsed
+      successful_code = (200..299).include?(code)
+      self.response = parsed if parsed
+
+      # Some responses are empty but are successful
+      if body == '""' && successful_code
+        self.response = ''
+        self.success = true
+      elsif parsed && successful_code
         self.success = true
       else
         self.errors << RequestError.new(body, code, path)

data/lib/circleci/project.rb

@@ -16,18 +16,6 @@ module CircleCi
       CircleCi.http.get '/projects'
     end
 
-    ##
-    #
-    # Get all recent builds for a specific project
-    #
-    # @param username [String] - User or org name who owns project
-    # @param project  [String] - Name of project
-    # @return         [CircleCi::Response] - Response object
-
-    def self.recent_builds username, project
-      CircleCi.http.get "/project/#{username}/#{project}"
-    end
-
     ##
     #
     # Build the latest master push for this project
@@ -42,31 +30,33 @@ module CircleCi
 
     ##
     #
-    # Get all recent builds for a specific branch of a project
+    # Build the latest push for this branch of a specific project
     #
     # @param username [String] - User or org name who owns project
     # @param project  [String] - Name of project
     # @param branch   [String] - Name of branch
+    # @param build_parameters   [Hash] - Optional Build Parameters
     # @return         [CircleCi::Response] - Response object
 
-    def self.recent_builds_branch username, project, branch
-      CircleCi.http.get "/project/#{username}/#{project}/tree/#{branch}"
+    def self.build_branch username, project, branch, build_parameters = {}
+      body = {}
+      body["build_parameters"] = build_parameters unless build_parameters.empty?
+      CircleCi.http.post "/project/#{username}/#{project}/tree/#{branch}", {}, body
     end
 
     ##
     #
-    # Build the latest push for this branch of a specific project
+    # Add a ssh key to a build
     #
     # @param username [String] - User or org name who owns project
     # @param project  [String] - Name of project
-    # @param branch   [String] - Name of branch
-    # @param build_parameters   [Hash] - Optional Build Parameters
+    # @param build    [String] - Build number
+    # @param key      [String] - The ssh private key
+    # @param hostname [String] - The hostname identified by the key
     # @return         [CircleCi::Response] - Response object
-
-    def self.build_branch username, project, branch, build_parameters = {}
-      body = {}
-      body["build_parameters"] = build_parameters unless build_parameters.empty?
-      CircleCi.http.post "/project/#{username}/#{project}/tree/#{branch}", {}, body
+    def self.build_ssh_key username, project, build, key, hostname
+      body = { hostname: hostname, private_key: key }
+      CircleCi.http.post "/project/#{username}/#{project}/#{build}/ssh-users", {}, body
     end
 
     ##
@@ -83,7 +73,21 @@ module CircleCi
 
     ##
     #
-    # Enable a project in CircleCI. Causes a CircleCI SSH key to be added to the GitHub. Requires admin privilege to the repository.
+    # Delete a checkout key for a project
+    #
+    # @param username     [String] - User or org name who owns project
+    # @param project      [String] - Name of project
+    # @param fingerprint  [String] - Fingerprint of a checkout key
+    # @return             [CircleCi::Response] - Response object
+
+    def self.delete_checkout_key username, project, fingerprint
+      CircleCi.http.delete "/project/#{username}/#{project}/checkout-key/#{fingerprint}"
+    end
+
+    ##
+    #
+    # Enable a project in CircleCI. Causes a CircleCI SSH key to be added to
+    # the GitHub. Requires admin privilege to the repository.
     #
     # @param username [String] - User or org name who owns project
     # @param project  [String] - Name of project
@@ -107,14 +111,66 @@ module CircleCi
 
     ##
     #
-    # Unfollow the project
+    # Get a checkout key for a project
+    #
+    # @param username     [String] - User or org name who owns project
+    # @param project      [String] - Name of project
+    # @param fingerprint  [String] - Fingerprint of a checkout key
+    # @return             [CircleCi::Response] - Response object
+
+    def self.get_checkout_key username, project, fingerprint
+      CircleCi.http.get "/project/#{username}/#{project}/checkout-key/#{fingerprint}"
+    end
+
+    ##
+    #
+    # Get a list of checkout keys for project
     #
     # @param username [String] - User or org name who owns project
     # @param project  [String] - Name of project
     # @return         [CircleCi::Response] - Response object
 
-    def self.unfollow username, project
-      CircleCi.http.post "/project/#{username}/#{project}/unfollow"
+    def self.list_checkout_keys username, project
+      CircleCi.http.get "/project/#{username}/#{project}/checkout-key"
+    end
+
+    ##
+    #
+    # Create a checkout key for a project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @param type     [String] - The type of key to create. Can be 'deploy-key' or 'github-user-key'.
+    # @return         [CircleCi::Response] - Response object
+
+    def self.new_checkout_key username, project, type
+      body = { type: type }
+      CircleCi.http.post "/project/#{username}/#{project}/checkout-key", {}, body
+    end
+
+    ##
+    #
+    # Get all recent builds for a specific project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @return         [CircleCi::Response] - Response object
+
+    def self.recent_builds username, project
+      CircleCi.http.get "/project/#{username}/#{project}"
+    end
+
+    ##
+    #
+    # Get all recent builds for a specific branch of a project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @param branch   [String] - Name of branch
+    # @return         [CircleCi::Response] - Response object
+
+    def self.recent_builds_branch username, project, branch
+      CircleCi.http.get "/project/#{username}/#{project}/tree/#{branch}"
     end
 
     ##
@@ -129,6 +185,32 @@ module CircleCi
       CircleCi.http.get "/project/#{username}/#{project}/settings"
     end
 
+    ##
+    #
+    # Add a ssh key to a project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @param key      [String] - The ssh private key
+    # @param hostname [String] - The hostname identified by the key
+    # @return         [CircleCi::Response] - Response object
+    def self.ssh_key username, project, key, hostname
+      body = { hostname: hostname, private_key: key }
+      CircleCi.http.post "/project/#{username}/#{project}/ssh-key", {}, body
+    end
+
+    ##
+    #
+    # Unfollow the project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @return         [CircleCi::Response] - Response object
+
+    def self.unfollow username, project
+      CircleCi.http.post "/project/#{username}/#{project}/unfollow"
+    end
+
   end
 
 end

data/lib/circleci/user.rb

@@ -16,6 +16,17 @@ module CircleCi
       CircleCi.http.get '/me'
     end
 
+    ##
+    #
+    # Add a Heroku API key to CircleCI
+    #
+    # @param apikey   [String] - The Heroku API key
+    # @return         [CircleCi::Response] - Response object
+    def self.heroku_key apikey
+      body = { apikey: apikey }
+      CircleCi.http.post '/user/heroku-key', {}, body
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chavez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,54 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.12
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.12
+        version: 0.8.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.12
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.12
+        version: 0.8.10
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: gemcutter
   requirement: !ruby/object:Gem::Requirement
@@ -71,9 +59,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,29 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.10.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,40 +146,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.11.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.11.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -230,20 +200,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.22.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.22.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.22.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -264,7 +234,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7.6
-description: Wraps Circle CI API calls in a gem.
+description: Ruby gem for Circle CI REST API
 email: chavez@example.com
 executables: []
 extensions: []
@@ -304,5 +274,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Circle CI API Wrapper
+summary: Circle CI REST API gem
 test_files: []