ngrok-api 0.24.0 → 0.25.0

data/spec/ngrokapi/services/vaults_client_spec.rb

@@ -0,0 +1,186 @@
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::VaultsClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/vaults' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: vault_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @vaults_client = NgrokAPI::Services::VaultsClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults'
+      replacements = {
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:metadata] = "New metadata"
+      data[:description] = "New description"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.create(
+        name: "New name",
+        metadata: "New metadata",
+        description: "New description"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+    end
+  end
+
+  describe "#create!" do
+    it "will make a post request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults'
+      replacements = {
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:metadata] = "New metadata"
+      data[:description] = "New description"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.create(
+        name: "New name",
+        metadata: "New metadata",
+        description: "New description"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+      # expect(result.id).to eq(vault_result["id"])
+    end
+  end
+
+  describe "#update" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: vault_result["id"],
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:metadata] = "New metadata"
+      data[:description] = "New description"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.update(
+        id: vault_result["id"],
+        name: "New name",
+        metadata: "New metadata",
+        description: "New description"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: vault_result["id"],
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:metadata] = "New metadata"
+      data[:description] = "New description"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.update(
+        id: vault_result["id"],
+        name: "New name",
+        metadata: "New metadata",
+        description: "New description"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+      # expect(result.id).to eq(vault_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @vaults_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @vaults_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect do
+        expect(@client).to receive(:delete).with(path % replacements, danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result = @vaults_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: vault_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.get(
+        id: vault_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Vault" do
+      path = '/vaults/%{id}'
+      replacements = {
+        id: vault_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(vault_result)
+      result = @vaults_client.get(
+        id: vault_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Vault)
+      # expect(result.id).to eq(vault_result["id"])
+    end
+  end
+
+  describe "#list" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      expect(@client).to receive(:list).
+        and_return(vault_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @vaults_client.list(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -905,6 +905,59 @@ def ip_restriction_results
   }
 end
 
+def kubernetes_operator_binding_create_result
+  {
+  }
+end
+
+def kubernetes_operator_binding_result
+  {
+  }
+end
+
+def kubernetes_operator_binding_update_result
+  {
+  }
+end
+
+def kubernetes_operator_cert_result
+  {
+  }
+end
+
+def kubernetes_operator_deployment_result
+  {
+  }
+end
+
+def kubernetes_operator_deployment_update_result
+  {
+  }
+end
+
+def kubernetes_operator_result
+  {
+    "id" => "ko_1rV3S8JZQ9vZ2J5Z8Z8Z8Z8Z8Z8",
+    "uri" => "https://api.ngrok.com/kubernetes_operators/ko_1rV3S8JZQ9vZ2J5Z8Z8Z8Z8Z8Z",
+  }
+end
+
+def kubernetes_operator_results
+  {
+    "operators" => [
+      kubernetes_operator_result,
+    ],
+    "uri" => "https://api.ngrok.com/kubernetes_operators",
+    "next_page_uri" => nil,
+  }
+end
+
+def kubernetes_operators_get_bound_endpoints_input
+  {
+    "id" => kubernetes_operator_result["id"],
+  }
+end
+
 def ref_result
   {
   }
@@ -1538,3 +1591,67 @@ def weighted_backend_results
     "next_page_uri" => nil,
   }
 end
+
+def secret_result
+  {
+    "id" => "secret_2y0arDtaBNqxT0gSw2pfBObOjgc",
+    "uri" => "https://api.ngrok.com.lan/vault_secrets/secret_2y0arDtaBNqxT0gSw2pfBObOjgc",
+    "name" => "foooooo-updated",
+    "description" => "Updated secret after rotation",
+    "metadata" => "env=prod,rotation=2025",
+    "created_at" => "2025-06-03T18:09:00Z",
+    "updated_at" => "2025-06-03T19:00:00Z",
+    "created_by" => {
+      "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3",
+      "uri" => "",
+    },
+    "last_updated_by" => {
+      "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3",
+      "uri" => "",
+    },
+    "vault" => {
+      "id" => "vault_2y0YkHvDtItsU4xNJpBPGx8EW2K",
+      "uri" => "https://api.ngrok.com.lan/vaults/vault_2y0YkHvDtItsU4xNJpBPGx8EW2K",
+    },
+  }
+end
+
+def secret_results
+  {
+    "secrets" => [
+      secret_result,
+    ],
+    "uri" => "https://api.ngrok.com.lan/vault_secrets",
+    "next_page_uri" => nil,
+  }
+end
+
+def vault_result
+  {
+    "id" => "vault_2xxf3F5QAzvG3OZYm7xyZ2Nhpkb",
+    "uri" => "https://api.ngrok.com.lan/vaults/vault_2xxf3F5QAzvG3OZYm7xyZ2Nhpkb",
+    "name" => "foo-renamed",
+    "description" => "Updated vault for prod environment",
+    "metadata" => "env=prod,team=secops",
+    "created_at" => "2025-06-02T17:14:03Z",
+    "updated_at" => "2025-06-03T10:25:00Z",
+    "created_by" => {
+      "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3",
+      "uri" => "",
+    },
+    "last_updated_by" => {
+      "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3",
+      "uri" => "",
+    },
+  }
+end
+
+def vault_results
+  {
+    "vaults" => [
+      vault_result,
+    ],
+    "uri" => "https://api.ngrok.com.lan/vaults",
+    "next_page_uri" => nil,
+  }
+end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-api
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - ''
-autorequire:
 bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
@@ -120,6 +119,7 @@ files:
 - doc/NgrokAPI/Models/SSHCredential.html
 - doc/NgrokAPI/Models/SSHHostCertificate.html
 - doc/NgrokAPI/Models/SSHUserCertificate.html
+- doc/NgrokAPI/Models/Secret.html
 - doc/NgrokAPI/Models/StaticBackend.html
 - doc/NgrokAPI/Models/StaticBackendTLS.html
 - doc/NgrokAPI/Models/TCPEdge.html
@@ -130,6 +130,7 @@ files:
 - doc/NgrokAPI/Models/TunnelGroupBackend.html
 - doc/NgrokAPI/Models/TunnelSession.html
 - doc/NgrokAPI/Models/UserAgent.html
+- doc/NgrokAPI/Models/Vault.html
 - doc/NgrokAPI/Models/WeightedBackend.html
 - doc/NgrokAPI/PagedIterator.html
 - doc/NgrokAPI/Services.html
@@ -176,6 +177,7 @@ files:
 - doc/NgrokAPI/Services/SSHCredentialsClient.html
 - doc/NgrokAPI/Services/SSHHostCertificatesClient.html
 - doc/NgrokAPI/Services/SSHUserCertificatesClient.html
+- doc/NgrokAPI/Services/SecretsClient.html
 - doc/NgrokAPI/Services/StaticBackendsClient.html
 - doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html
 - doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html
@@ -191,6 +193,7 @@ files:
 - doc/NgrokAPI/Services/TunnelGroupBackendsClient.html
 - doc/NgrokAPI/Services/TunnelSessionsClient.html
 - doc/NgrokAPI/Services/TunnelsClient.html
+- doc/NgrokAPI/Services/VaultsClient.html
 - doc/NgrokAPI/Services/WeightedBackendsClient.html
 - doc/_index.html
 - doc/class_list.html
@@ -295,6 +298,7 @@ files:
 - docs/NgrokAPI/Models/SSHCredential.html
 - docs/NgrokAPI/Models/SSHHostCertificate.html
 - docs/NgrokAPI/Models/SSHUserCertificate.html
+- docs/NgrokAPI/Models/Secret.html
 - docs/NgrokAPI/Models/StaticBackend.html
 - docs/NgrokAPI/Models/StaticBackendTLS.html
 - docs/NgrokAPI/Models/TCPEdge.html
@@ -305,6 +309,7 @@ files:
 - docs/NgrokAPI/Models/TunnelGroupBackend.html
 - docs/NgrokAPI/Models/TunnelSession.html
 - docs/NgrokAPI/Models/UserAgent.html
+- docs/NgrokAPI/Models/Vault.html
 - docs/NgrokAPI/Models/WeightedBackend.html
 - docs/NgrokAPI/PagedIterator.html
 - docs/NgrokAPI/Services.html
@@ -351,6 +356,7 @@ files:
 - docs/NgrokAPI/Services/SSHCredentialsClient.html
 - docs/NgrokAPI/Services/SSHHostCertificatesClient.html
 - docs/NgrokAPI/Services/SSHUserCertificatesClient.html
+- docs/NgrokAPI/Services/SecretsClient.html
 - docs/NgrokAPI/Services/StaticBackendsClient.html
 - docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html
 - docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html
@@ -366,6 +372,7 @@ files:
 - docs/NgrokAPI/Services/TunnelGroupBackendsClient.html
 - docs/NgrokAPI/Services/TunnelSessionsClient.html
 - docs/NgrokAPI/Services/TunnelsClient.html
+- docs/NgrokAPI/Services/VaultsClient.html
 - docs/NgrokAPI/Services/WeightedBackendsClient.html
 - docs/_index.html
 - docs/class_list.html
@@ -459,6 +466,7 @@ files:
 - lib/ngrokapi/models/reserved_domain_cert_job.rb
 - lib/ngrokapi/models/reserved_domain_cert_policy.rb
 - lib/ngrokapi/models/reserved_domain_cert_status.rb
+- lib/ngrokapi/models/secret.rb
 - lib/ngrokapi/models/ssh_certificate_authority.rb
 - lib/ngrokapi/models/ssh_credential.rb
 - lib/ngrokapi/models/ssh_host_certificate.rb
@@ -473,6 +481,7 @@ files:
 - lib/ngrokapi/models/tunnel_group_backend.rb
 - lib/ngrokapi/models/tunnel_session.rb
 - lib/ngrokapi/models/user_agent.rb
+- lib/ngrokapi/models/vault.rb
 - lib/ngrokapi/models/weighted_backend.rb
 - lib/ngrokapi/paged_iterator.rb
 - lib/ngrokapi/services/.gitkeep
@@ -514,6 +523,7 @@ files:
 - lib/ngrokapi/services/ip_restrictions_client.rb
 - lib/ngrokapi/services/reserved_addrs_client.rb
 - lib/ngrokapi/services/reserved_domains_client.rb
+- lib/ngrokapi/services/secrets_client.rb
 - lib/ngrokapi/services/ssh_certificate_authorities_client.rb
 - lib/ngrokapi/services/ssh_credentials_client.rb
 - lib/ngrokapi/services/ssh_host_certificates_client.rb
@@ -531,6 +541,7 @@ files:
 - lib/ngrokapi/services/tunnel_group_backends_client.rb
 - lib/ngrokapi/services/tunnel_sessions_client.rb
 - lib/ngrokapi/services/tunnels_client.rb
+- lib/ngrokapi/services/vaults_client.rb
 - lib/ngrokapi/services/weighted_backends_client.rb
 - lib/ngrokapi/version.rb
 - ngrok-api.gemspec
@@ -609,6 +620,7 @@ files:
 - spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb
 - spec/ngrokapi/models/reserved_domain_cert_status_spec.rb
 - spec/ngrokapi/models/reserved_domain_spec.rb
+- spec/ngrokapi/models/secret_spec.rb
 - spec/ngrokapi/models/ssh_certificate_authority_spec.rb
 - spec/ngrokapi/models/ssh_credential_spec.rb
 - spec/ngrokapi/models/ssh_host_certificate_spec.rb
@@ -623,6 +635,7 @@ files:
 - spec/ngrokapi/models/tunnel_session_spec.rb
 - spec/ngrokapi/models/tunnel_spec.rb
 - spec/ngrokapi/models/user_agent_spec.rb
+- spec/ngrokapi/models/vault_spec.rb
 - spec/ngrokapi/models/weighted_backend_spec.rb
 - spec/ngrokapi/paged_iterator_spec.rb
 - spec/ngrokapi/services/.gitkeep
@@ -664,6 +677,7 @@ files:
 - spec/ngrokapi/services/ip_restrictions_client_spec.rb
 - spec/ngrokapi/services/reserved_addrs_client_spec.rb
 - spec/ngrokapi/services/reserved_domains_client_spec.rb
+- spec/ngrokapi/services/secrets_client_spec.rb
 - spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb
 - spec/ngrokapi/services/ssh_credentials_client_spec.rb
 - spec/ngrokapi/services/ssh_host_certificates_client_spec.rb
@@ -681,13 +695,13 @@ files:
 - spec/ngrokapi/services/tunnel_group_backends_client_spec.rb
 - spec/ngrokapi/services/tunnel_sessions_client_spec.rb
 - spec/ngrokapi/services/tunnels_client_spec.rb
+- spec/ngrokapi/services/vaults_client_spec.rb
 - spec/ngrokapi/services/weighted_backends_client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ngrok/ngrok-api-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -702,8 +716,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
   it easier to consume in Ruby.