jenkins_api_client 1.0.0.beta.4 → 1.0.0.beta.5

data/Gemfile

@@ -13,4 +13,5 @@ group :development do
   gem "simplecov"
   gem "yard-thor"
   gem "yard"
+  gem "pry"
 end

data/Vagrantfile

@@ -6,7 +6,7 @@ Vagrant.configure("2") do |config|
   # options are documented and commented below. For a complete reference,
   # please see the online documentation at vagrantup.com.
 
-  config.vm.hostname = "jenkins-api-client"
+  config.vm.hostname = "jenkins"
 
   # Every Vagrant virtual environment requires a box to build off of.
   config.vm.box = "opscode-ubuntu-12.04"
@@ -19,7 +19,7 @@ Vagrant.configure("2") do |config|
   # via the IP. Host-only networks can talk to the host machine as well as
   # any other machines on the same network, but cannot be accessed (through this
   # network interface) by any external networks.
-  config.vm.network :private_network, ip: "33.33.33.10"
+  config.vm.network :private_network, ip: "33.33.33.100"
 
   # Create a public network, which generally matched to bridged network.
   # Bridged networks make the machine appear as another physical device on
@@ -78,6 +78,6 @@ Vagrant.configure("2") do |config|
     " sudo gem1.9.1 install bundler;" +
     " bundle install;" +
     " travis/setup.sh;" +
-    " bundle exec rake unit_tests;" +
-    " bundle exec rake func_tests"
+    " bundle exec rake unit_tests;"
+    #" bundle exec rake func_tests"
 end

data/lib/jenkins_api_client/client.rb

@@ -60,7 +60,8 @@ module JenkinsApi
       "timeout",
       "ssl",
       "follow_redirects",
-      "identity_file"
+      "identity_file",
+      "cookies"
     ].freeze
 
     # Initialize a Client object with Jenkins CI server credentials
@@ -87,6 +88,7 @@ module JenkinsApi
     # @option args [String] :log_location (STDOUT) the location for the log file
     # @option args [Fixnum] :log_level (Logger::INFO) The level for messages to be logged. Should be one of:
     #   Logger::DEBUG (0), Logger::INFO (1), Logger::WARN (2), Logger::ERROR (2), Logger::FATAL (3)
+    # @option args [String] :cookies Cookies to be sent with all requests in the format: name=value; name2=value2
     #
     # @return [JenkinsApi::Client] a client object to Jenkins API
     #
@@ -249,6 +251,7 @@ module JenkinsApi
     #
     def make_http_request(request, follow_redirect = @follow_redirects)
       request.basic_auth @username, @password if @username
+      request['Cookie'] = @cookies if @cookies
 
       if @proxy_ip
         http = Net::HTTP::Proxy(@proxy_ip, @proxy_port).new(@server_ip, @server_port)
@@ -339,7 +342,6 @@ module JenkinsApi
         # that barf with empty post
         request = Net::HTTP::Post.new("#{@jenkins_path}#{url_prefix}")
         @logger.info "POST #{url_prefix}"
-        request.content_type = 'application/json'
         if @crumbs_enabled
           request[@crumb["crumbRequestField"]] = @crumb["crumb"]
         end
@@ -544,13 +546,8 @@ module JenkinsApi
     # @return [String] The output of the executed groovy script
     #
     def exec_script(script_text)
-      url = URI.escape("#{@jenkins_path}/scriptText")
-      request = Net::HTTP::Post.new("#{url}")
-      request.form_data = { 'script' =>  script_text }
-      @logger.info "POST #{url}"
-
-      response = make_http_request(request)
-      handle_exception(response, 'body')
+      response = api_post_request('/scriptText', {'script' => script_text}, true)
+      response.body
     end
 
     # Execute the Jenkins CLI

data/lib/jenkins_api_client/exceptions.rb

@@ -196,11 +196,11 @@ module JenkinsApi
     end
 
     # This exception class handles cases where the Jenkins API returns with a
-    # 500 Internel Server Error.
+    # 500 Internal Server Error.
     #
     class InternalServerError < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        message = "Internel Server Error. Perhaps the in-memory configuration" +
+        message = "Internal Server Error. Perhaps the in-memory configuration" +
           " Jenkins is different from the disk configuration. Please try to" +
           " reload the configuration" if message.nil? || message.empty?
         super(logger, message)

data/lib/jenkins_api_client/node.rb

@@ -20,12 +20,15 @@
 # THE SOFTWARE.
 #
 
+require 'jenkins_api_client/urihelper'
+
 module JenkinsApi
   class Client
     # This class communicates with Jenkins "/computer" API to obtain details
     # about nodes or slaves connected to the Jenkins.
     #
     class Node
+      include JenkinsApi::UriHelper
 
       # General attributes of a node.
       # This allows the following methods to be called on this node object.
@@ -186,7 +189,7 @@ module JenkinsApi
       def delete(node_name)
         @logger.info "Deleting node '#{node_name}'"
         if list.include?(node_name)
-          @client.api_post_request("/computer/#{node_name}/doDelete")
+          @client.api_post_request("/computer/#{path_encode node_name}/doDelete")
         else
           raise "The specified node '#{node_name}' doesn't exist in Jenkins."
         end
@@ -284,7 +287,7 @@ module JenkinsApi
       def get_config(node_name)
         @logger.info "Obtaining the config.xml of node '#{node_name}'"
         node_name = "(master)" if node_name == "master"
-        @client.get_config("/computer/#{node_name}")
+        @client.get_config("/computer/#{ path_encode node_name}")
       end
 
       # Posts the given config.xml to the Jenkins node
@@ -295,7 +298,7 @@ module JenkinsApi
       def post_config(node_name, xml)
         @logger.info "Posting the config.xml of node '#{node_name}'"
         node_name = "(master)" if node_name == "master"
-        @client.post_config("/computer/#{node_name}/config.xml", xml)
+        @client.post_config("/computer/#{path_encode node_name}/config.xml", xml)
       end
 
     end

data/lib/jenkins_api_client/version.rb

@@ -29,7 +29,7 @@ module JenkinsApi
     # Tiny version of the gem used for patches
     TINY    = 0
     # Used for pre-releases
-    PRE     = 'beta.4'
+    PRE     = 'beta.5'
     # Version String of Jenkins API Client.
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/scripts/login_with_pry.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby1.9.1
+# This script provides an easier way to login to Jenkins server API.
+# It logs you in with the credentials and server details you proided and then
+# starts an IRB session so you can interactively play with the API.
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'jenkins_api_client'
+require 'yaml'
+require 'pry'
+
+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/spec.yml'
+else
+  config_file = ARGV.shift
+end
+
+begin
+  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
+
+Pry.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.4
+  version: 1.0.0.beta.5
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -187,6 +187,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -232,6 +248,7 @@ files:
 - lib/jenkins_api_client/version.rb
 - lib/jenkins_api_client/view.rb
 - scripts/login_with_irb.rb
+- scripts/login_with_pry.rb
 - spec/func_tests/client_spec.rb
 - spec/func_tests/job_spec.rb
 - spec/func_tests/node_spec.rb.pending