circleci 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a8c8dbe2997c816b48f601d71ca462261071db6
-  data.tar.gz: 65826412f05aca0a009c5e6358c8016b1c54b050
+  metadata.gz: 2b593d6e0bcf64fc14fb6ad923be106b6909cbd3
+  data.tar.gz: 702ed7c6b41beef442a87c7d1f6ce0139a0fd51e
 SHA512:
-  metadata.gz: d6eb8eaf6d13fd82f49274380457ad9f8ee3b653cd7bb1be2a66e2488f8287a08ff0269870e87f6329bc7121361958a3abf1c525f033c5ccd14ec68a0b28435e
-  data.tar.gz: 2598e61e61c78cddb3bdc1ae834de500075fecf8a55e0d75dbcfb2d6253f20d0b6787b2ffb0766e89149edfbcc1a56b34c2c1546d5a455dfe86d81dac0f44267
+  metadata.gz: a13042709bc07021325712265b2060d7b9fa4551bfd78163b90f337d6008c52d77cfe201f11d1a3f3331c3aafe705337e49f6064ca8bb89af870c4c97447772a
+  data.tar.gz: b795a0a4b3bbff5acac6b7bd8441e82859ae4e9a696df45b1fc86c189c185de0991c5ccbbf4ce5a478ac788729f94d1c1460df6453dfd292b4bbce9daf7e06e0

data/README.md

@@ -44,6 +44,17 @@ CircleCi.configure do |config|
 end
 ```
 
+Overriding request settings such as not verifying SSL
+
+```ruby
+CircleCi.configure do |config|
+  config.token = ENV['CIRCLECI_TOKEN']
+  config.request_overrides = {
+    verify_ssl: false
+  }
+end
+```
+
 ## API Endpoints
 
 * [User](#user)
@@ -61,7 +72,7 @@ end
   * [Get Checkout Key](#get_checkout_key)
   * [List Checkout Keys](#list_checkout_keys)
   * [New Checkout Key](#new_checkout_key)
-  * [Recent Builds](#recent_builds)
+  * [Recent Builds](#project_recent_builds)
   * [Recent Builds Branch](#recent_builds_branch)
   * [Settings](#settings)
   * [Set Envvar](#set_envvar)
@@ -73,7 +84,8 @@ end
   * [Get](#get)
   * [Retry](#retry)
   * [Tests](#tests)
-* [Organization](#organization)
+* [Recent Builds](#recent_builds)
+  * [Get](#recent_builds_get)
 
 ### [User](#user)
 
@@ -516,7 +528,7 @@ Example response
 }
 ```
 
-#### [recent_builds](#recent_builds)
+#### [recent_builds](#project_recent_builds)
 
 Endpoint: `/project/:username/:repository`
 
@@ -524,6 +536,13 @@ Build summary for each of the last 30 recent builds, ordered by build_num.
 
 ```ruby
 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.body
 ```
@@ -977,170 +996,59 @@ res.body
 ]
 ```
 
-### [organization](#organization)
+### [Recent Builds](#recent_builds)
 
-Endpoint: `/organization/:name`
+#### [get](#recent_builds_get)
 
-Recent builds for an entire organization
+Endpoint: `/recent-builds`
+
+Build summary for each of the last 30 recent builds, ordered by build_num.
 
 ```ruby
-res = CircleCi.organization 'my-org'
-res.succes?
+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
 ```
 
 ```javascript
