ngrok-api 0.9.0 → 0.16.0

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+    #  sessions that are running and connected to the ngrok service. Each tunnel
+    #  session can include one or more Tunnels.
+    #
+    # https://ngrok.com/docs/api#api-tunnel-sessions
+    class TunnelSessionsClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'tunnel_sessions'
+      # The API path for the requests
+      PATH = '/tunnel_sessions'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # List all online tunnel sessions running on this account.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-list
+      def list(before_id: nil, limit: nil,
+               url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelSession
+        )
+      end
+
+      ##
+      # List all online tunnel sessions running on this account.
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-list
+      def list!(before_id: nil, limit: nil,
+                url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelSession,
+          danger: true
+        )
+      end
+
+      ##
+      # Get the detailed status of a tunnel session by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelSession] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-get
+      def get(id: "")
+        path = '/tunnel_sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+      end
+
+      ##
+      # Get the detailed status of a tunnel session by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelSession] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-get
+      def get!(id: "")
+        path = '/tunnel_sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent to restart. The agent restarts
+      # itself by calling exec() on platforms that support it. This operation is notably
+      # not supported on Windows. When an agent restarts, it reconnects with a new
+      # tunnel session ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-restart
+      def restart(id: "")
+        path = '/tunnel_sessions/%{id}/restart'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent to restart. The agent restarts
+      # itself by calling exec() on platforms that support it. This operation is notably
+      # not supported on Windows. When an agent restarts, it reconnects with a new
+      # tunnel session ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-restart
+      def restart!(id: "")
+        path = '/tunnel_sessions/%{id}/restart'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements, danger: true)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent that started this tunnel session to
+      # exit.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-stop
+      def stop(id: "")
+        path = '/tunnel_sessions/%{id}/stop'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent that started this tunnel session to
+      # exit.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-stop
+      def stop!(id: "")
+        path = '/tunnel_sessions/%{id}/stop'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements, danger: true)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent to update itself to the latest
+      # version. After this call completes successfully, the ngrok agent will be in the
+      # update process. A caller should wait some amount of time to allow the update to
+      # complete (at least 10 seconds) before making a call to the Restart endpoint to
+      # request that the agent restart itself to start using the new code. This call
+      # will never update an ngrok agent to a new major version which could cause
+      # breaking compatibility issues. If you wish to update to a new major version,
+      # that must be done manually. Still, please be aware that updating your ngrok
+      # agent could break your integration. This call will fail in any of the following
+      # circumstances: there is no update available the ngrok agent's configuration
+      # disabled update checks the agent is currently in process of updating the agent
+      # has already successfully updated but has not yet been restarted
+      #
+      # @param [string] id
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-update
+      def update(id: "", version: "")
+        path = '/tunnel_sessions/%{id}/update'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements)
+      end
+
+      ##
+      # Issues a command instructing the ngrok agent to update itself to the latest
+      # version. After this call completes successfully, the ngrok agent will be in the
+      # update process. A caller should wait some amount of time to allow the update to
+      # complete (at least 10 seconds) before making a call to the Restart endpoint to
+      # request that the agent restart itself to start using the new code. This call
+      # will never update an ngrok agent to a new major version which could cause
+      # breaking compatibility issues. If you wish to update to a new major version,
+      # that must be done manually. Still, please be aware that updating your ngrok
+      # agent could break your integration. This call will fail in any of the following
+      # circumstances: there is no update available the ngrok agent's configuration
+      # disabled update checks the agent is currently in process of updating the agent
+      # has already successfully updated but has not yet been restarted
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-sessions-update
+      def update!(id: "", version: "")
+        path = '/tunnel_sessions/%{id}/update'
+        replacements = {
+          id: id,
+        }
+        @client.post(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/tunnels_client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Tunnels provide endpoints to access services exposed by a running ngrok
+    #  agent tunnel session or an SSH reverse tunnel session.
+    #
+    # https://ngrok.com/docs/api#api-tunnels
+    class TunnelsClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'tunnels'
+      # The API path for the requests
+      PATH = '/tunnels'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # List all online tunnels currently running on the account.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-list
+      def list(before_id: nil, limit: nil,
+               url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::Tunnel
+        )
+      end
+
+      ##
+      # List all online tunnels currently running on the account.
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-list
+      def list!(before_id: nil, limit: nil,
+                url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::Tunnel,
+          danger: true
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/version.rb

@@ -2,6 +2,6 @@ module NgrokAPI
   # rubocop:disable Layout/SpaceAroundOperators
 
   # The current version of the gem
-  VERSION="0.9.0".freeze
+  VERSION="0.16.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/lib/ngrokapi.rb

@@ -3,7 +3,7 @@
 require 'json'
 require 'net/http'
 
-Dir[File.join('.', 'lib', '**/*.rb')].each do |f|
+Dir[File.join('.', 'lib', '**/*.rb')].sort.each do |f|
   require f
 end
 

data/ngrok-api.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.description = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
     it easier to consume in Ruby.'
 
-  s.required_ruby_version = '>= 3.0.0'
+  s.required_ruby_version = '>= 2.7.2'
 
   all_files = `git ls-files`.split("\n")
   test_files = `git ls-files -- {test,spec,features}/*`.split('\n')

data/spec/ngrokapi/client_spec.rb

@@ -1,33 +1,158 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Client do
-  before(:each) do
-    @client = NgrokAPI::Client.new(api_key: 'abc')
-  end
-
-  describe "#api_keys" do
-    it "returns an instance of the api_keys_client" do
-      expect(@client.api_keys.class).to eq(NgrokAPI::Services::ApiKeysClient)
-    end
-  end
-
-  describe "#endpoint_configurations" do
-    it "returns an instance of the endpoint_configurations_client" do
-      expect(@client.endpoint_configurations.class).to eq(
-        NgrokAPI::Services::EndpointConfigurationsClient
-      )
-    end
-  end
-
-  describe "#reserved_domains" do
-    it "returns an instance of the reserved_domains_client" do
-      expect(@client.reserved_domains.class).to eq(NgrokAPI::Services::ReservedDomainsClient)
-    end
-  end
-
-  describe "#tls_certificates" do
-    it "returns an instance of the tls_certificates_client" do
-      expect(@client.tls_certificates.class).to eq(NgrokAPI::Services::TlsCertificatesClient)
-    end
-  end
-end
+require 'spec_helper'
+require 'ostruct'
+
+RSpec.describe NgrokAPI::Client do
+  before(:each) do
+    @client = NgrokAPI::Client.new(api_key: 'abc')
+  end
+
+  describe "#abuse_reports" do
+    it "returns an instance of the AbuseReportsClient" do
+      expect(@client.abuse_reports.class).to eq(NgrokAPI::Services::AbuseReportsClient)
+    end
+  end
+
+  describe "#agent_ingresses" do
+    it "returns an instance of the AgentIngressesClient" do
+      expect(@client.agent_ingresses.class).to eq(NgrokAPI::Services::AgentIngressesClient)
+    end
+  end
+
+  describe "#api_keys" do
+    it "returns an instance of the APIKeysClient" do
+      expect(@client.api_keys.class).to eq(NgrokAPI::Services::APIKeysClient)
+    end
+  end
+
+  describe "#certificate_authorities" do
+    it "returns an instance of the CertificateAuthoritiesClient" do
+      expect(@client.certificate_authorities.class).to eq(NgrokAPI::Services::CertificateAuthoritiesClient)
+    end
+  end
+
+  describe "#credentials" do
+    it "returns an instance of the CredentialsClient" do
+      expect(@client.credentials.class).to eq(NgrokAPI::Services::CredentialsClient)
+    end
+  end
+
+  describe "#endpoint_configurations" do
+    it "returns an instance of the EndpointConfigurationsClient" do
+      expect(@client.endpoint_configurations.class).to eq(NgrokAPI::Services::EndpointConfigurationsClient)
+    end
+  end
+
+  describe "#event_streams" do
+    it "returns an instance of the EventStreamsClient" do
+      expect(@client.event_streams.class).to eq(NgrokAPI::Services::EventStreamsClient)
+    end
+  end
+
+  describe "#event_destinations" do
+    it "returns an instance of the EventDestinationsClient" do
+      expect(@client.event_destinations.class).to eq(NgrokAPI::Services::EventDestinationsClient)
+    end
+  end
+
+  describe "#event_subscriptions" do
+    it "returns an instance of the EventSubscriptionsClient" do
+      expect(@client.event_subscriptions.class).to eq(NgrokAPI::Services::EventSubscriptionsClient)
+    end
+  end
+
+  describe "#event_sources" do
+    it "returns an instance of the EventSourcesClient" do
+      expect(@client.event_sources.class).to eq(NgrokAPI::Services::EventSourcesClient)
+    end
+  end
+
+  describe "#ip_policies" do
+    it "returns an instance of the IPPoliciesClient" do
+      expect(@client.ip_policies.class).to eq(NgrokAPI::Services::IPPoliciesClient)
+    end
+  end
+
+  describe "#ip_policy_rules" do
+    it "returns an instance of the IPPolicyRulesClient" do
+      expect(@client.ip_policy_rules.class).to eq(NgrokAPI::Services::IPPolicyRulesClient)
+    end
+  end
+
+  describe "#ip_restrictions" do
+    it "returns an instance of the IPRestrictionsClient" do
+      expect(@client.ip_restrictions.class).to eq(NgrokAPI::Services::IPRestrictionsClient)
+    end
+  end
+
+  describe "#reserved_addrs" do
+    it "returns an instance of the ReservedAddrsClient" do
+      expect(@client.reserved_addrs.class).to eq(NgrokAPI::Services::ReservedAddrsClient)
+    end
+  end
+
+  describe "#reserved_domains" do
+    it "returns an instance of the ReservedDomainsClient" do
+      expect(@client.reserved_domains.class).to eq(NgrokAPI::Services::ReservedDomainsClient)
+    end
+  end
+
+  describe "#ssh_certificate_authorities" do
+    it "returns an instance of the SSHCertificateAuthoritiesClient" do
+      expect(@client.ssh_certificate_authorities.class).to eq(NgrokAPI::Services::SSHCertificateAuthoritiesClient)
+    end
+  end
+
+  describe "#ssh_credentials" do
+    it "returns an instance of the SSHCredentialsClient" do
+      expect(@client.ssh_credentials.class).to eq(NgrokAPI::Services::SSHCredentialsClient)
+    end
+  end
+
+  describe "#ssh_host_certificates" do
+    it "returns an instance of the SSHHostCertificatesClient" do
+      expect(@client.ssh_host_certificates.class).to eq(NgrokAPI::Services::SSHHostCertificatesClient)
+    end
+  end
+
+  describe "#ssh_user_certificates" do
+    it "returns an instance of the SSHUserCertificatesClient" do
+      expect(@client.ssh_user_certificates.class).to eq(NgrokAPI::Services::SSHUserCertificatesClient)
+    end
+  end
+
+  describe "#tls_certificates" do
+    it "returns an instance of the TLSCertificatesClient" do
+      expect(@client.tls_certificates.class).to eq(NgrokAPI::Services::TLSCertificatesClient)
+    end
+  end
+
+  describe "#tunnel_sessions" do
+    it "returns an instance of the TunnelSessionsClient" do
+      expect(@client.tunnel_sessions.class).to eq(NgrokAPI::Services::TunnelSessionsClient)
+    end
+  end
+
+  describe "#tunnels" do
+    it "returns an instance of the TunnelsClient" do
+      expect(@client.tunnels.class).to eq(NgrokAPI::Services::TunnelsClient)
+    end
+  end
+
+  describe "#pointcfg_module" do
+    it "returns an instance of OpenStruct covering namespaces" do
+      ns = @client.pointcfg_module
+      expect(ns.logging.class).to eq(NgrokAPI::Services::EndpointLoggingModuleClient)
+      expect(ns.circuit_breaker.class).to eq(NgrokAPI::Services::EndpointCircuitBreakerModuleClient)
+      expect(ns.compression.class).to eq(NgrokAPI::Services::EndpointCompressionModuleClient)
+      expect(ns.tls_termination.class).to eq(NgrokAPI::Services::EndpointTLSTerminationModuleClient)
+      expect(ns.ip_policy.class).to eq(NgrokAPI::Services::EndpointIPPolicyModuleClient)
+      expect(ns.mutual_tls.class).to eq(NgrokAPI::Services::EndpointMutualTLSModuleClient)
+      expect(ns.request_headers.class).to eq(NgrokAPI::Services::EndpointRequestHeadersModuleClient)
+      expect(ns.response_headers.class).to eq(NgrokAPI::Services::EndpointResponseHeadersModuleClient)
+      expect(ns.oauth.class).to eq(NgrokAPI::Services::EndpointOAuthModuleClient)
+      expect(ns.webhook_validation.class).to eq(NgrokAPI::Services::EndpointWebhookValidationModuleClient)
+      expect(ns.saml.class).to eq(NgrokAPI::Services::EndpointSAMLModuleClient)
+      expect(ns.oidc.class).to eq(NgrokAPI::Services::EndpointOIDCModuleClient)
+    end
+  end
+end

data/spec/ngrokapi/models/abuse_report_hostname_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::AbuseReportHostname do
+  before(:each) do
+    @client = class_double("AbuseReportHostnamesClient")
+    @abuse_report_hostname = NgrokAPI::Models::AbuseReportHostname.new(client: @client, result: abuse_report_hostname_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::AbuseReportHostname.new(client: @client, result: abuse_report_hostname_result)
+      expect(@abuse_report_hostname == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@abuse_report_hostname.to_s).to eq abuse_report_hostname_result.to_s
+    end
+  end
+end

data/spec/ngrokapi/models/abuse_report_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::AbuseReport do
+  before(:each) do
+    @client = class_double("AbuseReportsClient")
+    @abuse_report = NgrokAPI::Models::AbuseReport.new(client: @client, result: abuse_report_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::AbuseReport.new(client: @client, result: abuse_report_result)
+      expect(@abuse_report == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@abuse_report.to_s).to eq abuse_report_result.to_s
+    end
+  end
+end

data/spec/ngrokapi/models/agent_ingress_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::AgentIngress do
+  before(:each) do
+    @client = class_double("AgentIngresssClient")
+    @agent_ingress = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
+      expect(@agent_ingress == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@agent_ingress.to_s).to eq agent_ingress_result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@agent_ingress.client).to receive(:delete)
+      @agent_ingress.delete
+    end
+  end
+
+  describe "#update" do
+    it "calls update on the client" do
+      new_description = 'New description'
+      new_metadata = 'New metadata'
+      expect(@agent_ingress.client).to receive(:update)
+      @agent_ingress.update(
+        description: new_description,
+        metadata: new_metadata
+      )
+      expect(@agent_ingress.description).to eq new_description
+      expect(@agent_ingress.metadata).to eq new_metadata
+    end
+  end
+end