jenkins-client 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jenkins-client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Griffin
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,73 @@
+# Jenkins::Client
+
+This is a small gem used for listing, finding and creating Jenkins jobs on a Jenkins CI server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jenkins-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenkins-client
+
+## Usage
+
+In rails add an initialiser like this
+
+``` ruby
+Jenkins::Client.configure do |c|
+  c.username = "user"
+  c.password = "pass"
+  c.url = "http://jenkinsurl.com"
+end
+```
+
+Then you can issue the following commands in your app.
+
+### All
+
+`Jenkins::Client::Job.all` pulls back a list of objects that represent all the Jenkins jobs on the server.
+
+### Find
+
+`Jenkins::Client::Job.find("job_name")` pulls back a single Jenkins job based on the job name.
+
+### Create
+
+`Jenkins::Client::Job.create("job_name", config).should be_true` will create a new Jenkins job on the server based on the config you pass in. Jenkins uses XML config files on the server and this is what you should send as the config. Example
+
+``` xml
+<?xml version='1.0' encoding='UTF-8'?>
+<project>
+  <actions/>
+  <description></description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders/>
+  <publishers/>
+  <buildWrappers/>
+</project>
+```
+
+To export an existing config simply look in the jobs path inside your Jenkins server and pull back a job's `config.xml` file.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/jenkins-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jenkins-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Griffin"]
+  gem.email         = ["johnog@gmail.com"]
+  gem.description   = "List, find and create Jenkins jobs on a Jenkins CI server"
+  gem.summary       = "List, find and create Jenkins jobs on a Jenkins CI server"
+  gem.homepage      = "https://github.com/john-griffin/jenkins-client"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "jenkins-client"
+  gem.require_paths = ["lib"]
+  gem.version       = Jenkins::Client::VERSION
+
+  gem.add_dependency "faraday", "~> 0.7.6"
+  gem.add_dependency "faraday_middleware", "~> 0.8.4"
+  gem.add_dependency 'rash', "~> 0.3.2"
+
+  gem.add_development_dependency "rspec", "~> 2.8.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock", "~> 1.7.10"
+  gem.add_development_dependency "guard-rspec", "~> 0.6.0"
+end

data/lib/jenkins-client.rb

@@ -0,0 +1,2 @@
+require "jenkins-client/version"
+require "jenkins-client/job"

data/lib/jenkins-client/client.rb

@@ -0,0 +1,38 @@
+require "faraday"
+require "faraday_middleware"
+require 'rash'
+
+module Jenkins
+  class Client
+    class << self
+      attr_accessor :username, :password, :url, :connection
+
+      def configure
+        yield self
+        setup_connection
+      end
+
+      def setup_connection
+        @connection = Faraday.new(:url => url) do |builder|
+          builder.use FaradayMiddleware::Rashify
+          builder.use FaradayMiddleware::ParseJson
+          builder.adapter  :net_http
+        end
+        @connection.basic_auth username, password
+      end
+
+      def get(path)
+        connection.get(path)
+      end
+
+      def post(path, body)
+        resp = @connection.post do |req|
+          req.headers['Content-Type'] = 'application/xml'
+          req.url path
+          req.body = body
+        end
+        resp.status == 200
+      end
+    end
+  end
+end

data/lib/jenkins-client/job.rb

@@ -0,0 +1,20 @@
+require "jenkins-client/client"
+
+module Jenkins
+  class Client
+    class Job
+      def self.all
+        resp = Jenkins::Client.get "/api/json"
+        resp.body.jobs
+      end
+
+      def self.find(name)
+        all.select{|j| j.name == name}.first
+      end
+
+      def self.create(name, config)
+        Jenkins::Client.post("/createItem/api/xml?name=#{CGI.escape(name)}", config)
+      end
+    end
+  end
+end

data/lib/jenkins-client/version.rb

@@ -0,0 +1,5 @@
+module Jenkins
+  class Client
+    VERSION = "0.0.1"
+  end
+end

data/spec/fixtures/jenkins_config.xml

@@ -0,0 +1,17 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project>
+  <actions/>
+  <description></description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders/>
+  <publishers/>
+  <buildWrappers/>
+</project>

data/spec/jenkins-client/job_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+require "jenkins-client"
+require "jenkins-client/job"
+
+describe Jenkins::Client::Job do
+  def jenkins_config(url)
+    Jenkins::Client.configure do |c|
+      c.username = "testuser"
+      c.password = "testpass"
+      c.url = url
+    end
+  end
+
+  def empty_jenkins_config
+    jenkins_config("https://emptyjenkinstest.com")
+  end
+
+  before(:each) do
+    jenkins_config("https://jenkinstest.com")
+  end
+
+  before(:each) do
+    body = '{"assignedLabels":[{}],"mode":"NORMAL","nodeDescription":"the master Jenkins node","nodeName":"","numExecutors":2,"description":null,"jobs":[
+    {"name":"foo-bar","url":"https://testjenkins.com/job/foo-bar/","color":"blue"},
+    {"name":"woohoo","url":"https://jenkinstest.com/job/woohoo/","color":"red"},
+    {"name":"wat","url":"https://jenkinstest.com/job/wat/","color":"red"},
+    {"name":"fudge","url":"https://jenkinstest.com/job/fudge/","color":"blue"},
+    {"name":"amaze","url":"https://jenkinstest.com/job/amaze/","color":"blue"}]}'
+    stub_request(:get, "https://testuser:testpass@jenkinstest.com/api/json").
+       with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+       to_return(:status => 200, :body => body, :headers => {})        
+  end
+
+  before(:each) do
+    body = '{"assignedLabels":[{}],"mode":"NORMAL","nodeDescription":"the master Jenkins node","nodeName":"","numExecutors":2,"description":null,"jobs":[]}'
+    stub_request(:get, "https://testuser:testpass@emptyjenkinstest.com/api/json").
+       with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+       to_return(:status => 200, :body => body, :headers => {})        
+  end
+
+  describe ".all" do
+    context "given some jobs are available" do
+      let(:jobs){Jenkins::Client::Job.all}
+
+      it "will return a list of jobs" do
+        jobs.should have(5).items
+      end
+
+      it "will contain an expected job" do
+        jobs.should include({
+          "name"=>"foo-bar", 
+          "url"=>"https://testjenkins.com/job/foo-bar/",
+          "color"=>"blue"
+        })
+      end
+    end
+
+    context "given no jobs" do
+      before(:each) do
+        empty_jenkins_config
+      end
+
+      it "will have no jobs" do
+        Jenkins::Client::Job.all.should be_empty
+      end
+    end
+  end
+
+  describe ".find" do
+    context "given some jobs are available" do
+      it "will find the specified job" do
+        job = Jenkins::Client::Job.find("woohoo")
+        job.url.should eq("https://jenkinstest.com/job/woohoo/")
+      end
+    end
+
+    context "given a match isn't found" do
+      it "will be nil" do
+        Jenkins::Client::Job.find("badname").should be_nil
+      end
+    end
+
+    context "given no jobs" do
+      before(:each) do
+        empty_jenkins_config
+      end
+    
+      it "will be nil" do
+        Jenkins::Client::Job.find("woohoo").should be_nil
+      end
+    end
+  end
+
+  describe ".create" do
+    before(:each) do
+      stub_request(:post, "https://testuser:testpass@jenkinstest.com/createItem/api/xml?name=excellent").
+         to_return(:status => 200, :body => "", :headers => {})
+    end
+
+    context "given an xml config file" do
+      it "will be able to create a new jenkins job" do
+        config = File.open("spec/fixtures/jenkins_config.xml").read
+        Jenkins::Client::Job.create("excellent", config).should be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: jenkins-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Griffin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70266235683860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266235683860
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70266235683100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266235683100
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: &70266235682080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266235682080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70266235681340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70266235681340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70266235680480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70266235680480
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70266235679620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.10
+  type: :development
+  prerelease: false
+  version_requirements: *70266235679620
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70266235672500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70266235672500
+description: List, find and create Jenkins jobs on a Jenkins CI server
+email:
+- johnog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- jenkins-client.gemspec
+- lib/jenkins-client.rb
+- lib/jenkins-client/client.rb
+- lib/jenkins-client/job.rb
+- lib/jenkins-client/version.rb
+- spec/fixtures/jenkins_config.xml
+- spec/jenkins-client/job_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/john-griffin/jenkins-client
+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'
+      segments:
+      - 0
+      hash: 2674017292482177410
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2674017292482177410
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: List, find and create Jenkins jobs on a Jenkins CI server
+test_files:
+- spec/fixtures/jenkins_config.xml
+- spec/jenkins-client/job_spec.rb
+- spec/spec_helper.rb