ngrok-api 0.16.0 → 0.19.0

data/lib/ngrokapi/services/tunnel_group_backends_client.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A Tunnel Group Backend balances traffic among all online tunnels that match
+    #  a label selector.
+    #
+    # https://ngrok.com/docs/api#api-tunnel-group-backends
+    class TunnelGroupBackendsClient
+      # The API path for the requests
+      PATH = '/backends/tunnel_group'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'backends'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new TunnelGroup backend
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-create
+      def create(description: "", metadata: "", labels: {})
+        path = '/backends/tunnel_group'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new TunnelGroup backend
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-create
+      def create!(description: "", metadata: "", labels: {})
+        path = '/backends/tunnel_group'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a TunnelGroup backend by 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-group-backends-delete
+      def delete!(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a TunnelGroup backend by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-get
+      def get(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get detailed information about a TunnelGroup backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-get
+      def get!(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # List all TunnelGroup backends 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-group-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelGroupBackend
+        )
+      end
+
+      ##
+      # List all TunnelGroup backends 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-group-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelGroupBackend,
+          danger: true
+        )
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update(id: "", description: nil, metadata: nil, labels: {})
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update!(id: "", description: nil, metadata: nil, labels: {})
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -29,8 +29,7 @@ module NgrokAPI
       # @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)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -40,7 +39,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelSession
         )
@@ -56,8 +55,7 @@ module NgrokAPI
       # @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)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -68,7 +66,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelSession,
           danger: true
@@ -89,7 +87,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+        NgrokAPI::Models::TunnelSession.new(client: self, attrs: result)
       end
 
       ##
@@ -107,7 +105,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+        NgrokAPI::Models::TunnelSession.new(client: self, attrs: result)
       end
 
       ##

data/lib/ngrokapi/services/tunnels_client.rb

@@ -28,8 +28,7 @@ module NgrokAPI
       # @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)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -39,7 +38,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Tunnel
         )
@@ -55,8 +54,7 @@ module NgrokAPI
       # @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)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -67,12 +65,47 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Tunnel,
           danger: true
         )
       end
+
+      ##
+      # Get the status of a tunnel by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Tunnel] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-get
+      def get(id: "")
+        path = '/tunnels/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::Tunnel.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get the status of a tunnel by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Tunnel] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-get
+      def get!(id: "")
+        path = '/tunnels/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::Tunnel.new(client: self, attrs: result)
+      end
     end
   end
 end

data/lib/ngrokapi/services/weighted_backends_client.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A Weighted Backend balances traffic among the referenced backends. Traffic
+    #  is assigned proportionally to each based on its weight. The percentage of
+    #  traffic is calculated by dividing a backend's weight by the sum of all
+    #  weights.
+    #
+    # https://ngrok.com/docs/api#api-weighted-backends
+    class WeightedBackendsClient
+      # The API path for the requests
+      PATH = '/backends/weighted'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'backends'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new Weighted backend
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-create
+      def create(description: "", metadata: "", backends: {})
+        path = '/backends/weighted'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new Weighted backend
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-create
+      def create!(description: "", metadata: "", backends: {})
+        path = '/backends/weighted'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Delete a Weighted backend by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-delete
+      def delete(id: "")
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a Weighted backend by 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-weighted-backends-delete
+      def delete!(id: "")
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a Weighted backend by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-get
+      def get(id: "")
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get detailed information about a Weighted backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-get
+      def get!(id: "")
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # List all Weighted backends 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-weighted-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::WeightedBackend
+        )
+      end
+
+      ##
+      # List all Weighted backends 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-weighted-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::WeightedBackend,
+          danger: true
+        )
+      end
+
+      ##
+      # Update Weighted backend by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-update
+      def update(id: "", description: nil, metadata: nil, backends: {})
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Update Weighted backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-update
+      def update!(id: "", description: nil, metadata: nil, backends: {})
+        path = '/backends/weighted/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      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.16.0".freeze
+  VERSION="0.19.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')].sort.each do |f|
+Dir[File.join(__dir__, '**', '*.rb')].sort.each do |f|
   require f
 end