foreman_expire_hosts 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7e5fececc8a6357b994cfdf74ea38209c525017
-  data.tar.gz: aecb6afe763b2133c97d6857aebd17fb81cd6ef4
+  metadata.gz: e6fe2409547a823dfd323178e3d0919eac77bebc
+  data.tar.gz: 87226ce69f178e588ca451eef22a0d8982bc1f99
 SHA512:
-  metadata.gz: 44dadad8e98963b00b856b3e74fbe3cb14ba98c729fa54ad3007dd4c51fcdbcc5f63dfdb58b34693a43b613388d7e0396a7b1c2bce994a27e894bd4780d4b80c
-  data.tar.gz: e26f4b92ed9d29a45e72e6748b2141b82bb687482b15999474b95fbe1d9e244f74c6d6ba55b54c47751baf11b68bb0a52851a4b2928f290c7c4b5a1a8e471e89
+  metadata.gz: 815773fd3b98e15221daca80534cbf0ab0cc376ae4328409df26564a19bcfac2bea34d4aad22095e42439c7273726d909a005b8a6ae70ca7e4ede080e4436eea
+  data.tar.gz: e556d4c3b0ff806fd126551cc7af2d36af1bc033e0ed0946cc947f64c8470a87cd3ce60555fd5f14d792bd99139df3c416e44f980df37db1c74dc2d41d4787bf

data/README.md

@@ -2,11 +2,17 @@
 
 # Context
 
-Foreman makes host creation extremely simple for a sysadmin or a user.  However this simplicity lead to wasteful usage of compute resources. foreman_expiry plugin allows to specify an expiry date for the host. On this date the host will be deleted.
+Foreman makes host creation extremely simple for a sysadmin or a user.  However this simplicity leads to wasteful usage of compute resources. foreman_expiry plugin allows to specify an expiry date for the host. On this date the host will be deleted.
 
-This plugin add expired on(date) field to host form under Additional Information section. If we create any host with expiry date, then that host will be stopped on given date and then deleted. If host has null/blank for expired on field then that host will be live forever (until it deleted manually).
+This plugin add expired on(date) field to host form under Additional Information section. If we create any host with expiry date, then that host will be stopped on given date and then deleted. If a host has no expiration date set then that host will live forever (until it is deleted manually).
 
