ngrok-wrapper 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 270d9efa417c5821721519760816d3febbf085d183680ad0268a244eaec4a753
-  data.tar.gz: dd477aa0effed04807720dd6e22a3f607b79f88b343318c7d1674c18e573b056
+  metadata.gz: af2e280f5efacf50a98453cbd8bbc26840b00fa74d31eff6346abc14fed1650f
+  data.tar.gz: 383a1dd7792b1dbff611f6f826ba24e9b904e41005622c8a7b68edbe45a82646
 SHA512:
-  metadata.gz: e8d752ee9ee727a5e54705e1c7d361b6babd13415a68173325df4cf4a2c7158fa37cc60920b8023e9b57b45c1ce1450325bcc17949885045ff1f1d3b9bebcb7a
-  data.tar.gz: 7f3e3c5404e138e6f4a01ed06c77d13f746bc977057b91494a26f98f80fa59fa2c55b992cf6bf015142e6bc38ff4fc1fcd73e5537e77018801a8b945e9b33623
+  metadata.gz: dd6252001dbc722e9e087131e3eb8abc8561dce031d323a5a649b228233e6ebb7b39ceb04e9966c27701fd779aa6e3056c223331b1353175da1ac9715e0e28e5
+  data.tar.gz: 79e8891907659df3e858cad810b30e209139c1e9c1de0dee5834598ab2f4fd2e89a90aad17600bad8f8f084fd9273b8e89f97879a2660ce9787783ee013203ac

data/.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -40,6 +40,6 @@ jobs:
         run: bundle exec rspec
 
       - name: Code Climate
-        uses: paambaati/codeclimate-action@v3.0.0
+        uses: paambaati/codeclimate-action@v3.2.0
         env:
           CC_TEST_REPORTER_ID: d1116c05a48e27785cb11369bde3a5e7f9d9e5a114d294bcbefa19cd193b029c

data/.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

data/.rubocop.yml

@@ -65,8 +65,14 @@ Metrics/BlockLength:
 RSpec/MultipleExpectations:
   Max: 13
 
-RSpec/NestedGroups:
+RSpec/MultipleMemoizedHelpers:
+  Description: Checks if example groups contain too many `let` and `subject` calls.
+  Enabled: true
+  AllowSubject: true
   Max: 7
 
+RSpec/NestedGroups:
+  Max: 8
+
 Style/StringLiterals:
   ConsistentQuotesInMultiline: true

data/.ruby-version

@@ -1 +1 @@
-2.6.9
+2.7.6

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.9
+ruby 2.7.6

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [v0.3.0](https://github.com/texpert/ngrok-wrapper/tree/v0.3.0) (2022-11-19)
+
+[Full Changelog](https://github.com/texpert/ngrok-wrapper/compare/v0.2.0...v0.3.0)
+
+Both Ngrok v2, and v3 are now supported.
+
+Tested and working on Ubuntu Linux and macOS.
+
+**Merged pull requests:**
+
+- Added compatibility with Ngrok v3.x \(specs also enhanced to test both 2 and 3 versions\) [\#24](https://github.com/texpert/ngrok-wrapper/pull/24) ([texpert](https://github.com/texpert))
+- Prepare for different ngrok versions params, still for version 2 [\#23](https://github.com/texpert/ngrok-wrapper/pull/23) ([texpert](https://github.com/texpert))
+- Allow region subdomains - modify Rails config.hosts example to parse the host from NGROK\_URL [\#22](https://github.com/texpert/ngrok-wrapper/pull/22) ([texpert](https://github.com/texpert))
+- Set main Ruby version to 2.7.6 [\#21](https://github.com/texpert/ngrok-wrapper/pull/21) ([texpert](https://github.com/texpert))
+- Bump actions/checkout from 2 to 3 [\#19](https://github.com/texpert/ngrok-wrapper/pull/19) ([texpert](https://github.com/texpert))
+
+## [v0.2.0](https://github.com/texpert/ngrok-wrapper/tree/v0.2.0) (2022-02-19)
+
+[Full Changelog](https://github.com/texpert/ngrok-wrapper/compare/v0.1.0...v0.2.0)
+
+### Making Ngrok process survive server stop on Linux
+
+It was working OK on Mac OS on the 0.1.0 release, but not on Linux.
+
+It came out that `Process.setsid` should be applied to the spawned process to establish this process as a new session 
+and process group leader. This is completely detaching it from the parent process, so it won't be killed when the 
+parent will go down.
+
+
+**Merged pull requests:**
+
+- Add config.hosts example for Rails \>= 6.0.0 [\#18](https://github.com/texpert/ngrok-wrapper/pull/18) ([texpert](https://github.com/texpert))
+- Ngrok.start should try to return first @ngrok\_url\_https or then @ngrok\_url [\#17](https://github.com/texpert/ngrok-wrapper/pull/17) ([texpert](https://github.com/texpert))
+- Use fork, Process.setsid and spawn instead of just spawn, to change the owner of ngrok process [\#16](https://github.com/texpert/ngrok-wrapper/pull/16) ([texpert](https://github.com/texpert))
+
 ## [v0.1.0](https://github.com/texpert/ngrok-wrapper/tree/v0.1.0) (2022-01-09)
 
 [Full Changelog](https://github.com/texpert/ngrok-wrapper/compare/3e032fa019c91ee7338a7ad3a3335e6c5597b394...v0.1.0)

data/README.md

@@ -1,6 +1,6 @@
 # Ngrok::Wrapper
 
-Ngrok-wrapper gem is a ruby wrapper for ngrok v2.
+Ngrok-wrapper gem is a ruby wrapper for ngrok v2.x or v3.x.
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/d978e217a8219326e325/maintainability)](https://codeclimate.com/github/texpert/ngrok-wrapper/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/d978e217a8219326e325/test_coverage)](https://codeclimate.com/github/texpert/ngrok-wrapper/test_coverage)
@@ -22,7 +22,9 @@ So, excuse me, [Anton Bogdanovich](https://github.com/bogdanovich), but I've dec
 
 ## Installation
 
-*Note:* You must have ngrok v2+ installed available in your `PATH`.
+**Pre-requisites:** You must have `ngrok` v2+ or v3+ installed available in your `PATH`.
+
+**Upgrade Note:** Do not forget to run `ngrok config upgrade` after upgrading `ngrok` from v2.x to v3.x 
 
 Add this line to your application's Gemfile:
 
@@ -32,7 +34,7 @@ gem 'ngrok-wrapper'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -139,7 +141,10 @@ end
 - And in `config/environments/development.rb`:
 
 ```ruby
-config.force_ssl = true if NGROK_ENABLED
+if NGROK_ENABLED
+  config.force_ssl = true
+  config.hosts << URI.parse(NGROK_URL).host # for Rails >= 6.0.0
+end  
 
 config.action_mailer.default_url_options = {
   host: NGROK_ENABLED ? NGROK_URL.delete_prefix('https://') : 'myapp.local',

data/lib/ngrok/wrapper/version.rb

@@ -2,6 +2,6 @@
 
 module Ngrok
   class Wrapper
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/ngrok/wrapper.rb

@@ -4,7 +4,16 @@ require_relative 'wrapper/version'
 require 'tempfile'
 
 module Ngrok
-  OPTIONAL_PARAMS = %i[authtoken bind_tls host_header hostname inspect region subdomain].freeze
+  VERSION_PARAMS = {
+    '2' => {
+      flag_prefix:       '-',
+      http_tunnel_flags: %i[config authtoken bind_tls host_header hostname inspect region subdomain].freeze
+    },
+    '3' => {
+      flag_prefix:       '--',
+      http_tunnel_flags: %i[config authtoken scheme host_header hostname inspect region subdomain].freeze
+    }
+  }.freeze
 
   class NotFound < StandardError; end
   class FetchUrlError < StandardError; end
@@ -24,6 +33,9 @@ module Ngrok
 
       def start(params = {})
         ensure_binary
+        @current_version_params = VERSION_PARAMS[@major_version]
+        @flag_prefix = @current_version_params[:flag_prefix]
+
         init(params)
 
         persistent_ngrok = @params[:persistence] == true
@@ -38,7 +50,7 @@ module Ngrok
           File.write(@persistence_file, { pid: @pid, ngrok_url: @ngrok_url, ngrok_url_https: @ngrok_url_https }.to_json)
         end
 
-        @ngrok_url
+        @ngrok_url_https || @ngrok_url
       end
 
       def stop
@@ -84,7 +96,7 @@ module Ngrok
       def raise_if_similar_ngroks(pid)
         other_ngrok_on_port = ngrok_process_status_lines.find do |line|
           # If found an Ngrok process with other pid, tunneling on the port, specified in Ngrok::Wrapper.start params
-          line.include?('ngrok http -log') && !line.start_with?(pid || '') && line.end_with?(addr.to_s)
+          line.include?("ngrok http #{@flag_prefix}log") && !line.start_with?(pid || '') && line.end_with?(addr.to_s)
         end
 
         raise Ngrok::Error, "ERROR: Other ngrok instances tunneling to port #{addr} found" if other_ngrok_on_port
@@ -93,7 +105,7 @@ module Ngrok
 
         tunnel_on_other_port = ngrok_process_status_lines.find do |line|
           # If the line starts with this pid, but the port is other than specified in Ngrok::Wrapper.start params
-          line.include?('ngrok http -log') && line.start_with?(pid) && !line.end_with?(addr.to_s)
+          line.include?("ngrok http #{@flag_prefix}log") && line.start_with?(pid) && !line.end_with?(addr.to_s)
         end
 
         return unless tunnel_on_other_port
@@ -104,7 +116,7 @@ module Ngrok
       def ngrok_process_status_lines(refetch: false)
         return @ngrok_process_status_lines if defined?(@ngrok_process_status_lines) && !refetch
 
-        @ngrok_process_status_lines = (`ps ax | grep "ngrok http"`).split("\n")
+        @ngrok_process_status_lines = (`ps ax | grep "ngrok http"`).split("\n").map(&:strip)
       end
 
       def try_params_from_running_ngrok
@@ -125,7 +137,7 @@ module Ngrok
       def ngrok_running?(pid)
         ngrok_process_status_lines.find do |line|
           # If found the Ngrok process with correct pid, tunneling on the port, specified in Ngrok::Wrapper.start params
-          line.include?('ngrok http -log') && line.start_with?(pid) && line.end_with?(addr.to_s)
+          line.include?("ngrok http #{@flag_prefix}log") && line.start_with?(pid) && line.end_with?(addr.to_s)
         end
       end
 
@@ -134,9 +146,15 @@ module Ngrok
         # Prepare the log file into which ngrok output will be redirected in `ngrok_exec_params`
         @params[:log] = @params[:log] ? File.open(@params[:log], 'w+') : Tempfile.new('ngrok')
         if persistent_ngrok
-          Process.spawn("exec nohup ngrok http #{ngrok_exec_params} &")
+          fork do
+            Process.setsid
+            system("exec nohup ngrok http #{ngrok_exec_params} &")
+          end
+
+          sleep 0.5
+
           @pid = ngrok_process_status_lines(refetch: true)
-                 .find { |line| line.include?('ngrok http -log') && line.end_with?(addr.to_s) }.split[0]
+                 .find { |line| line.include?("ngrok http #{@flag_prefix}log") && line.end_with?(addr.to_s) }.split[0]
         else
           @pid = Process.spawn("exec ngrok http #{ngrok_exec_params}")
           at_exit { Ngrok::Wrapper.stop }
@@ -146,11 +164,11 @@ module Ngrok
       end
 
       def ngrok_exec_params
-        exec_params = +'-log=stdout -log-level=debug '
-        OPTIONAL_PARAMS.each do |opt|
-          exec_params << "-#{opt.to_s.tr('_', '-')}=#{@params[opt]} " if @params.key?(opt)
+        exec_params = +"#{@flag_prefix}log=stdout #{@flag_prefix}log-level=debug "
+        @current_version_params[:http_tunnel_flags].each do |flag|
+          exec_params << "#{@flag_prefix}#{flag.to_s.tr('_', '-')}=#{@params[flag]} " if @params.key?(flag)
         end
-        exec_params << "-config #{@params[:config]} #{@params[:addr]} > #{@params[:log].path}"
+        exec_params << " #{@params[:addr]} > #{@params[:log].path}"
       end
 
       def fetch_urls
@@ -185,7 +203,7 @@ module Ngrok
       end
 
       def ensure_binary
-        `ngrok version`
+        @major_version, * = `ngrok version`.chomp.delete_prefix('ngrok version ').split('.')
       rescue Errno::ENOENT
         raise Ngrok::NotFound, 'Ngrok binary not found'
       end

data/spec/ngrok/wrapper_spec.rb

@@ -4,352 +4,369 @@ RSpec.describe 'Ngrok::Wrapper' do
   let(:log) { File.read("#{RSPEC_ROOT}/fixtures/ngrok.sample.log") }
   let(:fake_pid) { rand(99_999) }
 
-  before do
-    allow(Ngrok::Wrapper).to receive(:ensure_binary)
-    allow(Ngrok::Wrapper).to receive(:raise_if_similar_ngroks)
-    allow(Process).to receive(:spawn).and_return(fake_pid)
-    allow(Process).to receive(:kill)
-  end
-
-  it 'has a version number' do
-    expect(Ngrok::Wrapper::VERSION).not_to be nil
-  end
-
-  describe 'Before start' do
-    before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
+  ngrok_versions = %w[2 3]
 
-    it 'is not running' do
-      expect(Ngrok::Wrapper.running?).to be false
-    end
-
-    it 'is stopped' do
-      expect(Ngrok::Wrapper.stopped?).to be true
-    end
+  ngrok_versions.each do |ngrok_version|
+    describe "Ngrok v#{ngrok_version}" do
+      let(:flag_prefix) { Ngrok::VERSION_PARAMS[ngrok_version][:flag_prefix] }
+      let(:config_path) { "#{flag_prefix}config /Users/thunder/.ngrok2/ngrok.yml" }
 
-    it 'has :stopped status' do
-      expect(Ngrok::Wrapper.status).to eq :stopped
-    end
-  end
+      before do
+        Ngrok::Wrapper.instance_variable_set(:@major_version, ngrok_version)
+        allow(Ngrok::Wrapper).to receive(:ensure_binary)
+        allow(Ngrok::Wrapper).to receive(:ngrok_process_status_lines)
+        allow(Ngrok::Wrapper).to receive(:raise_if_similar_ngroks)
+        allow(Process).to receive(:spawn).and_return(fake_pid)
+        allow(Process).to receive(:kill)
+      end
 
-  describe 'After start' do
-    before do
-      allow_any_instance_of(Tempfile).to receive(:read).and_return(log)
+      it 'has a version number' do
+        expect(Ngrok::Wrapper::VERSION).not_to be nil
+      end
 
-      Ngrok::Wrapper.start
-    end
+      describe 'Before start' do
+        before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
 
-    after { Ngrok::Wrapper.stop }
+        it 'is not running' do
+          expect(Ngrok::Wrapper.running?).to be false
+        end
 
-    it 'is running' do
-      expect(Ngrok::Wrapper.running?).to be true
-    end
+        it 'is stopped' do
+          expect(Ngrok::Wrapper.stopped?).to be true
+        end
 
-    it 'is not stopped' do
-      expect(Ngrok::Wrapper.stopped?).to be false
-    end
+        it 'has :stopped status' do
+          expect(Ngrok::Wrapper.status).to eq :stopped
+        end
+      end
 
-    it 'has :running status' do
-      expect(Ngrok::Wrapper.status).to eq :running
-    end
+      describe 'After start' do
+        before do
+          allow_any_instance_of(Tempfile).to receive(:read).and_return(log)
 
-    it 'has correct port property' do
-      expect(Ngrok::Wrapper.port).to eq(3001)
-    end
+          Ngrok::Wrapper.start
+        end
 
-    it 'has correct addr property' do
-      expect(Ngrok::Wrapper.addr).to eq(3001)
-    end
+        after { Ngrok::Wrapper.stop }
 
-    it 'has valid ngrok_url' do
-      expect(Ngrok::Wrapper.ngrok_url).to be =~ %r{http://.*ngrok\.io$}
-    end
+        it 'is running' do
+          expect(Ngrok::Wrapper.running?).to be true
+        end
 
-    it 'has valid ngrok_url_https' do
-      expect(Ngrok::Wrapper.ngrok_url_https).to be =~ %r{https://.*ngrok\.io$}
-    end
+        it 'is not stopped' do
+          expect(Ngrok::Wrapper.stopped?).to be false
+        end
 
-    it 'has correct pid property' do
-      expect(Ngrok::Wrapper.pid).to be > 0
-    end
-  end
+        it 'has :running status' do
+          expect(Ngrok::Wrapper.status).to eq :running
+        end
 
-  describe 'Custom log file' do
-    before { allow_any_instance_of(File).to receive(:read).and_return(log) }
+        it 'has correct port property' do
+          expect(Ngrok::Wrapper.port).to eq(3001)
+        end
 
-    it 'uses custom log file' do
-      Ngrok::Wrapper.start(log: 'test.log')
-      expect(Ngrok::Wrapper.running?).to eq true
-      expect(Ngrok::Wrapper.params[:log].path).to eq 'test.log'
-      Ngrok::Wrapper.stop
-      expect(Ngrok::Wrapper.stopped?).to eq true
-    end
-  end
+        it 'has correct addr property' do
+          expect(Ngrok::Wrapper.addr).to eq(3001)
+        end
 
-  describe 'Invalid or missing authtoken' do
-    describe 'when no authtoken is specified in ngrok config file' do
-      let(:no_auth_log) { File.read("#{RSPEC_ROOT}/fixtures/ngrok.no_auth_token.log") }
+        it 'has valid ngrok_url' do
+          expect(Ngrok::Wrapper.ngrok_url).to be =~ %r{http://.*ngrok\.io$}
+        end
 
-      it 'raises Ngrok::Error exception' do
-        allow_any_instance_of(Tempfile).to receive(:read).and_return(no_auth_log)
+        it 'has valid ngrok_url_https' do
+          expect(Ngrok::Wrapper.ngrok_url_https).to be =~ %r{https://.*ngrok\.io$}
+        end
 
-        expect { Ngrok::Wrapper.start }.to raise_error Ngrok::Error
+        it 'has correct pid property' do
+          expect(Ngrok::Wrapper.pid).to be > 0
+        end
       end
-    end
 
-    describe 'when an invalid authtoken is specified in ngrok config file' do
-      let(:invalid_auth_log) { File.read("#{RSPEC_ROOT}/fixtures/ngrok.no_auth_token.log") }
+      describe 'Custom log file' do
+        before { allow_any_instance_of(File).to receive(:read).and_return(log) }
 
-      it 'fails with incorrect authtoken' do
-        allow_any_instance_of(Tempfile).to receive(:read).and_return(invalid_auth_log)
-
-        expect do
-          Ngrok::Wrapper.start(authtoken: 'incorrect_token')
-        end.to raise_error Ngrok::Error
+        it 'uses custom log file' do
+          Ngrok::Wrapper.start(log: 'test.log')
+          expect(Ngrok::Wrapper.running?).to eq true
+          expect(Ngrok::Wrapper.params[:log].path).to eq 'test.log'
+          Ngrok::Wrapper.stop
+          expect(Ngrok::Wrapper.stopped?).to eq true
+        end
       end
-    end
-  end
 
-  describe 'Custom addr' do
-    before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
+      describe 'Invalid or missing authtoken' do
+        describe 'when no authtoken is specified in ngrok config file' do
+          let(:no_auth_log) { File.read("#{RSPEC_ROOT}/fixtures/ngrok.no_auth_token.log") }
 
-    it 'maps port param to addr' do
-      port = 10_010
-      Ngrok::Wrapper.start(port: port)
-      expect(Ngrok::Wrapper.addr).to eq port
-      Ngrok::Wrapper.stop
-    end
+          it 'raises Ngrok::Error exception' do
+            allow_any_instance_of(Tempfile).to receive(:read).and_return(no_auth_log)
 
-    it 'returns just the port when the address contains a host' do
-      addr = '192.168.0.5:10010'
-      Ngrok::Wrapper.start(addr: addr)
-      expect(Ngrok::Wrapper.port).to eq 10_010
-      Ngrok::Wrapper.stop
-    end
+            expect { Ngrok::Wrapper.start }.to raise_error Ngrok::Error
+          end
+        end
 
-    it 'supports remote addresses' do
-      addr = '192.168.0.5:10010'
-      Ngrok::Wrapper.start(addr: addr)
-      expect(Ngrok::Wrapper.addr).to eq addr
-      Ngrok::Wrapper.stop
-    end
-  end
+        describe 'when an invalid authtoken is specified in ngrok config file' do
+          let(:invalid_auth_log) { File.read("#{RSPEC_ROOT}/fixtures/ngrok.no_auth_token.log") }
 
-  describe 'Custom region' do
-    before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
+          it 'fails with incorrect authtoken' do
+            allow_any_instance_of(Tempfile).to receive(:read).and_return(invalid_auth_log)
 
-    it "doesn't include the -region parameter when it is not provided" do
-      Ngrok::Wrapper.start
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-region=')
-      Ngrok::Wrapper.stop
-    end
+            expect do
+              Ngrok::Wrapper.start(authtoken: 'incorrect_token')
+            end.to raise_error Ngrok::Error
+          end
+        end
+      end
 
-    it 'includes the -region parameter with the correct value when it is provided' do
-      region = 'eu'
-      Ngrok::Wrapper.start(region: region)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-region=#{region}")
-      Ngrok::Wrapper.stop
-    end
-  end
+      describe 'Custom addr' do
+        before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
 
-  describe 'Custom bind-tls' do
-    before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
+        after { Ngrok::Wrapper.stop }
 
-    it "doesn't include the -bind-tls parameter when it is not provided" do
-      Ngrok::Wrapper.start
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-bind-tls=')
-      Ngrok::Wrapper.stop
-    end
+        it 'maps port param to addr' do
+          port = 10_010
+          Ngrok::Wrapper.start(port: port)
+          expect(Ngrok::Wrapper.addr).to eq port
+        end
 
-    it 'includes the -bind-tls parameter with the correct value when it is true' do
-      bind_tls = true
-      Ngrok::Wrapper.start(bind_tls: bind_tls)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-bind-tls=#{bind_tls}")
-      Ngrok::Wrapper.stop
-    end
+        it 'returns just the port when the address contains a host' do
+          addr = '192.168.0.5:10010'
+          Ngrok::Wrapper.start(addr: addr)
+          expect(Ngrok::Wrapper.port).to eq 10_010
+        end
 
-    it 'includes the -bind-tls parameter with the correct value when it is false' do
-      bind_tls = false
-      Ngrok::Wrapper.start(bind_tls: bind_tls)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-bind-tls=#{bind_tls}")
-      Ngrok::Wrapper.stop
-    end
-  end
+        it 'supports remote addresses' do
+          addr = '192.168.0.5:10010'
+          Ngrok::Wrapper.start(addr: addr)
+          expect(Ngrok::Wrapper.addr).to eq addr
+        end
+      end
 
-  describe 'Custom host header' do
-    after { Ngrok::Wrapper.stop }
+      describe 'Custom region' do
+        before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
 
-    it "doesn't include the -host-header parameter when it is not provided" do
-      expect(Ngrok::Wrapper).to receive(:fetch_urls)
-      Ngrok::Wrapper.start
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-host-header=')
-    end
+        after { Ngrok::Wrapper.stop }
 
-    it 'includes the -host-header parameter with the correct value when it is provided' do
-      expect(Ngrok::Wrapper).to receive(:fetch_urls)
-      host_header = 'foo.bar'
-      Ngrok::Wrapper.start(host_header: host_header)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-host-header=#{host_header}")
-    end
-  end
+        it "doesn't include the -region parameter when it is not provided" do
+          Ngrok::Wrapper.start
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-region=')
+        end
 
-  describe 'Custom parameters provided' do
-    before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
+        it 'includes the -region parameter with the correct value when it is provided' do
+          region = 'eu'
+          Ngrok::Wrapper.start(region: region)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-region=#{region}")
+        end
+      end
 
-    it "doesn't include the -inspect parameter when it is not provided" do
-      Ngrok::Wrapper.start
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-inspect=')
-      Ngrok::Wrapper.stop
-    end
+      describe 'Custom bind-tls' do
+        # It is 'bind_tls' for Ngrok v2, and 'scheme' for Ngrok v3
+        let(:bind_tls_flag) { Ngrok::VERSION_PARAMS[ngrok_version][:http_tunnel_flags][2] }
 
-    it 'includes the -inspect parameter with the correct value when it is provided' do
-      Ngrok::Wrapper.start(inspect: true)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include('-inspect=true')
-      Ngrok::Wrapper.stop
+        before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
 
-      Ngrok::Wrapper.start(inspect: false)
-      expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include('-inspect=false')
-      Ngrok::Wrapper.stop
-    end
-  end
+        after { Ngrok::Wrapper.stop }
 
-  describe '#start' do
-    after { Ngrok::Wrapper.stop }
+        it "doesn't include the -bind-tls parameter when it is not provided" do
+          Ngrok::Wrapper.start
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params))
+            .not_to include("#{flag_prefix}#{bind_tls_flag.to_s.tr('_', '-')}=")
+        end
 
-    describe 'when persistence param is true' do
-      before do
-        allow(File).to receive(:write)
-        allow(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok).and_call_original
-        allow(Ngrok::Wrapper).to receive(:parse_persistence_file).and_return(state)
-      end
+        it 'includes the -bind-tls parameter with the correct value when it is true' do
+          Ngrok::Wrapper.start(bind_tls_flag => true)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params))
+            .to include("#{flag_prefix}#{bind_tls_flag.to_s.tr('_', '-')}=true")
+        end
 
-      describe 'tries fetching params of an already running Ngrok and store Ngrok process data into a file' do
-        describe 'when fetching params returns nil' do
-          let(:state) { nil }
+        it 'includes the -bind-tls parameter with the correct value when it is false' do
+          Ngrok::Wrapper.start(bind_tls_flag => false)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params))
+            .to include("#{flag_prefix}#{bind_tls_flag.to_s.tr('_', '-')}=false")
+        end
+      end
 
-          it "doesn't check for similar ngroks running" do
-            expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
-            expect(Ngrok::Wrapper).not_to receive(:raise_if_similar_ngroks)
-            expect(Ngrok::Wrapper).not_to receive(:ngrok_running?)
-            expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true)
-            expect(File).to receive(:write)
+      describe 'Custom host header' do
+        after { Ngrok::Wrapper.stop }
 
-            Ngrok::Wrapper.start(persistence: true)
-          end
+        it "doesn't include the -host-header parameter when it is not provided" do
+          expect(Ngrok::Wrapper).to receive(:fetch_urls)
+          Ngrok::Wrapper.start
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-host-header=')
         end
 
-        describe 'when fetching params returns a legit hash' do
-          let(:state) do
-            { 'pid'             => '795',
-              'ngrok_url'       => 'http://b1cd-109-185-141-9.ngrok.io',
-              'ngrok_url_https' => 'https://b1cd-109-185-141-9.ngrok.io' }
-          end
+        it 'includes the -host-header parameter with the correct value when it is provided' do
+          expect(Ngrok::Wrapper).to receive(:fetch_urls)
+          host_header = 'foo.bar'
+          Ngrok::Wrapper.start(host_header: host_header)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include("-host-header=#{host_header}")
+        end
+      end
 
-          describe 'checking if a similar Ngrok is running' do
-            before do
-              allow(Ngrok::Wrapper).to receive(:raise_if_similar_ngroks).and_call_original
-              allow(Ngrok::Wrapper).to receive(:ngrok_process_status_lines).and_return(ngrok_ps_lines)
+      describe 'Custom parameters provided' do
+        before { allow_any_instance_of(Tempfile).to receive(:read).and_return(log) }
 
-              expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
-            end
+        it "doesn't include the -inspect parameter when it is not provided" do
+          Ngrok::Wrapper.start
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).not_to include('-inspect=')
+          Ngrok::Wrapper.stop
+        end
 
-            describe 'when Ngrok process with params from the persisted file is running' do
-              let(:ngrok_ps_lines) do
-                ['795 ??  S   0:04.81 ngrok http -log -config /Users/thunder/.ngrok2/ngrok.yml https://localhost:3001']
-              end
+        it 'includes the -inspect parameter with the correct value when it is provided' do
+          Ngrok::Wrapper.start(inspect: true)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include('-inspect=true')
+          Ngrok::Wrapper.stop
 
-              it 'set Ngrok::Wrapper pid and status attributes' do
-                expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
+          Ngrok::Wrapper.start(inspect: false)
+          expect(Ngrok::Wrapper.__send__(:ngrok_exec_params)).to include('-inspect=false')
+          Ngrok::Wrapper.stop
+        end
+      end
 
-                Ngrok::Wrapper.start(persistence: true)
+      describe '#start' do
+        after { Ngrok::Wrapper.stop }
 
-                expect(Ngrok::Wrapper.pid).to eql('795')
-                expect(Ngrok::Wrapper.status).to eql(:running)
-                expect(Ngrok::Wrapper.ngrok_url).to eql('http://b1cd-109-185-141-9.ngrok.io')
-                expect(Ngrok::Wrapper.ngrok_url_https).to eql('https://b1cd-109-185-141-9.ngrok.io')
-              end
-            end
+        describe 'when persistence param is true' do
+          before do
+            allow(File).to receive(:write)
+            allow(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok).and_call_original
+            allow(Ngrok::Wrapper).to receive(:parse_persistence_file).and_return(state)
+          end
 
-            describe 'when a similar Ngrok with other pid is already running' do
-              let(:ngrok_ps_lines) do
-                ['71986 ?? S  0:04.81 ngrok http -log -config /Users/thunder/.ngrok2/ngrok.yml https://localhost:3001']
-              end
+          describe 'tries fetching params of an already running Ngrok and store Ngrok process data into a file' do
+            describe 'when fetching params returns nil' do
+              let(:state) { nil }
 
-              it 'raises exception' do
-                expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
+              it "doesn't check for similar ngroks running" do
+                expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
+                expect(Ngrok::Wrapper).not_to receive(:raise_if_similar_ngroks)
+                expect(Ngrok::Wrapper).not_to receive(:ngrok_running?)
+                expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true)
+                expect(File).to receive(:write)
 
-                expect { Ngrok::Wrapper.start(persistence: true) }
-                  .to raise_error(Ngrok::Error, 'ERROR: Other ngrok instances tunneling to port 3001 found')
+                Ngrok::Wrapper.start(persistence: true)
               end
             end
 
-            describe 'when Ngrok with the persisted pid is already running, but on a different port' do
+            describe 'when fetching params returns a legit hash' do
               let(:ngrok_ps_lines) do
-                ['795 ??  S   0:04.81 ngrok http -log -config /Users/thunder/.ngrok2/ngrok.yml https://localhost:3000']
+                ["795 ??  S   0:04.81 ngrok http #{flag_prefix}log -config #{config_path} https://localhost:3001"]
               end
 
-              it 'raises exception' do
-                expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
-
-                expect { Ngrok::Wrapper.start(persistence: true) }
-                  .to raise_error(Ngrok::Error, 'ERROR: Ngrok pid #795 tunneling on other port 3000')
-              end
-            end
-
-            describe 'when no Ngrok process with params from the persisted file or similar is running' do
-              let(:ngrok_ps_lines) do
-                ['834 ??  S   0:04.81 ngrok http -log -config /Users/thunder/.ngrok2/ngrok.yml https://localhost:5001']
+              let(:state) do
+                { 'pid'             => '795',
+                  'ngrok_url'       => 'http://b1cd-109-185-141-9.ngrok.io',
+                  'ngrok_url_https' => 'https://b1cd-109-185-141-9.ngrok.io' }
               end
 
-              let(:new_ngrok_ps_lines) do
-                ['835 ??  S   0:04.81 ngrok http -log -config /Users/thunder/.ngrok2/ngrok.yml https://localhost:3001']
+              before { allow(Ngrok::Wrapper).to receive(:ngrok_process_status_lines).and_return(ngrok_ps_lines) }
+
+              describe 'checking if a similar Ngrok is running' do
+                before do
+                  allow(Ngrok::Wrapper).to receive(:raise_if_similar_ngroks).and_call_original
+
+                  expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
+                end
+
+                describe 'when Ngrok process with params from the persisted file is running' do
+                  it 'set Ngrok::Wrapper pid and status attributes' do
+                    expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
+
+                    result = Ngrok::Wrapper.start(persistence: true)
+
+                    expect(Ngrok::Wrapper.pid).to eql('795')
+                    expect(Ngrok::Wrapper.status).to eql(:running)
+                    expect(Ngrok::Wrapper.ngrok_url).to eql('http://b1cd-109-185-141-9.ngrok.io')
+                    expect(Ngrok::Wrapper.ngrok_url_https).to eql('https://b1cd-109-185-141-9.ngrok.io')
+                    expect(result).to eql('https://b1cd-109-185-141-9.ngrok.io')
+                  end
+                end
+
+                describe 'when a similar Ngrok with other pid is already running' do
+                  let(:ngrok_ps_lines) do
+                    ["71986 ?? S  0:04.81 ngrok http #{flag_prefix}log -config #{config_path} https://localhost:3001"]
+                  end
+
+                  it 'raises exception' do
+                    expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
+
+                    expect { Ngrok::Wrapper.start(persistence: true) }
+                      .to raise_error(Ngrok::Error, 'ERROR: Other ngrok instances tunneling to port 3001 found')
+                  end
+                end
+
+                describe 'when Ngrok with the persisted pid is already running, but on a different port' do
+                  let(:ngrok_ps_lines) do
+                    ["795 ??  S   0:04.81 ngrok http #{flag_prefix}log -config #{config_path} https://localhost:3000"]
+                  end
+
+                  it 'raises exception' do
+                    expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
+
+                    expect { Ngrok::Wrapper.start(persistence: true) }
+                      .to raise_error(Ngrok::Error, 'ERROR: Ngrok pid #795 tunneling on other port 3000')
+                  end
+                end
+
+                describe 'when no Ngrok process with params from the persisted file or similar is running' do
+                  let(:ngrok_ps_lines) do
+                    ["834 ??  S   0:04.81 ngrok http #{flag_prefix}log -config #{config_path} https://localhost:5001"]
+                  end
+
+                  let(:new_ngrok_ps_lines) do
+                    ["835 ??  S   0:04.81 ngrok http #{flag_prefix}log -config #{config_path} https://localhost:3001"]
+                  end
+
+                  it 'sets Ngrok::Wrapper pid and status attributes' do
+                    allow(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true).and_call_original
+                    allow(Ngrok::Wrapper).to receive(:fork)
+                    allow(Ngrok::Wrapper)
+                      .to receive(:ngrok_process_status_lines).with(refetch: true).and_return(new_ngrok_ps_lines)
+                    allow(Ngrok::Wrapper).to receive(:fetch_urls)
+
+                    expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true)
+                    expect(Ngrok::Wrapper).to receive(:fork)
+                    expect(Ngrok::Wrapper).to receive(:ngrok_process_status_lines).with(refetch: true)
+                    allow(Ngrok::Wrapper).to receive(:fetch_urls)
+
+                    Ngrok::Wrapper.start(persistence: true)
+
+                    expect(Ngrok::Wrapper.pid).to eql('835')
+                    expect(Ngrok::Wrapper.status).to eql(:running)
+                  end
+                end
               end
 
-              it 'sets Ngrok::Wrapper pid and status attributes' do
-                allow(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true).and_call_original
-                allow(Ngrok::Wrapper)
-                  .to receive(:ngrok_process_status_lines).with(refetch: true).and_return(new_ngrok_ps_lines)
-                allow(Ngrok::Wrapper).to receive(:fetch_urls)
-
-                expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true)
-                expect(Ngrok::Wrapper)
-                  .to receive(:ngrok_process_status_lines).with(refetch: true)
-                allow(Ngrok::Wrapper).to receive(:fetch_urls)
+              it 'tries fetching params of an already running Ngrok and store Ngrok process data into a file' do
+                expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
+                expect(File).to receive(:write)
 
                 Ngrok::Wrapper.start(persistence: true)
-
-                expect(Ngrok::Wrapper.pid).to eql('835')
-                expect(Ngrok::Wrapper.status).to eql(:running)
               end
             end
           end
+        end
+
+        describe 'when persistence param is not true' do
+          after { Ngrok::Wrapper.stop }
 
-          it 'tries fetching params of an already running Ngrok and store Ngrok process data into a file' do
-            expect(Ngrok::Wrapper).to receive(:try_params_from_running_ngrok)
-            expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: true)
-            expect(File).to receive(:write)
+          it "doesn't try to fetch params of an already running Ngrok" do
+            expect(Ngrok::Wrapper).not_to receive(:try_params_from_running_ngrok)
+            expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: false)
+            expect_any_instance_of(File).not_to receive(:write)
 
-            Ngrok::Wrapper.start(persistence: true)
+            Ngrok::Wrapper.start(persistence: false)
           end
         end
-      end
-    end
-
-    describe 'when persistence param is not true' do
-      it "doesn't try to fetch params of an already running Ngrok" do
-        expect(Ngrok::Wrapper).not_to receive(:try_params_from_running_ngrok)
-        expect(Ngrok::Wrapper).to receive(:spawn_new_ngrok).with(persistent_ngrok: false)
-        expect_any_instance_of(File).not_to receive(:write)
 
-        Ngrok::Wrapper.start(persistence: false)
-      end
-    end
+        describe 'when Ngrok::Wrapper is already running' do
+          it "doesn't try to spawn a new Ngrok process" do
+            allow(Ngrok::Wrapper).to receive(:stopped?).and_return(false)
+            expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
 
-    describe 'when Ngrok::Wrapper is already running' do
-      it "doesn't try to spawn a new Ngrok process" do
-        allow(Ngrok::Wrapper).to receive(:stopped?).and_return(false)
-        expect(Ngrok::Wrapper).not_to receive(:spawn_new_ngrok)
-
-        Ngrok::Wrapper.start
+            Ngrok::Wrapper.start
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Bogdanovich
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
 summary: Ngrok-wrapper gem is a ruby wrapper for ngrok2