jenkins_api_client 0.14.1 → 1.0.0

data/spec/unit_tests/plugin_spec.rb

@@ -0,0 +1,165 @@
+require File.expand_path('../spec_helper', __FILE__)
+require "json"
+
+describe JenkinsApi::Client::PluginManager do
+  context "With properly initialized Client" do
+    before do
+      mock_logger = Logger.new "/dev/null"
+      @client = double
+      @client.should_receive(:logger).and_return(mock_logger)
+      @plugin = JenkinsApi::Client::PluginManager.new(@client)
+      @installed_plugins = load_json_from_fixture("installed_plugins.json")
+      @available_plugins = load_json_from_fixture("available_plugins.json")
+      @updatable_plugins = load_json_from_fixture("updatable_plugins.json")
+    end
+
+    describe "InstanceMethods" do
+      describe "#initialize" do
+        it "initializes by receiving an instane of client object" do
+          mock_logger = Logger.new "/dev/null"
+          @client.should_receive(:logger).and_return(mock_logger)
+          expect(
+            lambda { JenkinsApi::Client::PluginManager.new(@client) }
+          ).not_to raise_error
+        end
+      end
+
+      describe "#list_installed" do
+        it "lists all installed plugins in jenkins" do
+          @client.should_receive(:api_get_request).
+            with("/pluginManager", "tree=plugins[shortName,version]").
+            and_return(@installed_plugins)
+          plugins = @plugin.list_installed
+          plugins.class.should == Hash
+          plugins.size.should == @installed_plugins["plugins"].size
+        end
+        supported_filters = [
+          :active, :bundled, :deleted, :downgradable, :enabled,
+          :hasUpdate, :pinned
+        ]
+        supported_filters.each do |filter|
+          it "lists all installed plugins matching filter '#{filter}'" do
+            @client.should_receive(:api_get_request).
+              with("/pluginManager",
+                "tree=plugins[shortName,version,#{filter}]"
+              ).and_return(@installed_plugins)
+            @plugin.list_installed(filter => true).class.should == Hash
+          end
+        end
+        it "lists all installed plugins matching multiple filters" do
+          @client.should_receive(:api_get_request).
+            with("/pluginManager",
+                 "tree=plugins[shortName,version,bundled,deleted]").
+            and_return(@installed_plugins)
+          @plugin.list_installed(:bundled => true, :deleted => true).class.
+            should == Hash
+        end
+        it "raises an error if unsupported filter is specified" do
+          expect(
+            lambda { @plugin.list_installed(:unsupported => true) }
+          ).to raise_error(ArgumentError)
+        end
+      end
+
+      describe "#list_available" do
+        it "lists all available plugins in jenkins update center" do
+          @client.should_receive(:api_get_request).
+            with("/updateCenter/coreSource", "tree=availables[name,version]").
+            and_return(@available_plugins)
+          @plugin.list_available.class.should == Hash
+        end
+      end
+
+      describe "#list_updates" do
+        it "lists all available plugin updates in jenkins update center" do
+          @client.should_receive(:api_get_request).
+            with("/updateCenter/coreSource", "tree=updates[name,version]").
+            and_return(@updatable_plugins)
+          @plugin.list_updates.class.should == Hash
+        end
+      end
+
+      describe "#install" do
+        it "installs a single plugin given as a string" do
+          @client.should_receive(:api_post_request).
+            with("/pluginManager/install",
+              {"plugin.awesome-plugin.default" => "on"}
+            )
+          @plugin.install("awesome-plugin")
+        end
+        it "installs multiple plugins given as an array" do
+          @client.should_receive(:api_post_request).
+            with("/pluginManager/install",
+              {
+                "plugin.awesome-plugin-1.default" => "on",
+                "plugin.awesome-plugin-2.default" => "on",
+                "plugin.awesome-plugin-3.default" => "on"
+              }
+            )
+          @plugin.install([
+            "awesome-plugin-1",
+            "awesome-plugin-2",
+            "awesome-plugin-3"
+          ])
+        end
+      end
+
+      describe "#uninstall" do
+        it "uninstalls a single plugin given as a string" do
+          @client.should_receive(:api_post_request).
+            with("/pluginManager/plugin/awesome-plugin/doUninstall")
+          @plugin.uninstall("awesome-plugin")
+        end
+        it "uninstalls multiple plugins given as array" do
+          plugins = ["awesome-plugin-1", "awesome-plugin-2", "awesome-plugin-3"]
+          plugins.each do |plugin|
+            @client.should_receive(:api_post_request).
+              with("/pluginManager/plugin/#{plugin}/doUninstall")
+          end
+          @plugin.uninstall(plugins)
+        end
+      end
+
+      describe "#enable" do
+        it "enables a single plugin given as a string" do
+          @client.should_receive(:api_post_request).
+            with("/pluginManager/plugin/awesome-plugin/makeEnabled")
+          @plugin.enable("awesome-plugin")
+        end
+        it "enables multiple plugins given as array" do
+          plugins = ["awesome-plugin-1", "awesome-plugin-2", "awesome-plugin-3"]
+          plugins.each do |plugin|
+            @client.should_receive(:api_post_request).
+              with("/pluginManager/plugin/#{plugin}/makeEnabled")
+          end
+          @plugin.enable(plugins)
+        end
+      end
+
+      describe "#disable" do
+        it "disables a single plugin given as a string" do
+          @client.should_receive(:api_post_request).
+            with("/pluginManager/plugin/awesome-plugin/makeDisabled")
+          @plugin.disable("awesome-plugin")
+        end
+        it "disabless multiple plugins given as array" do
+          plugins = ["awesome-plugin-1", "awesome-plugin-2", "awesome-plugin-3"]
+          plugins.each do |plugin|
+            @client.should_receive(:api_post_request).
+              with("/pluginManager/plugin/#{plugin}/makeDisabled")
+          end
+          @plugin.disable(plugins)
+        end
+      end
+
+      describe "#restart_required?" do
+        it "checks if restart is required after plugin install/uninstall" do
+          @client.should_receive(:api_get_request).
+            with("/updateCenter", "tree=restartRequiredForCompletion").
+            and_return({"restartRequiredForCompletion" => true})
+          @plugin.restart_required?.should == true
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests/spec_helper.rb

