ngrok-api-ruby/lib/ngrokapi/http_client.rb

# 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 to list resources
    #
    # @param [boolean] danger determine if we should throw an exception on 404 or not
    # @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
    # @param [string] url Full URL of the resource, mutually exclusive with path
    # @return [json] response body
    def list(danger: false, 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, danger: danger, 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