RubyGems - zendesk_api - Versions diffs - 0.3.14 → 0.4.0.rc1 - Mend

zendesk_api 0.3.14 → 0.4.0.rc1

Files changed (141) hide show

data/.yardopts +6 -2
data/Gemfile +3 -2
data/Gemfile.lock +4 -4
data/Readme.md +3 -268
data/lib/zendesk_api/actions.rb +51 -46
data/lib/zendesk_api/association.rb +1 -1
data/lib/zendesk_api/associations.rb +2 -6
data/lib/zendesk_api/client.rb +8 -9
data/lib/zendesk_api/collection.rb +84 -50
data/lib/zendesk_api/configuration.rb +4 -0
data/lib/zendesk_api/error.rb +22 -0
data/lib/zendesk_api/middleware/request/etag_cache.rb +1 -7
data/lib/zendesk_api/middleware/request/upload.rb +1 -2
data/lib/zendesk_api/middleware/response/raise_error.rb +20 -0
data/lib/zendesk_api/resource.rb +33 -5
data/lib/zendesk_api/resources.rb +36 -11
data/lib/zendesk_api/server/base.rb +1 -1
data/lib/zendesk_api/server/helper.rb +3 -3
data/lib/zendesk_api/server/models/zlib_json.rb +1 -1
data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +7 -7
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +414 -51
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +321 -25
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +413 -46
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +389 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +410 -47
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +98 -362
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +457 -676
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +110 -20
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +264 -6
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +43 -82
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +671 -15
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +207 -233
data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +499 -24
data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +614 -15
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +73 -23
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +68 -18
data/lib/zendesk_api/server/public/doc/ZendeskAPI/{FormatError.html → Error.html} +19 -27
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +127 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/{Server/UserRequest.html → Error/NetworkError.html} +18 -16
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +371 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +127 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +426 -63
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +414 -51
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +389 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +414 -51
data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +405 -16
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +405 -16
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +413 -46
data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +404 -41
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +606 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +810 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +422 -59
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +606 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +75 -12
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +593 -16
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +418 -55
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +420 -31
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +1025 -20
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +610 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +317 -21
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +428 -39
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +63 -79
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +34 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +305 -9
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +433 -41
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +405 -16
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +389 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +600 -31
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +464 -101
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +427 -25
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +435 -32
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +389 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +389 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +592 -15
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +427 -64
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +907 -17
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +414 -55
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +325 -29
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +414 -51
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +413 -46
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +258 -6
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +62 -12
data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +671 -15
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +800 -28
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +505 -142
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +412 -49
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +475 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +606 -0
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +9 -15
data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +433 -66
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +415 -13
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +451 -49
data/lib/zendesk_api/server/public/doc/_index.html +72 -72
data/lib/zendesk_api/server/public/doc/class_list.html +1 -1
data/lib/zendesk_api/server/public/doc/css/style.css +10 -0
data/lib/zendesk_api/server/public/doc/file.Readme.html +20 -260
data/lib/zendesk_api/server/public/doc/file_list.html +1 -1
data/lib/zendesk_api/server/public/doc/frames.html +1 -1
data/lib/zendesk_api/server/public/doc/index.html +20 -260
data/lib/zendesk_api/server/public/doc/method_list.html +309 -517
data/lib/zendesk_api/server/public/doc/top-level-namespace.html +3 -35
data/lib/zendesk_api/verbs.rb +0 -4
data/lib/zendesk_api/version.rb +1 -1
data/spec/core/client_spec.rb +53 -13
data/spec/core/collection_spec.rb +32 -4
data/spec/core/create_resource_spec.rb +1 -1
data/spec/core/data_resource_spec.rb +2 -2
data/spec/core/middleware/request/etag_cache_spec.rb +6 -7
data/spec/core/middleware/request/upload_spec.rb +2 -10
data/spec/core/middleware/response/callback_spec.rb +1 -1
data/spec/core/middleware/response/raise_error_spec.rb +40 -0
data/spec/core/read_resource_spec.rb +0 -2
data/spec/core/resource_spec.rb +13 -5
data/spec/core/search_spec.rb +1 -1
data/spec/core/spec_helper.rb +3 -3
data/spec/live/automation_spec.rb +23 -0
data/spec/live/organization_field_spec.rb +12 -0
data/spec/live/ticket_spec.rb +8 -2
data/spec/live/trigger_spec.rb +23 -0
data/spec/live/user_field_spec.rb +12 -0
data/spec/live/user_spec.rb +0 -2
data/spec/live/view_spec.rb +17 -1
data/spec/server/spec_helper.rb +2 -2
data/zendesk_api.gemspec +1 -1
metadata +88 -51
checksums.yaml +0 -7
data/lib/zendesk_api/rescue.rb +0 -63
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +0 -860
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +0 -190
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +0 -131
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +0 -523
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +0 -684
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +0 -303
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +0 -508
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +0 -244
data/spec/core/rescue_spec.rb +0 -151

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html DELETED Viewed

@@ -1,190 +0,0 @@
-<!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::Console::Eval
-    &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 (E)</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="../Console.html" title="ZendeskAPI::Console (module)">Console</a></span></span>
-     &raquo;
-    <span class="title">Eval</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::Console::Eval
-</h1>
-<dl class="box">
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/zendesk_api/console/console.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="#loop_eval-instance_method" title="#loop_eval (instance method)">- (Object) <strong>loop_eval</strong>(str) </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="loop_eval-instance_method">
-    - (<tt>Object</tt>) <strong>loop_eval</strong>(str)
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/console.rb', line 11</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_loop_eval'>loop_eval</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_split'>split</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*\/\s*</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_split'>split</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_split'>split</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
-    <span class='id identifier rubyid_s'>s</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\d+</span><span class='regexp_end'>/</span></span> <span class='op'>?</span> <span class='id identifier rubyid_s'>s</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_s'>s</span><span class='rbrace'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_split'>split</span> <span class='op'>=</span> <span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_split'>split</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span>
-  <span class='comment'># puts ZendeskAPI::Console::ZD_DIRUP
-</span>  <span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.\.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ZendeskAPI::Console::ZD_DIRUP</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_split'>split</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</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.html DELETED Viewed

@@ -1,131 +0,0 @@
-<!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 DELETED Viewed

@@ -1,523 +0,0 @@
-<!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>