Module: FmRest::V1::Utils

Included in:
FmRest::V1
Defined in:
lib/fmrest/v1/utils.rb

Constant Summary collapse

VALID_SCRIPT_KEYS = 
[:prerequest, :presort, :after].freeze

Instance Method Summary collapse

Instance Method Details

#convert_script_params(script_options) ⇒ Object

Converts custom script options to a hash with the Data API's expected JSON script format.

If script_options is a string or symbol it will be passed as the name of the script to execute (after the action, e.g. save).

If script_options is an array the first element will be the name of the script to execute (after the action) and the second element (if any) will be its param value.

If script_options is a hash it will expect to contain one or more of the following keys: :prerequest, :presort, :after

Any of those keys should contain either a string/symbol or array, which will be treated as described above, except for their own script execution order (prerequest, presort or after action).

Examples:

convert_script_params("My Script")
# => { "script": "My Script" }

convert_script_params(["My Script", "the param"])
# => { "script": "My Script", "script.param": "the param" }

convert_script_params(after: "After Script", prerequest: "Prerequest Script")
# => { "script": "After Script", "script.prerequest": "Prerequest Script" }

convert_script_params(presort: ["Presort Script", "foo"], prerequest: "Prerequest Script")
# => {
#      "script.presort": "After Script",
#      "script.presort.param": "foo",
#      "script.prerequest": "Prerequest Script"
#    }



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
 
# File 'lib/fmrest/v1/utils.rb', line 43

def convert_script_params(script_options)
  params = {}

  case script_options
  when String, Symbol
    params[:script] = script_options.to_s

  when Array
    params.merge!(convert_script_arguments(script_options))

  when Hash
    script_options.each_key do |key|
      next if VALID_SCRIPT_KEYS.include?(key)
      raise ArgumentError, "Invalid script option #{key.inspect}"
    end

    if script_options.has_key?(:prerequest)
      params.merge!(convert_script_arguments(script_options[:prerequest], :prerequest))
    end

    if script_options.has_key?(:presort)
      params.merge!(convert_script_arguments(script_options[:presort], :presort))
    end

    if script_options.has_key?(:after)
      params.merge!(convert_script_arguments(script_options[:after]))
    end
  end

  params
end