ngrok-api 0.12.0 → 0.14.0

data/lib/ngrokapi/services/ip_policies_client.rb

@@ -3,7 +3,7 @@
 module NgrokAPI
   module Services
     ##
-    # IP Policies are reusable groups of CIDR ranges with an allow or deny
+    # IP Policies are reusable groups of CIDR ranges with an `allow` or `deny`
     #  action. They can be attached to endpoints via the Endpoint Configuration IP
     #  Policy module. They can also be used with IP Restrictions to control source
     #  IP ranges that can start tunnel sessions and connect to the API and dashboard.
@@ -145,6 +145,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -153,6 +154,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all IP policies 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-ip-policies-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::IPPolicy,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of an IP policy by ID
       #

data/lib/ngrokapi/services/ip_policy_rules_client.rb

@@ -141,6 +141,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -149,6 +150,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all IP policy rules 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-ip-policy-rules-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::IPPolicyRule,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of an IP policy rule by ID
       #

data/lib/ngrokapi/services/ip_restrictions_client.rb

@@ -148,6 +148,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -156,6 +157,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all IP restrictions 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-ip-restrictions-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::IPRestriction,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of an IP restriction by ID
       #

data/lib/ngrokapi/services/ip_whitelist_client.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Services
     ##
     # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
-    #  with an endpoints type instead.
+    #  with an `endpoints` type instead.
     #
     # https://ngrok.com/docs/api#api-ip-whitelist
     class IPWhitelistClient
@@ -139,6 +139,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -147,6 +148,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all IP whitelist entries 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-ip-whitelist-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::IPWhitelistEntry,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of an IP whitelist entry by ID
       #

data/lib/ngrokapi/services/reserved_addrs_client.rb

@@ -142,6 +142,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -150,6 +151,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all reserved addresses 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-reserved-addrs-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::ReservedAddr,
+          danger: true
+        )
+      end
+
       ##
       # Update the attributes of a reserved address.
       #

data/lib/ngrokapi/services/reserved_domains_client.rb

@@ -155,6 +155,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -163,6 +164,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all reserved domains 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-reserved-domains-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::ReservedDomain,
+          danger: true
+        )
+      end
+
       ##
       # Update the attributes of a reserved domain.
       #

data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb

@@ -144,6 +144,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -152,6 +153,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all SSH Certificate Authorities 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-ssh-certificate-authorities-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::SSHCertificateAuthority,
+          danger: true
+        )
+      end
+
       ##
       # Update an SSH Certificate Authority
       #

data/lib/ngrokapi/services/ssh_credentials_client.rb

@@ -142,6 +142,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -150,6 +151,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all ssh credentials 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-ssh-credentials-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::SSHCredential,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of an ssh_credential by ID
       #

data/lib/ngrokapi/services/ssh_host_certificates_client.rb

@@ -151,6 +151,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -159,6 +160,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all SSH Host Certificates issued 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-ssh-host-certificates-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::SSHHostCertificate,
+          danger: true
+        )
+      end
+
       ##
       # Update an SSH Host Certificate
       #

data/lib/ngrokapi/services/ssh_user_certificates_client.rb

@@ -157,6 +157,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -165,6 +166,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all SSH User Certificates issued 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-ssh-user-certificates-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::SSHUserCertificate,
+          danger: true
+        )
+      end
+
       ##
       # Update an SSH User Certificate
       #

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -144,6 +144,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -152,6 +153,38 @@ module NgrokAPI
         )
       end
 
+      ##
+      # List all TLS certificates 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-tls-certificates-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::TLSCertificate,
+          danger: true
+        )
+      end
+
       ##
       # Update attributes of a TLS Certificate by ID
       #

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -40,6 +40,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -48,6 +49,38 @@ module NgrokAPI
         )
       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
       #

data/lib/ngrokapi/services/tunnels_client.rb

@@ -39,6 +39,7 @@ module NgrokAPI
           url: url,
           path: PATH
         )
+
         NgrokAPI::Models::Listable.new(
           client: self,
           result: result,
@@ -46,6 +47,38 @@ module NgrokAPI
           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.12.0".freeze
+  VERSION="0.14.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/spec/ngrokapi/client_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'ostruct'
 
 RSpec.describe NgrokAPI::Client do
   before(:each) do
@@ -136,4 +137,22 @@ RSpec.describe NgrokAPI::Client 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/event_source_list_spec.rb

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