foreman_reserve 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b47f26dc034d5b901b2661b71bb038d7555b864f
+  data.tar.gz: 312437ec807d584309fb1cc3eef4e050a7eacc20
+SHA512:
+  metadata.gz: 967b9021d5c71dabd6eddf4c8c7ec0d213ee356b63fab9aaadb2d0836a533b19c982babcef6bc45e37359b7603f7a4975c32af3c2c42543ab3cf22584bf796ce
+  data.tar.gz: 84457171d2912961de32a5b7802643d7297a29ed84ad35735f115d8c906da740cccba40fba6bf9d65ace5e3f891f1ac91f2b34fe2533206eb1edabdefa19205d

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,33 @@
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joseph Mitchell Magen
+
+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.rdoc

@@ -0,0 +1,52 @@
+= foreman_reserve
+
+This gem will added a route to the API to return the name of available host(s)
+
+= Installation:
+
+gem 'foreman_reserve', :git => "https://github.com/isratrade/foreman_reserve.git"
+
+In order to work, the foreman application must be the following two lines commented out.
+
+config/routes.rb 
+	# match '*a', :to => 'errors#routing'
+
+config/routes/v1.rb
+	# match '*other', :to => 'home#route_error'
+
+= Usage
+
+To return 1 host:
+curl -u admin:secret -H 'accept:application/json' http://0.0.0.0:3000/api/hosts_reserve
+
+To return multiple hosts, pass a parameter called 'amount'
+
+curl -u admin:secret -H 'accept:application/json' http://0.0.0.0:3000/api/hosts_reserve?amount=3
+
+Filter using a specific query: (name ~ virt%)
+
+curl -u admin:secret -H 'accept:application/json' 'http://0.0.0.0:3000/api/hosts_reserve?query=name%20~%20virt%25'
+
+Release a specific host:
+
+curl -u admin:secret -H 'accept:application/json' 'http://0.0.0.0:3000/api/hosts_release?host_name=myreservedhost'
+
+Release a group of hosts using a query: (name ~ virt%)
+
+curl -u admin:secret -H 'accept:application/json' 'http://0.0.0.0:3000/api/hosts_reserve?query=name%20~%20virt%25'
+
+== Contributing to foreman_reserve
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Joseph Mitchell Magen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "foreman_reserve"
+  gem.homepage = "http://github.com/isratrade/foreman_reserve"
+  gem.license = "MIT"
+  gem.summary = %Q{Plugin engine for Foreman to reserve a host}
+  gem.description = %Q{Plugin engine for Foreman to reserve a host}
+  gem.email = "jmagen@redhat.com"
+  gem.authors = ["Joseph Mitchell Magen"]
+  gem.version = '0.1.4'
+end
+#Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "foreman_reserve #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/app/controllers/foreman_reserve/api/hosts_controller.rb

