jenkins_api_client 0.1.1 → 0.2.1

data/.gitignore

@@ -0,0 +1,29 @@
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# test script
+test
+
+# simplecov code coverage directory
+coverage
+
+# Yard doc
+doc
+.yardoc
+#
+Gemfile.lock
+
+# MacOS:
+.DS_Store
+
+# vim, emacs, textmate
+*~
+\#*
+.\#*
+*.tmproj
+tmtags
+*.swp

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = CHANGELOG
 
+===== v0.2.0  [02-NOV-2012]
+* Added command line interface for basic operations
+
 ===== v0.1.1  [30-OCT-2012]
 * Updated gem dependencies to work with Ruby 1.8.7
 

data/Gemfile

@@ -2,6 +2,8 @@ source "http://rubygems.org"
 
 gem "nokogiri", "~> 1.5.5"
 gem "activesupport", "~> 3.2.8"
+gem "thor", "~> 0.16.0"
+gem "json", ">= 0"
 
 group :development do
   gem "bundler", "~> 1.2.1"

data/README.rdoc

@@ -122,6 +122,15 @@ with 'failure' as the threshold, and also chain three jobs in parallel.
     raise "Unable to build job: #{job}" unless code == 302
   }
 
+=== Using with command line
+Command line interface is supported only from version 0.2.0.
+See help using <tt>jenkinscli help</tt>
+
+There are three ways for authentication using command line interface
+1. Passing all credentials and server information using command line parameters
+2. Passing the credentials file as the command line parameter
+3. Having the credentials file in the default location <tt>HOME/.jenkins_api_client/login.yml</tt>
+
 === Debug
 
 The call to client initialization accepts a debug parameter. If it is set to <tt>true</tt> it will print

data/Rakefile

@@ -9,6 +9,9 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.platform     = Gem::Platform::RUBY
   gemspec.date         = Time.now.utc.strftime("%Y-%m-%d")
   gemspec.require_path = 'lib'
+  gemspec.executables  = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gemspec.files        = `git ls-files`.split("\n")
+  gemspec.extra_rdoc_files = ['CHANGELOG.rdoc', 'LICENSE', 'README.rdoc']
   gemspec.authors      = [ 'Kannan Manickam' ]
   gemspec.email        = [ 'arangamani.kannan@gmail.com' ]
   gemspec.homepage     = 'https://github.com/arangamani/jenkins_api_client'
@@ -16,9 +19,6 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.description  = %{
 This is a simple and easy-to-use Jenkins Api client with features focused on
 automating Job configuration programaticaly and so forth}
+  gemspec.test_files = `git ls-files -- {spec}/*`.split("\n")
   gemspec.rubygems_version = '1.8.17'
-  gemspec.add_runtime_dependency 'json'
-  gemspec.add_development_dependency 'rake',         '0.8.7'
-  gemspec.add_development_dependency 'activesupport'
-  gemspec.add_development_dependency 'bundler'
 end

data/bin/jenkinscli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'jenkins_api_client'
+JenkinsApi::CLI::Base.start

data/lib/jenkins_api_client.rb

@@ -1 +1,2 @@
-require File.expand_path('../jenkins_api_client/client', __FILE__)
+Dir[File.dirname(__FILE__) + '/jenkins_api_client/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/jenkins_api_client/cli/*.rb'].each {|file| require file }

data/lib/jenkins_api_client/cli/base.rb

@@ -0,0 +1,49 @@
+#
+# 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 'thor'
+require 'thor/group'
+require "#{File.dirname(__FILE__)}/../client.rb"
+require "#{File.dirname(__FILE__)}/job.rb"
+
+module JenkinsApi
+  module CLI
+
+    class Base < Thor
+      map "-v" => :version
+
+      desc "version", "Shows current version"
+      def version
+        puts JenkinsApi::Client::VERSION
+      end
+    end
+
+  end
+end
+
+JenkinsApi::CLI::Base.register(
+  JenkinsApi::CLI::Job,
+  'job',
+  'job [subcommand]',
+  'Provides functions to access the job interface of Jenkins CI server'
+)
+

