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

ngrok-api 0.9.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 (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/Error.html ADDED Viewed

@@ -0,0 +1,305 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: NgrokAPI::Error
+    &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::Error";
+  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 (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
+     &raquo;
+    <span class="title">Error</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: NgrokAPI::Error
+</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">NgrokAPI::Error</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/error.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Base Error class for all Ngrok Errors</p>
+  </div>
+</div>
+<div class="tags">
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NgrokAPI::Errors::NotFoundError</a></span></p>
+</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="#response-instance_method" title="#response (instance method)">#<strong>response</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 response.</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)">#<strong>initialize</strong>(msg: &quot;An error occurred with the NgrokAPI&quot;, response: nil)  &#x21d2; Error </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Error.</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>(msg: &quot;An error occurred with the NgrokAPI&quot;, response: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Error (class)">Error</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of Error.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line 9</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>An error occurred with the NgrokAPI</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</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=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="response-instance_method">
+    #<strong>response</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute response.</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/error.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='ivar'>@response</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>

data/doc/NgrokAPI/Errors/NotFoundError.html ADDED Viewed

@@ -0,0 +1,309 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: NgrokAPI::Errors::NotFoundError
+    &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::Errors::NotFoundError";
+  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 (N)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span></span>
+     &raquo;
+    <span class="title">NotFoundError</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: NgrokAPI::Errors::NotFoundError
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="../Error.html" title="NgrokAPI::Error (class)">NgrokAPI::Error</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">StandardError</li>
+            <li class="next"><span class='object_link'><a href="../Error.html" title="NgrokAPI::Error (class)">NgrokAPI::Error</a></span></li>
+            <li class="next">NgrokAPI::Errors::NotFoundError</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/errors/not_found_error.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Error representing a 404 not found</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="#response-instance_method" title="#response (instance method)">#<strong>response</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 response.</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)">#<strong>initialize</strong>(msg: &quot;Resource not found&quot;, response: nil)  &#x21d2; NotFoundError </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of NotFoundError.</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>(msg: &quot;Resource not found&quot;, response: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of NotFoundError.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+10
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/errors/not_found_error.rb', line 10</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Resource not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='id identifier rubyid_msg'>msg</span><span class='comma'>,</span> <span class='label'>response:</span> <span class='id identifier rubyid_response'>response</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=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="response-instance_method">
+    #<strong>response</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute response.</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/errors/not_found_error.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='ivar'>@response</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>