Class: AsanaExceptionNotifier::UnsafeFilter

Inherits:
Object
  • Object
show all
Includes:
ApplicationHelper
Defined in:
lib/asana_exception_notifier/classes/unsafe_filter.rb

Overview

class used to filter unsafe params

Constant Summary collapse

UNSAFE_OPTIONS =

the default options that are considered unsafe

%w(
  password password_confirmation new_password new_password_confirmation
  old_password email_address email authenticity_token utf8
  client_secret code authentication_token access_token refresh_token token
).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ApplicationHelper

add_files_to_zip, archive_files, ensure_thread_running, escape, execute_with_rescue, expanded_path, extract_body, force_utf8_encoding, get_extension_and_name_from_file, get_hash_rows, get_table_headers, get_table_rows, hash_to_html_attributes, inspect_value, log_bactrace, log_exception, logger, mount_table_for_hash, path_is_a_template?, permitted_options, prepare_archive_creation, rails_logger, remove_blank, rescue_interrupt, root, run_new_thread, set_fieldset_key, split_archive, tempfile_details, template_dir, template_path_exist

Methods included from HeredocHelper

link_helper, mount_table

Constructor Details

#initialize(arguments, unsafe_options = []) ⇒ void

Initializes the instance with the arguments that will be filtered and the additional unsafe options and starts filtering the arguments

