foreman_expire_hosts 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a46f4ef05040228424339f7bb3e64d1f0fd4856
-  data.tar.gz: 224e1a6a8458ea48fe76246f91d524c644a1e395
+  metadata.gz: 93ce6b56c3992acaf75ce33279400688b6feb3c6
+  data.tar.gz: c5ebb3c23813c35e438c1e636aaa0f89c265035a
 SHA512:
-  metadata.gz: 06f65256c9e252b8e5177208a97051e8563dd4c0e4a0a0163290d8b7d5f1d36948fe4f599bdaf9caef3a129c130b1ea13e20831ca6e1a3b56adb2f8fad5b158f
-  data.tar.gz: 99313de528e91e2bf57d568616590d88fe0571534cb885c69767472c902507e4b4bdcb4c1130aeda31c019cf84d62dca37212f131e0274c87ec8395a0abee2ee
+  metadata.gz: 3c96161b39033fa298be9570693b7f216e8745cd7f615f54055119dcd63c7e2f0c8123e1a40f334bad43f4819233bd8e4c3636daef9c00168ca69bb4986d0044
+  data.tar.gz: 17c238e649d88559d2e7708ae0a35b31604d7a201df5721b4ff231c6fe1d4bfc8cac21170a6e2b63b27685eb633b3958a9931f6c9b4489f81bf8ac0aaa697680

data/.rubocop.yml

@@ -22,7 +22,7 @@ Rails/ActionFilter:
 Metrics/MethodLength:
   Max: 40
 
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 Style/RedundantSelf:
@@ -31,7 +31,7 @@ Style/RedundantSelf:
 Metrics/ClassLength:
   Max: 500
 
-Style/FileName:
+Naming/FileName:
   Exclude:
       - 'db/seeds.d/*'
 
@@ -52,3 +52,29 @@ Style/EachWithObject:
 
 Metrics/ParameterLists:
   Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+
+# May be enabled for Foreman >= 1.16
+Rails/ApplicationRecord:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,26 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-10-20 20:55:41 +0200 using RuboCop version 0.42.0.
+# on 2017-08-01 16:36:14 +0200 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'lib/expire_hosts_notifications.rb'
-    - 'lib/foreman_expire_hosts/engine.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'app/models/host_status/expiration_status.rb'
-
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
@@ -30,12 +15,19 @@ Lint/UselessAssignment:
 Metrics/AbcSize:
   Max: 51
 
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+    - 'test/**/*.rb'
+
 # Offense count: 3
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 86
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 89
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 362
@@ -53,32 +45,3 @@ Metrics/PerceivedComplexity:
 Rails/OutputSafety:
   Exclude:
     - 'app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
-Style/EmptyLinesAroundClassBody:
-  Exclude:
-    - 'app/mailers/expire_hosts_mailer.rb'
-    - 'app/models/setting/expire_hosts.rb'
-    - 'lib/expire_hosts_notifications.rb'
-
-# Offense count: 105
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
-Style/HashSyntax:
-  Enabled: false
-
-# Offense count: 12
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
-# SupportedStyles: space, no_space, compact
-Style/SpaceInsideHashLiteralBraces:
-  Exclude:
-    - 'app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb'
-    - 'app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb'
-    - 'lib/expire_hosts_notifications.rb'
-    - 'lib/foreman_expire_hosts/engine.rb'
-    - 'test/functional/concerns/hosts_controller_extensions_test.rb'

data/README.md

@@ -15,6 +15,7 @@ This plugin will send two warning notifications before host expiry (see Settings
 | >= 1.11         | ~> 2.0         |
 | >= 1.13         | ~> 2.1         |
 | >= 1.15         | ~> 3.0         |
+| >= 1.16         | ~> 4.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)

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

@@ -1,16 +1,14 @@
 module ForemanExpireHosts
   module HostControllerExtensions
-    extend ActiveSupport::Concern
-
-    included do
-      before_filter :validate_multiple_expiration, :only => :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
+    def self.prepended(base)
+      base.class_eval do
+        before_filter :validate_multiple_expiration, :only => :update_multiple_expiration
+        before_filter :find_multiple_with_expire_hosts, :only => [:select_multiple_expiration, :update_multiple_expiration]
+        alias_method :find_multiple_with_expire_hosts, :find_multiple
+      end
     end
 
-    def select_multiple_expiration
-    end
+    def select_multiple_expiration; end
 
     def update_multiple_expiration
       expiration_date = params[:host][:expired_on]
@@ -22,10 +20,10 @@ module ForemanExpireHosts
         begin
           host.expired_on = expiration_date
           host.save!
-        rescue => error
+        rescue StandardError => error
           failed_hosts[host.name] = error
           message = if expiration_date.present?
-                      _('Failed to set expiration date for %{host} to %{expiration_date}.') % {:host => host, :expiration_date => l(expiration_date)}
+                      _('Failed to set expiration date for %{host} to %{expiration_date}.') % { :host => host, :expiration_date => l(expiration_date) }
                     else
                       _('Failed to clear expiration date for %s.') % host
                     end