@@ -0,0 +1,143 @@
+module Api
+  module V1
+    class ForemanReserveController < Api::V1::BaseController
+      unloadable
+
+    def get_reserved(query='')
+      hosts = User.current.admin? ? Host::Managed : Host::Managed.my_hosts
+      hosts.search_for(query)
+      hosts.each do |host|
+        params = host.info()['parameters']
+        if params and
+            params.key?('RESERVED') and 
+            params['RESERVED'] != 'false'
+          host
+        end
+      end
+    end
+
+    def get_free(query='')
+      hosts = User.current.admin? ? Host::Managed : Host::Managed.my_hosts
+      hosts.search_for(query)
+      hosts.each do |host|
+        params = host.info()['parameters']
+        if params
+            and params.has_key('RESERVED')
+            and params['RESERVED'] == 'false'
+          host
+        end
+      end
+    end
+
+    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 
+
+    def reserve
+      amount          = (params[:amount] || 1).to_i
+      reason          = params[:reason] || 'true'
+      ## Lock to avoid reserving the same host twice
+      unless File.exists? "/tmp/foreman_reserve.lock"
+        File.open("/tmp/foreman_reserve.lock", 'w') {}
+      end 
+      lock = File.new("/tmp/foreman_reserve.lock")
+      begin
+        lock.flock(File::LOCK_EX)
+        potential_hosts = get_free(params[:query])
+        return not_found if potential_hosts.empty?
+        return not_acceptable if potential_hosts.count < amount
+        @hosts = potential_hosts[0..(amount-1)].each do |host|
+          logger.error host.class.name
+          logger.error host.class.instance_methods(false)
+          logger.error Host.class.instance_methods(false)
+          host.reserve!(reason)
+        end
+      ensure
+        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 }
+      end
+    end
+
+    def release
+      host_name     = (params[:host_name] || '')
+      query         = params[:query]
+      amount        = (params[:amount] || 0 ).to_i
+      if host_name != ''
+        query = "#{query} AND name = #{host_name}"
+      end
+      reserved_hosts = get_reserved(query)
+      return not_found if reserved_hosts.empty?
+      if amount != 0
+        return not_acceptable if reserved_hosts.count < amount
+        @hosts = reserved_hosts[0..(amount-1)].each { |host| host.release! }
+      else
+        @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 }
+      end
+    end
+
+    def show_reserved
+      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 }
+      end
+    end
+
+      def show_available
+        amount = (params[:amount] || 0).to_i
+        hosts  = get_free(params[:query])
+        return not_found if hosts.empty?
+        if amount != 0
+          return not_acceptable if hosts.count < amount
+          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 }
+        end
+      end
+
+      def update_reason
+        amount          = (params[:amount] || 0).to_i
+        reason          = params[:reason] || 'true'
+        potential_hosts = get_reserved(params[:query])
+        return not_found if potential_hosts.empty?
+        if amount != 0
+          return not_acceptable if potential_hosts.count < amount
+          potential_hosts[0..(amount-1)].each { |host| host.reserve!(reason) }
+        else
+          potential_hosts.each { |host| host.reserve!(reason) }
+        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 }
+        end
+      end
+
+      def not_acceptable
+        head :status => 406
+      end
+
+    end
+  end
+end

data/app/models/foreman_reserve/host_extensions.rb

@@ -0,0 +1,24 @@
+module ForemanReserve
+  module HostExtensions
+    extend ActiveSupport::Concern
+      module InstanceMethods
+        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
+        def release!
+          param = "RESERVED"
+          if p=host_parameters.find_by_name(param)
+            p.update_attribute(:value, "false")
+          end
+        end
+        def as_json(options={})
+          super(:methods => [:host_parameters])
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+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"
+
+end

data/foreman_reserve.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "foreman_reserve"
+  s.version = "0.1.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joseph Mitchell Magen", "David Caro"]
+  s.date = "2013-02-05"
+  s.description = "Plugin engine for Foreman to reserve a host"
+  s.email = "jmagen@redhat.com"
+  s.extra_rdoc_files = ["LICENSE.txt", "README.rdoc"]
+  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",
+             "config/routes.rb", "foreman_reserve.gemspec",
+             "lib/foreman_reserve/engine.rb", "lib/foreman_reserve.rb",
+             "lib/rails/railties/tasks.rake", "test/helper.rb",
+             "test/test_foreman_reserve.rb"]
+  s.homepage = "http://github.com/david-caro/foreman_reserve"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Plugin engine for Foreman to allocate hosts"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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/engine.rb

@@ -0,0 +1,14 @@
+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
+    end
+
+  end
+end

data/lib/foreman_reserve.rb

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

data/lib/rails/railties/tasks.rake

@@ -0,0 +1,8 @@
+namespace :foreman_reserve do
+  
+  desc "example gem rake task"
+  task :report => :environment do
+    puts "you just ran the example gem rake task"
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'foreman_reserve'
+
+class Test::Unit::TestCase
+end

data/test/test_foreman_reserve.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestForemanReserve < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: foreman_reserve
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Joseph Mitchell Magen
+- David Caro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 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
+description: Plugin engine for Foreman to reserve a host
+email: jmagen@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- 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
+- config/routes.rb
+- foreman_reserve.gemspec
+- lib/foreman_reserve/engine.rb
+- lib/foreman_reserve.rb
+- lib/rails/railties/tasks.rake
+- test/helper.rb
+- test/test_foreman_reserve.rb
+homepage: http://github.com/david-caro/foreman_reserve
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 3
+summary: Plugin engine for Foreman to allocate hosts
+test_files: []