ngrok-api 0.9.0 → 0.12.0

data/spec/ngrokapi/services/api_keys_client_spec.rb

@@ -1,127 +1,160 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Services::ApiKeysClient do
-  let(:base_url) { 'https://api.ngrok.com' }
-  let(:path) { '/api_keys' }
-  let(:not_found) do
-    NgrokAPI::Errors::NotFoundError.new(response: api_key_result)
-  end
-
-  before(:each) do
-    @client = class_double("HttpClient")
-    @api_keys_client = NgrokAPI::Services::ApiKeysClient.new(client: @client)
-  end
-
-  describe "#create" do
-    it "will make a POST request and return a newly created instance of NgrokAPI::Models::ApiKey" do
-      merged = api_key_result
-      merged['metadata'] = 'data'
-      expect(@client).to receive(:post).with(path, data: { metadata: 'data' }).and_return(merged)
-      result2 = @api_keys_client.create(metadata: 'data')
-      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
-      expect(result2.id).to eq(api_key_result["id"])
-      expect(result2.metadata).to eq('data')
-    end
-  end
-
-  describe "#delete" do
-    it "will make a DELETE request" do
-      expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}").and_return(nil)
-      @api_keys_client.delete(id: api_key_result["id"])
-    end
-  end
-
-  describe "#delete!" do
-    it "will make a DELETE request" do
-      expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}", danger: true).
-        and_return(nil)
-      @api_keys_client.delete!(id: api_key_result["id"])
-    end
-
-    it "will make a DELETE request and return NotFoundError if 404" do
-      expect do
-        expect(@client).to receive(:delete).with("#{path}/#{api_key_result["id"]}", danger: true).
-          and_raise(NgrokAPI::Errors::NotFoundError)
-        result2 = @api_keys_client.delete!(id: api_key_result["id"])
-        expect(result2).to be nil
-      end.to raise_error(NgrokAPI::Errors::NotFoundError)
-    end
-  end
-
-  describe "#get" do
-    it "will make a GET request and return a NgrokAPI::Models::ApiKey" do
-      expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}").and_return(api_key_result)
-      result2 = @api_keys_client.get(id: api_key_result["id"])
-      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
-      expect(result2.id).to eq(api_key_result["id"])
-    end
-  end
-
-  describe "#get!" do
-    it "will make a GET request and return a NgrokAPI::Models::ApiKey" do
-      expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}", danger: true).and_return(api_key_result)
-      result2 = @api_keys_client.get!(id: api_key_result["id"])
-      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
-      expect(result2.id).to eq(api_key_result["id"])
-    end
-
-    it "will make a GET request and return NotFoundError if 404" do
-      expect do
-        expect(@client).to receive(:get).with("#{path}/#{api_key_result["id"]}", danger: true).
-          and_raise(NgrokAPI::Errors::NotFoundError)
-        result2 = @api_keys_client.get!(id: api_key_result["id"])
-        expect(result2).to be nil
-      end.to raise_error(NgrokAPI::Errors::NotFoundError)
-    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(api_key_results)
-      url = "#{base_url}#{path}?before_id=#{api_key_result["id"]}&limit=1"
-      result2 = @api_keys_client.list(url: url)
-      expect(result2.class).to eq(NgrokAPI::Models::Listable)
-      expect(result2.items.first.id).to eq(api_key_result["id"])
-    end
-  end
-
-  describe "#update" do
-    it "will make a PATCH request and return an updated instance of NgrokAPI::Models::ApiKey" do
-      merged = api_key_result
-      merged['metadata'] = 'data'
-      expect(@client).to receive(:patch).
-        with("#{path}/#{api_key_result["id"]}", data: { metadata: 'data' }).
-        and_return(merged)
-      result2 = @api_keys_client.update(id: api_key_result["id"], metadata: 'data')
-      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
-      expect(result2.id).to eq(api_key_result["id"])
-      expect(result2.metadata).to eq('data')
-    end
-  end
-
-  describe "#update!" do
-    it "will make a PATCH request and return an updated instance of NgrokAPI::Models::ApiKey" do
-      merged = api_key_result
-      merged['metadata'] = 'data'
-      expect(@client).to receive(:patch).
-        with("#{path}/#{api_key_result["id"]}", danger: true, data: { metadata: 'data' }).
-        and_return(merged)
-      result2 = @api_keys_client.update!(id: api_key_result["id"], metadata: 'data')
-      expect(result2.class).to eq(NgrokAPI::Models::ApiKey)
-      expect(result2.id).to eq(api_key_result["id"])
-      expect(result2.metadata).to eq('data')
-    end
-
-    it "will make a PATCH request and return NotFoundError if 404" do
-      expect do
-        merged = api_key_result
-        merged['metadata'] = 'data'
-        expect(@client).to receive(:patch).
-          with("#{path}/#{api_key_result["id"]}", danger: true, data: { metadata: 'data' }).
-          and_raise(NgrokAPI::Errors::NotFoundError)
-        result2 = @api_keys_client.update!(id: api_key_result["id"], metadata: 'data')
-        expect(result2).to be nil
-      end.to raise_error(NgrokAPI::Errors::NotFoundError)
-    end
-  end
-end
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::APIKeysClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/api_keys' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: api_key_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @api_keys_client = NgrokAPI::Services::APIKeysClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::APIKey" do
+      path = '/api_keys'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(api_key_result)
+      result = @api_keys_client.create(
+        description: "New description",
+        metadata: "New metadata"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::APIKey)
+      # expect(result.id).to eq(api_key_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @api_keys_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @api_keys_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/api_keys/%{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 = @api_keys_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::APIKey" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(api_key_result)
+      result = @api_keys_client.get(
+        id: api_key_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::APIKey)
+      # expect(result.id).to eq(api_key_result["id"])
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::APIKey" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(api_key_result)
+      result = @api_keys_client.get(
+        id: api_key_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::APIKey)
+      # expect(result.id).to eq(api_key_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(api_key_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @api_keys_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::APIKey" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(api_key_result)
+      result = @api_keys_client.update(
+        id: api_key_result["id"],
+        description: "New description",
+        metadata: "New metadata"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::APIKey)
+      # expect(result.id).to eq(api_key_result["id"])
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::APIKey" do
+      path = '/api_keys/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(api_key_result)
+      result = @api_keys_client.update(
+        id: api_key_result["id"],
+        description: "New description",
+        metadata: "New metadata"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::APIKey)
+      # expect(result.id).to eq(api_key_result["id"])
+    end
+  end
+end

