jenkins_api_client 0.2.1 → 0.3.0

data/lib/jenkins_api_client/system.rb

@@ -0,0 +1,87 @@
+#
+# Copyright (c) 2012 Kannan Manickam <arangamani.kannan@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+require 'timeout'
+
+module JenkinsApi
+  class Client
+    class System
+
+      # Initializes a new System object.
+      #
+      # @param [Object] client a reference to Client
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns a string representation of System class.
+      #
+      def to_s
+        "#<JenkinsApi::Client::System>"
+      end
+
+      # Sends a quiet down request to the server.
+      #
+      def quiet_down
+        @client.api_post_request("/quietDown")
+      end
+
+      # Cancels the quiet doen request sent to the server.
+      #
+      def cancel_quiet_down
+        @client.api_post_request("/cancelQuietDown")
+      end
+
+      # Restarts the Jenkins server
+      #
+      # @param [Bool] force whether to force restart or wait till all jobs are completed.
+      #
+      def restart(force = false)
+        if force
+          @client.api_post_request("/restart")
+        else
+          @client.api_post_request("/safeRestart")
+        end
+      end
+
+      # This method waits till the server becomes ready after a start or restart.
+      #
+      def wait_for_ready
+        Timeout::timeout(120) do
+          while true do
+            response = @client.get_root
+            puts "[INFO] Waiting for jenkins to restart..." if @client.debug
+            if (response.body =~ /Please wait while Jenkins is restarting/ || response.body =~ /Please wait while Jenkins is getting ready to work/)
+              sleep 15
+              redo
+            else
+               return true
+            end
+          end
+        end
+        false
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/version.rb

@@ -22,6 +22,10 @@
 
 module JenkinsApi
   class Client
-    VERSION = "0.2.1"
+    MAJOR   = 0
+    MINOR   = 3
+    TINY    = 0
+    PRE     = nil
+    VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end
 end

data/spec/client_spec.rb

@@ -20,6 +20,11 @@ describe JenkinsApi::Client do
       end
     end
 
+    it "Should be able to toggle the debug value" do
+      value = @client.debug
+      @client.toggle_debug.should_not == value
+    end
+
     it "Should be able to initialize with valid credentials" do
       client1 = JenkinsApi::Client.new(YAML.load_file(File.expand_path(@creds_file, __FILE__)))
       client1.class.should == JenkinsApi::Client

data/spec/node_spec.rb

@@ -0,0 +1,48 @@
+#
+# Specifying JenkinsApi::Client::Node class capabilities
+# Author Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::Node do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/login.yml'
+      @node_name = 'master'
+      begin
+        @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path(@creds_file, __FILE__)))
+      rescue Exception => e
+        puts "WARNING: Credentials are not set properly."
+        puts e.message
+      end
+    end
+
+    it "Should be able to list all nodes" do
+      @client.node.list.class.should == Array
+    end
+
+    it "Should be able to list all general attributes" do
+      node_attributes = JenkinsApi::Client::Node::GENERAL_ATTRIBUTES
+      node_attributes.each do |attr|
+        @client.node.method("get_#{attr}").call
+      end
+    end
+
+    it "Should be able to list all node properties" do
+      node_properties = JenkinsApi::Client::Node::NODE_PROPERTIES
+      node_properties.each do |property|
+        @client.node.method("is_#{property}?").call(@node_name)
+      end
+    end
+
+    it "Should be able to list all node attributes" do
+      node_attributes = JenkinsApi::Client::Node::NODE_ATTRIBUTES
+      node_attributes.each do |attr|
+        @client.node.method("get_node_#{attr}").call(@node_name)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -10,9 +10,9 @@ require 'pp'
 require 'yaml'
 require 'nokogiri'
 
-RSpec.configure do |config|
-  config.mock_with :flexmock
-end
+#RSpec.configure do |config|
+#  config.mock_with :flexmock
+#end
 
 module JenkinsApiSpecHelper
   class Helper

data/spec/system_spec.rb

@@ -0,0 +1,46 @@
+#
+# Specifying JenkinsApi::Client::System class capabilities
+# Author: Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::System do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/login.yml'
+      begin
+        @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path(@creds_file, __FILE__)))
+      rescue Exception => e
+        puts "WARNING: Credentials are not set properly."
+        puts e.message
+      end
+    end
+
+    it "Should be able to quiet down a Jenkins server" do
+      @client.system.quiet_down.to_i.should == 302
+    end
+
+    it "Should be able to cancel the quiet down a Jenkins server" do
+      @client.system.cancel_quiet_down.to_i.should == 302
+    end
+
+    it "Should be able to restart a Jenkins server safely" do
+      @client.system.restart.to_i.should == 302
+    end
+
+    it "Should be able to wait after a safe restart" do
+      @client.system.wait_for_ready.should == true
+    end
+
+    it "Should be able to force restart a Jenkins server" do
+      @client.system.restart(true).to_i.should == 302
+    end
+
+    it "Should be able to wait after a force restart" do
+      @client.system.wait_for_ready.should == true
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -75,28 +75,44 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
@@ -104,7 +120,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
@@ -139,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! '
 
   This is a simple and easy-to-use Jenkins Api client with features focused on
@@ -151,27 +183,34 @@ executables:
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.rdoc
-- README.rdoc
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - LICENCE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/jenkinscli
 - config/login.yml.example
 - lib/jenkins_api_client.rb
 - lib/jenkins_api_client/cli/base.rb
+- lib/jenkins_api_client/cli/helper.rb
 - lib/jenkins_api_client/cli/job.rb
+- lib/jenkins_api_client/cli/node.rb
+- lib/jenkins_api_client/cli/system.rb
 - lib/jenkins_api_client/client.rb
 - lib/jenkins_api_client/exceptions.rb
 - lib/jenkins_api_client/job.rb
+- lib/jenkins_api_client/node.rb
+- lib/jenkins_api_client/system.rb
 - lib/jenkins_api_client/version.rb
 - scripts/login_with_irb.rb
 - spec/client_spec.rb
 - spec/job_spec.rb
+- spec/node_spec.rb
 - spec/spec_helper.rb
+- spec/system_spec.rb
 homepage: https://github.com/arangamani/jenkins_api_client
 licenses: []
 post_install_message: 
@@ -186,7 +225,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2332251850265397219
+      hash: -1111690897825719008
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: