ngrok-api 0.14.0 → 0.17.0

data/spec/ngrokapi/services/edges_https_routes_client_spec.rb

@@ -0,0 +1,241 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::EdgesHTTPSRoutesClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/edges/https/%{edge_id}/routes' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: https_edge_route_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @edges_https_routes_client = NgrokAPI::Services::EdgesHTTPSRoutesClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::HTTPSEdgeRoute" do
+      path = '/edges/https/%{edge_id}/routes'
+      replacements = {
+        edge_id: https_edge_route_result["edge_id"],
+      }
+      data = {}
+      data[:match_type] = "New match_type"
+      data[:match] = "New match"
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:circuit_breaker] = "New circuit_breaker"
+      data[:compression] = "New compression"
+      data[:request_headers] = "New request_headers"
+      data[:response_headers] = "New response_headers"
+      data[:webhook_verification] = "New webhook_verification"
+      data[:oauth] = "New oauth"
+      data[:saml] = "New saml"
+      data[:oidc] = "New oidc"
+      data[:websocket_tcp_converter] = "New websocket_tcp_converter"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(https_edge_route_result)
+      result = @edges_https_routes_client.create(
+        edge_id: https_edge_route_result["edge_id"],
+        match_type: "New match_type",
+        match: "New match",
+        description: "New description",
+        metadata: "New metadata",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        circuit_breaker: "New circuit_breaker",
+        compression: "New compression",
+        request_headers: "New request_headers",
+        response_headers: "New response_headers",
+        webhook_verification: "New webhook_verification",
+        oauth: "New oauth",
+        saml: "New saml",
+        oidc: "New oidc",
+        websocket_tcp_converter: "New websocket_tcp_converter"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::HTTPSEdgeRoute)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::HTTPSEdgeRoute" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(https_edge_route_result)
+      result = @edges_https_routes_client.get(
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::HTTPSEdgeRoute)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::HTTPSEdgeRoute" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(https_edge_route_result)
+      result = @edges_https_routes_client.get(
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::HTTPSEdgeRoute)
+      # expect(result.id).to eq(https_edge_route_result["id"])
+    end
+  end
+
+  describe "#update" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::HTTPSEdgeRoute" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+      }
+      data = {}
+      data[:match_type] = "New match_type"
+      data[:match] = "New match"
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:circuit_breaker] = "New circuit_breaker"
+      data[:compression] = "New compression"
+      data[:request_headers] = "New request_headers"
+      data[:response_headers] = "New response_headers"
+      data[:webhook_verification] = "New webhook_verification"
+      data[:oauth] = "New oauth"
+      data[:saml] = "New saml"
+      data[:oidc] = "New oidc"
+      data[:websocket_tcp_converter] = "New websocket_tcp_converter"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(https_edge_route_result)
+      result = @edges_https_routes_client.update(
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+        match_type: "New match_type",
+        match: "New match",
+        description: "New description",
+        metadata: "New metadata",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        circuit_breaker: "New circuit_breaker",
+        compression: "New compression",
+        request_headers: "New request_headers",
+        response_headers: "New response_headers",
+        webhook_verification: "New webhook_verification",
+        oauth: "New oauth",
+        saml: "New saml",
+        oidc: "New oidc",
+        websocket_tcp_converter: "New websocket_tcp_converter"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::HTTPSEdgeRoute)
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::HTTPSEdgeRoute" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+      }
+      data = {}
+      data[:match_type] = "New match_type"
+      data[:match] = "New match"
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:circuit_breaker] = "New circuit_breaker"
+      data[:compression] = "New compression"
+      data[:request_headers] = "New request_headers"
+      data[:response_headers] = "New response_headers"
+      data[:webhook_verification] = "New webhook_verification"
+      data[:oauth] = "New oauth"
+      data[:saml] = "New saml"
+      data[:oidc] = "New oidc"
+      data[:websocket_tcp_converter] = "New websocket_tcp_converter"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(https_edge_route_result)
+      result = @edges_https_routes_client.update(
+        edge_id: https_edge_route_result["edge_id"],
+        id: https_edge_route_result["id"],
+        match_type: "New match_type",
+        match: "New match",
+        description: "New description",
+        metadata: "New metadata",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        circuit_breaker: "New circuit_breaker",
+        compression: "New compression",
+        request_headers: "New request_headers",
+        response_headers: "New response_headers",
+        webhook_verification: "New webhook_verification",
+        oauth: "New oauth",
+        saml: "New saml",
+        oidc: "New oidc",
+        websocket_tcp_converter: "New websocket_tcp_converter"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::HTTPSEdgeRoute)
+      # expect(result.id).to eq(https_edge_route_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: api_key_result["edge_id"],
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @edges_https_routes_client.delete(
+        edge_id: api_key_result["edge_id"],
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: api_key_result["edge_id"],
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @edges_https_routes_client.delete!(
+        edge_id: api_key_result["edge_id"],
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/edges/https/%{edge_id}/routes/%{id}'
+      replacements = {
+        edge_id: api_key_result["edge_id"],
+        id: api_key_result["id"],
+      }
+      expect do
+        expect(@client).to receive(:delete).with(path % replacements, danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result = @edges_https_routes_client.delete!(
+          edge_id: api_key_result["edge_id"],
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+end

data/spec/ngrokapi/services/edges_tcp_client_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::EdgesTCPClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/edges/tcp' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: tcp_edge_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @edges_tcp_client = NgrokAPI::Services::EdgesTCPClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::TCPEdge" do
+      path = '/edges/tcp'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(tcp_edge_result)
+      result = @edges_tcp_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TCPEdge)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::TCPEdge" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: tcp_edge_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(tcp_edge_result)
+      result = @edges_tcp_client.get(
+        id: tcp_edge_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TCPEdge)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::TCPEdge" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: tcp_edge_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(tcp_edge_result)
+      result = @edges_tcp_client.get(
+        id: tcp_edge_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TCPEdge)
+      # expect(result.id).to eq(tcp_edge_result["id"])
+    end
+  end
+
+  describe "#list" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      expect(@client).to receive(:list).
+        and_return(tcp_edge_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @edges_tcp_client.list(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+
+  describe "#update" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::TCPEdge" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: tcp_edge_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(tcp_edge_result)
+      result = @edges_tcp_client.update(
+        id: tcp_edge_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TCPEdge)
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::TCPEdge" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: tcp_edge_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(tcp_edge_result)
+      result = @edges_tcp_client.update(
+        id: tcp_edge_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TCPEdge)
+      # expect(result.id).to eq(tcp_edge_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @edges_tcp_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @edges_tcp_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/edges/tcp/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect do
+        expect(@client).to receive(:delete).with(path % replacements, danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result = @edges_tcp_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+end

data/spec/ngrokapi/services/edges_tls_client_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::EdgesTLSClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/edges/tls' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: tls_edge_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @edges_tls_client = NgrokAPI::Services::EdgesTLSClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::TLSEdge" do
+      path = '/edges/tls'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:mutual_tls] = "New mutual_tls"
+      data[:tls_termination] = "New tls_termination"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(tls_edge_result)
+      result = @edges_tls_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        mutual_tls: "New mutual_tls",
+        tls_termination: "New tls_termination"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSEdge)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::TLSEdge" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: tls_edge_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(tls_edge_result)
+      result = @edges_tls_client.get(
+        id: tls_edge_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSEdge)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::TLSEdge" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: tls_edge_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(tls_edge_result)
+      result = @edges_tls_client.get(
+        id: tls_edge_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSEdge)
+      # expect(result.id).to eq(tls_edge_result["id"])
+    end
+  end
+
+  describe "#list" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      expect(@client).to receive(:list).
+        and_return(tls_edge_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @edges_tls_client.list(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+
+  describe "#update" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::TLSEdge" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: tls_edge_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:mutual_tls] = "New mutual_tls"
+      data[:tls_termination] = "New tls_termination"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(tls_edge_result)
+      result = @edges_tls_client.update(
+        id: tls_edge_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        mutual_tls: "New mutual_tls",
+        tls_termination: "New tls_termination"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSEdge)
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::TLSEdge" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: tls_edge_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:hostports] = "New hostports"
+      data[:backend] = "New backend"
+      data[:ip_restriction] = "New ip_restriction"
+      data[:mutual_tls] = "New mutual_tls"
+      data[:tls_termination] = "New tls_termination"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(tls_edge_result)
+      result = @edges_tls_client.update(
+        id: tls_edge_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        hostports: "New hostports",
+        backend: "New backend",
+        ip_restriction: "New ip_restriction",
+        mutual_tls: "New mutual_tls",
+        tls_termination: "New tls_termination"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::TLSEdge)
+      # expect(result.id).to eq(tls_edge_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @edges_tls_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @edges_tls_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/edges/tls/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect do
+        expect(@client).to receive(:delete).with(path % replacements, danger: true).
+          and_raise(NgrokAPI::Errors::NotFoundError)
+        result = @edges_tls_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+end

data/spec/ngrokapi/services/endpoints_client_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::EndpointsClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/endpoints' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: endpoint_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @endpoints_client = NgrokAPI::Services::EndpointsClient.new(client: @client)
+  end
+
+  describe "#list" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      expect(@client).to receive(:list).
+        and_return(endpoint_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @endpoints_client.list(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Endpoint" do
+      path = '/endpoints/%{id}'
+      replacements = {
+        id: endpoint_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(endpoint_result)
+      result = @endpoints_client.get(
+        id: endpoint_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Endpoint)
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Endpoint" do
+      path = '/endpoints/%{id}'
+      replacements = {
+        id: endpoint_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(endpoint_result)
+      result = @endpoints_client.get(
+        id: endpoint_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Endpoint)
+      # expect(result.id).to eq(endpoint_result["id"])
+    end
+  end
+end