@@ -62,12 +60,12 @@ module ForemanExpireHosts
       end
     end
 
-    def action_permission_with_expire_hosts
+    def action_permission
       case params[:action]
       when 'select_multiple_expiration', 'update_multiple_expiration'
         :edit
       else
-        action_permission_without_expire_hosts
+        super
       end
     end
   end

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

@@ -3,12 +3,12 @@ module ForemanExpireHosts
     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?
+      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && audit.comment.present?
       "<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?
+      return unless audit.auditable_type.to_s == 'Host' && audit.action == 'destroy' && audit.comment.present?
       "<tr><td>Comment</td><td>#{audit.comment}</td></tr>".html_safe
     end
   end

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

@@ -1,14 +1,11 @@
 module ForemanExpireHosts
   module HostsHelperExtensions
-    extend ActiveSupport::Concern
-
-    included do
-      alias_method_chain :multiple_actions, :expire_hosts
-    end
-
-    def multiple_actions_with_expire_hosts
-      return multiple_actions_without_expire_hosts unless authorized_for(:controller => :hosts, :action => :edit)
-      multiple_actions_without_expire_hosts + [[_('Change Expiration'), select_multiple_expiration_hosts_path]]
+    def multiple_actions
+      actions = super
+      if authorized_for(:controller => :hosts, :action => :edit)
+        actions << [_('Change Expiration'), select_multiple_expiration_hosts_path]
+      end
+      actions
     end
 
     def host_expiry_warning_message(host)
@@ -16,11 +13,11 @@ module ForemanExpireHosts
       if host.expired_past_grace_period?
         message = _('This host has expired %s ago and needs to be deleted manually.') % time_ago_in_words(host.expired_on)
       elsif host.expired?
-        message = _('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.') % {:delete_date => l(host.expiration_grace_period_end_date), :time_ago => time_ago_in_words(host.expired_on)}
+        message = _('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.') % { :delete_date => l(host.expiration_grace_period_end_date), :time_ago => time_ago_in_words(host.expired_on) }
       elsif host.expires_today?
         message = _('This host will expire today.')
       elsif host.pending_expiration?
-        message = _('This host will expire in %{distance_of_time} (on %{expire_date}).') % {:expire_date => l(host.expired_on), :distance_of_time => future_time_in_words(host.expired_on)}
+        message = _('This host will expire in %{distance_of_time} (on %{expire_date}).') % { :expire_date => l(host.expired_on), :distance_of_time => future_time_in_words(host.expired_on) }
       end
       message
     end

data/app/mailers/expire_hosts_mailer.rb

@@ -1,37 +1,89 @@
 class ExpireHostsMailer < ApplicationMailer
-
   default :content_type => 'text/html', :from => Setting[:email_reply_address] || 'noreply@your-foreman.com'
 
-  def deleted_hosts_notification(emails, hosts)
-    @hosts = hosts
-    mail(:to => emails, :subject => _('Deleted expired hosts in Foreman'), :importance => 'High')
+  def deleted_hosts_notification(recipient, hosts)
+    build_mail(
+      recipient: recipient,
+      subject: N_('Deleted expired hosts in Foreman'),
+      hosts: hosts
+    )
   end
 
-  def failed_to_delete_hosts_notification(emails, hosts)
-    @hosts = hosts
-    mail(:to => emails, :subject => _('Failed to delete expired hosts in Foreman'), :importance => 'High')
+  def failed_to_delete_hosts_notification(recipient, hosts)
+    build_mail(
+      recipient: recipient,
+      subject: N_('Failed to delete expired hosts in Foreman'),
+      hosts: hosts
+    )
   end
 
-  def stopped_hosts_notification(emails, delete_date, hosts)
-    @hosts       = hosts
+  def stopped_hosts_notification(recipient, delete_date, hosts)
     @delete_date = delete_date
-    mail(:to => emails, :subject => _('Stopped expired hosts in Foreman'), :importance => 'High') do |format|
-      format.html { render :layout => 'application_mailer' }
-    end
+    build_mail(
+      recipient: recipient,
+      subject: N_('Stopped expired hosts in Foreman'),
+      hosts: hosts
+    )
   end
 
-  def failed_to_stop_hosts_notification(emails, hosts)
+  def failed_to_stop_hosts_notification(recipient, hosts)
+    build_mail(
+      recipient: recipient,
+      subject: N_('Failed to stop expired hosts in Foreman'),
+      hosts: hosts
+    )
+  end
+
+  def expiry_warning_notification(recipient, expiry_date, hosts)
+    @expiry_date = expiry_date
+    build_mail(
+      recipient: recipient,
+      subject: N_('Expiring hosts in foreman'),
+      hosts: hosts
+    )
+  end
+
+  private
+
+  def build_mail(opts = {})
+    recipient = opts[:recipient]
+    subject = opts[:subject]
+    hosts = opts[:hosts]
+    user = user_for_recipient(recipient)
     @hosts = hosts
-    mail(:to => emails, :subject => _('Failed to stop expired hosts in Foreman'), :importance => 'High') do |format|
-      format.html { render :layout => 'application_mailer' }
+    @authorized_for_expiry_date_change = ForemanExpireHosts::ExpiryEditAuthorizer.new(
+      :user => user,
+      :hosts => hosts
+    ).authorized?
+    set_locale_for(user) do
+      mail(
+        :to => recipient_mail(recipient),
+        :subject => _(subject),
+        :importance => 'High'
+      ) do |format|
+        format.html { render :layout => 'application_mailer' }
+      end
     end
   end
 
-  def expiry_warning_notification(emails, expiry_date, hosts)
-    @hosts       = hosts
-    @expiry_date = expiry_date
-    mail(:to => emails, :subject => _('Expiring hosts in foreman'), :importance => 'High') do |format|
-      format.html { render :layout => 'application_mailer' }
+  def user_for_recipient(recipient)
+    case recipient
+    when Array
+      User.anonymous_admin
+    when User
+      recipient
+    else
+      raise Foreman::Exception.new(N_('Cannot map recipient %s to user'), recipient.inspect)
     end
   end
+
+  def recipient_mail(recipient)
+    return recipient if recipient.is_a?(Array)
+    return recipient.mail if recipient.mail.present?
+    admin_email
+  end
+
+  def admin_email
+    Setting[:administrator]
+  end
 end

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

@@ -17,7 +17,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, :only_explicit => true
+      scoped_search :on => :expired_on, :complete_value => true, :rename => :expires, :only_explicit => true
     end
 
     def validate_expired_on
@@ -26,7 +26,7 @@ module ForemanExpireHosts
           unless expired_on.to_s.to_date > Date.today
             errors.add(:expired_on, _('must be in the future'))
           end
-        rescue => e
+        rescue StandardError => e
           errors.add(:expired_on, _('is invalid'))
         end
       end
@@ -76,7 +76,7 @@ module ForemanExpireHosts
       return true if self.owner_type.nil? || self.owner.nil?
       Setting[:can_owner_modify_host_expiry_date] &&
         ((self.owner_type == 'User' && self.owner == User.current) ||
-         (self.owner_type == 'Usergroup' && self.owner.users.include?(User.current)))
+         (self.owner_type == 'Usergroup' && self.owner.all_users.include?(User.current)))
     end
 
     private

data/app/models/host_status/expiration_status.rb

@@ -50,7 +50,7 @@ module HostStatus
       end
     end
 
-    def relevant?(options = {})
+    def relevant?(_options = {})
       host.expires?
     end
   end

data/app/models/setting/expire_hosts.rb

@@ -1,4 +1,5 @@
 class Setting::ExpireHosts < Setting
+  Setting::BLANK_ATTRS.push('host_expiry_email_recipients')
 
   def self.load_defaults
     # Check the table exists
@@ -11,11 +12,10 @@ class Setting::ExpireHosts < Setting
         self.set('notify1_days_before_host_expiry', N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'), 7, N_('First expiry notification')),
         self.set('notify2_days_before_host_expiry', N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'), 1, N_('Second expiry notification')),
         self.set('days_to_delete_after_host_expiration', N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'), 3, N_('Expiry grace period in days')),
-        self.set('host_expiry_email_recipients', N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry wanting notifications then those emails can be configured here. This must be string and multiple emails can give with coma(,) separated'), 'foreman-admin@your_foreman.com', N_('Expiry e-mail recipients'))
+        self.set('host_expiry_email_recipients', N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry warning notifications then those emails can be configured comma separated here.'), nil, N_('Expiry e-mail recipients'))
       ].each { |s| self.create! s.update(:category => 'Setting::ExpireHosts') }
     end
 
     true
   end
-
 end

data/app/services/foreman_expire_hosts/action/base.rb

@@ -0,0 +1,57 @@
+module ForemanExpireHosts
+  module Action
+    class Base
+      attr_accessor :successful_hosts, :failed_hosts
+
+      def initialize
+        self.successful_hosts = []
+        self.failed_hosts = []
+      end
+
+      def engage
+        process
+        notify
+      end
+
+      private
+
+      def process
+        hosts.each do |host|
+          if action(host)
+            self.successful_hosts << host
+          else
+            self.failed_hosts << host
+          end
+        end
+      end
+
+      def notify
+        success_notification.new(
+          success_notification_options
+        ).deliver
+        failure_notification.new(
+          failure_notification_options
+        ).deliver
+      end
+
+      def hosts
+        selector.preload(:owner)
+      end
+
+      def success_notification_options
+        {
+          :hosts => successful_hosts
+        }
+      end
+
+      def failure_notification_options
+        {
+          :hosts => failed_hosts,
+          :to => User.anonymous_admin
+        }
+      end
+
+      delegate :logger, :to => :Rails
+    end
+  end
+end