<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Pubnub::Validator::CommonValidator
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!Pubnub/Validator/CommonValidator.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../../Pubnub.html" title="Pubnub (module)">Pubnub</a></span></span> » <span class='title'><span class='object_link'><a href="../Validator.html" title="Pubnub::Validator (module)">Validator</a></span></span>
»
<span class="title">CommonValidator</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Pubnub::Validator::CommonValidator
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="Client.html" title="Pubnub::Validator::Client (module)">Client</a></span>, <span class='object_link'><a href="Publish.html" title="Pubnub::Validator::Publish (module)">Publish</a></span>, <span class='object_link'><a href="Subscribe.html" title="Pubnub::Validator::Subscribe (module)">Subscribe</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/pubnub/validators/common_validator.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Validator for Client object</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#validate_origin-instance_method" title="#validate_origin (instance method)">- (Object) <strong>validate_origin</strong>(origin, required = false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Validates given origin.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate_publish_key-instance_method" title="#validate_publish_key (instance method)">- (Object) <strong>validate_publish_key</strong>(publish_key, required = false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Validates given publish key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#validate_subscribe_key-instance_method" title="#validate_subscribe_key (instance method)">- (Object) <strong>validate_subscribe_key</strong>(subscribe_key, required = false) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Validates given subscribe key.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="validate_origin-instance_method">
- (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>validate_origin</strong>(origin, required = false)
</h3><div class="docstring">
<div class="discussion">
<p>Validates given origin</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub/validators/common_validator.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_origin'>validate_origin</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_required'>required</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Missing required :origins_pool parameter.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_origin'>origin</span> <span class='op'>&&</span> <span class='id identifier rubyid_required'>required</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>origins_pool parameter is not valid. \
Should be type of Array.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="validate_publish_key-instance_method">
- (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>validate_publish_key</strong>(publish_key, required = false)
</h3><div class="docstring">
<div class="discussion">
<p>Validates given publish key</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39
40
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub/validators/common_validator.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_publish_key'>validate_publish_key</span><span class='lparen'>(</span><span class='id identifier rubyid_publish_key'>publish_key</span><span class='comma'>,</span> <span class='id identifier rubyid_required'>required</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Missing required :subscribe_key parameter.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_publish_key'>publish_key</span> <span class='op'>&&</span> <span class='id identifier rubyid_required'>required</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Publish key parameter is not valid. \
Should be type of String or Symbol.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_publish_key'>publish_key</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span> <span class='op'>||</span>
<span class='id identifier rubyid_publish_key'>publish_key</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="validate_subscribe_key-instance_method">
- (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>validate_subscribe_key</strong>(subscribe_key, required = false)
</h3><div class="docstring">
<div class="discussion">
<p>Validates given subscribe key</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24
25
26
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub/validators/common_validator.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_validate_subscribe_key'>validate_subscribe_key</span><span class='lparen'>(</span><span class='id identifier rubyid_subscribe_key'>subscribe_key</span><span class='comma'>,</span> <span class='id identifier rubyid_required'>required</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Missing required :subscribe_key parameter.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_subscribe_key'>subscribe_key</span> <span class='op'>&&</span> <span class='id identifier rubyid_required'>required</span>
<span class='id identifier rubyid_fail'>fail</span><span class='lparen'>(</span>
<span class='const'>InitializationError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Subscribe key parameter is not valid. \
Should be type of String or Symbol.</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_subscribe_key'>subscribe_key</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Aug 18 16:02:32 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.1.6).
</div>
</body>
</html>