Parameters:

  • arguments (#delete) —

    The arguments that will be filtered

  • unsafe_options (Array<String>, Array<Symbol>) (defaults to: []) —

    Additional unsafe options that will be used for filtering

See Also:

  • #remove_unsafe


36
37
38
39
40
 
# File 'lib/asana_exception_notifier/classes/unsafe_filter.rb', line 36

def initialize(arguments, unsafe_options = [])
  @unsafe_options = unsafe_options.present? && unsafe_options.is_a?(Array) ? unsafe_options.map(&:to_s) : []
  @arguments = arguments.present? ? arguments : {}
  remove_unsafe(@arguments)
end

Instance Attribute Details

#arguments ⇒ #delete (readonly)

The arguments that will be filtered

Returns:

  • (#delete) —

    THe arguments that will be filtered



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/asana_exception_notifier/classes/unsafe_filter.rb', line 10

class UnsafeFilter
  include AsanaExceptionNotifier::ApplicationHelper

  # the default options that are considered unsafe
  UNSAFE_OPTIONS = %w(
    password password_confirmation new_password new_password_confirmation
    old_password email_address email authenticity_token utf8
    client_secret code authentication_token access_token refresh_token token
  ).freeze

  # The arguments that will be filtered
  # @return [#delete] THe arguments that will be filtered
  attr_reader :arguments

  # Additional unsafe options that will be used for filtering
  # @return [Array<String>, Array<Symbol>] Additional unsafe options that will be used for filtering
  attr_reader :unsafe_options

  # Initializes the instance with the arguments that will be filtered and the additional unsafe options
  # and starts filtering the arguments
  # @see #remove_unsafe
  #
  # @param [#delete] arguments The arguments that will be filtered
  # @param [Array<String>, Array<Symbol>] unsafe_options Additional unsafe options that will be used for filtering
  #
  # @return [void]
  def initialize(arguments, unsafe_options = [])
    @unsafe_options = unsafe_options.present? && unsafe_options.is_a?(Array) ? unsafe_options.map(&:to_s) : []
    @arguments = arguments.present? ? arguments : {}
    remove_unsafe(@arguments)
  end

private

  # Returns the arguments, if they are blank
  # Otherwise first tries to remove attributes
  # then the blank values, and then tries to remove any remaining unsafe from the remaining object
  # @see #remove_blank
  # @see #remove_unsafe_from_object
  #
  # @param [#delete] args The arguments that will be filtered
  #
  # @return [Object, nil]
  def remove_unsafe(args)
    return args if args.blank?
    args.delete(:attributes!)
    remove_blank(args)
    remove_unsafe_from_object(args)
    args
  end

  # If arguments is a hash will try to remove any unsafe values
  # otherwise will call the remove_unsafe to start removing from object
  # @see #verify_unsafe_pair
  # @see #remove_unsafe
  #
  # @param [#delete] args The arguments that will be filtered
  #
  # @return [Object, nil]
  def remove_unsafe_from_object(args)
    if args.is_a?(Hash)
      args.each_pair do |key, value|
        verify_unsafe_pair(key, value)
      end
    else
      remove_unsafe(value: args)
    end
  end

  # returns true if the key is included in the default unsafe options or in the custom ones, otherwise false
  #
  # @param [String] key The key that will be checked if is unsafe
  #
  # @return [Boolean] returns true if the key is included in the default unsafe options or in the custom ones, otherwise false
  def unsafe?(key)
    @unsafe_options.include?(key) || AsanaExceptionNotifier::UnsafeFilter::UNSAFE_OPTIONS.include?(key)
  end

  # If the value is a hash, we start removing unsafe options from the hash, otherwise we check the key
  # @see #unsafe?
  # @param [String] key The key that will be checked if is unsafe
  # @param [Object] value The value that will be checked if it is unsafe
  #
  # @return [void]
  def verify_unsafe_pair(key, value)
    case value
      when Hash
        remove_unsafe(value)
      else
        args.delete(key) if unsafe?(key.to_s)
    end
  end
end

#unsafe_options ⇒ Array<String>, Array<Symbol> (readonly)

Additional unsafe options that will be used for filtering

Returns:

  • (Array<String>, Array<Symbol>) —

    Additional unsafe options that will be used for filtering



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/asana_exception_notifier/classes/unsafe_filter.rb', line 10

class UnsafeFilter
  include AsanaExceptionNotifier::ApplicationHelper

  # the default options that are considered unsafe
  UNSAFE_OPTIONS = %w(
    password password_confirmation new_password new_password_confirmation
    old_password email_address email authenticity_token utf8
    client_secret code authentication_token access_token refresh_token token
  ).freeze

  # The arguments that will be filtered
  # @return [#delete] THe arguments that will be filtered
  attr_reader :arguments

  # Additional unsafe options that will be used for filtering
  # @return [Array<String>, Array<Symbol>] Additional unsafe options that will be used for filtering
  attr_reader :unsafe_options

  # Initializes the instance with the arguments that will be filtered and the additional unsafe options
  # and starts filtering the arguments
  # @see #remove_unsafe
  #
  # @param [#delete] arguments The arguments that will be filtered
  # @param [Array<String>, Array<Symbol>] unsafe_options Additional unsafe options that will be used for filtering
  #
  # @return [void]
  def initialize(arguments, unsafe_options = [])
    @unsafe_options = unsafe_options.present? && unsafe_options.is_a?(Array) ? unsafe_options.map(&:to_s) : []
    @arguments = arguments.present? ? arguments : {}
    remove_unsafe(@arguments)
  end

private

  # Returns the arguments, if they are blank
  # Otherwise first tries to remove attributes
  # then the blank values, and then tries to remove any remaining unsafe from the remaining object
  # @see #remove_blank
  # @see #remove_unsafe_from_object
  #
  # @param [#delete] args The arguments that will be filtered
  #
  # @return [Object, nil]
  def remove_unsafe(args)
    return args if args.blank?
    args.delete(:attributes!)
    remove_blank(args)
    remove_unsafe_from_object(args)
    args
  end

  # If arguments is a hash will try to remove any unsafe values
  # otherwise will call the remove_unsafe to start removing from object
  # @see #verify_unsafe_pair
  # @see #remove_unsafe
  #
  # @param [#delete] args The arguments that will be filtered
  #
  # @return [Object, nil]
  def remove_unsafe_from_object(args)
    if args.is_a?(Hash)
      args.each_pair do |key, value|
        verify_unsafe_pair(key, value)
      end
    else
      remove_unsafe(value: args)
    end
  end

  # returns true if the key is included in the default unsafe options or in the custom ones, otherwise false
  #
  # @param [String] key The key that will be checked if is unsafe
  #
  # @return [Boolean] returns true if the key is included in the default unsafe options or in the custom ones, otherwise false
  def unsafe?(key)
    @unsafe_options.include?(key) || AsanaExceptionNotifier::UnsafeFilter::UNSAFE_OPTIONS.include?(key)
  end

  # If the value is a hash, we start removing unsafe options from the hash, otherwise we check the key
  # @see #unsafe?
  # @param [String] key The key that will be checked if is unsafe
  # @param [Object] value The value that will be checked if it is unsafe
  #
  # @return [void]
  def verify_unsafe_pair(key, value)
    case value
      when Hash
        remove_unsafe(value)
      else
        args.delete(key) if unsafe?(key.to_s)
    end
  end
end