ngrok-api 0.15.0 → 0.16.0

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -32,12 +32,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-create
-      def create(
-        description: "",
-        metadata: "",
-        certificate_pem:,
-        private_key_pem:
-      )
+      def create(description: "", metadata: "", certificate_pem:, private_key_pem:)
         path = '/tls_certificates'
         replacements = {
         }
@@ -57,9 +52,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -75,9 +68,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -92,9 +83,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -112,9 +101,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -133,11 +120,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -163,11 +147,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -194,11 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -220,11 +197,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -29,11 +29,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -59,11 +56,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -88,9 +82,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TunnelSession] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/tunnel_sessions/%{id}'
         replacements = {
           id: id,
@@ -108,9 +100,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TunnelSession] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/tunnel_sessions/%{id}'
         replacements = {
           id: id,
@@ -130,9 +120,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-restart
-      def restart(
-        id: ""
-      )
+      def restart(id: "")
         path = '/tunnel_sessions/%{id}/restart'
         replacements = {
           id: id,
@@ -151,9 +139,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-restart
-      def restart!(
-        id: ""
-      )
+      def restart!(id: "")
         path = '/tunnel_sessions/%{id}/restart'
         replacements = {
           id: id,
@@ -169,9 +155,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-stop
-      def stop(
-        id: ""
-      )
+      def stop(id: "")
         path = '/tunnel_sessions/%{id}/stop'
         replacements = {
           id: id,
@@ -188,9 +172,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-stop
-      def stop!(
-        id: ""
-      )
+      def stop!(id: "")
         path = '/tunnel_sessions/%{id}/stop'
         replacements = {
           id: id,
@@ -216,10 +198,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-update
-      def update(
-        id: "",
-        version: ""
-      )
+      def update(id: "", version: "")
         path = '/tunnel_sessions/%{id}/update'
         replacements = {
           id: id,
@@ -246,10 +225,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-update
-      def update!(
-        id: "",
-        version: ""
-      )
+      def update!(id: "", version: "")
         path = '/tunnel_sessions/%{id}/update'
         replacements = {
           id: id,

data/lib/ngrokapi/services/tunnels_client.rb

@@ -28,11 +28,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnels-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -58,11 +55,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnels-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/version.rb

@@ -2,6 +2,6 @@ module NgrokAPI
   # rubocop:disable Layout/SpaceAroundOperators
 
   # The current version of the gem
-  VERSION="0.15.0".freeze
+  VERSION="0.16.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/lib/ngrokapi.rb

@@ -3,7 +3,7 @@
 require 'json'
 require 'net/http'
 
-Dir[File.join('.', 'lib', '**/*.rb')].each do |f|
+Dir[File.join('.', 'lib', '**/*.rb')].sort.each do |f|
   require f
 end
 

data/ngrok-api.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   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'
+  s.required_ruby_version = '>= 2.7.2'
 
   all_files = `git ls-files`.split("\n")
   test_files = `git ls-files -- {test,spec,features}/*`.split('\n')

data/spec/ngrokapi/client_spec.rb

@@ -12,6 +12,12 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
+  describe "#agent_ingresses" do
+    it "returns an instance of the AgentIngressesClient" do
+      expect(@client.agent_ingresses.class).to eq(NgrokAPI::Services::AgentIngressesClient)
+    end
+  end
+
   describe "#api_keys" do
     it "returns an instance of the APIKeysClient" do
       expect(@client.api_keys.class).to eq(NgrokAPI::Services::APIKeysClient)
@@ -78,12 +84,6 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
-  describe "#ip_whitelist" do
-    it "returns an instance of the IPWhitelistClient" do
-      expect(@client.ip_whitelist.class).to eq(NgrokAPI::Services::IPWhitelistClient)
-    end
-  end
-
   describe "#reserved_addrs" do
     it "returns an instance of the ReservedAddrsClient" do
       expect(@client.reserved_addrs.class).to eq(NgrokAPI::Services::ReservedAddrsClient)

data/spec/ngrokapi/models/agent_ingress_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::AgentIngress do
+  before(:each) do
+    @client = class_double("AgentIngresssClient")
+    @agent_ingress = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
+      expect(@agent_ingress == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@agent_ingress.to_s).to eq agent_ingress_result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@agent_ingress.client).to receive(:delete)
+      @agent_ingress.delete
+    end
+  end
+
+  describe "#update" do
+    it "calls update on the client" do
+      new_description = 'New description'
+      new_metadata = 'New metadata'
+      expect(@agent_ingress.client).to receive(:update)
+      @agent_ingress.update(
+        description: new_description,
+        metadata: new_metadata
+      )
+      expect(@agent_ingress.description).to eq new_description
+      expect(@agent_ingress.metadata).to eq new_metadata
+    end
+  end
+end

data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb}

@@ -1,45 +1,45 @@
 require 'spec_helper'
 
-RSpec.describe NgrokAPI::Services::IPWhitelistClient do
+RSpec.describe NgrokAPI::Services::AgentIngressesClient do
   let(:base_url) { 'https://api.ngrok.com' }
-  let(:path) { '/ip_whitelist' }
+  let(:path) { '/agent_ingresses' }
   let(:not_found) do
-    NgrokAPI::Errors::NotFoundError.new(response: ip_whitelist_entry_result)
+    NgrokAPI::Errors::NotFoundError.new(response: agent_ingress_result)
   end
 
   before(:each) do
     @client = class_double("HttpClient")
-    @ip_whitelist_client = NgrokAPI::Services::IPWhitelistClient.new(client: @client)
+    @agent_ingresses_client = NgrokAPI::Services::AgentIngressesClient.new(client: @client)
   end
 
   describe "#create" do
-    it "will make a post request and return an instance of NgrokAPI::Models::IPWhitelistEntry" do
-      path = '/ip_whitelist'
+    it "will make a post request and return an instance of NgrokAPI::Models::AgentIngress" do
+      path = '/agent_ingresses'
       replacements = {
       }
       data = {}
       data[:description] = "New description"
       data[:metadata] = "New metadata"
-      data[:ip_net] = "New ip_net"
+      data[:domain] = "New domain"
       expect(@client).to receive(:post).with(path % replacements, data: data).
-        and_return(ip_whitelist_entry_result)
-      result = @ip_whitelist_client.create(
+        and_return(agent_ingress_result)
+      result = @agent_ingresses_client.create(
         description: "New description",
         metadata: "New metadata",
-        ip_net: "New ip_net"
+        domain: "New domain"
       )
-      expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry)
+      expect(result.class).to eq(NgrokAPI::Models::AgentIngress)
     end
   end
 
   describe "#delete" do
     it "will make a delete request" do
-      path = '/ip_whitelist/%{id}'
+      path = '/agent_ingresses/%{id}'
       replacements = {
         id: api_key_result["id"],
       }
       expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
-      @ip_whitelist_client.delete(
+      @agent_ingresses_client.delete(
         id: api_key_result["id"]
       )
     end
@@ -47,25 +47,25 @@ RSpec.describe NgrokAPI::Services::IPWhitelistClient do
 
   describe "#delete!" do
     it "will make a delete request" do
-      path = '/ip_whitelist/%{id}'
+      path = '/agent_ingresses/%{id}'
       replacements = {
         id: api_key_result["id"],
       }
       expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
-      @ip_whitelist_client.delete!(
+      @agent_ingresses_client.delete!(
         id: api_key_result["id"]
       )
     end
 
     it "will make a delete request and return NotFoundError if 404" do
-      path = '/ip_whitelist/%{id}'
+      path = '/agent_ingresses/%{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 = @ip_whitelist_client.delete!(
+        result = @agent_ingresses_client.delete!(
           id: api_key_result["id"]
         )
         expect(result).to be nil
@@ -74,86 +74,86 @@ RSpec.describe NgrokAPI::Services::IPWhitelistClient do
   end
 
   describe "#get" do
-    it "will make a get request and return an instance of NgrokAPI::Models::IPWhitelistEntry" do
-      path = '/ip_whitelist/%{id}'
+    it "will make a get request and return an instance of NgrokAPI::Models::AgentIngress" do
+      path = '/agent_ingresses/%{id}'
       replacements = {
-        id: ip_whitelist_entry_result["id"],
+        id: agent_ingress_result["id"],
       }
       data = {}
       expect(@client).to receive(:get).with(path % replacements, data: data).
-        and_return(ip_whitelist_entry_result)
-      result = @ip_whitelist_client.get(
-        id: ip_whitelist_entry_result["id"]
+        and_return(agent_ingress_result)
+      result = @agent_ingresses_client.get(
+        id: agent_ingress_result["id"]
       )
-      expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry)
+      expect(result.class).to eq(NgrokAPI::Models::AgentIngress)
     end
   end
 
   describe "#get!" do
-    it "will make a get request and return an instance of NgrokAPI::Models::IPWhitelistEntry" do
-      path = '/ip_whitelist/%{id}'
+    it "will make a get request and return an instance of NgrokAPI::Models::AgentIngress" do
+      path = '/agent_ingresses/%{id}'
       replacements = {
-        id: ip_whitelist_entry_result["id"],
+        id: agent_ingress_result["id"],
       }
       data = {}
       expect(@client).to receive(:get).with(path % replacements, data: data).
-        and_return(ip_whitelist_entry_result)
-      result = @ip_whitelist_client.get(
-        id: ip_whitelist_entry_result["id"]
+        and_return(agent_ingress_result)
+      result = @agent_ingresses_client.get(
+        id: agent_ingress_result["id"]
       )
-      expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry)
-      # expect(result.id).to eq(ip_whitelist_entry_result["id"])
+      expect(result.class).to eq(NgrokAPI::Models::AgentIngress)
+      # expect(result.id).to eq(agent_ingress_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(ip_whitelist_entry_results)
+        and_return(agent_ingress_results)
       url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
-      result = @ip_whitelist_client.list(url: url)
+      result = @agent_ingresses_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::IPWhitelistEntry" do
-      path = '/ip_whitelist/%{id}'
+    it "will make a patch request and return an instance of NgrokAPI::Models::AgentIngress" do
+      path = '/agent_ingresses/%{id}'
       replacements = {
-        id: ip_whitelist_entry_result["id"],
+        id: agent_ingress_result["id"],
       }
       data = {}
       data[:description] = "New description"
       data[:metadata] = "New metadata"
       expect(@client).to receive(:patch).with(path % replacements, data: data).
-        and_return(ip_whitelist_entry_result)
-      result = @ip_whitelist_client.update(
-        id: ip_whitelist_entry_result["id"],
+        and_return(agent_ingress_result)
+      result = @agent_ingresses_client.update(
+        id: agent_ingress_result["id"],
         description: "New description",
         metadata: "New metadata"
       )
-      expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry)
+      expect(result.class).to eq(NgrokAPI::Models::AgentIngress)
     end
   end
 
   describe "#update!" do
-    it "will make a patch request and return an instance of NgrokAPI::Models::IPWhitelistEntry" do
-      path = '/ip_whitelist/%{id}'
+    it "will make a patch request and return an instance of NgrokAPI::Models::AgentIngress" do
+      path = '/agent_ingresses/%{id}'
       replacements = {
-        id: ip_whitelist_entry_result["id"],
+        id: agent_ingress_result["id"],
       }
       data = {}
       data[:description] = "New description"
       data[:metadata] = "New metadata"
       expect(@client).to receive(:patch).with(path % replacements, data: data).
-        and_return(ip_whitelist_entry_result)
-      result = @ip_whitelist_client.update(
-        id: ip_whitelist_entry_result["id"],
+        and_return(agent_ingress_result)
+      result = @agent_ingresses_client.update(
+        id: agent_ingress_result["id"],
         description: "New description",
         metadata: "New metadata"
       )
-      expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry)
-      # expect(result.id).to eq(ip_whitelist_entry_result["id"])
+      expect(result.class).to eq(NgrokAPI::Models::AgentIngress)
+      # expect(result.id).to eq(agent_ingress_result["id"])
     end
   end
 end