subordinate 0.2.2 → 0.3.0

data/lib/subordinate/client/load.rb

@@ -7,7 +7,7 @@ module Subordinate
     module Load
       # Returns the current load statistics of the Jenkins server
       #
-      # @see http://jenkins.missioncontrol.io:8080/queue/api/
+      # @see https://ci.jenkins-ci.org:8080/queue/api/
       #
       # @return [Hashie::Mash] load statistics response
       #

data/lib/subordinate/client/view.rb

@@ -0,0 +1,85 @@
+# View
+module Subordinate
+  class Client
+    # View
+    #
+    # @see https://ci.jenkins-ci.org/view/All%20Unstable/api/
+    module View
+      # Returns the specified view
+      #
+      # @see http://ci.jenkins-ci.org/view/All%20Unstable/api/json?pretty=true
+      #
+      # @param view_name [String] the name of the view you want inforamtion on
+      #
+      # @return [Hashie::Mash] response from the specified view
+      #
+      # @example Get the current view
+      #   Subordinate::Client.view("My-Awesome-View")
+      #
+      # @author Jason Truluck
+      def view(view_name, options = {})
+        get("view/#{view_name}/api/json", options)
+      end
+
+      # Returns all of the views with their corresponding jobs
+      #
+      # @see https://ci.jenkins-ci.org/api/json?tree=views[name,jobs[name]]
+      #
+      # @return [Hashie::Mash] response containing all views on the server and their respective jobs
+      #
+      # @example Get all the views
+      #   Subordinate::Client.all_views
+      #
+      # @author Jason Truluck
+      def all_views(options = {})
+        options.merge!(
+          :tree => "views[name,url,jobs[name,url]]"
+        )
+        get("api/json", options)
+      end
+
+
+      # Add a job to the Jenkins view
+      #
+      # @see http://ci.jenkins-ci.org/view/All%20Unstable/api/
+      #
+      # @param view_name [String] the name of the view you want inforamtion on
+      # @param job [String] the name of the job you want to add
+      #
+      # @return [Integer] status the status of the request
+      #
+      # @example Add the selected Job to the Jenkins View
+      #   Subordinate::Client.add_job_to_view("My-Awesome-View", "My-Awesome-Job")
+      #
+      # @author Jason Truluck
+      def add_job_to_view(view_name, job, options = {})
+        options.merge!(
+          :with_query_params => true,
+          :name => job
+        )
+        post("view/#{view_name}/addJobToView", options)
+      end
+
+      # Remove a job to the Jenkins view
+      #
+      # @see http://ci.jenkins-ci.org/view/All%20Unstable/api/
+      #
+      # @param view_name [String] the name of the view you want inforamtion on
+      # @param job [String] the name of the job you want to remove
+      #
+      # @return [Integer] status the status of the request
+      #
+      # @example Remove the selected job from the Jenkins View
+      #   Subordinate::Client.remove_job_from_view("My-Awesome-View", "My-Awesome-Job")
+      #
+      # @author Jason Truluck
+      def remove_job_from_view(view_name, job, options = {})
+        options.merge!(
+          :with_query_params => true,
+          :name => job
+        )
+        post("view/#{view_name}/removeJobFromView", options)
+      end
+    end
+  end
+end

data/lib/subordinate/client.rb

@@ -8,6 +8,7 @@ require "subordinate/client/system"
 require "subordinate/client/build"
 require "subordinate/client/queue"
 require "subordinate/client/load"
+require "subordinate/client/view"
 
 module Subordinate
   class Client
@@ -45,5 +46,6 @@ module Subordinate
     include Subordinate::Client::Build
     include Subordinate::Client::Queue
     include Subordinate::Client::Load
+    include Subordinate::Client::View
   end
 end

data/lib/subordinate/request.rb

@@ -1,3 +1,5 @@
+require 'multi_json'
+
 module Subordinate
   module Request
     def get(path, options = {})
