RubyGems - ngrok-api - Versions diffs - 0.9.0 - Mend

ngrok-api 0.9.0

Files changed (100) hide show

checksums.yaml +7 -0
data/.github/workflows/ci.yml +21 -0
data/.gitignore +13 -0
data/.rubocop.yml +28 -0
data/.rubocop_airbnb.yml +2 -0
data/.simplecov +1 -0
data/Gemfile +33 -0
data/Guardfile +16 -0
data/README.md +61 -0
data/Rakefile +7 -0
data/doc/NgrokAPI/Client.html +542 -0
data/doc/NgrokAPI/Error.html +305 -0
data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
data/doc/NgrokAPI/Errors.html +115 -0
data/doc/NgrokAPI/HttpClient.html +1104 -0
data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/doc/NgrokAPI/Models/Listable.html +934 -0
data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/doc/NgrokAPI/Models.html +117 -0
data/doc/NgrokAPI/PagedIterator.html +631 -0
data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/doc/NgrokAPI/Services.html +117 -0
data/doc/NgrokAPI.html +157 -0
data/doc/_index.html +309 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +126 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +126 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1227 -0
data/doc/top-level-namespace.html +110 -0
data/docs/NgrokAPI/Client.html +542 -0
data/docs/NgrokAPI/Error.html +305 -0
data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
data/docs/NgrokAPI/Errors.html +115 -0
data/docs/NgrokAPI/HttpClient.html +1104 -0
data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/docs/NgrokAPI/Models/Listable.html +934 -0
data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/docs/NgrokAPI/Models.html +117 -0
data/docs/NgrokAPI/PagedIterator.html +631 -0
data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/docs/NgrokAPI/Services.html +117 -0
data/docs/NgrokAPI.html +157 -0
data/docs/_index.html +309 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +497 -0
data/docs/file.README.html +126 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +126 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +1227 -0
data/docs/top-level-namespace.html +110 -0
data/lib/ngrokapi/client.rb +49 -0
data/lib/ngrokapi/error.rb +14 -0
data/lib/ngrokapi/errors/not_found_error.rb +16 -0
data/lib/ngrokapi/http_client.rb +132 -0
data/lib/ngrokapi/models/api_key.rb +64 -0
data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
data/lib/ngrokapi/models/listable.rb +42 -0
data/lib/ngrokapi/models/reserved_domain.rb +211 -0
data/lib/ngrokapi/models/tls_certificate.rb +62 -0
data/lib/ngrokapi/paged_iterator.rb +40 -0
data/lib/ngrokapi/services/api_keys_client.rb +144 -0
data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
data/lib/ngrokapi/version.rb +7 -0
data/lib/ngrokapi.rb +13 -0
data/ngrok-api.gemspec +27 -0
data/spec/ngrokapi/client_spec.rb +33 -0
data/spec/ngrokapi/http_client_spec.rb +75 -0
data/spec/ngrokapi/models/api_key_spec.rb +43 -0
data/spec/ngrokapi/models/listable_spec.rb +43 -0
data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
data/spec/spec_helper.rb +80 -0
metadata +144 -0

data/doc/NgrokAPI/PagedIterator.html ADDED Viewed

@@ -0,0 +1,631 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: NgrokAPI::PagedIterator
+    &mdash; Documentation by YARD 0.9.26
+</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 = "NgrokAPI::PagedIterator";
+  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 (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
+     &raquo;
+    <span class="title">PagedIterator</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>Class: NgrokAPI::PagedIterator
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">NgrokAPI::PagedIterator</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/paged_iterator.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Low level class which allows the user to iterate through the results of a list API call</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="#client-instance_method" title="#client (instance method)">#<strong>client</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute client.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#list_property-instance_method" title="#list_property (instance method)">#<strong>list_property</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute list_property.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#n-instance_method" title="#n (instance method)">#<strong>n</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute n.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#page-instance_method" title="#page (instance method)">#<strong>page</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute page.</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="#get_next-instance_method" title="#get_next (instance method)">#<strong>get_next</strong>  &#x21d2; object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, page:, list_property:)  &#x21d2; PagedIterator </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of PagedIterator.</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">
+    #<strong>initialize</strong>(client:, page:, list_property:)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of PagedIterator.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 10</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
+  <span class='label'>client:</span><span class='comma'>,</span>
+  <span class='label'>page:</span><span class='comma'>,</span>
+  <span class='label'>list_property:</span>
+<span class='rparen'>)</span>
+  <span class='ivar'>@n</span> <span class='op'>=</span> <span class='int'>0</span>
+  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
+  <span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span>
+  <span class='ivar'>@page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</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=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="client-instance_method">
+    #<strong>client</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute client.</p>
+  </div>
+</div>
+<div class="tags">
+</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/ngrokapi/paged_iterator.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
+  <span class='ivar'>@client</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="list_property-instance_method">
+    #<strong>list_property</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute list_property.</p>
+  </div>
+</div>
+<div class="tags">
+</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/ngrokapi/paged_iterator.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_list_property'>list_property</span>
+  <span class='ivar'>@list_property</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="n=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="n-instance_method">
+    #<strong>n</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute n.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_n'>n</span>
+  <span class='ivar'>@n</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="page=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="page-instance_method">
+    #<strong>page</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute page.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span>
+  <span class='ivar'>@page</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="get_next-instance_method">
+    #<strong>get_next</strong>  &#x21d2; <tt>object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>object</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>Returns an instance of a class.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 26</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get_next'>get_next</span>
+  <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='ivar'>@list_property</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='ivar'>@n</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>None</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>+=</span> <span class='int'>1</span>
+  <span class='id identifier rubyid_item'>item</span>
+<span class='kw'>rescue</span>
+  <span class='kw'>if</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span>
+    <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='int'>0</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span>
+    <span class='id identifier rubyid_get_next'>get_next</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri Sep 24 19:20:29 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.1).
+</div>
+    </div>
+  </body>
+</html>