jenkins_api_client 0.9.1 → 0.10.0

data/lib/jenkins_api_client/exceptions.rb

@@ -21,19 +21,26 @@
 #
 
 module JenkinsApi
+  # This module contains classes that define exceptions for various catories.
   module Exceptions
+    # This is the base class for Exceptions that is inherited from
+    # RuntimeError.
     class ApiException < RuntimeError
       def initialize(message = "")
         super("Error: #{message}")
       end
     end
 
+    # This exception class handles cases where invalid credentials are provided
+    # to connect to the Jenkins
     class UnautherizedException < ApiException
       def initialize(message = "")
         super("Invalid credentials are provided. #{message}")
       end
     end
 
+    # This exception class handles cases where a requested page is not found on
+    # the Jenkins API
     class NotFoundException < ApiException
       def initialize(message = "")
         super("Requested component is not found on the Jenkins CI server." +
@@ -41,6 +48,8 @@ module JenkinsApi
       end
     end
 
+    # This exception class handles cases where the Jenkins API returns with a
+    # 500 Internel Server Error
     class InternelServerErrorException < ApiException
       def initialize(message = "")
         super("Internel Server Error. Perhaps the in-memory configuration of" +
@@ -49,5 +58,12 @@ module JenkinsApi
              )
       end
     end
+
+    # Exception occurred while running java CLI commands
+    class CLIException < ApiException
+      def initialize(message = "")
+        super("Execute CLI Error. #{message}")
+      end
+    end
   end
 end

data/lib/jenkins_api_client/job.rb

@@ -22,6 +22,8 @@
 
 module JenkinsApi
   class Client
+    # This class communicates with the Jenkins "/job" API to obtain details
+    # about jobs, creating, deleting, building, and various other operations.
     class Job
 
       # Initialize the Job object and store the reference to Client object
@@ -211,6 +213,7 @@ module JenkinsApi
       # @option params [String] :notification_email Email address to send
       # @option params [TrueClass|FalseClass] :notification_email_for_every_unstable
       # Send email notification email for every unstable build
+      #
       def add_email_notification(params)
         raise "No job name specified" unless params[:name]
         raise "No email address specified" unless params[:notification_email]
@@ -357,7 +360,8 @@ module JenkinsApi
         end
         get_msg = "/job/#{job_name}/#{build_num}/logText/progressive#{mode}?"
         get_msg << "start=#{start}"
-        api_response = @client.api_get_request(get_msg, nil, nil)
+        raw_response = true
+        api_response = @client.api_get_request(get_msg, nil, nil, raw_response)
         #puts "Response: #{api_response.header['x-more-data']}"
         response = {}
         response['output'] = api_response.body

data/lib/jenkins_api_client/node.rb

@@ -22,6 +22,8 @@
 
 module JenkinsApi
   class Client
+    # This class communicates with Jenkins "/computer" API to obtain details
+    # about nodes or slaves connected to the Jenkins.
     class Node
 
       # General attributes of a node.

data/lib/jenkins_api_client/system.rb

@@ -24,6 +24,8 @@ require 'timeout'
 
 module JenkinsApi
   class Client
+    # This class is used to communicate with Jenkins and performing some admin
+    # level operations such as restarting and reloading Jenkins.
     class System
 
       # Initializes a new System object.

data/lib/jenkins_api_client/version.rb

@@ -22,10 +22,15 @@
 
 module JenkinsApi
   class Client
+    # Major version of the gem
     MAJOR   = 0
-    MINOR   = 9
-    TINY    = 1
+    # Minor version of the gem
+    MINOR   = 10
+    # Tiny version of the gem used for patches
+    TINY    = 0
+    # Used for pre-releases
     PRE     = nil
+    # Version String of Jenkins API Client.
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end
 end

data/lib/jenkins_api_client/view.rb

@@ -22,6 +22,9 @@
 
 module JenkinsApi
   class Client
+    # This class communicates with Jenkins "/view" API and used to create,
+    # delete, update, and various other operations permitted on the Jenkins
+    # API.
     class View
 
       # Initializes a new view object

data/scripts/login_with_irb.rb

@@ -7,8 +7,46 @@ require 'jenkins_api_client'
 require 'yaml'
 require 'irb'
 
+def prompt_for_username
+  get_from_stdin("Username: ", false)
+end
+
+def prompt_for_password
+  get_from_stdin("Password: ", true)
+end
+
+def get_from_stdin(prompt, mask = false)
+  $stdout.write(prompt)
+  
+  begin
+    Kernel::system "stty -echo" if mask == true
+    ret = gets.chomp!
+  ensure
+    if mask == true
+      Kernel::system "stty echo"
+      puts ""
+    end
+  end
+
+  ret
+end
+
+if ARGV.empty?
+  config_file = '~/.jenkins_api_client/login.yml'
+else
+  config_file = ARGV.shift
+end
+
 begin
-  @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
+  client_opts = YAML.load_file(File.expand_path(config_file))
+  unless client_opts.has_key?(:username)
+    client_opts[:username] = prompt_for_username()
+  end
+  unless client_opts.has_key?(:password) or client_opts.has_key?(:password_base64)
+    client_opts[:password] = prompt_for_password()
+  end
+  
+  @client = JenkinsApi::Client.new(client_opts)
   puts "logged-in to the Jenkins API, use the '@client' variable to use the client"
 end
 

data/spec/unit_tests/client_spec.rb

@@ -24,6 +24,21 @@ describe JenkinsApi::Client do
           end
         ).not_to raise_error
       end