@@ -23,8 +25,13 @@ module Subordinate
         when :get
           request.url(path, options)
         when :post
-          request.path = path
-          request.body = MultiJson.dump(options) unless options.empty?
+          with_query_params = options.delete(:with_query_params) || false
+          if with_query_params
+            request.url(path, options)
+          else
+            request.path = path
+            request.body = MultiJson.dump(options) unless options.empty?
+          end
         end
       end
       response

data/lib/subordinate/version.rb

@@ -1,3 +1,3 @@
 module Subordinate
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/subordinate/client/view_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+auth = YAML::load(File.open(File.expand_path("../../../fixtures/authentications.yml", __FILE__)))
+
+# View 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 "#view", :vcr do
+    let(:current_response) { subordinate.view(auth["view"]) }
+
+    it "returns the view response" do
+      current_response.should_not be_nil
+    end
+
+    context "methods" do
+      it "responds to .description" do
+        current_response.should respond_to(:description)
+      end
+
+      it "responds to .jobs" do
+        current_response.should respond_to(:jobs)
+      end
+
+      it "responds to .name" do
+        current_response.should respond_to(:name)
+      end
+
+      it "responds to .property" do
+        current_response.should respond_to(:property)
+      end
+
+      it "responds to .url" do
+        current_response.should respond_to(:url)
+      end
+    end
+  end
+
+  describe "#all_views", :vcr do
+    let(:current_response) { subordinate.all_views }
+
+    it "returns the view response" do
+      current_response.should_not be_nil
+    end
+
+    context "methods" do
+      it "respond to .views" do
+        current_response.should respond_to(:views)
+      end
+
+      describe "within views" do
+        it "respond to .jobs" do
+          current_response.views.first.should respond_to(:jobs)
+        end
+
+        it "respond to .name" do
+          current_response.views.first.should respond_to(:name)
+        end
+
+        it "respond to .url" do
+          current_response.views.first.should respond_to(:url)
+        end
+      end
+    end
+  end
+
+  describe "#add_job_to_view" do
+    it "responds with a success" do
+      stub_request(:post, "#{subordinate.api_endpoint}/view/#{auth['view']}/addJobToView").
+      to_return(:status => 200, :body => "", :headers => {})
+
+      subordinate.add_job_to_view(auth['view'], auth['job']).status.should == 200
+    end
+  end
+
+  describe "#remove_job_from_view" do
+    it "responds with a success" do
+      stub_request(:post, "#{subordinate.api_endpoint}/view/#{auth['view']}/removeJobFromView").
+      to_return(:status => 200, :body => "", :headers => {})
+
+      subordinate.remove_job_from_view(auth['view'], auth['job']).status.should == 200
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: subordinate
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -239,6 +239,7 @@ files:
 - lib/subordinate/client/load.rb
 - lib/subordinate/client/queue.rb
 - lib/subordinate/client/system.rb
+- lib/subordinate/client/view.rb
 - lib/subordinate/configuration.rb
 - lib/subordinate/connection.rb
 - lib/subordinate/request.rb
@@ -250,6 +251,7 @@ files:
 - spec/subordinate/client/load_spec.rb
 - spec/subordinate/client/queue_spec.rb
 - spec/subordinate/client/system_spec.rb
+- spec/subordinate/client/view_spec.rb
 - spec/subordinate/client_spec.rb
 - subordinate.gemspec
 homepage: https://github.com/jasontruluck/subordinate
@@ -266,7 +268,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2234839665290920209
+      hash: 1397159424799143771
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -275,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2234839665290920209
+      hash: 1397159424799143771
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -290,5 +292,6 @@ test_files:
 - spec/subordinate/client/load_spec.rb
 - spec/subordinate/client/queue_spec.rb
 - spec/subordinate/client/system_spec.rb
+- spec/subordinate/client/view_spec.rb
 - spec/subordinate/client_spec.rb
 has_rdoc: