foreman_reserve 0.1.8.2 → 0.1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76737d364a3fa9631d477672be79683f16103685
-  data.tar.gz: f3d9999a2f153c06cca10e1c26062a773f1830f2
+  metadata.gz: 9950443650dc6c90eb1f50231b1682743479c137
+  data.tar.gz: 2c86d8839a22a4b3f7044472ad145af0f4f922b1
 SHA512:
-  metadata.gz: bca9b3eae19e1f978806c2319caf8cb2e39bdd75d45fb9e5c185fbe43dea64c46eb487810fb83f1197bc4f294dd44a9696cb57f7c86fd2b75dbfad1ae4996007
-  data.tar.gz: 28793a8f0bb363813e53062c2d2a1d8622fb677844aa1fe2cc61406bb576332020d529101b07d9443bb858c752c897ccc1bcc81314e5710c11817c51ffaf9f37
+  metadata.gz: 36e1b1b07b6849e5dc4f6c60dcff26640c8e2c3ebe9b4c38b05902c56df47c76a97269d23db5cb4ec47a7fad5b01391e402bc76a5c7152c3cd71bdd2d87005d7
+  data.tar.gz: d567d2c8df0418bec61a318bda98c7d79d353a01eda0b9c20d91285d2792b33b300b7193da8173aba78135e836d5b559800150f654bfe9162385bf2130ad9f22

data/Rakefile

@@ -21,7 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Plugin engine for Foreman to reserve a host}
   gem.email = "dcaroest@redhat.com"
   gem.authors = ["David Caro", "Joseph Mitchell Magen"]
-  gem.version = '0.1.8.2'
+  gem.version = '0.1.8.3'
 end
 #Jeweler::RubygemsDotOrgTasks.new
 

data/app/controllers/{foreman_reserve/api/hosts_controller.rb → api/v2/reserves_controller.rb}

@@ -1,45 +1,8 @@
 module Api
-  module V1
-    class ForemanReserveController < Api::V1::BaseController
+  module V2
+    class ReservesController < V2::BaseController
       unloadable
 
-      # Get the list of reserved hosts
-      # @param query [String] Query to filter the hosts with
-      def get_reserved(query='')
-        hosts = User.current.admin? ? Host::Managed : Host::Managed.my_hosts
-        hosts = hosts.search_for(query)
-        hosts.find_all do |host|
-          params = host.info()['parameters']
-          params and
-              params.key?('RESERVED') and
-              params['RESERVED'] != 'false'
-        end
-      end
-
-      # Get the list of available hosts
-      # @param query [String] Query to filter the hosts with
-      def get_free(query='')
-        hosts = User.current.admin? ? Host::Managed : Host::Managed.my_hosts
-        hosts = hosts.search_for(query)
-        hosts.find_all do |host|
-          params = host.info()['parameters']
-          params and
-              params.key?('RESERVED') and
-              params['RESERVED'] == 'false'
-        end
-      end
-
-      # Return not found
-      # @param exception [String] Message to show
-      def not_found(exception = nil)
-          logger.debug "not found: #{exception}" if exception
-          respond_to do |format|
-              format.html { render "common/404", :status => 404 }
-              format.json { head :status => 404}
-              format.yaml { head :status => 404}
-          end
-          true
-      end
 
       # <b>API METHOD</b>: Reserve one or more hosts, will return 404 if the
       # given query gives no results and 406 (Not acceptable) if not enough free
@@ -74,9 +37,9 @@ module Api
           lock.flock(File::LOCK_UN)
         end
         respond_to do |format|
-          format.json {render :json => @hosts }
-          format.yaml {render :text => @hosts.to_yaml}
-          format.html {not_found }
+          format.json { render :json => @hosts }
+          format.yaml { render :text => @hosts.to_yaml }
+          format.html { not_found }
         end
       end
 
@@ -87,7 +50,7 @@ module Api
       #
       # * <tt><b>amount</b> (Int)</tt> <i>(defaults to: <tt>1</tt>)</i> ---
       #   Amount of hosts to release
-      # * <tt><b>host_name</b> (String)</tt> 
+      # * <tt><b>host_name</b> (String)</tt>
       #   <i>(defaults to: <tt>''</tt>)</i> ---
       #   If given, will also filter by that host name
       # * <tt><b>query</b> (String)</tt> <i>(defaults to: <tt>''</tt>)</i> ---
@@ -108,9 +71,9 @@ module Api
           @hosts = reserved_hosts.each { |host| host.release! }
         end
         respond_to do |format|
-          format.json {render :json => @hosts.map(&:name) }
-          format.yaml {render :text => @hosts.to_yaml}
-          format.html {not_found }
+          format.json { render :json => @hosts.map(&:name) }
+          format.yaml { render :text => @hosts.to_yaml }
+          format.html { render :json => hosts }
         end
       end
 
@@ -124,9 +87,9 @@ module Api
         hosts = get_reserved(params[:query])
         return not_found if hosts.empty?
         respond_to do |format|
-          format.json {render :json => hosts }
-          format.yaml {render :text => hosts.to_yaml}
-          format.html {not_found }
+          format.json { render :json => hosts }
+          format.yaml { render :text => hosts.to_yaml }
+          format.html { render :json => hosts }
         end
       end
 
@@ -148,9 +111,9 @@ module Api
           hosts = hosts[0..(amount-1)]
         end
         respond_to do |format|
-          format.json {render :json => hosts }
-          format.yaml {render :text => hosts.to_yaml}
-          format.html {not_found }
+          format.json { render :json => hosts }
+          format.yaml { render :text => hosts.to_yaml }
+          format.html { render :json => hosts }
         end
       end
 
@@ -179,10 +142,60 @@ module Api
         end
         @hosts = get_reserved(params[:query])
         respond_to do |format|
-          format.json {render :json => @hosts }
-          format.yaml {render :text => @hosts.to_yaml}
-          format.html {not_found }
+          format.json { render :json => @hosts }
+          format.yaml { render :text => @hosts.to_yaml }
+          format.html { render :json => hosts }
+        end
+      end
+
+      private
+
+      # Get the list of reserved hosts
+      # @param query [String] Query to filter the hosts with
+      def get_reserved(query='')
+        hosts = User.current.admin? ? Host : my_hosts
+        hosts = hosts.search_for(query)
+        hosts.find_all do |host|
+          params = host.info()['parameters']
+          params and
+            params.key?('RESERVED') and
+            params['RESERVED'] != 'false'
+        end
+      end
+
+      # Get the list of available hosts
+      # @param query [String] Query to filter the hosts with
+      def get_free(query='')
+        hosts = User.current.admin? ? Host : my_hosts
+        hosts = hosts.search_for(query)
+        hosts.find_all do |host|
+          params = host.info()['parameters']
+          params and
+            params.key?('RESERVED') and
+            params['RESERVED'] == 'false'
+        end
+      end
+
+      def my_hosts
+        if SETTINGS[:version].to_s.to_f >= 1.5
+          # Foreman 1.5+
+          Host.authorized(:view_hosts, Host)
+        else
+          # Foreman < 1.5
+          Host.my_hosts
+        end
+      end
+
+      # Return not found
+      # @param exception [String] Message to show
+      def not_found(exception = nil)
+        logger.debug "not found: #{exception}" if exception
+        respond_to do |format|
+          format.html { render "common/404", :status => 404 }
+          format.json { head :status => 404}
+          format.yaml { head :status => 404}
         end
+        true
       end
 
       # Return HTTP 406 (Not acceptable)

data/app/models/host/host_extensions.rb

@@ -0,0 +1,31 @@
+module Host::HostExtensions
+  extend ActiveSupport::Concern
+  module InstanceMethods
+
+    # Reserve the host
+    #
+    # @param reason [String] Reason to reserve the host under
+    def reserve!(reason = 'true')
+      param = "RESERVED"
+      if p=host_parameters.find_by_name(param)
+        p.update_attribute(:value, reason)
+      else
+        host_parameters.create!(:name => param, :value => reason)
+      end
+    end
+
+    # Release the host
+    def release!
+      param = "RESERVED"
+      if p=host_parameters.find_by_name(param)
+        p.update_attribute(:value, "false")
+      end
+    end
+
+    # Return a json represenatation of the host
+    def as_json(options={})
+      super(:methods => [:host_parameters])
+    end
+
+  end
+end

data/config/routes.rb

@@ -1,9 +1,27 @@
 Rails.application.routes.draw do
 
-  get "api/hosts_reserve"          => "api/v1/foreman_reserve#reserve"
-  get "api/hosts_release"          => "api/v1/foreman_reserve#release"
-  get "api/show_available"         => "api/v1/foreman_reserve#show_available"
-  get "api/show_reserved"          => "api/v1/foreman_reserve#show_reserved"
-  get "api/update_reserved_reason" => "api/v1/foreman_reserve#update_reason"
+  namespace :api, :defaults => {:format => 'json'} do
+    get 'hosts_reserve'          => 'v2/reserves#reserve'
+    get 'hosts_release'          => 'v2/reserves#release'
+    get 'show_available'         => 'v2/reserves#show_available'
+    get 'show_reserved'          => 'v2/reserves#show_reserved'
+    get 'update_reserved_reason' => 'v2/reserves#update_reason'
+
+    scope "(:apiv)", :module => :v2,
+                     :defaults => {:apiv => 'v2'},
+                     :apiv => /v1|v2/,
+                     :constraints => ApiConstraints.new(:version => 2) do
+
+      resources :reserves, :only => [] do
+        collection do
+          get 'reserve'
+          get 'release'
+          get 'show_available'
+          get 'show_reserved'
+          get 'update_reserved_reason' => 'reserves#update_reason'
+        end
+      end
+    end
+  end
 
 end

