Module: Fanforce::API::Utils

Extended by:
Utils
Includes:
Utils
Included in:
Fanforce, Fanforce::API, Utils
Defined in:
lib/fanforce/api/utils.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



6
 
# File 'lib/fanforce/api/utils.rb', line 6

def self.included(base) base.extend(self) end

Instance Method Details

#collect_known_params(params) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fanforce/api/utils.rb', line 41

def collect_known_params(params)
  params = symbolize_keys(params)
  if is_present?(params[:app_id])
    addon_type = :app
    addon_id = params[:app_id]
  elsif is_present?(params[:behavior_plugin_id])
    addon_type = :plugin
    addon_id = params[:behavior_plugin_id]
  elsif is_present?(params[:plugin_id])
    addon_type = :plugin
    addon_id = params[:plugin_id]
  elsif is_present?(params[:widget_id])
    addon_type = :widget
    addon_id = params[:widget_id]
  end
  remove_nil_values(:"#{addon_type}_id" => params[:"#{addon_type}_id"], addon_type: addon_type, addon_id: addon_id, organization_id: params[:organization_id], organization_slug: params[:organization_slug], api_key: params[:api_key], session_id: params[:session_id])
end

#remove_internal_params(params) ⇒ Object 



59
60
61
 
# File 'lib/fanforce/api/utils.rb', line 59

def remove_internal_params(params)
  params.clone.delete_if { |k,v| [:app_id, :behavior_plugin_id, :plugin_id, :widget_id, :addon_type, :addon_id, :organization_id, :organization_slug, :api_key].include? k }
end

#remove_nil_values(hash) ⇒ Object 



37
38
39
 
# File 'lib/fanforce/api/utils.rb', line 37

def remove_nil_values(hash)
  hash.clone.delete_if {|k,v| v.nil? }
end

#remove_sensitive_params(params) ⇒ Object 



63
64
65
 
# File 'lib/fanforce/api/utils.rb', line 63

def remove_sensitive_params(params)
  params.clone.delete_if { |k,v| [:api_key].include? k }
end

#valid_fanforce_js_request?(params = @params) ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
11
12
 
# File 'lib/fanforce/api/utils.rb', line 8

def valid_fanforce_js_request?(params=@params)
  return false if !params.is_a?(Hash)
  return false if is_blank?(params[:organization_id]) or is_blank?(params[:api_key])
  return true
end

#valid_fanforce_request?(params = @params) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
19
 
# File 'lib/fanforce/api/utils.rb', line 14

def valid_fanforce_request?(params=@params)
  return false if !params.is_a?(Hash)
  return false if is_blank?(params[:organization_id])
  return false if is_blank?(params[:app_id]) and is_blank?(params[:behavior_plugin_id]) and is_blank?(params[:plugin_id]) and is_blank?(params[:widget_id])
  return true
end

#valid_install_request?(params = @params) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
25
26
27
 
# File 'lib/fanforce/api/utils.rb', line 21

def valid_install_request?(params=@params)
  return false if !params.is_a?(Hash)
  return false if is_blank?(params[:organization_id])
  return false if is_blank?(params[:app_id]) and is_blank?(params[:behavior_plugin_id]) and is_blank?(params[:plugin_id]) and is_blank?(params[:widget_id])
  return false if is_blank?(params[:api_key])
  return true
end

#valid_uninstall_request?(params = @params) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
32
33
34
35
 
# File 'lib/fanforce/api/utils.rb', line 29

def valid_uninstall_request?(params=@params)
  return false if !params.is_a?(Hash)
  return false if is_blank?(params[:organization_id])
  return false if is_blank?(params[:app_id]) and is_blank?(params[:behavior_plugin_id]) and is_blank?(params[:plugin_id]) and is_blank?(params[:widget_id])
  return false if is_blank?(params[:api_key])
  return true
end