Module: Pubnub::Validator::CommonValidator

Included in:
AddChannelsToPush, AddMessageAction, Audit, ChannelRegistration, Client, Delete, GetAllChannelsMetadata, GetAllUuidMetadata, GetChannelMembers, GetChannelMetadata, GetMemberships, GetMessageActions, GetUuidMetadata, Grant, GrantToken, Heartbeat, HereNow, History, Leave, ListPushProvisions, MessageCounts, Presence, Publish, RemoveChannelMembers, RemoveChannelMetadata, RemoveChannelsFromPush, RemoveDeviceFromPush, RemoveMemberships, RemoveMessageAction, RemoveUuidMetadata, Revoke, RevokeToken, SetChannelMembers, SetChannelMetadata, SetMemberships, SetState, SetUuidMetadata, Signal, 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
20
21
 
# File 'lib/pubnub/validators/common_validator.rb', line 8

def validate_origin(origin, required = false)
  if !origin && required
    raise(
      InitializationError.new,
      'Missing required :origins_pool parameter.'
    )
  elsif !(origin.is_a?(String) || origin.blank?)
    raise(
      InitializationError.new,
      'origins_pool parameter is not valid. \
             Should be type of String.'
    )
  end
end

#validate_publish_key(publish_key, required = false) ⇒ Object

Validates given publish key



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/pubnub/validators/common_validator.rb', line 40

def validate_publish_key(publish_key, required = false)
  if !publish_key && required
    raise(
      InitializationError.new,
      'Missing required :subscribe_key parameter.'
    )
  elsif !([String, Symbol].include?(publish_key.class) ||
         publish_key.blank?)
    raise(
      InitializationError.new,
      'Publish key parameter is not valid. \
             Should be type of String or Symbol.'
    )
  end
end

#validate_subscribe_key(subscribe_key, required = false) ⇒ Object

Validates given subscribe key



24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/pubnub/validators/common_validator.rb', line 24

def validate_subscribe_key(subscribe_key, required = false)
  if !subscribe_key && required
    raise(
      InitializationError.new,
      'Missing required :subscribe_key parameter.'
    )
  elsif ![String, Symbol].include?(subscribe_key.class)
    raise(
      InitializationError.new,
      'Subscribe key parameter is not valid. \
             Should be type of String or Symbol.'
    )
  end
end

#validate_user_id(user_id) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/pubnub/validators/common_validator.rb', line 56

def validate_user_id(user_id)
  if !user_id || user_id.blank?
    raise(
      InitializationError.new,
      'Missing required :user_id parameter.'
    )
  elsif !([String, Symbol].include?(user_id.class) ||
    user_id.blank?)
    raise(
      InitializationError.new,
      'user_id parameter is not valid. \
             Should be type of String or Symbol.'
    )
  end
end