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

zendesk_api 0.2.6 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (121) hide show

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

@@ -0,0 +1,1212 @@
+<!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::Configuration
+    &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 (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
+     &raquo;
+    <span class="title">Configuration</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::Configuration
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">ZendeskAPI::Configuration</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/zendesk_api/configuration.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Holds the configuration options for the client and connection</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#adapter-instance_method" title="#adapter (instance method)">- (Symbol) <strong>adapter</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Faraday adapter.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#allow_http-instance_method" title="#allow_http (instance method)">- (Boolean) <strong>allow_http</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Whether to allow non-HTTPS connections for development purposes.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#cache-instance_method" title="#cache (instance method)">- (ZendeskAPI::LRUCache) <strong>cache</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Use this cache instead of default ZendeskAPI::LRUCache.new</p>
+<ul><li>
+<p>must respond to read/write/fetch e.g.</p>
+</li></ul>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#client_options-instance_method" title="#client_options (instance method)">- (Hash) <strong>client_options</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Client configurations (eg ssh config) to pass to Faraday.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#logger-instance_method" title="#logger (instance method)">- (Logger) <strong>logger</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Logger to use when logging requests.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#password-instance_method" title="#password (instance method)">- (String) <strong>password</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>The basic auth password.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#retry-instance_method" title="#retry (instance method)">- (Boolean) <strong>retry</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Whether to attempt to retry when rate-limited (http status: 429).</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#token-instance_method" title="#token (instance method)">- (String) <strong>token</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>The basic auth token.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#url-instance_method" title="#url (instance method)">- (String) <strong>url</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>The API url.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#username-instance_method" title="#username (instance method)">- (String) <strong>username</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>The basic auth username.</p>
+</div></span>
+</li>
+  </ul>
+    <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="#initialize-instance_method" title="#initialize (instance method)">- (Configuration) <strong>initialize</strong> </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Configuration.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#options-instance_method" title="#options (instance method)">- (Hash) <strong>options</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Sets accept and user_agent headers, and url.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="ZendeskAPI::Configuration (class)">Configuration</a></span></tt>) <strong>initialize</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>A new instance of Configuration</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+37
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 37</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+  <span class='ivar'>@client_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cache'>cache</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>LRUCache</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>1000</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="adapter=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="adapter-instance_method">
+    - (<tt>Symbol</tt>) <strong>adapter</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Faraday adapter</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Symbol</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Faraday adapter</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 26</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_adapter'>adapter</span>
+  <span class='ivar'>@adapter</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="allow_http=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="allow_http-instance_method">
+    - (<tt>Boolean</tt>) <strong>allow_http</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Whether to allow non-HTTPS connections for development purposes.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Whether to allow non-HTTPS connections for development purposes.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 29</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_allow_http'>allow_http</span>
+  <span class='ivar'>@allow_http</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="cache=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="cache-instance_method">
+    - (<tt><span class='object_link'>ZendeskAPI::LRUCache</span></tt>) <strong>cache</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Use this cache instead of default ZendeskAPI::LRUCache.new</p>
+<ul><li>
+<p>must respond to read/write/fetch e.g.
+ActiveSupport::Cache::MemoryStore.new)</p>
+</li><li>
+<p>pass false to disable caching</p>
+</li></ul>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'>ZendeskAPI::LRUCache</span></tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 35</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span>
+  <span class='ivar'>@cache</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="client_options=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="client_options-instance_method">
+    - (<tt>Hash</tt>) <strong>client_options</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Client configurations (eg ssh config) to pass to Faraday</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Client configurations (eg ssh config) to pass to Faraday</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 23</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_client_options'>client_options</span>
+  <span class='ivar'>@client_options</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="logger=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="logger-instance_method">
+    - (<tt>Logger</tt>) <strong>logger</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Logger to use when logging requests.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Logger</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Logger to use when logging requests.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 20</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
+  <span class='ivar'>@logger</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="password=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="password-instance_method">
+    - (<tt>String</tt>) <strong>password</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>The basic auth password.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The basic auth password.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span>
+  <span class='ivar'>@password</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="retry=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="retry-instance_method">
+    - (<tt>Boolean</tt>) <strong>retry</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Whether to attempt to retry when rate-limited (http status: 429).</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Whether to attempt to retry when rate-limited (http status: 429).</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 17</span>
+<span class='kw'>def</span> <span class='kw'>retry</span>
+  <span class='ivar'>@retry</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="token=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="token-instance_method">
+    - (<tt>String</tt>) <strong>token</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>The basic auth token.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The basic auth token.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 11</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
+  <span class='ivar'>@token</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="url=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="url-instance_method">
+    - (<tt>String</tt>) <strong>url</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>The API url. Must be https unless <span class='object_link'><a href="#allow_http-instance_method" title="ZendeskAPI::Configuration#allow_http (method)">#allow_http</a></span> is set.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The API url. Must be https unless <span class='object_link'><a href="#allow_http-instance_method" title="ZendeskAPI::Configuration#allow_http (method)">#allow_http</a></span> is set.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 14</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
+  <span class='ivar'>@url</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="username=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="username-instance_method">
+    - (<tt>String</tt>) <strong>username</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>The basic auth username.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>The basic auth username.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+5
+6
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 5</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span>
+  <span class='ivar'>@username</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="options-instance_method">
+    - (<tt>Hash</tt>) <strong>options</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Sets accept and user_agent headers, and url.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Faraday-formatted hash of options.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/configuration.rb', line 45</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
+  <span class='lbrace'>{</span>
+    <span class='symbol'>:headers</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
+      <span class='symbol'>:accept</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+      <span class='symbol'>:accept_encoding</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gzip;q=1.0,deflate;q=0.6,identity;q=0.3</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+      <span class='symbol'>:user_agent</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ZendeskAPI API </span><span class='embexpr_beg'>#{</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>VERSION</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
+    <span class='rbrace'>}</span><span class='comma'>,</span>
+    <span class='symbol'>:url</span> <span class='op'>=&gt;</span> <span class='ivar'>@url</span>
+  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_client_options'>client_options</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: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>