Module: Pubnub::Validator::CommonValidator

Included in:
Audit, ChannelRegistration, Client, Grant, Heartbeat, HereNow, History, Leave, Presence, Publish, Revoke, SetState, State, Subscribe, Time, WhereNow
Defined in:
lib/pubnub/validators/common_validator.rb

Overview

Validator for Client object

Instance Method Summary collapse

Instance Method Details

#validate_origin(origin, required = false) ⇒ Object

Validates given origin



8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/pubnub/validators/common_validator.rb', line 8

def validate_origin(origin, required = false)
  fail(
    InitializationError.new,
    'Missing required :origins_pool parameter.'
  ) if !origin && required

  fail(
    InitializationError.new,
    'origins_pool parameter is not valid. \
           Should be type of Array.'
  ) unless origin.is_a?(Array) || origin.blank?
end

#validate_publish_key(publish_key, required = false) ⇒ Object

Validates given publish key



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/pubnub/validators/common_validator.rb', line 36

def validate_publish_key(publish_key, required = false)
  fail(
    InitializationError.new,
    'Missing required :subscribe_key parameter.'
  ) if !publish_key && required

  fail(
    InitializationError.new,
    'Publish key parameter is not valid. \
           Should be type of String or Symbol.'
  ) unless [String, Symbol].include?(publish_key.class) ||
           publish_key.blank?
end

#validate_subscribe_key(subscribe_key, required = false) ⇒ Object

Validates given subscribe key



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/pubnub/validators/common_validator.rb', line 22

def validate_subscribe_key(subscribe_key, required = false)
  fail(
    InitializationError.new,
    'Missing required :subscribe_key parameter.'
  ) if !subscribe_key && required

  fail(
    InitializationError.new,
    'Subscribe key parameter is not valid. \
           Should be type of String or Symbol.'
  ) unless [String, Symbol].include?(subscribe_key.class)
end