-This plugin will send two warning notification before host expiry (see settings.yaml). It also sends notifications when the host stopped on its expiry date and when host is deleted after few days (configured in settings).
+This plugin will send two warning notification before host expiry (see Settings). It also sends notifications when the host stopped on its expiry date and when host is deleted after few days (configured in settings).
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | -------------- |
+| >= 1.11         | ~> 2.0         |
 
 # Screenshots
 ![Expiry date field in host form](https://raw.githubusercontent.com/ingenico-group/screenshots/master/foreman_host_expiry/expiry-date-field-in-host-form.png)
@@ -21,42 +27,43 @@ Please see the Foreman manual for appropriate instructions:
 
 * [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.Plugins)
 
-Example installation from source.
-Require foreman_expire_hosts gem installation (edit `~foreman/bundler.d/Gemfile.local.rb`):
-
-```yaml
-gem 'foreman_expire_hosts', :git => "https://github.com/ingenico-group/foreman_expire_hosts.git"
-```
+The gem name is "foreman_expire_hosts".
 
-Update Foreman with the new gems:
+RPM users can install the "tfm-rubygem-foreman_expire_hosts" or
+"rubygem-foreman_expire_hosts" packages.
 
-    bundle update foreman_expire_hosts
+This plugin has not been packeged for Debian, yet.
 
-# Dependency
-
-This gem required uglifier, execjs and therubyracer gems to load assets. If you install this plugin through RPM package, please install ruby193-rubygem-uglifier, ruby193-rubygem-execjs and ruby193-rubygem-therubyracer rpm package before installing this plugin RPM package
 
 # Post installation
 
 This plugin needs additional column in hosts table. Please run migration with below command
 
 ```yaml
-VERSION=20150427101516 RAILS_ENV=production rake db:migrate:up
+VERSION=20150427101516 foreman-rake db:migrate:up
 ```
 
-Add below line to crontab under root user to take appropriate action on expiring/expired hosts and notify user about those hosts. This cronjob will run at 11:30 PM(Midnight)
+If you have not installed this plugin through os packages, add below line to crontab to take appropriate action on expiring/expired hosts and notify user about those hosts. This cronjob will run at 07:45 AM.
 
 
 ```
-30 23 * * *  /usr/sbin/foreman-rake expired_hosts:deliver_notifications >> /var/log/foreman/expired_hosts.log 2>&1
+# /etc/cron.d/foreman_expire_hosts
+SHELL=/bin/sh
+PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
+
+RAILS_ENV=production
+FOREMAN_HOME=/usr/share/foreman
+
+# Send out notifications about expired hosts
+45 7 * * *      foreman    /usr/sbin/foreman-rake expired_hosts:deliver_notifications >>/var/log/foreman/expired_hosts.log 2>&1
 ```
 
 # Pre remove
 
-If we want to remove this feature and remove expired_on column from hosts table, please run below rake task and remove this gem from the Gemfile
+If we want to remove this feature and remove the expired_on column from hosts table, please run below rake task and either remove this gem from the Gemfile or uninstall the os package.
 
 ```yaml
-VERSION=20150427101516 RAILS_ENV=production rake db:migrate:down
+VERSION=20150427101516 foreman-rake db:migrate:down
 ```
 
 # Configuration
@@ -65,7 +72,7 @@ This plugin will add configurations to settings table and are editable from sett
 
 ![Plugin Settings](https://raw.githubusercontent.com/ingenico-group/screenshots/master/foreman_host_expiry/settings.png)
 
-NOTE: After installing this plugin, please update administrator email in Foreman Web UI (More -> Settings -> General) with valid email. This can be used to send notification when plugin failed to deliver notifications to its owner.
+NOTE: After installing this plugin, please update administrator email in Foreman Web UI (More -> Settings -> General) with valid email. This can be used to send notifications when the plugin failed to deliver notifications to its owner.
 
 
 # Foreman API to add expiry date to host
@@ -74,8 +81,8 @@ Existing foreman host create/edit API can be used to add/update host's expiry da
 
 Create host with expiry date
 
-```yaml
-POST /api/hosts
+```ruby
+# POST /api/hosts
 {
   "host": {
     "name": "testhost11",
@@ -99,13 +106,15 @@ POST /api/hosts
 
 curl command example
 
-```yaml
+```sh
 curl -u admin:changeme 'https://your-foreman-url.com/api/hosts' -d 'host[name]=testhost11&host[expired_on]=30/12/2014&......' -X POST
+
 ```
+
 Update host expiry date
 
-```yaml
-POST /api/hosts/testhost11
+```ruby
+# POST /api/hosts/testhost11
 {
   "host": {
     "expired_on": "30/12/2014"  # dd/mm/yyyy format
@@ -115,10 +124,23 @@ POST /api/hosts/testhost11
 
 curl command example
 
-```yaml
+```sh
 curl -u admin:changeme 'https://your-foreman-url.com/api/hosts/testhost11' -d 'host[expired_on]=30/12/2014' -X PUT
 ```
 
-## License
+# Copyright
+
+Copyright (c) 2016 The Foreman developers
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-GPLv3
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb

@@ -4,8 +4,9 @@ module ForemanExpireHosts
 
     included do
       before_filter :validate_multiple_expiration, :only => :update_multiple_expiration
-      before_filter :find_multiple, :only => [:select_multiple_expiration, :update_multiple_expiration]
+      before_filter :find_multiple_with_expire_hosts, :only => [:select_multiple_expiration, :update_multiple_expiration]
       alias_method_chain :action_permission, :expire_hosts
+      alias_method :find_multiple_with_expire_hosts, :find_multiple
     end
 
     def select_multiple_expiration

data/app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb

@@ -0,0 +1,15 @@
+module ForemanExpireHosts
+  module AuditsHelperExtensions
+    extend ActiveSupport::Concern
+
+    def destroyed_expired_host_audit_comment_in_list(audit)
+      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && !audit.comment.blank?
+      "<div style='color: #737373;font-size: 14px'>Comment: #{audit.comment}</div>".html_safe
+    end
+
+    def destroyed_expired_host_audit_comment_in_show(audit)
+      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && !audit.comment.blank?
+      "<tr><td>Comment</td><td>#{audit.comment}</td></tr>".html_safe
+    end
+  end
+end

data/app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb

@@ -24,18 +24,23 @@ module ForemanExpireHosts
       message
     end
 
-    def destroyed_expired_host_audit_comment_in_list(audit)
-      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && !audit.comment.blank?
-      "<div style='color: #737373;font-size: 14px'>Comment: #{audit.comment}</div>".html_safe
+    def future_time_in_words(to_time, options = {})
+      distance_of_time_in_words(to_time, Time.current, options)
     end
 
-    def destroyed_expired_host_audit_comment_in_show(audit)
-      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && !audit.comment.blank?
-      "<tr><td>Comment</td><td>#{audit.comment}</td></tr>".html_safe
+    def input_group_addon(content, options = {})
+      content_tag :span, class: 'input-group-addon' do
+        content_tag :span, content, options
+      end
     end
 
-    def future_time_in_words(to_time, options = {})
-      distance_of_time_in_words(to_time, Time.current, options)
+    def datepicker_f(f, attr, options = {})
+      field(f, attr, options) do
+        addClass options, "form-control"
+        date = f.text_field attr, options
+        addon = input_group_addon('', :class => 'glyphicon glyphicon-calendar')
+        input_group date, addon
+      end
     end
   end
 end

data/app/models/concerns/foreman_expire_hosts/host_ext.rb

@@ -18,7 +18,7 @@ module ForemanExpireHosts
       scope :expiring_today, -> { expiring.with_expire_date(Date.today) }
       scope :expired_past_grace_period, -> { expiring.where('expired_on < ?', Date.today + Setting[:days_to_delete_after_host_expiration].to_i) }
 
-      scoped_search :on => :expired_on, :complete_value => :true, :rename => :expires
+      scoped_search :on => :expired_on, :complete_value => :true, :rename => :expires, :only_explicit => true
     end
 
     def validate_expired_on

data/app/views/hosts/_expired_on_field.html.erb

@@ -2,7 +2,7 @@
   <%= stylesheet 'foreman_expire_hosts/application' %>
   <%= javascript 'foreman_expire_hosts/application' %>
 <% end %>
-<%= text_f f, :expired_on,
+<%= datepicker_f f, :expired_on,
            :value        => @host.expired_on.try(:strftime, '%d/%m/%Y'),
            :data         => { provide:              @host.can_modify_expiry_date? ? 'datepicker' : 'readonly',
                               orientation:          'top left',

data/app/views/hosts/select_multiple_expiration.html.erb

@@ -6,7 +6,7 @@
 
 <%= _('Host will be deleted automatically on given expired date. Leave blank to clear expiration date.') %>
 
-<%= text_f f, :expired_on,
+<%= datepicker_f f, :expired_on,
      :value        => (Date.today + 14).strftime('%d/%m/%Y'),
      :data         => { provide:              'datepicker',
                         orientation:          'top left',

data/lib/expire_hosts_notifications.rb

@@ -33,13 +33,13 @@ module ExpireHostsNotifications
       unless deleted_hosts.empty?
         ExpireHostsNotifications.hosts_by_user(deleted_hosts).each do |user_id, hosts_hash|
           catch_delivery_errors(_('Failed to deliver deleted hosts notification'), deleted_hosts) do
-            ExpireHostsMailer.deleted_hosts_notification(hosts_hash['email'], hosts_hash['hosts']).deliver_now
+            ExpireHostsMailer.deleted_hosts_notification(hosts_hash['email'], hosts_hash['hosts']).deliver
           end
         end
       end
       return if failed_delete_hosts.empty?
       catch_delivery_errors(_('Failed to deliver deleted hosts notification failed status'), failed_delete_hosts) do
-        ExpireHostsMailer.failed_to_delete_hosts_notification(self.admin_email, failed_delete_hosts).deliver_now
+        ExpireHostsMailer.failed_to_delete_hosts_notification(self.admin_email, failed_delete_hosts).deliver
       end
     end
 
@@ -65,13 +65,13 @@ module ExpireHostsNotifications
         delete_date = (Date.today + self.days_to_delete_after_expired.to_i)
         hosts_by_user(stopped_hosts).each do |user_id, hosts_hash|
           catch_delivery_errors(_('Failed to deliver stopped hosts notification'), stopped_hosts) do
-            ExpireHostsMailer.stopped_hosts_notification(hosts_hash['email'], delete_date, hosts_hash['hosts']).deliver_now
+            ExpireHostsMailer.stopped_hosts_notification(hosts_hash['email'], delete_date, hosts_hash['hosts']).deliver
           end
         end
       end
       return if failed_stop_hosts.empty?
       catch_delivery_errors(_('Failed to deliver stopped hosts notification failed status'), failed_stop_hosts) do
-        ExpireHostsMailer.failed_to_stop_hosts_notification(self.admin_email, failed_stop_hosts).deliver_now
+        ExpireHostsMailer.failed_to_stop_hosts_notification(self.admin_email, failed_stop_hosts).deliver
       end
     end
 
@@ -83,7 +83,7 @@ module ExpireHostsNotifications
       unless notifiable_hosts.empty?
         hosts_by_user(notifiable_hosts).each do |user_id, hosts_hash|
           catch_delivery_errors(_('Failed to deliver expiring hosts notification'), notifiable_hosts) do
-            ExpireHostsMailer.expiry_warning_notification(hosts_hash['email'], expiry_date, hosts_hash['hosts']).deliver_now
+            ExpireHostsMailer.expiry_warning_notification(hosts_hash['email'], expiry_date, hosts_hash['hosts']).deliver
           end
         end
       end

data/lib/foreman_expire_hosts/engine.rb

@@ -37,6 +37,7 @@ module ForemanExpireHosts
         Host::Managed.send :include, ForemanExpireHosts::HostExt
         HostsHelper.send :include, ForemanExpireHosts::HostsHelperExtensions
         HostsController.send :include, ForemanExpireHosts::HostControllerExtensions
+        AuditsHelper.send :include, ForemanExpireHosts::AuditsHelperExtensions
       rescue => e
         Rails.logger.warn "ForemanExpireHosts: skipping engine hook (#{e})"
       end

data/lib/foreman_expire_hosts/version.rb

@@ -1,3 +1,3 @@
 module ForemanExpireHosts
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -88,6 +88,7 @@ files:
 - app/assets/javascripts/foreman_expire_hosts/datepicker_for_host_expired_on_field.js
 - app/assets/stylesheets/foreman_expire_hosts/application.scss
 - app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb
+- app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb
 - app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb
 - app/helpers/expire_hosts_mailer_helper.rb
 - app/mailers/expire_hosts_mailer.rb