ngrok-api 0.18.0 → 0.19.0

data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TCPEdgeBackendModuleClient do
       replacements = {
         id: endpoint_backend_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_backend_result)
       result = @tcp_edge_backend_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TCPEdgeBackendModuleClient do
       replacements = {
         id: endpoint_backend_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_backend_result)
       result = @tcp_edge_backend_module_client.replace(

data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient do
       replacements = {
         id: endpoint_ip_policy_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_ip_policy_result)
       result = @tcp_edge_ip_restriction_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient do
       replacements = {
         id: endpoint_ip_policy_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_ip_policy_result)
       result = @tcp_edge_ip_restriction_module_client.replace(

data/spec/ngrokapi/services/tls_certificates_client_spec.rb

@@ -34,6 +34,29 @@ RSpec.describe NgrokAPI::Services::TLSCertificatesClient do
     end
   end
 
+  describe "#create!" do
+    it "will make a post request and return an instance of NgrokAPI::Models::TLSCertificate" do
+      path = '/tls_certificates'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:certificate_pem] = "New certificate_pem"
+      data[:private_key_pem] = "New private_key_pem"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(tls_certificate_result)
+      result = @tls_certificates_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        certificate_pem: "New certificate_pem",
+        private_key_pem: "New private_key_pem"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSCertificate)
+      # expect(result.id).to eq(tls_certificate_result["id"])
+    end
+  end
+
   describe "#delete" do
     it "will make a delete request" do
       path = '/tls_certificates/%{id}'

