ngrok-api 0.16.0 → 0.19.0

data/docs/README

@@ -1,94 +0,0 @@
-# ngrok-api
-
-This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
-easier to consume in Ruby.
-
-## Installation
-
-This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
-
-```ruby
-gem install ngrok-api
-```
-
-## Quickstart
-
-Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# Get an instance of the api_keys client and list all API keys
-keys_client = client.api_keys
-keys_client.list
-```
-
-## Automatic Paging
-
-The ngrok API pages all list resources but this library abstracts that away
-from you. All response objects from any ``list`` or ``list!`` methods return an object that
-implements an ``each`` method which will automatically fetch additional
-pages for you.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# list all api keys, transparently fetching additional
-# pages for you if necessary
-keys_client = client.api_keys
-keys_client.list.each do |key|
-  puts(key)
-end
-```
-
-## Instance Methods
-
-Instance methods like ``update`` and ``delete`` can be invoked on an instance of an
-API object itself as well as directly without needing to first fetch the object.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# update the metadata of a credential
-cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz')
-cred.update(metadata: {server_name: 'giraffe-1'}.to_json)
-
-# or do it in single call
-cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json)
-```
-
-## Bang Methods
-Most methods that interact with the API have a `!` counterpart. It raises an error when
-one is returned by the API.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# no error raised, even though it's a bad identifier
-# the error is simply returned
-cred = client.credentials.get(id: 'invalid')
-
-# this raises an NgrokAPI::Error
-cred = client.credentials.get!(id: 'invalid')
-```
-
-## Error Handling
-
-The ngrok API returns detailed information when an API call fails. Consult the
-section on errors for additional details.
-
-```ruby
-require 'ngrokapi'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-begin
-    client.ip_policies.get!(id: 'invalid')
-rescue NgrokAPI::Error => e
-    puts(e)
-    puts(e.response.to_s)
-end
-```

data/lib/ngrokapi/models/endpoint_configuration.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    class EndpointConfiguration
-      attr_reader :client,
-        :result,
-        :id,
-        :type,
-        :description,
-        :metadata,
-        :created_at,
-        :uri,
-        :basic_auth,
-        :circuit_breaker,
-        :compression,
-        :request_headers,
-        :response_headers,
-        :ip_policy,
-        :mutual_tls,
-        :tls_termination,
-        :webhook_validation,
-        :oauth,
-        :logging,
-        :saml,
-        :oidc,
-        :backend
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @id = @result['id']
-        @type = @result['type']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @created_at = @result['created_at']
-        @uri = @result['uri']
-        @basic_auth = @result['basic_auth']
-        @circuit_breaker = @result['circuit_breaker']
-        @compression = @result['compression']
-        @request_headers = @result['request_headers']
-        @response_headers = @result['response_headers']
-        @ip_policy = @result['ip_policy']
-        @mutual_tls = @result['mutual_tls']
-        @tls_termination = @result['tls_termination']
-        @webhook_validation = @result['webhook_validation']
-        @oauth = @result['oauth']
-        @logging = @result['logging']
-        @saml = @result['saml']
-        @oidc = @result['oidc']
-        @backend = @result['backend']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete an endpoint configuration. This operation will fail if the endpoint
-      # configuration is still referenced by any reserved domain or reserved address.
-      #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
-      def delete
-        @client.delete(
-          id: @id
-        )
-      end
-
-      ##
-      # Updates an endpoint configuration. If a module is not specified in the update,
-      # it will not be modified. However, each module configuration that is specified
-      # will completely replace the existing value. There is no way to delete an
-      # existing module via this API, instead use the delete module API.
-      #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-update
-      def update(
-        description: nil,
-        metadata: nil,
-        circuit_breaker: nil,
-        compression: nil,
-        request_headers: nil,
-        response_headers: nil,
-        ip_policy: nil,
-        mutual_tls: nil,
-        tls_termination: nil,
-        webhook_validation: nil,
-        oauth: nil,
-        logging: nil,
-        saml: nil,
-        oidc: nil
-      )
-        @description = description if description
-        @metadata = metadata if metadata
-        @circuit_breaker = circuit_breaker if circuit_breaker
-        @compression = compression if compression
-        @request_headers = request_headers if request_headers
-        @response_headers = response_headers if response_headers
-        @ip_policy = ip_policy if ip_policy
-        @mutual_tls = mutual_tls if mutual_tls
-        @tls_termination = tls_termination if tls_termination
-        @webhook_validation = webhook_validation if webhook_validation
-        @oauth = oauth if oauth
-        @logging = logging if logging
-        @saml = saml if saml
-        @oidc = oidc if oidc
-        @client.update(
-          id: @id,
-          description: description,
-          metadata: metadata,
-          circuit_breaker: circuit_breaker,
-          compression: compression,
-          request_headers: request_headers,
-          response_headers: response_headers,
-          ip_policy: ip_policy,
-          mutual_tls: mutual_tls,
-          tls_termination: tls_termination,
-          webhook_validation: webhook_validation,
-          oauth: oauth,
-          logging: logging,
-          saml: saml,
-          oidc: oidc
-        )
-      end
-    end
-  end
-end

