subordinate 0.1.1 → 0.2.0

data/README.md

@@ -79,6 +79,36 @@ Currently can safe restart, restart, and quiet down
 client.restart
 ```
 
+### [Build Queue](http://rdoc.info/github/jasontruluck/subordinate/master/Subordinate/Client/Queue)
+
+Retrieves the current build queue for the Jenkins server
+
+```ruby
+client.build_queue
+```
+
+### Using Depth query parameter
+
+For methods that allow you to specify a depth simply pass the depth you want via an option
+
+```ruby
+client.job("My-awesome-job", {:depth => 1})
+```
+
+The default depth is 0 for all methods.
+
+### Using Tree query parameters
+
+`tree` parameters are more efficient than using depth with exclude. They are available ot any methods that except them via options as well
+
+```ruby
+client.root({:tree => "jobs[name],views[name,jobs[name]]"}) 
+```
+
+A note from Jenkins: for array-type properties (such as jobs in this example), the name must be given in the original plural, not in the singular as the element would appear in XML (<job>). This will be more natural for e.g. json?tree=jobs[name] anyway: the JSON writer does not do plural-to-singular mangling because arrays are represented explicitly.
+
+Please see the [docs](https://ci.jenkins-ci.org/api/) for more info on tree parameters
+
 ## Testing
 
 This gem uses VCR to record requests to the api so you must test using a valid Jenkins server and credentails to test

data/lib/subordinate/client.rb

@@ -7,6 +7,7 @@ require "subordinate/client/job"
 require "subordinate/client/system"
 require "subordinate/client/build"
 require "subordinate/client/queue"
+require "subordinate/client/load"
 
 module Subordinate
   class Client
@@ -43,5 +44,6 @@ module Subordinate
     include Subordinate::Client::System
     include Subordinate::Client::Build
     include Subordinate::Client::Queue
+    include Subordinate::Client::Load
   end
 end

data/lib/subordinate/client/load.rb

@@ -0,0 +1,23 @@
+# Load
+module Subordinate
+  class Client
+    # Load statistics
+    #
+    # @see https://ci.jenkins-ci.org/job/jenkins_rc_branch/api/
+    module Load
+      # Returns the current load statistics of the Jenkins server
+      #
+      # @see http://jenkins.missioncontrol.io:8080/queue/api/
+      #
+      # @return [Hashie::Mash] load statistics response
+      #
+      # @example Get the current load statistics
+      #   Subordinate::Client.load_statistics
+      #
+      # @author Jason Truluck
+      def load_statistics(options = {})
+        get("overallLoad/api/json", options)
+      end
+    end
+  end
+end

data/lib/subordinate/client/queue.rb

@@ -9,7 +9,7 @@ module Subordinate
       #
       # @see http://jenkins.missioncontrol.io:8080/queue/api/
       #
-      # @return [Hashie::Mash] job response
+      # @return [Hashie::Mash] build queue response
       #
       # @example Get the current build queue
       #   Subordinate::Client.build_queue

data/lib/subordinate/version.rb

@@ -1,3 +1,3 @@
 module Subordinate
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/subordinate/client/load_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../fixtures/authentications.yml", __FILE__)))
+
+# Queue Spec
+describe Subordinate::Client do
+  before do
+    Subordinate.reset!
+    Subordinate.configure do |c|
+      c.subdomain = auth["subdomain"]
+      c.domain    = auth["domain"]
+      c.port      = auth["port"]
+      c.ssl       = false
+    end
+  end
+  let(:subordinate) { Subordinate::Client.new(:username => auth["username"], :api_token => auth["token"]) }
+
+  describe "#load_statistics", :vcr do
+    let(:current_response) { subordinate.load_statistics }
+
+    it "returns the load statistics response" do
+      current_response.should_not be_nil
+    end
+
+    context "methods" do
+      it "responds to .busyExecutors" do
+        current_response.should respond_to(:busyExecutors)
+      end
+
+      it "responds to .queueLength" do
+        current_response.should respond_to(:queueLength)
+      end
+
+      it "responds to .totalExecutors" do
+        current_response.should respond_to(:totalExecutors)
+      end
+
+      it "responds to .totalQueueLength" do
+        current_response.should respond_to(:totalQueueLength)
+      end
+    end
+  end
+end

data/spec/subordinate/client/queue_spec.rb

@@ -18,7 +18,7 @@ describe Subordinate::Client do
   describe "#build_queue", :vcr do
     let(:current_response) { subordinate.build_queue }
 
-    it "returns the job response" do
+    it "returns the build queue response" do
       current_response.should_not be_nil
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: subordinate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -220,6 +220,7 @@ files:
 - lib/subordinate/client.rb
 - lib/subordinate/client/build.rb
 - lib/subordinate/client/job.rb
+- lib/subordinate/client/load.rb
 - lib/subordinate/client/queue.rb
 - lib/subordinate/client/system.rb
 - lib/subordinate/configuration.rb
@@ -230,6 +231,7 @@ files:
 - spec/spec_helper.rb
 - spec/subordinate/client/build_spec.rb
 - spec/subordinate/client/job_spec.rb
+- spec/subordinate/client/load_spec.rb
 - spec/subordinate/client/queue_spec.rb
 - spec/subordinate/client/system_spec.rb
 - spec/subordinate/client_spec.rb
@@ -248,7 +250,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1032835890192964007
+      hash: -3274379220519707228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -257,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1032835890192964007
+      hash: -3274379220519707228
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -269,6 +271,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/subordinate/client/build_spec.rb
 - spec/subordinate/client/job_spec.rb
+- spec/subordinate/client/load_spec.rb
 - spec/subordinate/client/queue_spec.rb
 - spec/subordinate/client/system_spec.rb
 - spec/subordinate/client_spec.rb