ngrok-api 0.9.0

data/lib/ngrokapi/models/reserved_domain.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    ##
+    # A resource representing data from the reserved_domains API
+    class ReservedDomain
+      attr_reader :id,
+        :certificate,
+        :certificate_management_policy,
+        :certificate_management_status,
+        :client,
+        :cname_target,
+        :created_at,
+        :description,
+        :domain,
+        :http_endpoint_configuration,
+        :https_endpoint_configuration,
+        :metadata,
+        :region,
+        :result,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @created_at = @result['created_at']
+        @certificate = @result['certificate']
+        @certificate_management_policy = @result['certificate_management_policy']
+        @certificate_management_status = @result['certificate_management_status']
+        @cname_target = @result['cname_target']
+        @description = @result['description']
+        @domain = @result['domain']
+        @http_endpoint_configuration = @result['http_endpoint_configuration']
+        @https_endpoint_configuration = @result['https_endpoint_configuration']
+        @id = @result['id']
+        @metadata = @result['metadata']
+        @region = @result['region']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete this reserved domain.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete
+      def delete
+        @client.delete(id: @id)
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Update the attributes of this reserved domain.
+      #
+      # @param [string] description human-readable description of what this reserved domain will be used for
+      # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
+      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
+      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
+      # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
+      # @param [string] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def update(
+        certificate_id: nil,
+        certificate_management_policy: nil,
+        description: '',
+        http_endpoint_configuration_id: nil,
+        https_endpoint_configuration_id: nil,
+        metadata: ''
+      )
+        if certificate_management_policy
+          @certificate_management_policy = certificate_management_policy
+        end
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          http_endpoint_configuration_id: http_endpoint_configuration_id,
+          https_endpoint_configuration_id: https_endpoint_configuration_id,
+          certificate_id: certificate_id,
+          certificate_management_policy: certificate_management_policy
+        )
+        # TODO: update @certificate, etc?
+        # @certificate = new_result['certificate'] if certificate_id && new_result['certificate']
+        # if http_endpoint_configuration_id
+        #   @http_endpoint_configuration_id = http_endpoint_configuration_id
+        # end
+        # if https_endpoint_configuration_id
+        #   @https_endpoint_configuration_id = https_endpoint_configuration_id
+        # end
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Detach the certificate attached from this reserved domain.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
+      def delete_certificate
+        @certificate = nil
+        @client.delete_certificate(id: @id)
+      end
+
+      ##
+      # Detach the certificate management policy attached from this reserved domain.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
+      def delete_certificate_management_policy
+        @certificate_management_policy = nil
+        @certificate_management_status = nil
+        @client.delete_certificate_management_policy(id: @id)
+      end
+
+      ##
+      # Detach the http endpoint configuration attached from this reserved domain.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
+      def delete_http_endpoint_config
+        @http_endpoint_configuration = nil
+        @client.delete_http_endpoint_config(id: @id)
+      end
+
+      ##
+      # Detach the https endpoint configuration attached from this reserved domain.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
+      def delete_https_endpoint_config
+        @https_endpoint_configuration = nil
+        @client.delete_https_endpoint_config(id: @id)
+      end
+
+      ##
+      # Restore the certificate attached to this reserved domain.
+      # Only works if the @result is still present from a previous action
+      #
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def restore_certificate
+        @certificate = @result['certificate']
+        @client.update(id: @id, certificate_id: @result['certificate']['id'])
+      end
+
+      ##
+      # Restore the certificate management policy attached to this reserved domain.
+      # Only works if the @result is still present from a previous action
+      #
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def restore_certificate_management_policy
+        @certificate_management_policy = @result['certificate_management_policy']
+        @certificate_management_status = @result['certificate_management_status']
+        @client.update(
+          id: @id,
+          certificate_management_policy: @result['certificate_management_policy']
+        )
+      end
+
+      ##
+      # Restore the http endpoint configuration attached to this reserved domain.
+      # Only works if the @result is still present from a previous action
+      #
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def restore_http_endpoint_config
+        @http_endpoint_configuration = @result['http_endpoint_configuration']
+        @client.update(
+          id: @id,
+          http_endpoint_configuration_id: @result['http_endpoint_configuration']['id']
+        )
+      end
+
+      ##
+      # Restore the https endpoint configuration attached to this reserved domain.
+      # Only works if the @result is still present from a previous action
+      #
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def restore_https_endpoint_config
+        @https_endpoint_configuration = @result['https_endpoint_configuration']
+        @client.update(
+          id: @id,
+          https_endpoint_configuration_id: @result['https_endpoint_configuration']['id']
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tls_certificate.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    ##
+    # A resource representing data from the tls_certificate API
+    class TlsCertificate
+      attr_reader :id,
+        :client,
+        :created_at,
+        :description,
+        :metadata,
+        :result,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @created_at = @result['created_at']
+        @id = @result['id']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete this TLS certificate.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-delete
+      def delete
+        @client.delete(id: @id)
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Update the attributes of this TLS Certificate.
+      #
+      # @param [string] description human-readable description of this TLS certificate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::TlsCertificate] result from update request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-update
+      def update(description: nil, metadata: nil)
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(id: @id, description: description, metadata: metadata)
+      end
+      # rubocop:enable LineLength
+    end
+  end
+end

data/lib/ngrokapi/paged_iterator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  ##
+  # Low level class which allows the user to iterate through the results of a list API call
+  class PagedIterator
+    attr_accessor :page, :n
+    attr_reader :client, :list_property
+
+    def initialize(
+      client:,
+      page:,
+      list_property:
+    )
+      @n = 0
+      @client = client
+      @list_property = list_property
+      @page = page
+    end
+
+    ##
+    # Iterate through the result set, returning the next instance if we already have one, or make
+    # a new API call to next_page_uri to get more results and return the next one from that call.
+    #
+    # @return [object] Returns an instance of a class.
+    def get_next
+      item = @page.result[@list_property][@n]
+      raise "None" if item.nil?
+      self.n += 1
+      item
+    rescue
+      if @page.next_page_uri
+        res = @client.list(url: @page.next_page_uri)
+        self.n = 0
+        self.page = res
+        get_next
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/api_keys_client.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A client for interacting with the api_keys API
+    #
+    # https://ngrok.com/docs/api#api-api-keys
+    class ApiKeysClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'keys'
+      # The API path for API keys
+      PATH = '/api_keys'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Create a new API key. The generated API key can be used to authenticate to the ngrok API.
+      #
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::ApiKey] result from create request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-create
+      def create(description: nil, metadata: nil)
+        result = @client.post(PATH, data: build_data(description: description, metadata: metadata))
+        NgrokAPI::Models::ApiKey.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Delete an API key by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-delete
+      def delete(id: nil)
+        @client.delete("#{PATH}/#{id}")
+      end
+
+      ##
+      # Delete an API key by ID. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-delete
+      def delete!(id: nil)
+        @client.delete("#{PATH}/#{id}", danger: true)
+      end
+
+      ##
+      # Get the details of an API key by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ApiKey] result from get request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-get
+      def get(id: nil)
+        result = @client.get("#{PATH}/#{id}")
+        NgrokAPI::Models::ApiKey.new(client: self, result: result)
+      end
+
+      ##
+      # Get the details of an API key by ID. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ApiKey] result from get request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-get
+      def get!(id: nil)
+        result = @client.get("#{PATH}/#{id}", danger: true)
+        NgrokAPI::Models::ApiKey.new(client: self, result: result)
+      end
+
+      ##
+      # List all API keys owned by this account.
+      #
+      # @param [string] before_id
+      # @param [integer] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] the result listable
+      #
+      # https://ngrok.com/docs/api#api-api-keys-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::ApiKey
+        )
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Update attributes of an API key by ID.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::ApiKey] result from update request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-update
+      def update(id: nil, description: nil, metadata: nil)
+        result = @client.patch("#{PATH}/#{id}", data: build_data(description: description, metadata: metadata))
+        NgrokAPI::Models::ApiKey.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an API key by ID.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::ApiKey] result from update request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-update
+      def update!(id: nil, description: nil, metadata: nil)
+        data = build_data(description: description, metadata: metadata)
+        result = @client.patch("#{PATH}/#{id}", danger: true, data: data)
+        NgrokAPI::Models::ApiKey.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      private
+
+      def build_data(description: nil, metadata: nil)
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data
+      end
+    end
+  end
+end