data/lib/ngrokapi/models/endpoint_logging.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    class EndpointLogging
-      attr_reader :client,
-        :result,
-        :enabled,
-        :event_streams
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @enabled = @result['enabled']
-        @event_streams = @result['event_streams']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-    end
-  end
-end

data/lib/ngrokapi/models/endpoint_logging_mutate.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    class EndpointLoggingMutate
-      attr_reader :client,
-        :result,
-        :enabled,
-        :event_stream_ids
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @enabled = @result['enabled']
-        @event_stream_ids = @result['event_stream_ids']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-    end
-  end
-end

data/lib/ngrokapi/models/event_stream.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    class EventStream
-      attr_reader :client,
-        :result,
-        :id,
-        :uri,
-        :created_at,
-        :metadata,
-        :description,
-        :fields,
-        :event_type,
-        :destination_ids,
-        :sampling_rate
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @metadata = @result['metadata']
-        @description = @result['description']
-        @fields = @result['fields']
-        @event_type = @result['event_type']
-        @destination_ids = @result['destination_ids']
-        @sampling_rate = @result['sampling_rate']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete an Event Stream. Associated Event Destinations will be preserved.
-      #
-      # https://ngrok.com/docs/api#api-event-streams-delete
-      def delete
-        @client.delete(
-          id: @id
-        )
-      end
-
-      ##
-      # Update attributes of an Event Stream by ID.
-      #
-      # https://ngrok.com/docs/api#api-event-streams-update
-      def update(
-        metadata: nil,
-        description: nil,
-        fields: nil,
-        destination_ids: nil,
-        sampling_rate: nil
-      )
-        @metadata = metadata if metadata
-        @description = description if description
-        @fields = fields if fields
-        @destination_ids = destination_ids if destination_ids
-        @sampling_rate = sampling_rate if sampling_rate
-        @client.update(
-          id: @id,
-          metadata: metadata,
-          description: description,
-          fields: fields,
-          destination_ids: destination_ids,
-          sampling_rate: sampling_rate
-        )
-      end
-    end
-  end
-end

data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Services
-    ##
-    # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module
-    class EndpointCircuitBreakerModuleClient
-      # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/circuit_breaker'
-
-      attr_reader :client
-
-      def initialize(client:)
-        @client = client
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointCircuitBreaker] a_module
-      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
-      def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data)
-        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointCircuitBreaker] a_module
-      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
-      def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
-      def get(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
-      def get!(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
-      def delete(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
-      def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
-    end
-  end
-end

data/lib/ngrokapi/services/endpoint_compression_module_client.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Services
-    ##
-    # https://ngrok.com/docs/api#api-endpoint-compression-module
-    class EndpointCompressionModuleClient
-      # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/compression'
-
-      attr_reader :client
-
-      def initialize(client:)
-        @client = client
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointCompression] a_module
-      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
-      def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data)
-        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointCompression] a_module
-      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
-      def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
-      def get(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
-      def get!(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-delete
-      def delete(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-delete
-      def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
-    end
-  end
-end