data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeBackendModuleClient do
       replacements = {
         id: endpoint_backend_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_backend_result)
       result = @tls_edge_backend_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeBackendModuleClient do
       replacements = {
         id: endpoint_backend_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_backend_result)
       result = @tls_edge_backend_module_client.replace(

data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient do
       replacements = {
         id: endpoint_ip_policy_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_ip_policy_result)
       result = @tls_edge_ip_restriction_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient do
       replacements = {
         id: endpoint_ip_policy_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_ip_policy_result)
       result = @tls_edge_ip_restriction_module_client.replace(

data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeMutualTLSModuleClient do
       replacements = {
         id: endpoint_mutual_tls_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_mutual_tls_result)
       result = @tls_edge_mutual_tls_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeMutualTLSModuleClient do
       replacements = {
         id: endpoint_mutual_tls_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_mutual_tls_result)
       result = @tls_edge_mutual_tls_module_client.replace(

data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb

@@ -18,8 +18,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient do
       replacements = {
         id: endpoint_tls_termination_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_tls_termination_result)
       result = @tls_edge_tls_termination_module_client.replace(
@@ -36,8 +35,7 @@ RSpec.describe NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient do
       replacements = {
         id: endpoint_tls_termination_result["id"],
       }
-      data = {}
-      data[:module] = "New a_module"
+      data = "New a_module"
       expect(@client).to receive(:put).with(path % replacements, data: data).
         and_return(endpoint_tls_termination_result)
       result = @tls_edge_tls_termination_module_client.replace(

data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb

@@ -32,6 +32,27 @@ RSpec.describe NgrokAPI::Services::TunnelGroupBackendsClient do
     end
   end
 
+  describe "#create!" do
+    it "will make a post request and return an instance of NgrokAPI::Models::TunnelGroupBackend" do
+      path = '/backends/tunnel_group'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:labels] = "New labels"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(tunnel_group_backend_result)
+      result = @tunnel_group_backends_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        labels: "New labels"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TunnelGroupBackend)
+      # expect(result.id).to eq(tunnel_group_backend_result["id"])
+    end
+  end
+
   describe "#delete" do
     it "will make a delete request" do
       path = '/backends/tunnel_group/%{id}'

data/spec/ngrokapi/services/weighted_backends_client_spec.rb

@@ -32,6 +32,27 @@ RSpec.describe NgrokAPI::Services::WeightedBackendsClient do
     end
   end
 
+  describe "#create!" do
+    it "will make a post request and return an instance of NgrokAPI::Models::WeightedBackend" do
+      path = '/backends/weighted'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:backends] = "New backends"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(weighted_backend_result)
+      result = @weighted_backends_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        backends: "New backends"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::WeightedBackend)
+      # expect(result.id).to eq(weighted_backend_result["id"])
+    end
+  end
+
   describe "#delete" do
     it "will make a delete request" do
       path = '/backends/weighted/%{id}'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-api
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - ''
@@ -155,7 +155,6 @@ files:
 - doc/NgrokAPI/Services/TunnelSessionsClient.html
 - doc/NgrokAPI/Services/TunnelsClient.html
 - doc/NgrokAPI/Services/WeightedBackendsClient.html
-- doc/README
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -297,7 +296,6 @@ files:
 - docs/NgrokAPI/Services/TunnelSessionsClient.html
 - docs/NgrokAPI/Services/TunnelsClient.html
 - docs/NgrokAPI/Services/WeightedBackendsClient.html
-- docs/README
 - docs/_index.html
 - docs/class_list.html
 - docs/css/common.css

data/doc/README

@@ -1,94 +0,0 @@
-# ngrok-api
-
-This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
-easier to consume in Ruby.
-
-## Installation
-
-This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
-
-```ruby
-gem install ngrok-api
-```
-
-## Quickstart
-
-Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
-
-```ruby
-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
-```
-
-## Automatic Paging
-
-The ngrok API pages all list resources but this library abstracts that away
-from you. All response objects from any ``list`` or ``list!`` methods return an object that
-implements an ``each`` method which will automatically fetch additional
-pages for you.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# list all api keys, transparently fetching additional
-# pages for you if necessary
-keys_client = client.api_keys
-keys_client.list.each do |key|
-  puts(key)
-end
-```
-
-## Instance Methods
-
-Instance methods like ``update`` and ``delete`` can be invoked on an instance of an
-API object itself as well as directly without needing to first fetch the object.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# update the metadata of a credential
-cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz')
-cred.update(metadata: {server_name: 'giraffe-1'}.to_json)
-
-# or do it in single call
-cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json)
-```
-
-## Bang Methods
-Most methods that interact with the API have a `!` counterpart. It raises an error when
-one is returned by the API.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# no error raised, even though it's a bad identifier
-# the error is simply returned
-cred = client.credentials.get(id: 'invalid')
-
-# this raises an NgrokAPI::Error
-cred = client.credentials.get!(id: 'invalid')
-```
-
-## Error Handling
-
-The ngrok API returns detailed information when an API call fails. Consult the
-section on errors for additional details.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-begin
-    client.ip_policies.get!(id: 'invalid')
-rescue NgrokAPI::Error => e
-    puts(e)
-    puts(e.response.to_s)
-end
-```

data/docs/README

@@ -1,94 +0,0 @@
-# ngrok-api
-
-This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
-easier to consume in Ruby.
-
-## Installation
-
-This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
-
-```ruby
-gem install ngrok-api
-```
-
-## Quickstart
-
-Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
-
-```ruby
-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
-```
-
-## Automatic Paging
-
-The ngrok API pages all list resources but this library abstracts that away
-from you. All response objects from any ``list`` or ``list!`` methods return an object that
-implements an ``each`` method which will automatically fetch additional
-pages for you.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# list all api keys, transparently fetching additional
-# pages for you if necessary
-keys_client = client.api_keys
-keys_client.list.each do |key|
-  puts(key)
-end
-```
-
-## Instance Methods
-
-Instance methods like ``update`` and ``delete`` can be invoked on an instance of an
-API object itself as well as directly without needing to first fetch the object.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# update the metadata of a credential
-cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz')
-cred.update(metadata: {server_name: 'giraffe-1'}.to_json)
-
-# or do it in single call
-cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json)
-```
-
-## Bang Methods
-Most methods that interact with the API have a `!` counterpart. It raises an error when
-one is returned by the API.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# no error raised, even though it's a bad identifier
-# the error is simply returned
-cred = client.credentials.get(id: 'invalid')
-
-# this raises an NgrokAPI::Error
-cred = client.credentials.get!(id: 'invalid')
-```
-
-## Error Handling
-
-The ngrok API returns detailed information when an API call fails. Consult the
-section on errors for additional details.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-begin
-    client.ip_policies.get!(id: 'invalid')
-rescue NgrokAPI::Error => e
-    puts(e)
-    puts(e.response.to_s)
-end
-```