-[
-   {
-      "dont_build":null,
-      "committer_name":"Chavez",
-      "usage_queued_at":"2014-04-12T10:29:59.352Z",
-      "branch":"master",
-      "body":"Update Missing ''e'' in CircleCi in README.md",
-      "author_date":"2014-03-12T23:14:53Z",
-      "node":[
-         {
-            "username":"ubuntu",
-            "ssh_enabled":null,
-            "port":64721,
-            "public_ip_addr":"54.82.224.94"
-         }
-      ],
-      "committer_date":"2014-03-12T23:14:53Z",
-      "compare":null,
-      "retries":null,
-      "parallel":1,
-      "committer_email":"mtchavez@users.noreply.github.com",
-      "build_time_millis":16308,
-      "why":"retry",
-      "author_email":"mtchavez@users.noreply.github.com",
-      "ssh_enabled":null,
-      "start_time":"2014-04-12T10:29:59.587Z",
-      "stop_time":"2014-04-12T10:30:15.895Z",
-      "lifecycle":"finished",
-      "user":{
-         "is_user":true,
-         "login":"hwartig",
-         "name":"Harald Wartig",
-         "email":"hwartig@users.noreply.github.com"
-      },
-      "subject":"Merge pull request #4 from Alex-Poon/master",
-      "messages":[
-
-      ],
-      "job_name":null,
-      "retry_of":1,
-      "previous_successful_build":{
-         "build_time_millis":37685,
-         "status":"success",
-         "build_num":1
-      },
-      "outcome":"success",
-      "status":"success",
-      "vcs_revision":"f33617404dc392ddd676fdde87cd5c87369e1857",
-      "build_num":2,
-      "username":"hwartigcom",
-      "vcs_url":"https://github.com/hwartigcom/circleci",
-      "timedout":false,
-      "previous":{
-         "build_time_millis":37685,
-         "status":"success",
-         "build_num":1
-      },
-      "canceled":false,
-      "infrastructure_fail":false,
-      "failed":null,
-      "reponame":"circleci",
-      "build_url":"https://circleci.com/gh/hwartigcom/circleci/2",
-      "feature_flags":{
-
-      },
-      "author_name":"Chavez",
-      "queued_at":"2014-04-12T10:29:59.517Z"
-   },
-   {
-      "dont_build":null,
-      "committer_name":"Chavez",
-      "usage_queued_at":"2014-04-08T06:58:09.522Z",
-      "branch":"master",
-      "body":"Update Missing ''e'' in CircleCi in README.md",
-      "author_date":"2014-03-12T23:14:53Z",
-      "node":[
-         {
-            "username":"ubuntu",
-            "ssh_enabled":null,
-            "port":64775,
-            "public_ip_addr":"54.198.9.232"
-         }
-      ],
-      "committer_date":"2014-03-12T23:14:53Z",
-      "compare":null,
-      "retries":[
-         2
-      ],
-      "parallel":1,
-      "committer_email":"mtchavez@users.noreply.github.com",
-      "build_time_millis":37685,
-      "why":"first-build",
-      "author_email":"mtchavez@users.noreply.github.com",
-      "ssh_enabled":null,
-      "start_time":"2014-04-08T06:58:09.868Z",
-      "stop_time":"2014-04-08T06:58:47.553Z",
-      "lifecycle":"finished",
-      "user":{
-         "is_user":true,
-         "login":"hwartig",
-         "name":"Harald Wartig",
-         "email":"hwartig@users.noreply.github.com"
-      },
-      "subject":"Merge pull request #4 from Alex-Poon/master",
-      "messages":[
-
-      ],
-      "job_name":null,
-      "retry_of":null,
-      "previous_successful_build":null,
-      "outcome":"success",
-      "status":"success",
-      "vcs_revision":"f33617404dc392ddd676fdde87cd5c87369e1857",
-      "build_num":1,
-      "username":"hwartigcom",
-      "vcs_url":"https://github.com/hwartigcom/circleci",
-      "timedout":false,
-      "previous":null,
-      "all_commit_details":[
-         {
-            "committer_name":"Chavez",
-            "body":"Update Missing ''e'' in CircleCi in README.md",
-            "author_date":"2014-03-12T23:14:53Z",
-            "committer_date":"2014-03-12T23:14:53Z",
-            "commit_url":"https://github.com/hwartigcom/circleci/commit/f33617404dc392ddd676fdde87cd5c87369e1857",
-            "committer_email":"mtchavez@users.noreply.github.com",
-            "author_email":"mtchavez@users.noreply.github.com",
-            "subject":"Merge pull request #4 from Alex-Poon/master",
-            "commit":"f33617404dc392ddd676fdde87cd5c87369e1857",
-            "author_name":"Chavez"
-         }
-      ],
-      "canceled":false,
-      "infrastructure_fail":false,
-      "failed":null,
-      "reponame":"circleci",
-      "build_url":"https://circleci.com/gh/hwartigcom/circleci/1",
-      "feature_flags":{
-
-      },
-      "author_name":"Chavez",
-      "queued_at":"2014-04-08T06:58:09.739Z"
-   }
-]
+[ {
+  "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
 
 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.
+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

data/lib/circleci.rb

@@ -7,6 +7,7 @@ files = %w[
   config
   http
   project
+  recent_builds
   request_error
   response
   user
@@ -42,18 +43,4 @@ module CircleCi
   def http # @private
     Http.new(config)
   end
-
-  ##
-  #
-  # Get recent builds for an organization
-  #
-  # @param name   [String] Name of the organization. Currently CircleCi treats
-  #               the name case sensetive so make sure the spelling is the same
-  #               as the github organisation.
-  # @param params [Hash] Additional query params.
-  # @return       [CircleCi::Response] - Response object.
-
-  def organization(name, params = {})
-    http.get "/organization/#{name}", params
-  end
 end

data/lib/circleci/config.rb

@@ -9,7 +9,7 @@ module CircleCi
     DEFAULT_URI = "#{DEFAULT_HOST}/api/#{DEFAULT_VERSION}".freeze
     DEFAULT_PORT = 80
 
-    attr_accessor :token, :host, :port, :version
+    attr_accessor :token, :host, :port, :request_overrides, :version
 
     ##
     #
@@ -19,6 +19,7 @@ module CircleCi
       @host = DEFAULT_HOST
       @port = DEFAULT_PORT
       @version = DEFAULT_VERSION
+      @request_overrides = {}
     end
 
     def uri

data/lib/circleci/http.rb

@@ -36,15 +36,20 @@ module CircleCi
     end
 
     def create_request_args(http_verb, url, body)
-      return [http_verb, url, body, headers] if http_verb == 'post'
-      [http_verb, url, headers]
+      args = {
+        method: http_verb.to_sym,
+        url: url,
+        headers: headers }
+      args[:payload] = body if http_verb == 'post'
+      args.merge!(@config.request_overrides)
+      args
     end
 
     def request(http_verb, path, body = {})
       url  = "#{@config.uri}#{path}"
       args = create_request_args http_verb, url, body
 
-      RestClient.send(*args) do |res, _, raw_res|
+      RestClient::Request.execute(args) do |res, _, raw_res|
         body = res.body.to_s
         body.force_encoding(Encoding::UTF_8)
         code = raw_res.code.to_i

data/lib/circleci/project.rb

@@ -177,10 +177,11 @@ module CircleCi
     #
     # @param username [String] - User or org name who owns project
     # @param project  [String] - Name of project
+    # @param params   [Hash] - Parameters for builds (limit, offset, filter)
     # @return         [CircleCi::Response] - Response object
 
-    def self.recent_builds(username, project)
-      CircleCi.http.get "/project/#{username}/#{project}"
+    def self.recent_builds(username, project, params = {})
+      CircleCi.http.get "/project/#{username}/#{project}", params
     end
 
     ##

data/lib/circleci/recent_builds.rb

@@ -0,0 +1,17 @@
+module CircleCi
+  ##
+  #
+  # Class for interacting with recent builds
+  class RecentBuilds
+    ##
+    #
+    # Get get recent builds for your account
+    #
+    # @param params [Hash] - Params to send for recent builds (limit, offset)
+    # @return         [CircleCi::Response] - Response object
+
+    def self.get(params = {})
+      CircleCi.http.get '/recent-builds', params
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Chavez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -317,6 +317,7 @@ files:
 - lib/circleci/config.rb
 - lib/circleci/http.rb
 - lib/circleci/project.rb
+- lib/circleci/recent_builds.rb
 - lib/circleci/request_error.rb
 - lib/circleci/response.rb
 - lib/circleci/user.rb