ngrok-api 0.26.0 → 0.27.0

data/spec/ngrokapi/models/service_user_spec.rb

@@ -0,0 +1,44 @@
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::ServiceUser do
+  before(:each) do
+    @client = class_double("ServiceUsersClient")
+    @service_user = NgrokAPI::Models::ServiceUser.new(client: @client, attrs: service_user_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::ServiceUser.new(client: @client, attrs: service_user_result)
+      expect(@service_user == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@service_user.to_s).to eq service_user_result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@service_user.client).to receive(:delete)
+      @service_user.delete
+    end
+  end
+
+  describe "#update" do
+    it "calls update on the client" do
+      new_name = 'New name'
+      new_active = 'New active'
+      expect(@service_user.client).to receive(:update)
+      @service_user.update(
+        name: new_name,
+        active: new_active
+      )
+      expect(@service_user.name).to eq new_name
+      expect(@service_user.active).to eq new_active
+    end
+  end
+end

data/spec/ngrokapi/services/credentials_client_spec.rb

@@ -32,7 +32,8 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do
         acl: "New acl",
         owner_id: "New owner_id",
         owner_email: "New owner_email",
-        precomputed_token: "New precomputed_token"
+        precomputed_token: "New precomputed_token",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::Credential)
     end
@@ -56,7 +57,8 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do
         acl: "New acl",
         owner_id: "New owner_id",
         owner_email: "New owner_email",
-        precomputed_token: "New precomputed_token"
+        precomputed_token: "New precomputed_token",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::Credential)
       # expect(result.id).to eq(credential_result["id"])

data/spec/ngrokapi/services/secrets_client_spec.rb

@@ -25,6 +25,7 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
       data[:metadata] = "New metadata"
       data[:description] = "New description"
       data[:vault_id] = "New vault_id"
+      data[:vault_name] = "New vault_name"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(secret_result)
       result = @secrets_client.create(
@@ -32,7 +33,8 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
         value: "New value",
         metadata: "New metadata",
         description: "New description",
-        vault_id: "New vault_id"
+        vault_id: "New vault_id",
+        vault_name: "New vault_name"
       )
       expect(result.class).to eq(NgrokAPI::Models::Secret)
     end
@@ -49,6 +51,7 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
       data[:metadata] = "New metadata"
       data[:description] = "New description"
       data[:vault_id] = "New vault_id"
+      data[:vault_name] = "New vault_name"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(secret_result)
       result = @secrets_client.create(
@@ -56,7 +59,8 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
         value: "New value",
         metadata: "New metadata",
         description: "New description",
-        vault_id: "New vault_id"
+        vault_id: "New vault_id",
+        vault_name: "New vault_name"
       )
       expect(result.class).to eq(NgrokAPI::Models::Secret)
       # expect(result.id).to eq(secret_result["id"])

data/spec/ngrokapi/services/service_users_client_spec.rb

@@ -0,0 +1,178 @@
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::ServiceUsersClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/service_users' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: service_user_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @service_users_client = NgrokAPI::Services::ServiceUsersClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::ServiceUser" do
+      path = '/service_users'
+      replacements = {
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:active] = "New active"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.create(
+        name: "New name",
+        active: "New active"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+    end
+  end
+
+  describe "#create!" do
+    it "will make a post request and return an instance of NgrokAPI::Models::ServiceUser" do
+      path = '/service_users'
+      replacements = {
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:active] = "New active"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.create(
+        name: "New name",
+        active: "New active"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+      # expect(result.id).to eq(service_user_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @service_users_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @service_users_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/service_users/%{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 = @service_users_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::ServiceUser" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: service_user_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.get(
+        id: service_user_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::ServiceUser" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: service_user_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.get(
+        id: service_user_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+      # expect(result.id).to eq(service_user_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(service_user_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @service_users_client.list(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+
+  describe "#update" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::ServiceUser" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: service_user_result["id"],
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:active] = "New active"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.update(
+        id: service_user_result["id"],
+        name: "New name",
+        active: "New active"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::ServiceUser" do
+      path = '/service_users/%{id}'
+      replacements = {
+        id: service_user_result["id"],
+      }
+      data = {}
+      data[:name] = "New name"
+      data[:active] = "New active"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(service_user_result)
+      result = @service_users_client.update(
+        id: service_user_result["id"],
+        name: "New name",
+        active: "New active"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::ServiceUser)
+      # expect(result.id).to eq(service_user_result["id"])
+    end
+  end
+end

data/spec/ngrokapi/services/ssh_credentials_client_spec.rb

@@ -33,7 +33,8 @@ RSpec.describe NgrokAPI::Services::SSHCredentialsClient do
         acl: "New acl",
         public_key: "New public_key",
         owner_id: "New owner_id",
-        owner_email: "New owner_email"
+        owner_email: "New owner_email",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::SSHCredential)
     end
@@ -58,7 +59,8 @@ RSpec.describe NgrokAPI::Services::SSHCredentialsClient do
         acl: "New acl",
         public_key: "New public_key",
         owner_id: "New owner_id",
-        owner_email: "New owner_email"
+        owner_email: "New owner_email",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::SSHCredential)
       # expect(result.id).to eq(ssh_credential_result["id"])

