jenkins-json-api 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.swo
+*.swp
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,13 @@
+
+source :rubygems
+
+## production: trollop, json
+gem 'trollop'
+gem 'json'
+
+## testing: cucumber, rspec, mock-server-thin
+group :test do
+  gem 'cucumber'
+  gem 'rspec'
+  gem 'mock-server-thin'
+end

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,34 @@
+# jenkins-json-api
+
+Ruby wrapper for Jenkins JSON API
+
+## NOTES
+
+ * ```features/``` directory is test for the runnable ```rjja``` CLI
+ * ```spec/``` directory is tests for the library itself (kinda unit-test)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jenkins-json-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenkins-json-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) 
+
+task :default => :spec

data/bin/rjja

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+
+require 'trollop'
+require 'resolv'
+
+require_relative '../lib/jenkins-json-api'
+
+# argparsing and handling
+SUB_COMMANDS = %w( job )
+opts = Trollop::options do
+  opt :host, "host of Jenkins instance", type: String
+  stop_on SUB_COMMANDS
+end
+
+Trollop::die :host, "mandatory" unless opts[:host]
+
+cmd = ARGV.shift
+cmd_opts = case cmd
+  when "job"
+    subcmd = ARGV.shift
+    case subcmd
+      when "list"
+    # else
+    #   Trollop::die "unknown subcommand #{subcmd.inspect}"
+    end
+  #else
+  #  Trollop::die "unknown subcommand #{cmd.inspect}"
+  end
+
+Trollop::die "no action given" if cmd.nil?
+
+jenkins = Jenkins.new opts[:host]
+
+hostname, port = opts[:host].split ':'
+begin
+  Resolv.getaddress hostname
+  jenkins.get_all_jobs.each do |job|
+    name = job.name
+    succ_str = 'failed'
+    succ_str = 'success' if job.success?
+    puts "#{name} #{succ_str}"
+  end
+rescue Resolv::ResolvError, OpenURI::HTTPError
+  puts "Error: Network error"
+  exit 2
+end
+
+

data/examples/all_job_runner.rb

@@ -0,0 +1,11 @@
+require 'jenkins-json-api'
+
+jenkins = Jenkins.new 'myjenkinshost:80'
+
+
+jenkins.get_all_jobs.each do |job|
+  if job.name =~ /myjobpattern/
+    puts job.name
+    job.build_async # sending request async, useful if there is many job
+  end
+end

data/features/error_handling.feature

@@ -0,0 +1,19 @@
+Feature: handling errors in rjja
+  In order to see useful error and help messages
+  As an agile developer who using continuous integration
+  I want to know what I did wrong
+
+  Scenario: missing host parameter
+    Given the rjja binary
+    When I execute rjja with parameters ""
+    Then it should print "Error: argument --host mandatory.","Try --help for help."
+
+  Scenario: no action given
+    Given the rjja binary
+    When I execute rjja with parameters "--host=somehost"
+    Then it should print "Error: no action given.", "Try --help for help."
+
+  Scenario: non-existent host
+    Given the rjja binary
+    When I execute rjja with parameters "--host=asdf job list"
+    Then it should print "Error: Network error"

data/features/print_jobs.feature

@@ -0,0 +1,11 @@
+Feature: rjja - print all job
+  In order to get feedback from my jenkins CI tool
+  As an agile developer who using continuous integration
+  I want to know my jenkins-jobs' names and their statuses
+
+  Scenario: print all job
+    Given jenkins on port "4000" with jobs "firstjob", "secjob" with statuses respectively "success", "failed"
+    When I execute rjja with parameters "--host=localhost:4000 job list"
+    Then it should print "firstjob success", "secjob failed"
+
+

data/features/step_definitions.rb

@@ -0,0 +1,32 @@
+
+
+Given /^jenkins on port "(.*?)" with jobs "(.*?)", "(.*?)" with statuses respectively "(.*?)", "(.*?)"$/ do |port, job1, job2, stat1, stat2|
+  mock_resp(port: port) do
+    get('/api/json') do
+      # TODO nicer jenkins response generation
+      { 'jobs' => [ { 'name' => job1, 'color' => status_to_color(stat1) },
+                    { 'name' => job2, 'color' => status_to_color(stat2) } ]
+      }.to_json
+    end
+  end
+
+end
+
+When /^I execute rjja with parameters "(.*?)"$/ do |params|
+  @resp = exec_cli params
+end
+
+Then /^it should print "(.*?)"$/ do |line1|
+  lines = line1.split /"\s*,\s*"/
+  #@resp.chomp.should == line1
+  @resp.split("\n").should =~ lines
+end
+
+Given /^the rjja binary$/ do
+  # TODO  File.exists
+end
+
+Then /^it should print the usage$/ do
+  pending # express the regexp above with the code you wish you had
+end
+

data/features/support/env.rb

@@ -0,0 +1,27 @@
+
+require 'mock_server_thin'
+
+RJJA_BIN='bin/rjja'
+
+def exec_cli(params)
+  cmd = "#{RJJA_BIN} #{params}"
+  puts cmd
+  ret = `#{cmd} 2>&1`
+  puts "RETURNED:\n---------\n#{ret}\n-----------"
+  ret
+end
+
+def status_to_color(s)
+  if s =~ /fail/
+    'red'
+  else s =~ /succ/
+    'blue'
+  end
+end
+
+def mock_resp( opts = {}, &block )
+  app = Class.new(Sinatra::Base)
+  app.class_eval &block
+  @server = MockServerThin.new(app,opts,&block).start
+end
+

