Module: Optimizely::Helpers::Validator

Defined in:
lib/optimizely/helpers/validator.rb

Class Method Summary collapse

Class Method Details

.attributes_valid?(attributes) ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
28
29
30
31
32
33
 
# File 'lib/optimizely/helpers/validator.rb', line 25

def attributes_valid?(attributes)
  # Determines if provided attributes are valid.
  #
  # attributes - User attributes to be validated.
  #
  # Returns boolean depending on validity of attributes.

  attributes.is_a?(Hash)
end

.datafile_valid?(datafile) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/optimizely/helpers/validator.rb', line 45

def datafile_valid?(datafile)
  # Determines if a given datafile is valid.
  #
  # datafile - String JSON representing the project.
  #
  # Returns boolean depending on validity of datafile.

  begin
    datafile = JSON.load(datafile)
  rescue
    return false
  end

  version = datafile['version']

  if version == Optimizely::V1_CONFIG_VERSION
    JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V1, datafile)
  else
    JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V2, datafile)
  end
end

.error_handler_valid?(error_handler) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
71
72
73
74
75
 
# File 'lib/optimizely/helpers/validator.rb', line 67

def error_handler_valid?(error_handler)
  # Determines if a given error handler is valid.
  #
  # error_handler - error_handler to be validated.
  #
  # Returns boolean depending on whether error_handler has a handle_error method.

  error_handler.respond_to?(:handle_error)
end

.event_dispatcher_valid?(event_dispatcher) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
84
85
 
# File 'lib/optimizely/helpers/validator.rb', line 77

def event_dispatcher_valid?(event_dispatcher)
  # Determines if a given event dispatcher is valid.
  #
  # event_dispatcher - event_dispatcher to be validated.
  #
  # Returns boolean depending on whether event_dispatcher has a dispatch_event method.

  event_dispatcher.respond_to?(:dispatch_event)
end

.event_tags_valid?(event_tags) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
40
41
42
43
 
# File 'lib/optimizely/helpers/validator.rb', line 35

def event_tags_valid?(event_tags)
  # Determines if provided event tags are valid.
  #
  # event_tags - Event tags to be validated.
  #
  # Returns boolean depending on validity of event tags.

  event_tags.is_a?(Hash)
end

.logger_valid?(logger) ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
95
 
# File 'lib/optimizely/helpers/validator.rb', line 87

def logger_valid?(logger)
  # Determines if a given logger is valid.
  #
  # logger - logger to be validated.
  #
  # Returns boolean depending on whether logger has a log method.

  logger.respond_to?(:log)
end