Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add YARD + docs directory #14

Merged
merged 1 commit into from
Jun 17, 2020
Merged

Add YARD + docs directory #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
474 changes: 474 additions & 0 deletions docs/Twilito.html
View file
Open in desktop

Large diffs are not rendered by default.

269 changes: 269 additions & 0 deletions docs/Twilito/API.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Twilito::API

&mdash; Documentation by YARD 0.9.25

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" />

<link rel="stylesheet" href="../css/common.css" type="text/css" />

<script type="text/javascript">
pathId = "Twilito::API";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Twilito.html" title="Twilito (module)">Twilito</a></span></span>
&raquo;
<span class="title">API</span>

</div>

<div id="search">

<a class="full_list_link" id="class_list_link"
href="../class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Module: Twilito::API



</h1>
<div class="box_info">









<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Twilito.html" title="Twilito (module)">Twilito</a></span></dd>
</dl>



<dl>
<dt>Defined in:</dt>
<dd>lib/twilito/api.rb</dd>
</dl>

</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="#messages_uri-instance_method" title="#messages_uri (instance method)">#<strong>messages_uri</strong>(account_sid) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'></div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#send_response-instance_method" title="#send_response (instance method)">#<strong>send_response</strong>(args) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'></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="messages_uri-instance_method">

#<strong>messages_uri</strong>(account_sid) &#x21d2; <tt>Object</tt>





</h3><table class="source_code">
<tr>
<td>
<pre class="lines">


18
19
20
21
22
23
24
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/twilito/api.rb', line 18</span>

<span class='kw'>def</span> <span class='id identifier rubyid_messages_uri'>messages_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_account_sid'>account_sid</span><span class='rparen'>)</span>
<span class='id identifier rubyid_components'>components</span> <span class='op'>=</span> <span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="Configuration.html" title="Twilito::Configuration (class)">Configuration</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Configuration.html#TWILIO_VERSION-constant" title="Twilito::Configuration::TWILIO_VERSION (constant)">TWILIO_VERSION</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accounts</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_account_sid'>account_sid</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Messages.json</span><span class='tstring_end'>&#39;</span></span>
<span class='rbracket'>]</span>

<span class='const'>URI</span><span class='op'>::</span><span class='const'>HTTPS</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span>
<span class='label'>host:</span> <span class='const'><span class='object_link'><a href="Configuration.html" title="Twilito::Configuration (class)">Configuration</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Configuration.html#TWILIO_HOST-constant" title="Twilito::Configuration::TWILIO_HOST (constant)">TWILIO_HOST</a></span></span><span class='comma'>,</span>
<span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_components'>components</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="send_response-instance_method">

#<strong>send_response</strong>(args) &#x21d2; <tt>Object</tt>





</h3><table class="source_code">
<tr>
<td>
<pre class="lines">


5
6
7
8
9
10
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/twilito/api.rb', line 5</span>

<span class='kw'>def</span> <span class='id identifier rubyid_send_response'>send_response</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_messages_uri'>messages_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:account_sid</span><span class='rbracket'>]</span><span class='rparen'>)</span>

<span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='label'>use_ssl:</span> <span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_http'>http</span><span class='op'>|</span>
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span>
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_initialize_http_header'>initialize_http_header</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_user_agent'>user_agent</span><span class='rparen'>)</span>
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_basic_auth'>basic_auth</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:account_sid</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:auth_token</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_set_form_data'>set_form_data</span><span class='lparen'>(</span><span class='id identifier rubyid_twilio_params'>twilio_params</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span><span class='rparen'>)</span>

<span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_req'>req</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>

</div>

<div id="footer">
Generated on Wed Jun 17 06:45:24 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>

</div>
</body>
</html>
124 changes: 124 additions & 0 deletions docs/Twilito/ArgumentError.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Twilito::ArgumentError

&mdash; Documentation by YARD 0.9.25

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" />

<link rel="stylesheet" href="../css/common.css" type="text/css" />

<script type="text/javascript">
pathId = "Twilito::ArgumentError";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Twilito.html" title="Twilito (module)">Twilito</a></span></span>
&raquo;
<span class="title">ArgumentError</span>

</div>

<div id="search">

<a class="full_list_link" id="class_list_link"
href="../class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Exception: Twilito::ArgumentError



</h1>
<div class="box_info">

<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>

<ul class="fullTree">
<li>Object</li>

<li class="next">StandardError</li>

<li class="next">Twilito::ArgumentError</li>

</ul>
<a href="#" class="inheritanceTree">show all</a>

</dd>
</dl>











<dl>
<dt>Defined in:</dt>
<dd>lib/twilito.rb</dd>
</dl>

</div>











</div>

<div id="footer">
Generated on Wed Jun 17 06:45:24 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>

</div>
</body>
</html>
Loading