+
+      it "initializes with proxy args without exception" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new(
+              :server_ip => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :password => 'password',
+              :proxy_ip => '127.0.0.1',
+              :proxy_port => 8081
+            )
+          end
+        ).not_to raise_error
+      end
     end
 
     describe "#SubClassAccessorMethods" do
@@ -187,6 +202,14 @@ describe JenkinsApi::Client do
           ).not_to raise_error(NoMethodError)
         end
       end
+
+      describe "#exec_cli" do
+        it "is defined and should execute the CLI" do
+          expect(
+            lambda { @client.exec_cli("version") }
+          ).not_to raise_error(NoMethodError)
+        end
+      end
     end
   end
 
@@ -230,6 +253,34 @@ describe JenkinsApi::Client do
           end
         ).to raise_error
       end
+
+      it "Should fail if proxy_ip is specified but proxy_port is not" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new({
+              :bogus => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :password => 'password',
+              :proxy_ip => '127.0.0.1',
+            })
+          end
+        ).to raise_error
+      end
+
+      it "Should fail if proxy_port is specified but proxy_ip is not" do
+        expect(
+          lambda do
+            JenkinsApi::Client.new({
+              :bogus => '127.0.0.1',
+              :server_port => 8080,
+              :username => 'username',
+              :password => 'password',
+              :proxy_port => 8081,
+            })
+          end
+        ).to raise_error
+      end
     end
   end
 end

data/spec/unit_tests/job_spec.rb

@@ -197,8 +197,10 @@ describe JenkinsApi::Client::Job do
 
       describe "#get_console_output" do
         it "accepts the job name and the obtains the console output" do
-          @client.should_receive(:api_get_request).and_return(
-            Net::HTTP.get_response(URI('http://example.com/index.html')))
+          msg = "/job/test_job/1/logText/progressiveText?start=0"
+          @client.should_receive(:api_get_request).
+                  with(msg, nil, nil, true).
+                  and_return(Net::HTTP.get_response(URI('http://example.com/index.html')))
           @job.get_console_output('test_job', 1, 0, 'text')
         end
 

metadata

@@ -1,138 +1,172 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jenkins_api_client
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 1
-  version: 0.9.1
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Kannan Manickam
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-02 00:00:00 -07:00
-default_executable: jenkinscli
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+date: 2013-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: thor
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 16
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.16.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
-  name: json
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: terminal-table
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.0
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  type: :runtime
   prerelease: false
-  type: :development
-  name: bundler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.6.4
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :development
-  name: simplecov
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id008
-description: |-
-  
+  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
-  automating Job configuration programaticaly and so forth
-email: 
+
+  automating Job configuration programaticaly and so forth'
+email:
 - arangamani.kannan@gmail.com
-executables: 
+executables:
 - jenkinscli
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .jenkins.yml
 - .travis.yml
@@ -143,6 +177,8 @@ files:
 - Rakefile
 - bin/jenkinscli
 - config/login.yml.example
+- java_deps/jenkins-cli.jar
+- jenkins_api_client.gemspec
 - lib/jenkins_api_client.rb
 - lib/jenkins_api_client/build_queue.rb
 - lib/jenkins_api_client/cli/base.rb
@@ -173,35 +209,28 @@ files:
 - spec/unit_tests/spec_helper.rb
 - spec/unit_tests/system_spec.rb
 - spec/unit_tests/view_spec.rb
-has_rdoc: true
 homepage: https://github.com/arangamani/jenkins_api_client
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Jenkins JSON API Client
 test_files: []
-