data/jenkins-json-api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenkins-json-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jenkins-json-api"
+  gem.version       = Jenkins::Json::Api::VERSION
+  gem.authors       = ["Marton Suranyi"]
+  gem.email         = ["marton.suranyi@gmail.com"]
+  gem.description   = %q{Ruby wrapper for Jenkins JSON API}
+  gem.summary       = %q{Very experimental!}
+  gem.homepage      = "https://github.com/susu/jenkins-json-api"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/jenkins-json-api/version.rb

@@ -0,0 +1,7 @@
+module Jenkins
+  module Json
+    module Api
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/jenkins-json-api.rb

@@ -0,0 +1,71 @@
+
+require 'json'
+require 'open-uri'
+
+class Jenkins
+
+  class Job
+    SUCCESS = 'blue'
+    FAILED = 'red'
+
+    def initialize(json)
+      @name = json['name']
+      @url  = json['url']
+      @color = json['color']
+    end
+
+    def success?
+      return true if color == SUCCESS
+      return false if color == FAILED
+      raise "Inconsistent class state! color: #{color}"
+    end
+
+    def build
+      open url+'build'
+    end
+
+    def build_async
+      Process.waitpid @job if @job
+      @job = fork do
+        build
+      end
+    end
+
+    def to_s
+      "\n  #{super.to_s}\n    name: #{name}\n    url: #{url}\n    success: #{success?}\n"
+    end
+
+    def ==(r)
+      r.name == name and
+      r.url  == url  and
+      r.success? == success?
+    end
+
+    attr_reader :name, :url, :color
+  end
+
+  def initialize(host)
+    @host = host
+  end
+
+  def get_all_jobs
+    get_json['jobs'].map { |job| Job.new(job) }
+  end
+
+  def build_all
+    get_all_jobs.each do |job|
+      job.build
+    end
+  end
+
+
+  attr_reader :host
+  private
+    def get_json(med = nil)
+      JSON.parse(open( api_url(med) ).read)
+    end
+    def api_url(med)
+      "http://#{host}/api/json"
+    end
+end
+

data/spec/jenkins_spec.rb

@@ -0,0 +1,42 @@
+
+require 'spec_helper'
+
+require_relative '../lib/jenkins-json-api'
+
+describe Jenkins do
+  subject { Jenkins.new testhost }
+  let(:testhost) { 'myjenkinshost.com' }
+
+  its(:host) { should == testhost }
+
+  let(:job1_hash) { { 'name'  => 'gerrit_master',
+                      'url'   => "http://#{testhost}/job/gerrit_master/",
+                      'color' => 'blue' } }
+  let(:job2_hash) { { 'name'  => 'anotherjob',
+                      'url'   => "http://#{testhost}/job/anotherjob/",
+                      'color' => 'red' } }
+
+  let(:json_hash) { { 'jobs' => [ job1_hash, job2_hash ] } }
+
+  let(:jobs) { [ Jenkins::Job.new(job1_hash), Jenkins::Job.new(job2_hash) ] }
+
+  context "get_all_jobs success" do
+    before(:each) { JSON.should_receive(:parse).and_return( json_hash ) }
+    before(:each) { subject.stub_chain(:open,:read) }
+
+    its(:get_all_jobs) { should have(2).items }
+
+    its(:get_all_jobs) do
+      should =~ jobs
+    end
+  end
+
+  context "build_all" do
+    it "should send build URL for all jobs" do
+      jobs.each { |job| job.should_receive :build }
+      subject.should_receive( :get_all_jobs ).and_return jobs
+      subject.build_all
+    end
+  end
+end
+

data/spec/job_spec.rb

@@ -0,0 +1,24 @@
+
+require 'spec_helper'
+
+require_relative '../lib/jenkins-json-api'
+
+describe Jenkins::Job do
+  let(:job1_hash) { { 'name'  => 'gerrit_master',
+                      'url'   => "http://testhost/job/gerrit_master/",
+                      'color' => 'blue' } }
+
+  subject { Jenkins::Job.new(job1_hash) }
+  its(:name) { should == 'gerrit_master' }
+  its(:url)  { should == job1_hash['url'] }
+  its(:success?) { should == true }
+
+  context "build a job" do
+
+    it "should send url request to build to job" do
+      subject.should_receive(:open).once.with "#{job1_hash['url']}build"
+
+      subject.build
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+
+module JenkinsTestDataGenerator
+  def self.root()
+    { jobs: [ {name:'proj1'},
+              {name:'2ndjob'} ] }.to_json
+  end
+
+  def self.real_root()
+    open('spec/root.json').read
+  end
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jenkins-json-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marton Suranyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies: []
+description: Ruby wrapper for Jenkins JSON API
+email:
+- marton.suranyi@gmail.com
+executables:
+- rjja
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rjja
+- examples/all_job_runner.rb
+- features/error_handling.feature
+- features/print_jobs.feature
+- features/step_definitions.rb
+- features/support/env.rb
+- jenkins-json-api.gemspec
+- lib/jenkins-json-api.rb
+- lib/jenkins-json-api/version.rb
+- spec/jenkins_spec.rb
+- spec/job_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/susu/jenkins-json-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Very experimental!
+test_files:
+- features/error_handling.feature
+- features/print_jobs.feature
+- features/step_definitions.rb
+- features/support/env.rb
+- spec/jenkins_spec.rb
+- spec/job_spec.rb
+- spec/spec_helper.rb