data/spec/ngrokapi/services/certificate_authorities_client_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::CertificateAuthoritiesClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/certificate_authorities' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: certificate_authority_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @certificate_authorities_client = NgrokAPI::Services::CertificateAuthoritiesClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::CertificateAuthority" do
+      path = '/certificate_authorities'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:ca_pem] = "New ca_pem"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(certificate_authority_result)
+      result = @certificate_authorities_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        ca_pem: "New ca_pem"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority)
+      # expect(result.id).to eq(certificate_authority_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @certificate_authorities_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @certificate_authorities_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/certificate_authorities/%{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 = @certificate_authorities_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::CertificateAuthority" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: certificate_authority_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(certificate_authority_result)
+      result = @certificate_authorities_client.get(
+        id: certificate_authority_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority)
+      # expect(result.id).to eq(certificate_authority_result["id"])
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::CertificateAuthority" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: certificate_authority_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(certificate_authority_result)
+      result = @certificate_authorities_client.get(
+        id: certificate_authority_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority)
+      # expect(result.id).to eq(certificate_authority_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(certificate_authority_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @certificate_authorities_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::CertificateAuthority" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: certificate_authority_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(certificate_authority_result)
+      result = @certificate_authorities_client.update(
+        id: certificate_authority_result["id"],
+        description: "New description",
+        metadata: "New metadata"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority)
+      # expect(result.id).to eq(certificate_authority_result["id"])
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::CertificateAuthority" do
+      path = '/certificate_authorities/%{id}'
+      replacements = {
+        id: certificate_authority_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(certificate_authority_result)
+      result = @certificate_authorities_client.update(
+        id: certificate_authority_result["id"],
+        description: "New description",
+        metadata: "New metadata"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority)
+      # expect(result.id).to eq(certificate_authority_result["id"])
+    end
+  end
+end

data/spec/ngrokapi/services/credentials_client_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Services::CredentialsClient do
+  let(:base_url) { 'https://api.ngrok.com' }
+  let(:path) { '/credentials' }
+  let(:not_found) do
+    NgrokAPI::Errors::NotFoundError.new(response: credential_result)
+  end
+
+  before(:each) do
+    @client = class_double("HttpClient")
+    @credentials_client = NgrokAPI::Services::CredentialsClient.new(client: @client)
+  end
+
+  describe "#create" do
+    it "will make a post request and return an instance of NgrokAPI::Models::Credential" do
+      path = '/credentials'
+      replacements = {
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:acl] = "New acl"
+      expect(@client).to receive(:post).with(path % replacements, data: data).
+        and_return(credential_result)
+      result = @credentials_client.create(
+        description: "New description",
+        metadata: "New metadata",
+        acl: "New acl"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Credential)
+      # expect(result.id).to eq(credential_result["id"])
+    end
+  end
+
+  describe "#delete" do
+    it "will make a delete request" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
+      @credentials_client.delete(
+        id: api_key_result["id"]
+      )
+    end
+  end
+
+  describe "#delete!" do
+    it "will make a delete request" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: api_key_result["id"],
+      }
+      expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
+      @credentials_client.delete!(
+        id: api_key_result["id"]
+      )
+    end
+
+    it "will make a delete request and return NotFoundError if 404" do
+      path = '/credentials/%{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 = @credentials_client.delete!(
+          id: api_key_result["id"]
+        )
+        expect(result).to be nil
+      end.to raise_error(NgrokAPI::Errors::NotFoundError)
+    end
+  end
+
+  describe "#get" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Credential" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: credential_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(credential_result)
+      result = @credentials_client.get(
+        id: credential_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Credential)
+      # expect(result.id).to eq(credential_result["id"])
+    end
+  end
+
+  describe "#get!" do
+    it "will make a get request and return an instance of NgrokAPI::Models::Credential" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: credential_result["id"],
+      }
+      data = {}
+      expect(@client).to receive(:get).with(path % replacements, data: data).
+        and_return(credential_result)
+      result = @credentials_client.get(
+        id: credential_result["id"]
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Credential)
+      # expect(result.id).to eq(credential_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(credential_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @credentials_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::Credential" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: credential_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:acl] = "New acl"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(credential_result)
+      result = @credentials_client.update(
+        id: credential_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        acl: "New acl"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Credential)
+      # expect(result.id).to eq(credential_result["id"])
+    end
+  end
+
+  describe "#update!" do
+    it "will make a patch request and return an instance of NgrokAPI::Models::Credential" do
+      path = '/credentials/%{id}'
+      replacements = {
+        id: credential_result["id"],
+      }
+      data = {}
+      data[:description] = "New description"
+      data[:metadata] = "New metadata"
+      data[:acl] = "New acl"
+      expect(@client).to receive(:patch).with(path % replacements, data: data).
+        and_return(credential_result)
+      result = @credentials_client.update(
+        id: credential_result["id"],
+        description: "New description",
+        metadata: "New metadata",
+        acl: "New acl"
+      )
+      expect(result.class).to eq(NgrokAPI::Models::Credential)
+      # expect(result.id).to eq(credential_result["id"])
+    end
+  end
+end