@@ -1,9 +1,19 @@
 require File.expand_path('../../../lib/jenkins_api_client', __FILE__)
 require 'logger'
+require 'json'
 
 RSpec.configure do |config|
   config.before(:each) do
   end
-
 end
 
+def load_json_from_fixture(file_name)
+  JSON.load(
+    File.read(
+      File.expand_path(
+        "../fixtures/files/#{file_name}",
+        __FILE__
+      )
+    )
+  )
+end

data/spec/unit_tests/system_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('../fake_http_response', __FILE__)
 
 describe JenkinsApi::Client::System do
   context "With properly initialized Client" do
@@ -65,7 +66,7 @@ describe JenkinsApi::Client::System do
 
       describe "#wait_for_ready" do
         it "exits if the response body doesn't have the wait message" do
-          @client.should_receive(:get_root).and_return(Net::HTTP.get_response(URI('http://example.com/index.html')))
+          @client.should_receive(:get_root).and_return(FakeResponse.new)
           @system.wait_for_ready
         end
       end

data/spec/unit_tests/user_spec.rb

@@ -85,7 +85,7 @@ __USERLIST
       @client.should_receive(:logger).and_return(mock_logger)
       @client.should_receive(:timeout).and_return(mock_timeout)
       @client.stub(:api_get_request).with('/asynchPeople').and_return(PEOPLE_JSON)
-      @client.stub(:api_get_request).with('/user/Fred Flintstone').and_return(FRED_JSON)
+      @client.stub(:api_get_request).with('/user/Fred%20Flintstone').and_return(FRED_JSON)
       @client.stub(:api_get_request).with('/user/fred').and_return(FRED_JSON)
       @client.stub(:api_get_request).with('/user/wilma').and_return(WILMA_JSON)
       @user = JenkinsApi::Client::User.new(@client)

data/travis/hudson.model.UpdateCenter.xml

@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<sites>
+  <site>
+    <id>default</id>
+    <url>http://updates.jenkins-ci.org/update-center.json</url>
+  </site>
+</sites>

data/travis/setup.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/bash -x
 
 # Install Jenkins
 wget -q -O - http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key | sudo apt-key add -
@@ -9,6 +9,7 @@ sudo apt-get install -qq jenkins
 # Configure Jenkins
 sudo service jenkins stop
 sudo cp -f travis/jenkins_config.xml /var/lib/jenkins/config.xml
+sudo cp -f travis/hudson.model.UpdateCenter.xml /var/lib/jenkins/hudson.model.UpdateCenter.xml
 sudo mkdir -p /var/lib/jenkins/users/testuser
 sudo cp -f travis/user_config.xml /var/lib/jenkins/users/testuser/config.xml
 sudo service jenkins start

metadata

@@ -1,181 +1,187 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 0.14.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Kannan Manickam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
   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
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :runtime
   prerelease: false
   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
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 - !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: yard-thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    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: ! '
+description: |2-
 
   This is a simple and easy-to-use Jenkins Api client with features focused on
-
-  automating Job configuration programaticaly and so forth'
+  automating Job configuration programaticaly and so forth
 email:
 - arangamani.kannan@gmail.com
 executables:
@@ -183,9 +189,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .jenkins.yml
-- .travis.yml
+- ".gitignore"
+- ".jenkins.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -209,28 +215,38 @@ files:
 - lib/jenkins_api_client/exceptions.rb
 - lib/jenkins_api_client/job.rb
 - lib/jenkins_api_client/node.rb
+- lib/jenkins_api_client/plugin_manager.rb
 - lib/jenkins_api_client/system.rb
+- lib/jenkins_api_client/urihelper.rb
 - lib/jenkins_api_client/user.rb
 - 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
+- spec/func_tests/node_spec.rb.pending
+- spec/func_tests/plugin_spec.rb
 - spec/func_tests/spec_helper.rb
 - spec/func_tests/system_spec.rb
 - spec/func_tests/user_spec.rb
 - spec/func_tests/view_spec.rb
 - spec/unit_tests/build_queue_spec.rb
 - spec/unit_tests/client_spec.rb
+- spec/unit_tests/fake_http_response.rb
+- spec/unit_tests/fixtures/files/available_plugins.json
 - spec/unit_tests/fixtures/files/computer_sample.xml
+- spec/unit_tests/fixtures/files/installed_plugins.json
 - spec/unit_tests/fixtures/files/job_sample.xml
+- spec/unit_tests/fixtures/files/updatable_plugins.json
 - spec/unit_tests/job_spec.rb
 - spec/unit_tests/node_spec.rb
+- spec/unit_tests/plugin_spec.rb
 - spec/unit_tests/spec_helper.rb
 - spec/unit_tests/system_spec.rb
 - spec/unit_tests/user_spec.rb
 - spec/unit_tests/view_spec.rb
+- travis/hudson.model.UpdateCenter.xml
 - travis/jenkins_config.xml
 - travis/jenkins_config_with_crumb.xml
 - travis/setup.sh
@@ -239,29 +255,25 @@ files:
 - travis/user_config.xml
 homepage: https://github.com/arangamani/jenkins_api_client
 licenses: []
+metadata: {}
 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: 2979339971375720651
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Jenkins JSON API Client
 test_files: []