data/foreman_reserve.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foreman_reserve"
-  s.version = "0.1.8.2"
+  s.version = "0.1.8.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Caro", "Joseph Mitchell Magen"]
-  s.date = "2014-01-30"
+  s.date = "2014-03-07"
   s.description = "Plugin engine for Foreman to reserve a host"
   s.email = "dcaroest@redhat.com"
   s.extra_rdoc_files = [
@@ -18,14 +18,12 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
-    "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "app/controllers/foreman_reserve/api/hosts_controller.rb",
-    "app/models/foreman_reserve/host_extensions.rb",
+    "app/controllers/api/v2/reserves_controller.rb",
+    "app/models/host/host_extensions.rb",
     "config/routes.rb",
     "foreman_reserve.gemspec",
     "lib/foreman_reserve.rb",
@@ -37,26 +35,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = "2.0.14"
   s.summary = "Plugin engine for Foreman to reserve a host"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2.2"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.2.2"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.2.2"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-  end
 end
 

data/lib/foreman_reserve.rb

@@ -1,3 +1,4 @@
+require "foreman_reserve/engine"
+
 module ForemanReserve
-    require "foreman_reserve/engine"
 end

data/lib/foreman_reserve/engine.rb

@@ -1,13 +1,27 @@
-require 'foreman_reserve'
-require 'rails'
-require 'action_controller'
-
 module ForemanReserve
   class Engine < ::Rails::Engine
 
     config.to_prepare do
-        Host::Managed.send :include, ForemanReserve::HostExtensions
-        Host.send :include, ForemanReserve::HostExtensions
+      if SETTINGS[:version].to_s.to_f >= 1.2
+        # Foreman 1.2
+        Host::Managed.send :include, Host::HostExtensions
+      else
+        # Foreman < 1.2
+        Host.send :include, Host::HostExtensions
+      end
+    end
+
+    initializer 'foreman_reserve.register_plugin', :after=> :finisher_hook do |app|
+      Foreman::Plugin.register :foreman_reserve do
+        requires_foreman '>= 1.4'
+
+        security_block :foreman_reserve do
+          permission :view_reserved_hosts,    { 'api/v2/reserves' => [:show_available, :show_reserved] }
+          permission :reserve_and_free_hosts, { 'api/v2/reserves' => [:reserve, :release, :update_reason] }
+        end
+
+        role "Reserve Hosts", [:view_reserved_hosts, :reserve_and_free_hosts]
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_reserve
 version: !ruby/object:Gem::Version
-  version: 0.1.8.2
+  version: 0.1.8.3
 platform: ruby
 authors:
 - David Caro
@@ -9,64 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  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: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies: []
 description: Plugin engine for Foreman to reserve a host
 email: dcaroest@redhat.com
 executables: []
@@ -76,14 +20,12 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
-- app/controllers/foreman_reserve/api/hosts_controller.rb
-- app/models/foreman_reserve/host_extensions.rb
+- app/controllers/api/v2/reserves_controller.rb
+- app/models/host/host_extensions.rb
 - config/routes.rb
 - foreman_reserve.gemspec
 - lib/foreman_reserve.rb

data/Gemfile

@@ -1,14 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.2.2"
-  gem "jeweler", "~> 1.8.4"
-#  gem "rcov", ">= 0"
-end

data/Gemfile.lock

@@ -1,33 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.2.9)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    git (1.2.5)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    multi_json (1.3.7)
-    rake (10.0.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.1)
-    shoulda-matchers (1.4.1)
-      activesupport (>= 3.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.2.2)
-  jeweler (~> 1.8.4)
-  rdoc (~> 3.12)
-  shoulda

data/app/models/foreman_reserve/host_extensions.rb

@@ -1,33 +0,0 @@
-module ForemanReserve
-  module HostExtensions
-    extend ActiveSupport::Concern
-    module InstanceMethods
-
-      # Reserve the host
-      #
-      # @param reason [String] Reason to reserve the host under
-      def reserve!(reason = 'true')
-        param = "RESERVED"
-        if p=host_parameters.find_by_name(param)
-          p.update_attribute(:value, reason)
-        else
-          host_parameters.create!(:name => param, :value => reason)
-        end
-      end
-
-      # Release the host
-      def release!
-        param = "RESERVED"
-        if p=host_parameters.find_by_name(param)
-          p.update_attribute(:value, "false")
-        end
-      end
-
-      # Return a json represenatation of the host
-      def as_json(options={})
-        super(:methods => [:host_parameters])
-      end
-
-    end
-  end
-end