data/lib/jenkins_api_client/cli/job.rb

@@ -0,0 +1,109 @@
+#
+# 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 File.expand_path('../base', __FILE__)
+require 'fileutils'
+
+module JenkinsApi
+  module CLI
+
+    class Job < Thor
+      include Thor::Actions
+      class_option :username,        :aliases => "-u", :desc => "Name of Jenkins user"
+      class_option :password,        :aliases => "-p", :desc => "Password of Jenkins user"
+      class_option :password_base64, :aliases => "-b", :desc => "Base 64 encoded password of Jenkins user"
+      class_option :server_ip,       :aliases => "-s", :desc => "Jenkins server IP address"
+      class_option :server_port,     :aliases => "-o", :desc => "Jenkins server port"
+      class_option :creds_file,      :aliases => "-c", :desc => "Credentials file for communicating with Jenkins server"
+
+      no_tasks {
+        def setup
+          if options[:username] && options[:server_ip] && (options[:password] || options[:password_base64])
+            creds = options
+          elsif options[:creds_file]
+            creds = YAML.load_file(File.expand_path(options[:creds_file], __FILE__))
+          elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
+            creds = YAML.load_file(File.expand_path("#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__))
+          else
+            say "Credentials are not set. Please pass them as parameters or set them in the default credentials file", :red
+          end
+           JenkinsApi::Client.new(creds)
+        end
+      }
+
+      desc "test", "Test job"
+      def test
+        #invoke :creds
+        setup
+        puts "test: #{options[:username]}"
+        #puts self.options[:username] if self.options[:username]
+      end
+
+      desc "list", "List jobs"
+      method_option :filter, :aliases => "-f", :desc => "Regular expression to filter jobs"
+      def list
+        @client = setup
+        if options[:filter]
+          puts @client.job.list(options[:filter])
+        else
+          puts @client.job.list_all
+        end
+      end
+
+      desc "build JOB", "Build a job"
+      def build(job)
+        @client = setup
+        @client.job.build(job)
+      end
+
+      desc "status JOB", "Get the current build status of a job"
+      def status(job)
+        @client = setup
+        puts @client.job.get_current_build_status(job)
+      end
+
+      desc "listrunning", "List running jobs"
+      def listrunning
+        @client =  setup
+        puts @client.job.list_running
+      end
+
+      desc "delete JOB", "Delete the job"
+      def delete(job)
+        @client = setup
+        puts @client.job.delete(job)
+      end
+
+      desc "restrict JOB", "Restricts a job to a specific node"
+      method_option :node, :aliases => "-n", :desc => "Node to be restricted to"
+      def restrict(job)
+        @client = setup
+        if options[:node]
+          @client.job.restrict_to_node(job, options[:node])
+        else
+          say "You need to specify the node to be restricted to.", :red
+        end
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/version.rb

@@ -22,6 +22,6 @@
 
 module JenkinsApi
   class Client
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -44,62 +44,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.8
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-- !ruby/object:Gem::Dependency
-  name: jeweler
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :development
+        version: 0.16.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: builder
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.1.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.1.3
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -108,55 +76,55 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 1.2.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 1.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -178,18 +146,24 @@ description: ! '
   automating Job configuration programaticaly and so forth'
 email:
 - arangamani.kannan@gmail.com
-executables: []
+executables:
+- jenkinscli
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.rdoc
 - README.rdoc
 files:
+- .gitignore
 - CHANGELOG.rdoc
 - Gemfile
 - LICENCE
 - README.rdoc
 - Rakefile
+- bin/jenkinscli
 - config/login.yml.example
 - lib/jenkins_api_client.rb
+- lib/jenkins_api_client/cli/base.rb
+- lib/jenkins_api_client/cli/job.rb
 - lib/jenkins_api_client/client.rb
 - lib/jenkins_api_client/exceptions.rb
 - lib/jenkins_api_client/job.rb
@@ -212,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -930333391334275040
+      hash: 2332251850265397219
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: