ngrok-api 0.9.0

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A client for interacting with the tls_certificates API
+    #
+    # https://ngrok.com/docs/api#api-tls-certificates
+    class TlsCertificatesClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'tls_certificates'
+      # The API path for tls certificates
+      PATH = '/tls_certificates'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Upload a new 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.
+      # @param [string] certificate_pem chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_.
+      # @param [string] private_key_pem private key for the TLS certificate, PEM-encoded. See `Private Keys` <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.
+      # @return [NgrokAPI::Models::TlsCertificate] result from create request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-create
+      def create(
+        certificate_pem: '',
+        description: '',
+        metadata: '',
+        private_key_pem: ''
+      )
+        data = {
+          certificate_pem: certificate_pem,
+          description: description,
+          metadata: metadata,
+          private_key_pem: private_key_pem,
+        }
+        result = @client.post(PATH, data: data)
+        NgrokAPI::Models::TlsCertificate.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Delete a TLS certificate by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-delete
+      def delete(id: nil)
+        @client.delete("#{PATH}/#{id}")
+      end
+
+      ##
+      # Delete a TLS certificate 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-tls-certificates-delete
+      def delete!(id: nil)
+        @client.delete("#{PATH}/#{id}", danger: true)
+      end
+
+      ##
+      # Get detailed information about a TLS certificate by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TlsCertificate] result from get request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-get
+      def get(id: nil)
+        result = @client.get("#{PATH}/#{id}")
+        NgrokAPI::Models::TlsCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about a TLS certificate by ID. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TlsCertificate] result from get request
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-get
+      def get!(id: nil)
+        result = @client.get("#{PATH}/#{id}", danger: true)
+        NgrokAPI::Models::TlsCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # List all TLS certificates on 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-tls-certificates-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::TlsCertificate
+        )
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Update attributes of a TLS Certificate by ID.
+      #
+      # @param [string] id
+      # @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(
+        id: nil,
+        description: nil,
+        metadata: nil
+      )
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch("#{PATH}/#{id}", data: data)
+        NgrokAPI::Models::TlsCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of a TLS Certificate by ID. Throw an exception if 404.
+      #
+      # @param [string] id
+      # @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!(
+        id: nil,
+        description: nil,
+        metadata: nil
+      )
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch("#{PATH}/#{id}", danger: true, data: data)
+        NgrokAPI::Models::TlsCertificate.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+    end
+  end
+end

data/lib/ngrokapi/version.rb

@@ -0,0 +1,7 @@
+module NgrokAPI
+  # rubocop:disable Layout/SpaceAroundOperators
+
+  # The current version of the gem
+  VERSION="0.9.0".freeze
+  # rubocop:enable Layout/SpaceAroundOperators
+end

data/lib/ngrokapi.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+Dir[File.join('.', 'lib', '**/*.rb')].each do |f|
+  require f
+end
+
+##
+# The Module which contains the Ngrok API gem
+module NgrokAPI
+end

data/ngrok-api.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'ngrokapi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ngrok-api'
+  s.version     = NgrokAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['']
+  s.email       = ['']
+  s.homepage    = 'https://github.com/ngrok/ngrok-api-ruby'
+  s.summary     = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+    it easier to consume in Ruby.'
+  s.description = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+    it easier to consume in Ruby.'
+
+  s.required_ruby_version = '>= 3.0.0'
+
+  all_files = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split('\n')
+
+  s.files = all_files - test_files
+  s.executables = `git ls-files -- bin/*`.split('\n').map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/ngrokapi/client_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Client do
+  before(:each) do
+    @client = NgrokAPI::Client.new(api_key: 'abc')
+  end
+
+  describe "#api_keys" do
+    it "returns an instance of the api_keys_client" do
+      expect(@client.api_keys.class).to eq(NgrokAPI::Services::ApiKeysClient)
+    end
+  end
+
+  describe "#endpoint_configurations" do
+    it "returns an instance of the endpoint_configurations_client" do
+      expect(@client.endpoint_configurations.class).to eq(
+        NgrokAPI::Services::EndpointConfigurationsClient
+      )
+    end
+  end
+
+  describe "#reserved_domains" do
+    it "returns an instance of the reserved_domains_client" do
+      expect(@client.reserved_domains.class).to eq(NgrokAPI::Services::ReservedDomainsClient)
+    end
+  end
+
+  describe "#tls_certificates" do
+    it "returns an instance of the tls_certificates_client" do
+      expect(@client.tls_certificates.class).to eq(NgrokAPI::Services::TlsCertificatesClient)
+    end
+  end
+end

data/spec/ngrokapi/http_client_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::HttpClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/api_keys' }
+
+  before(:each) do
+    api_key = 'abc'
+    @client = NgrokAPI::HttpClient.new(api_key: api_key)
+  end
+
+  describe "#delete" do
+    it "will delete and return an empty body" do
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:delete, url).to_return(body: nil)
+      expect(@client.delete(url)).to eq(nil)
+    end
+  end
+
+  describe "#get" do
+    it "will get the returned resource json" do
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:get, url).to_return(body: api_key_result.to_json)
+      expect(@client.get(url)).to eq(api_key_result)
+    end
+
+    it "will raise a NotFoundError if 404" do
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:get, url).to_return(body: nil, status: 404)
+      expect do
+        @client.get(url, danger: true)
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+
+    it "will raise a NgrokAPI::Error if >= 400" do
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:get, url).to_return(body: nil, status: 400)
+      expect do
+        @client.get(url, danger: true)
+      end.to raise_error(NgrokAPI::Error)
+    end
+  end
+
+  describe "#list" do
+    it "with a url will return based on the absolute URL" do
+      url = "#{base_url}#{path}?before_id=#{api_key_result["id"]}&limit=1"
+      stub_request(:get, url).to_return(body: api_key_results.to_json)
+      expect(@client.list(url: url)).to eq(api_key_results)
+    end
+
+    it "without a url will return based on the path, before_id, and limit" do
+      url = "#{base_url}#{path}?before_id=#{api_key_result["id"]}&limit=1"
+      stub_request(:get, url).to_return(body: api_key_results.to_json)
+      expect(@client.list(before_id: api_key_result["id"], limit: 1, path: path)).to eq(api_key_results)
+    end
+  end
+
+  describe "#patch" do
+    it "updates an existing resource" do
+      merged = api_key_result
+      merged['metadata'] = 'updated'
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:patch, url).to_return(body: merged.to_json)
+      expect(@client.patch(url)).to eq(merged)
+    end
+  end
+
+  describe "#post" do
+    it "creates a new resource" do
+      url = "#{base_url}#{path}/#{api_key_result["id"]}"
+      stub_request(:post, url).to_return(body: api_key_result.to_json)
+      expect(@client.post(url)).to eq(api_key_result)
+    end
+  end
+end

data/spec/ngrokapi/models/api_key_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::ApiKey do
+  before(:each) do
+    @client = class_double("ApiKeysClient")
+    @api_key = NgrokAPI::Models::ApiKey.new(client: @client, result: api_key_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      key2 = NgrokAPI::Models::ApiKey.new(client: @client, result: api_key_result)
+      expect(@api_key == key2).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@api_key.to_s).to eq api_key_result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@api_key.client).to receive(:delete)
+      @api_key.delete
+    end
+  end
+
+  describe "#update" do
+    it "updates instance's description and metadata and call update on the client" do
+      new_description = 'new description'
+      new_metadata = 'new metadata'
+      expect(@api_key.client).to receive(:update)
+
+      @api_key.update(
+        description: new_description,
+        metadata: new_metadata,
+      )
+      expect(@api_key.description).to eq new_description
+      expect(@api_key.metadata).to eq new_metadata
+    end
+  end
+end

data/spec/ngrokapi/models/listable_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::Listable do
+  before(:each) do
+    @client = class_double("ApiKeysClient")
+    @listable = NgrokAPI::Models::Listable.new(
+      client: @client,
+      result: api_key_results,
+      list_property: 'keys',
+      klass: NgrokAPI::Models::ApiKey
+    )
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      listable2 = NgrokAPI::Models::Listable.new(
+        client: @client,
+        result: api_key_results,
+        list_property: 'keys',
+        klass: NgrokAPI::Models::ApiKey
+      )
+      expect(@listable == listable2).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@listable.to_s).to eq api_key_results.to_s
+    end
+  end
+
+  describe "keys" do
+    it "consistent of ApiKeys" do
+      expect(@listable.items.size).to eq api_key_results['keys'].size
+    end
+  end
+
+  describe "iter" do
+    it "is a PagedIterator" do
+      expect(@listable.iter.class).to eq NgrokAPI::PagedIterator
+    end
+  end
+end

data/spec/ngrokapi/models/reserved_domain_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::ReservedDomain do
+  let(:result) do
+    {
+      "id" => "rd_1xxLksFRG6o5MoAKX8UrtPnXbmz",
+      "uri" => "https://api.ngrok.com/reserved_domains/rd_1xxLksFRG6o5MoAKX8UrtPnXbmz",
+      "created_at" => "2021-09-10T16:38:58Z",
+      "description" => "",
+      "metadata" => "",
+      "domain" => "tahouetnaoh.ngrok.io",
+      "region" => "us",
+      "cname_target" => nil,
+      "http_endpoint_configuration" => {
+        "id" => "ec_1xv9oZpu0g1sbaZvxuqKQJVCLW5",
+        "uri" => "https://api.ngrok.com/endpoint_configurations/ec_1xv9oZpu0g1sbaZvxuqKQJVCLW5",
+      },
+      "https_endpoint_configuration" => nil,
+      "certificate" => nil,
+      "certificate_management_policy" => nil,
+      "certificate_management_status" => nil,
+    }
+  end
+
+  before(:each) do
+    @client = class_double("ReservedDomainsClient")
+    @domain = NgrokAPI::Models::ReservedDomain.new(client: @client, result: result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      domain2 = NgrokAPI::Models::ReservedDomain.new(client: @client, result: result)
+      expect(@domain == domain2).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@domain.to_s).to eq result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@domain.client).to receive(:delete)
+      @domain.delete
+    end
+  end
+
+  describe "#update" do
+    it "updates the instance's description and metadata and call update on the client" do
+      # new_certificate_id = 'new certificate_id'
+      # new_http_endpoint_configuration_id = 'new http_endpoint_configuration_id'
+      # new_https_endpoint_configuration_id = 'new https_endpoint_configuration_id'
+      new_certificate_management_policy = 'new certificate_management_policy'
+      new_description = 'new description'
+      new_metadata = 'new metadata'
+      expect(@domain.client).to receive(:update)
+
+      # certificate_id: new_certificate_id,
+      # http_endpoint_configuration_id: new_http_endpoint_configuration_id,
+      # https_endpoint_configuration_id: new_https_endpoint_configuration_id
+      @domain.update(
+        description: new_description,
+        metadata: new_metadata,
+        certificate_management_policy: new_certificate_management_policy
+      )
+      expect(@domain.description).to eq new_description
+      expect(@domain.metadata).to eq new_metadata
+      expect(@domain.certificate_management_policy).to eq new_certificate_management_policy
+      # expect(@domain.certificate_id).to eq new_certificate_id
+      # expect(@domain.http_endpoint_configuration_id).to eq new_http_endpoint_configuration_id
+      # expect(@domain.https_endpoint_configuration_id).to eq new_https_endpoint_configuration_id
+    end
+  end
+
+  describe "#delete_certificate" do
+  end
+
+  describe "#delete_certificate_management_policy" do
+  end
+
+  describe "#delete_http_endpoint_config" do
+  end
+
+  describe "#delete_https_endpoint_config" do
+  end
+
+  describe "#restore_certificate" do
+  end
+
+  describe "#restore_certificate_management_policy" do
+  end
+
+  describe "#restore_http_endpoint_config" do
+  end
+
+  describe "#restore_https_endpoint_config" do
+  end
+end

data/spec/ngrokapi/paged_iterator_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::PagedIterator do
+  let(:client) { class_double("ApiKeysClient") }
+  let(:uri) { "https://api.ngrok.com/api_keys" }
+  let(:next_page_uri) { "#{uri}?before_id=ak_1xuyYBCA83z5zo2MkBJ0JjvxPIs&limit=1" }
+  let(:results) do
+    { "keys" => [api_key_result], "uri" => uri, "next_page_uri" => next_page_uri }
+  end
+  let(:empty_results) do
+    { "keys" => [], "uri" => uri, "next_page_uri" => next_page_uri }
+  end
+  let(:empty_last_results) do
+    { "keys" => [], "uri" => uri, "next_page_uri" => nil }
+  end
+  let(:item) { NgrokAPI::Models::ApiKey.new(client: client, result: api_key_result) }
+  let(:page) do
+    NgrokAPI::Models::Listable.new(
+      client: client,
+      result: results,
+      list_property: 'keys',
+      klass: NgrokAPI::Models::ApiKey
+    )
+  end
+  let(:empty_page) do
+    NgrokAPI::Models::Listable.new(
+      client: client,
+      result: empty_results,
+      list_property: 'keys',
+      klass: NgrokAPI::Models::ApiKey
+    )
+  end
+  let(:empty_last_page) do
+    NgrokAPI::Models::Listable.new(
+      client: client,
+      result: empty_last_results,
+      list_property: 'keys',
+      klass: NgrokAPI::Models::ApiKey
+    )
+  end
+
+  describe "#get_next" do
+    it "gets the next result from cache" do
+      paged_iterator = NgrokAPI::PagedIterator.new(
+        client: client,
+        page: page,
+        list_property: 'keys'
+      )
+      expect(page).not_to receive(:next_page_uri)
+      expect(paged_iterator.get_next).to eq(api_key_result)
+    end
+
+    it "gets the next result based on next_page_uri if not in cache" do
+      paged_iterator = NgrokAPI::PagedIterator.new(
+        client: client,
+        page: empty_page,
+        list_property: 'keys'
+      )
+      expect(empty_page).to receive(:result).and_return(item)
+      expect(empty_page).to receive(:next_page_uri)
+      expect(paged_iterator.get_next).to eq(nil)
+    end
+
+    it "gets the next result based on next_page_uri if not in cache (with data)" do
+      paged_iterator = NgrokAPI::PagedIterator.new(
+        client: client,
+        page: empty_page,
+        list_property: 'keys'
+      )
+      expect(client).to receive(:list).with({ url: next_page_uri }).and_return(page)
+      expect(paged_iterator.get_next).to eq(api_key_result)
+    end
+
+    it "gets the next result based on next_page_uri if not in cache (without data)" do
+      paged_iterator = NgrokAPI::PagedIterator.new(
+        client: client,
+        page: empty_page,
+        list_property: 'keys'
+      )
+      expect(client).to receive(:list).with({ url: next_page_uri }).and_return(empty_last_page)
+      expect(paged_iterator.get_next).to eq(nil)
+    end
+  end
+end