RubyGems - ngrok-api - Versions diffs - 0.9.0 - Mend

ngrok-api 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (100) hide show

checksums.yaml +7 -0
data/.github/workflows/ci.yml +21 -0
data/.gitignore +13 -0
data/.rubocop.yml +28 -0
data/.rubocop_airbnb.yml +2 -0
data/.simplecov +1 -0
data/Gemfile +33 -0
data/Guardfile +16 -0
data/README.md +61 -0
data/Rakefile +7 -0
data/doc/NgrokAPI/Client.html +542 -0
data/doc/NgrokAPI/Error.html +305 -0
data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
data/doc/NgrokAPI/Errors.html +115 -0
data/doc/NgrokAPI/HttpClient.html +1104 -0
data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/doc/NgrokAPI/Models/Listable.html +934 -0
data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/doc/NgrokAPI/Models.html +117 -0
data/doc/NgrokAPI/PagedIterator.html +631 -0
data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/doc/NgrokAPI/Services.html +117 -0
data/doc/NgrokAPI.html +157 -0
data/doc/_index.html +309 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +126 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +126 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1227 -0
data/doc/top-level-namespace.html +110 -0
data/docs/NgrokAPI/Client.html +542 -0
data/docs/NgrokAPI/Error.html +305 -0
data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
data/docs/NgrokAPI/Errors.html +115 -0
data/docs/NgrokAPI/HttpClient.html +1104 -0
data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/docs/NgrokAPI/Models/Listable.html +934 -0
data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/docs/NgrokAPI/Models.html +117 -0
data/docs/NgrokAPI/PagedIterator.html +631 -0
data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/docs/NgrokAPI/Services.html +117 -0
data/docs/NgrokAPI.html +157 -0
data/docs/_index.html +309 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +497 -0
data/docs/file.README.html +126 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +126 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +1227 -0
data/docs/top-level-namespace.html +110 -0
data/lib/ngrokapi/client.rb +49 -0
data/lib/ngrokapi/error.rb +14 -0
data/lib/ngrokapi/errors/not_found_error.rb +16 -0
data/lib/ngrokapi/http_client.rb +132 -0
data/lib/ngrokapi/models/api_key.rb +64 -0
data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
data/lib/ngrokapi/models/listable.rb +42 -0
data/lib/ngrokapi/models/reserved_domain.rb +211 -0
data/lib/ngrokapi/models/tls_certificate.rb +62 -0
data/lib/ngrokapi/paged_iterator.rb +40 -0
data/lib/ngrokapi/services/api_keys_client.rb +144 -0
data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
data/lib/ngrokapi/version.rb +7 -0
data/lib/ngrokapi.rb +13 -0
data/ngrok-api.gemspec +27 -0
data/spec/ngrokapi/client_spec.rb +33 -0
data/spec/ngrokapi/http_client_spec.rb +75 -0
data/spec/ngrokapi/models/api_key_spec.rb +43 -0
data/spec/ngrokapi/models/listable_spec.rb +43 -0
data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
data/spec/spec_helper.rb +80 -0
metadata +144 -0

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.26
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Fri Sep 24 19:20:29 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-3.0.1).
+</div>
+    </div>
+  </body>
+</html>

data/lib/ngrokapi/client.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module NgrokAPI
+  ##
+  # Low-level api client for communicating with Ngrok's HTTP API.
+  # Use this object to instantiate your clients.
+  class Client
+    def initialize(
+      api_key:,
+      base_url: 'https://api.ngrok.com'
+    )
+      @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
+    end
+    ##
+    # Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient
+    #
+    # @return [NgrokAPI::Services::ApiKeysClient]
+    def api_keys
+      @_api_keys ||= NgrokAPI::Services::ApiKeysClient.new(client: @client)
+    end
+    ##
+    # Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient
+    #
+    # @return [NgrokAPI::Services::EndpointConfigurationsClient]
+    def endpoint_configurations
+      @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(
+        client: @client
+      )
+    end
+    ##
+    # Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient
+    #
+    # @return [NgrokAPI::Services::ReservedDomainsClient]
+    def reserved_domains
+      @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
+    end
+    ##
+    # Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient
+    #
+    # @return [NgrokAPI::Services::TlsCertificatesClient]
+    def tls_certificates
+      @_tls_certificates ||= NgrokAPI::Services::TlsCertificatesClient.new(client: @client)
+    end
+  end
+end

data/lib/ngrokapi/error.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module NgrokAPI
+  ##
+  # Base Error class for all Ngrok Errors
+  class Error < StandardError
+    attr_reader :response
+    def initialize(msg: "An error occurred with the NgrokAPI", response: nil)
+      @response = response
+      super(msg)
+    end
+  end
+end

data/lib/ngrokapi/errors/not_found_error.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module NgrokAPI
+  module Errors
+    ##
+    # Error representing a 404 not found
+    class NotFoundError < NgrokAPI::Error
+      attr_reader :response
+      def initialize(msg: "Resource not found", response: nil)
+        @response = response
+        super(msg: msg, response: response)
+      end
+    end
+  end
+end

data/lib/ngrokapi/http_client.rb ADDED Viewed

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+module NgrokAPI
+  ##
+  # Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have
+  # to use this class directly, but use the individual clients to make your API calls.
+  class HttpClient
+    attr_reader :api_key,
+      :base_url
+    def initialize(
+      api_key:,
+      base_url: 'https://api.ngrok.com'
+    )
+      @api_key = api_key
+      @base_url = base_url
+    end
+    ##
+    # Make a DELETE request to a given URI
+    #
+    # @param [string] path URL resource path.
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @return [nil]
+    def delete(path, danger: false)
+      uri = get_uri(path)
+      req = Net::HTTP::Delete.new(uri, headers)
+      json_do(uri, req, danger: danger)
+    end
+    ##
+    # Make a GET request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def get(path, danger: false, data: {})
+      uri = get_uri(path, data: data)
+      req = Net::HTTP::Get.new(uri, headers)
+      json_do(uri, req, danger: danger)
+    end
+    ##
+    # Make a GET request
+    #
+    # @param [string] before_id URL resource path
+    # @param [integer] limit URL resource path
+    # @param [string] path resource path, mutually exclusive with url
+    # @param [string] url Full URL of the resource, mutually exclusive with path
+    # @return [json] response body
+    def list(before_id: nil, limit: nil, path: nil, url: nil)
+      if url
+        get(url)
+      else
+        data = {}
+        data[:before_id] = before_id if before_id
+        data[:limit] = limit if limit
+        get(path, data: data)
+      end
+    end
+    ##
+    # Make a PATCH request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def patch(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Patch.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: data.to_json)
+    end
+    ##
+    # Make a POST request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def post(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Post.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: data.to_json)
+    end
+    private
+    def headers
+      {
+        'Authorization': "Bearer #{@api_key}",
+        'Ngrok-Version': '2',
+      }
+    end
+    def headers_with_json
+      headers.merge({ 'Content-Type': 'application/json' })
+    end
+    def json_do(uri, req, danger: false, data: nil)
+      resp = Net::HTTP.start(uri.hostname, uri.port, req_options(uri)) do |http|
+        http.request(req, data)
+      end
+      if danger
+        if resp.code.to_i == 404
+          raise NgrokAPI::Errors::NotFoundError.new(response: resp)
+        elsif resp.code.to_i >= 400
+          raise NgrokAPI::Error.new(response: resp)
+        end
+      end
+      if resp.body && resp.body != ''
+        JSON.parse(resp.body)
+      end
+    end
+    def req_options(uri)
+      { use_ssl: uri.scheme == 'https' }
+    end
+    def get_uri(path, data: nil)
+      data = (!data.nil? && data != {}) ? "?#{URI.encode_www_form(data)}" : ""
+      URI("#{url(path)}#{data}")
+    end
+    def url(path)
+      path = path.delete_prefix(@base_url)
+      "#{@base_url}#{path}"
+    end
+  end
+end

data/lib/ngrokapi/models/api_key.rb ADDED Viewed

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module NgrokAPI
+  module Models
+    ##
+    # A resource representing data from the api_keys API
+    class ApiKey
+      attr_reader :id,
+        :client,
+        :created_at,
+        :description,
+        :metadata,
+        :result,
+        :token,
+        :uri
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @created_at = @result['created_at']
+        @id = @result['id']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @token = @result['token']
+        @uri = @result['uri']
+      end
+      def ==(other)
+        @result == other.result
+      end
+      def to_s
+        @result.to_s
+      end
+      ##
+      # Delete this API key.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-delete
+      def delete
+        @client.delete(id: @id)
+      end
+      # rubocop:disable LineLength
+      ##
+      # Update the attributes of this API key.
+      #
+      # @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(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/models/endpoint_configuration.rb ADDED Viewed

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+module NgrokAPI
+  module Models
+    ##
+    # A resource representing data from the endpoint_configuration API
+    class EndpointConfiguration
+      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 endpoint configuration.
+      #
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
+      def delete
+        @client.delete(id: @id)
+      end
+      # rubocop:disable LineLength
+      ##
+      # Update this 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.
+      #
+      # @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
+      # @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
+      # @param [string] circuit_breaker circuit breaker module configuration
+      # @param [string] compression compression module configuration
+      # @param [string] request_headers request headers module configuration
+      # @param [string] response_headers response headers module configuration
+      # @param [string] ip_policy ip policy module configuration
+      # @param [string] mutual_tls mutual TLS module configuration
+      # @param [string] tls_termination TLS termination module configuration
+      # @param [string] webhook_validation webhook validation module configuration
+      # @param [string] oauth oauth module configuration
+      # @param [string] logging logging module configuration
+      # @param [string] saml saml module configuration
+      # @param [string] oidc oidc module configuration
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from update request
+      #
+      # 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
+      # rubocop:enable LineLength
+    end
+  end
+end

data/lib/ngrokapi/models/listable.rb ADDED Viewed

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module NgrokAPI
+  module Models
+    ##
+    # A resource representing multiple instances from a given "list" API call
+    class Listable
+      attr_reader :client,
+        :klass,
+        :iter,
+        :items,
+        :list_property,
+        :next_page_uri,
+        :result,
+        :uri
+      def initialize(client:, result:, list_property:, klass:)
+        @client = client
+        @result = result
+        @list_property = list_property
+        @next_page_uri = @result['next_page_uri']
+        @uri = @result['uri']
+        @items = @result[list_property].map do |item|
+          klass.new(client: client, result: item)
+        end
+        @iter = NgrokAPI::PagedIterator.new(
+          client: client,
+          page: self,
+          list_property: list_property
+        )
+      end
+      def ==(other)
+        @result == other.result
+      end
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end