circleci 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04056867e88eb217db97d350b1eb1faf1609f475
+  data.tar.gz: d53e9a9219df13259dbc10968a03f961088ad077
+SHA512:
+  metadata.gz: ab88cfa60af02d17a1f530da5a0df3803fc47045fc9243165ed6a5aedabc4fe3037a24020f3cd3a18cc39814fe59d1c3e9b6c31f8239cda840b7b0cfdd3add52
+  data.tar.gz: a305b3c3c00ce1e2c1d8f8c0c30e90441b2c075f735efff24e523762d465a2216a7011a5ecffa88fb9f0366cf9e414df373a4332582cf23df6be00784e086e4a

data/README.md

@@ -2,6 +2,7 @@ circleci
 ========
 
 [![Build Status](https://travis-ci.org/mtchavez/circleci.png)](https://travis-ci.org/mtchavez/circleci)
+[![endorse](http://api.coderwall.com/mtchavez/endorsecount.png)](http://coderwall.com/mtchavez)
 
 Circle CI API Wrapper
 
@@ -31,7 +32,9 @@ end
 
 ### User
 
-The ```/me``` endpoint provides information about the signed in user.
+#### CircleCi::User.me
+
+Provides information about the signed in user.
 
 ```ruby
 res = CircleCi::User.me
@@ -48,3 +51,286 @@ Example response
 }
 ```
 
+### Project
+
+#### CircleCi::Project.all
+
+List of all the repos you have access to on Github, with build information organized by branch.
+
+```ruby
+res = CircleCi::Project.all
+res.success?
+res.body
+```
+
+Example response
+
+```json
+[ {
+  "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
+    }
+  }
+} ]
+```
+
+#### CircleCi::Project.recent_builds
+
+Build summary for each of the last 30 recent builds, ordered by build_num.
+
+```ruby
+res = CirclCi::Project.recent_builds 'username', 'reponame'
+res.success?
+res.body
+```
+
+Example response
+
+```json
+[ {
+  "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
+  } ]
+```
+
+#### CircleCi::Project.recent_builds_branch
+
+Build summary for each of the last 30 recent builds for a specific branch, ordered by build_num.
+
+```ruby
+res = CirclCi::Project.recent_builds_branch 'username', 'reponame', 'branch'
+res.success?
+res.body
+```
+
+Example response
+
+```json
+[ {
+  "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
+  } ]
+```
+
+#### CircleCi::Project.clear_cache
+
+Clears the cache for a project
+
+```ruby
+res = CircleCi::Project.clear_cache
+res.body['status']
+```
+
+Example response
+
+```json
+{
+  "status" : "build caches deleted"
+}
+```
+
+### Build
+
+#### CircleCi::Build.get
+
+Full details for a single build, including the output for all actions. The response includes all of the fields from the build summary.
+
+```ruby
+res = CircleCi::Build.get 'username', 'repo', 'build #'
+res.success?
+res.body
+```
+
+Example response
+
+```json
+{
+  "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
+    } ]
+  } ],
+}
+```
+
+#### CircleCi::Build.retry
+
+Retries the build, returns a summary of the new build.
+
+```ruby
+res = CircleCi::Build.retry 'username', 'repo', 'build #'
+res.success?
+res.body['status'] # 'queued'
+res.body
+```
+
+Example response
+
+```json
+{
+  "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
+  }
+```
+
+### Tests
+
+Run using ```rake```
+
+## License
+
+Written by Chavez
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/lib/circleci/build.rb

@@ -1,11 +1,33 @@
 module CircleCi
 
+    ##
+    #
+    # Class for managing builds for a project
+
   class Build
 
+    ##
+    #
+    # Get a specific build for a project
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @param build    [String] - Build ID
+    # @return         [CircleCi::Response] - Response object
+
     def self.get username, project, build
       CircleCi.http.get "/project/#{username}/#{project}/#{build}"
     end
 
+    ##
+    #
+    # Kick off a retry of a specific build
+    #
+    # @param username [String] - User or org name who owns project
+    # @param project  [String] - Name of project
+    # @param build    [String] - Build ID
+    # @return         [CircleCi::Response] - Response object
+
     def self.retry username, project, build
       CircleCi.http.post "/project/#{username}/#{project}/#{build}/retry"
     end

data/lib/circleci/config.rb

@@ -1,5 +1,5 @@
 module CircleCi
-##
+  ##
   #
   # Config class used internally.
   # Configure API calls using AlPapi.configure

data/lib/circleci/project.rb

@@ -1,15 +1,54 @@
 module CircleCi
 
+  ##
+  #
+  # Class for interacting with Projects
+
   class Project
 
+    ##
+    #
+    # Return all projects for your API key
+    #
+    # @return [CircleCi::Response] - Response object
+
     def self.all
       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
 
+    ##
+    #
+    # 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
+
+    ##
+    #
+    # Clear the build cache 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.clear_cache username, project
       CircleCi.http.delete "/project/#{username}/#{project}/build-cache"
     end

data/lib/circleci/user.rb

@@ -1,7 +1,17 @@
 module CircleCi
 
+  ##
+  #
+  # Class to access user details for a specific API key
+
   class User
 
+    ##
+    #
+    # Get user account details
+    #
+    # @return [CircleCi::Response] - Response object
+
     def self.me
       CircleCi.http.get '/me'
     end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circleci
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Chavez
@@ -14,97 +13,85 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.11
 description: Wraps Circle CI API calls in a gem.
@@ -114,6 +101,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- README.md
+- lib/circleci.rb
 - lib/circleci/build.rb
 - lib/circleci/config.rb
 - lib/circleci/http.rb
@@ -121,32 +110,29 @@ files:
 - lib/circleci/request_error.rb
 - lib/circleci/response.rb
 - lib/circleci/user.rb
-- lib/circleci.rb
-- README.md
 homepage: http://github.com/mtchavez/circleci
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8 --main=README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Circle CI API Wrapper
 test_files: []
 has_rdoc: