Updated per code review

2026-05-17 16:50:40 +00:00 · 2021-09-16 09:17:00 -06:00
parent edf29eeb48
commit 2e56d4facb
36 changed files with 18049 additions and 118 deletions
@@ -5,15 +5,11 @@ module NgrokAPI
  # Low-level api client for communicating with Ngrok's HTTP API.
  # Use this object to instantiate your clients.
  class Client
-    attr_reader :api_key,
-      :base_url
-
    def initialize(
      api_key:,
      base_url: 'https://api.ngrok.com'
    )
-      @api_key = api_key
-      @base_url = base_url
+      @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
    end

    ##
@@ -21,7 +17,7 @@ module NgrokAPI
    #
    # @return [NgrokAPI::Services::ApiKeysClient]
    def api_keys
-      @_api_keys ||= NgrokAPI::Services::ApiKeysClient.new(client: self)
+      @_api_keys ||= NgrokAPI::Services::ApiKeysClient.new(client: @client)
    end

    ##
@@ -30,7 +26,7 @@ module NgrokAPI
    # @return [NgrokAPI::Services::EndpointConfigurationsClient]
    def endpoint_configurations
      @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(
-        client: self
+        client: @client
      )
    end

@@ -39,7 +35,7 @@ module NgrokAPI
    #
    # @return [NgrokAPI::Services::ReservedDomainsClient]
    def reserved_domains
-      @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: self)
+      @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
    end

    ##
@@ -47,107 +43,7 @@ module NgrokAPI
    #
    # @return [NgrokAPI::Services::TlsCertificatesClient]
    def tls_certificates
-      @_tls_certificates ||= NgrokAPI::Services::TlsCertificatesClient.new(client: self)
-    end
-
-    ##
-    # Make a DELETE request to a given URI
-    #
-    # @param [string] path URL resource path
-    # @return [nil]
-    def delete(path)
-      uri = get_uri(path)
-      req = Net::HTTP::Delete.new(uri, headers)
-      json_do(uri, req)
-    end
-
-    ##
-    # Make a GET request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def get(path, data: {})
-      uri = get_uri(path, data: data)
-      req = Net::HTTP::Get.new(uri, headers)
-      json_do(uri, req)
-    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 [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def patch(path, data: {})
-      uri = get_uri(path)
-      req = Net::HTTP::Patch.new(uri, headers_with_json)
-      json_do(uri, req, data: data.to_json)
-    end
-
-    ##
-    # Make a POST request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def post(path, data: {})
-      uri = get_uri(path)
-      req = Net::HTTP::Post.new(uri, headers_with_json)
-      json_do(uri, req, 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, data: nil)
-      resp = Net::HTTP.start(uri.hostname, uri.port, req_options(uri)) do |http|
-        http.request(req, data)
-      end
-      JSON.parse(resp.body) if resp.body
-    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}"
+      @_tls_certificates ||= NgrokAPI::Services::TlsCertificatesClient.new(client: @client)
    end
  end
 end
@@ -0,0 +1,119 @@
+# 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
+    # @return [nil]
+    def delete(path)
+      uri = get_uri(path)
+      req = Net::HTTP::Delete.new(uri, headers)
+      json_do(uri, req)
+    end
+
+    ##
+    # Make a GET request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def get(path, data: {})
+      uri = get_uri(path, data: data)
+      req = Net::HTTP::Get.new(uri, headers)
+      json_do(uri, req)
+    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 [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def patch(path, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Patch.new(uri, headers_with_json)
+      json_do(uri, req, data: data.to_json)
+    end
+
+    ##
+    # Make a POST request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def post(path, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Post.new(uri, headers_with_json)
+      json_do(uri, req, 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, data: nil)
+      resp = Net::HTTP.start(uri.hostname, uri.port, req_options(uri)) do |http|
+        http.request(req, data)
+      end
+      JSON.parse(resp.body) if resp.body
+    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