data/spec/spec_helper.rb

@@ -1661,3 +1661,24 @@ def vaults_get_secrets_by_vault_input
     "id" => vault_result["id"],
   }
 end
+
+def service_user_result
+  {
+    "id" => "bot_2feR0haVZwmcFwgfEc1UPQwIaIQ",
+    "uri" => "https://api.ngrok.com/service_users/bot_2feR0haVZwmcFwgfEc1UPQwIaIQ",
+    "name" => "new new service user from API",
+    "active" => true,
+    "created_at" => "2024-04-26T19:22:15Z",
+    "token" => nil,
+  }
+end
+
+def service_user_results
+  {
+    "service_users" => [
+      service_user_result,
+    ],
+    "uri" => "https://api.ngrok.com/service_users",
+    "next_page_uri" => "https://api.ngrok.com/service_users?before_id=bot_2feR0ilITzTz046nJryEWY2XTrd&limit=1",
+  }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-api
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - ''
@@ -120,6 +120,7 @@ files:
 - doc/NgrokAPI/Models/SSHHostCertificate.html
 - doc/NgrokAPI/Models/SSHUserCertificate.html
 - doc/NgrokAPI/Models/Secret.html
+- doc/NgrokAPI/Models/ServiceUser.html
 - doc/NgrokAPI/Models/StaticBackend.html
 - doc/NgrokAPI/Models/StaticBackendTLS.html
 - doc/NgrokAPI/Models/TCPEdge.html
@@ -178,6 +179,7 @@ files:
 - doc/NgrokAPI/Services/SSHHostCertificatesClient.html
 - doc/NgrokAPI/Services/SSHUserCertificatesClient.html
 - doc/NgrokAPI/Services/SecretsClient.html
+- doc/NgrokAPI/Services/ServiceUsersClient.html
 - doc/NgrokAPI/Services/StaticBackendsClient.html
 - doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html
 - doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html
@@ -299,6 +301,7 @@ files:
 - docs/NgrokAPI/Models/SSHHostCertificate.html
 - docs/NgrokAPI/Models/SSHUserCertificate.html
 - docs/NgrokAPI/Models/Secret.html
+- docs/NgrokAPI/Models/ServiceUser.html
 - docs/NgrokAPI/Models/StaticBackend.html
 - docs/NgrokAPI/Models/StaticBackendTLS.html
 - docs/NgrokAPI/Models/TCPEdge.html
@@ -357,6 +360,7 @@ files:
 - docs/NgrokAPI/Services/SSHHostCertificatesClient.html
 - docs/NgrokAPI/Services/SSHUserCertificatesClient.html
 - docs/NgrokAPI/Services/SecretsClient.html
+- docs/NgrokAPI/Services/ServiceUsersClient.html
 - docs/NgrokAPI/Services/StaticBackendsClient.html
 - docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html
 - docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html
@@ -467,6 +471,7 @@ files:
 - lib/ngrokapi/models/reserved_domain_cert_policy.rb
 - lib/ngrokapi/models/reserved_domain_cert_status.rb
 - lib/ngrokapi/models/secret.rb
+- lib/ngrokapi/models/service_user.rb
 - lib/ngrokapi/models/ssh_certificate_authority.rb
 - lib/ngrokapi/models/ssh_credential.rb
 - lib/ngrokapi/models/ssh_host_certificate.rb
@@ -524,6 +529,7 @@ files:
 - lib/ngrokapi/services/reserved_addrs_client.rb
 - lib/ngrokapi/services/reserved_domains_client.rb
 - lib/ngrokapi/services/secrets_client.rb
+- lib/ngrokapi/services/service_users_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
@@ -621,6 +627,7 @@ files:
 - 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/service_user_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
@@ -678,6 +685,7 @@ files:
 - 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/service_users_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
@@ -716,7 +724,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.7.2
 specification_version: 4
 summary: This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
   it easier to consume in Ruby.