RubyGems - zendesk_api - Versions diffs - 0.2.6 → 0.3.0 - Mend

zendesk_api 0.2.6 → 0.3.0

Files changed (121) hide show

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html ADDED Viewed

@@ -0,0 +1,131 @@
+<!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: ZendeskAPI::Server
+    &mdash; Documentation by YARD 0.8.4.1
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!" + escape(window.location.href);
+</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 (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
+     &raquo;
+    <span class="title">Server</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: ZendeskAPI::Server
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/zendesk_api/server/html_renderer.rb<span class="defines">,<br />
+  lib/zendesk_api/server/base.rb,<br /> lib/zendesk_api/server/helper.rb,<br /> lib/zendesk_api/server/models/zlib_json.rb,<br /> lib/zendesk_api/server/models/user_request.rb</span>
+</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Modified from DoubleDoc <a
+href="https://github.com/staugaard/double_doc/blob/master/lib/double_doc/html_renderer.rb">github.com/staugaard/double_doc/blob/master/lib/double_doc/html_renderer.rb</a></p>
+  </div>
+</div>
+<div class="tags">
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Server/Helper.html" title="ZendeskAPI::Server::Helper (module)">Helper</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Server/App.html" title="ZendeskAPI::Server::App (class)">App</a></span>, <span class='object_link'><a href="Server/HtmlRenderer.html" title="ZendeskAPI::Server::HtmlRenderer (class)">HtmlRenderer</a></span>, <span class='object_link'><a href="Server/UserRequest.html" title="ZendeskAPI::Server::UserRequest (class)">UserRequest</a></span>, <span class='object_link'><a href="Server/ZlibJSON.html" title="ZendeskAPI::Server::ZlibJSON (class)">ZlibJSON</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Mon Feb 11 17:45:36 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.4.1 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html ADDED Viewed

@@ -0,0 +1,523 @@
+<!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>
+  Class: ZendeskAPI::Server::App
+    &mdash; Documentation by YARD 0.8.4.1
+</title>
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</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 (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Server.html" title="ZendeskAPI::Server (module)">Server</a></span></span>
+     &raquo;
+    <span class="title">App</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>Class: ZendeskAPI::Server::App
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Sinatra::Base</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Sinatra::Base</li>
+            <li class="next">ZendeskAPI::Server::App</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/zendesk_api/server/base.rb</dd>
+</dl>
+<div class="clear"></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="#%27%2F%27-instance_method" title="#'/' (instance method)">- (Boolean) <strong>'/'</strong>(options = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#%27%2F%3Aobject_id%27-instance_method" title="#'/:object_id' (instance method)">- (Boolean) <strong>'/:object_id'</strong>(options = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Success of this call.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#%27%2Fsearch%27-instance_method" title="#'/search' (instance method)">- (Boolean) <strong>'/search'</strong>(options = {}) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Success of this call.</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="'/'-instance_method">
+    - (<tt>Boolean</tt>) <strong>'/'</strong>(options = {})
+</h3><div class="docstring">
+  <div class="discussion">
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Options to pass to the request</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Options to pass to the request</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Success of this call</p>
+</div>
+    </li>
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Success of this call</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+67
+68
+69</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/server/base.rb', line 67</span>
+<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_haml'>haml</span> <span class='symbol'>:index</span><span class='comma'>,</span> <span class='symbol'>:format</span> <span class='op'>=&gt;</span> <span class='symbol'>:html5</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="'/:object_id'-instance_method">
+    - (<tt>Boolean</tt>) <strong>'/:object_id'</strong>(options = {})
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Success of this call</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Options to pass to the request</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Success of this call</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/server/base.rb', line 71</span>
+<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/:object_id</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
+  <span class='kw'>begin</span>
+    <span class='ivar'>@user_request</span> <span class='op'>=</span> <span class='const'>UserRequest</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='symbol'>:_id</span> <span class='op'>=&gt;</span> <span class='const'>Moped</span><span class='op'>::</span><span class='const'>BSON</span><span class='op'>::</span><span class='const'>ObjectId</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:object_id</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+  <span class='kw'>rescue</span> <span class='const'>Moped</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>InvalidObjectId</span><span class='semicolon'>;</span> <span class='kw'>end</span>
+  <span class='kw'>if</span> <span class='ivar'>@user_request</span>
+    <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>url</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
+    <span class='ivar'>@path</span> <span class='op'>=</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span>
+    <span class='ivar'>@method</span> <span class='op'>=</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span>
+    <span class='ivar'>@json</span> <span class='op'>=</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_json'>json</span>
+    <span class='ivar'>@url_params</span> <span class='op'>=</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_url_params'>url_params</span>
+    <span class='id identifier rubyid_set_request'>set_request</span><span class='lparen'>(</span><span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+    <span class='id identifier rubyid_set_response'>set_response</span><span class='lparen'>(</span><span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@user_request</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_haml'>haml</span> <span class='symbol'>:index</span><span class='comma'>,</span> <span class='symbol'>:format</span> <span class='op'>=&gt;</span> <span class='symbol'>:html5</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="'/search'-instance_method">
+    - (<tt>Boolean</tt>) <strong>'/search'</strong>(options = {})
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Success of this call</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>options</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Options to pass to the request</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Success of this call</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+91
+92
+93
+94
+95
+96
+97</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/server/base.rb', line 91</span>
+<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/search</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_md'>md</span> <span class='op'>=</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_documentation'>documentation</span><span class='lbracket'>[</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
+    <span class='id identifier rubyid_md'>md</span><span class='lbracket'>[</span><span class='symbol'>:body</span><span class='rbracket'>]</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_help'>help</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Mon Feb 11 17:45:41 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.4.1 (ruby-1.9.3).
+</div>
+  </body>
+</html>