ngrok-api 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e381b8c6f77364976fd9c107c5cd435b8b72a74f9e01b84a990eba6eb61746f
-  data.tar.gz: 79d3fc87e66c4e04a482f5140cfed3f028fb4b3361955adc8b7ef7d925622070
+  metadata.gz: 1ab5ceebe53e0641dcf20ff7d62d74e081fd349a62c3ee3bb6ed6023b61174d3
+  data.tar.gz: 195d75db8c7fe4d830c55637f3226a0bc283370e07ef79ff1c4e683cfbfff837
 SHA512:
-  metadata.gz: d30a021657a83ed0bf7c85b6b193934f41f02b2d86f4cf1cc4fbc85ebb2c607a57493e968eeaacbc48e83de2a202d2f8e9b96069cbc45790ca57a810e6fa3174
-  data.tar.gz: ad67e28b618df654e5019bdb20b0c8c77ff5974a99f58f4bf7c93f317ef7154f88877190c5ea7eea3a6ce9bb2e318fbe4c31a0248c4c8d023348a6a0f6599567
+  metadata.gz: c92971ebedeffe60f4227503884acaa4ab5ed74faaffef616b2cb4fac705a4dba992cd8a3c04b5c6316c808eb170d302129f0569d85461994569a5967c488a63
+  data.tar.gz: 226efb2dae11473f3bbd8b65ed04942ad09c3a10ae0d5f60f5f533a73cdbc3140093e51422f6204c9d905276ac7606613e42e85b698471cd3133b309e5731f2c

data/README.md

@@ -20,12 +20,39 @@ A quickstart guide and a full API reference are included in the [ngrok Ruby API
 Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
 
 ```ruby
-require 'ngrokapi/client'
+require 'ngrokapi'
 client = NgrokAPI::Client.new(api_key: '<API KEY>')
 
 # Get an instance of the api_keys client and list all API keys
 keys_client = client.api_keys
 keys_client.list
+
+# Or set up an edge and backend with the ability to change your configuration later
+edge = client.edges.https.create!(
+  description: "A Ruby Created Edge",
+  metadata: '{"client": "ruby"}',
+  hostports: ["your-subdomain.ngrok.io:443"]
+)
+
+backend = client.backends.tunnel_group.create!(
+  description: "A Ruby Created Backend",
+  labels: {"client_example": "ruby"}
+)
+
+route = client.edges.https_routes.create!(
+  edge_id: edge.id,
+  match_type: "path_prefix",
+  match: "/",
+  description: "Root",
+  backend: NgrokAPI::Models::EndpointBackendMutate.new(attrs: {"enabled": true, "backend_id": backend.id}),
+  compression: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": true})
+)
+
+client.edge_modules.https_edge_route_compression.replace!(
+  edge_id: edge.id,
+  id: route.id,
+  a_module: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": false})
+)
 ```
 
 ## Local Documentation

data/doc/NgrokAPI/Client.html

@@ -1966,7 +1966,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 10 16:54:38 2022 by
+  Generated on Mon Apr 11 19:32:55 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-2.7.5).
 </div>

data/doc/NgrokAPI/Error.html

@@ -295,7 +295,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 10 16:54:38 2022 by
+  Generated on Mon Apr 11 19:32:55 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-2.7.5).
 </div>

data/doc/NgrokAPI/Errors/NotFoundError.html

@@ -299,7 +299,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 10 16:54:40 2022 by
+  Generated on Mon Apr 11 19:32:57 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-2.7.5).
 </div>

data/doc/NgrokAPI/Errors.html

@@ -105,7 +105,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 10 16:54:38 2022 by
+  Generated on Mon Apr 11 19:32:55 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-2.7.5).
 </div>

data/doc/NgrokAPI/HttpClient.html

@@ -331,6 +331,30 @@
 <p>Make a POST request to a given URI with optional data.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, danger: false, data: {})  &#x21d2; json </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Make a PUT request to a given URI with optional data.</p>
+</div></span>
+  
 </li>
 
       
@@ -993,7 +1017,7 @@
 <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Patch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1112,7 +1136,126 @@
 <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="put-instance_method">
+  
+    #<strong>put</strong>(path, danger: false, data: {})  &#x21d2; <tt>json</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Make a PUT request to a given URI with optional data</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>path</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>URL resource path</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>danger</span>
+      
+      
+        <span class='type'>(<tt>boolean</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>false</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>determine if we should throw an exception on 404 or not</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>data</span>
+      
+      
+        <span class='type'>(<tt>hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>hash which will be converted to query parameters or form data</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>json</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>response body</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+95
+96
+97
+98
+99</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 95</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Put</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1124,7 +1267,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 10 16:54:39 2022 by
+  Generated on Mon Apr 11 19:32:56 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.27 (ruby-2.7.5).
 </div>