ngrok-tunnel 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4744a8f70e339c7390520de791b624d36c167b4f
-  data.tar.gz: 51739d7cdb5f89fd86d7cfb6376571d563b12cc9
+  metadata.gz: 4d13e641f1a360b61919ea2b25fbe2756fc17a79
+  data.tar.gz: ccf64005f90a0bc710ba7163ed54d93f6b5b39df
 SHA512:
-  metadata.gz: 966afd8e4d1b6f87438ba320d5c06f4229b65981470f345245c0694b0028041e00da2a6de0a1f98079478b4f30f9dc2a5c6e729401c3b21bf5d790dcecfe5e24
-  data.tar.gz: 2ebf404553a5d007937b7bbf35e10f45e4d3932b8d8e09ffb18f4897ace33d7d485d8ec3f425ed9cffec0cde8919c40da62778c5a895f4e9ca966498ee9fcb0b
+  metadata.gz: 81b37596784331467111f41936c68840db91501c75e9f81b16563e444e97ab4e57ea220e608f79f9d6f46bd36a2e38c55836f962f0c5276672d0d0c41b2d57ea
+  data.tar.gz: b733920ba70cdd3f2654deb568509e2e37002c2abcd1a50213d1e8ae48b3236c7888a9d5bcdde468821bfd1ad57bd97908253585da9ace4f9e4d94a9a5c4bcd7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.1.1
+
+- Added support for `region` parameter
+- Added support for `host-header` parameter
+
 ## 2.1.0
 
 - Added support for non-local server using `addr` parameter

data/README.md

@@ -73,6 +73,13 @@ Ngrok::Tunnel.start(addr: 'foo.dev:80',
 
 ```
 
+### With Rails (Rack server)
+
+See [examples/rack-server.rb](examples/rack-server.rb) to get an idea how to use it along with a Rack server so that it automatically starts and stops when a Rack server does.
+
+### With RSpec and Capybara
+
+Use this gem: [ngrok-rspec](https://github.com/bogdanovich/ngrok-rspec)
 
 ## Contributing
 

data/examples/rack-server.rb

@@ -0,0 +1,20 @@
+# Add these to the end of a configuration file of your prefered web-server,
+# e.g. config/puma.rb, config/unicorn.rb, or config/thin.rb
+# Use ./.ngrok or ~/.ngrok as a config file. Don't forget to add it to `.gitignore' in the former case.
+# Set NGROK_INSPECT=false to disable the inspector web-server.
+unless ENV['RAILS_ENV'] == 'production'
+  require 'ngrok/tunnel'
+  options = {addr: ENV['PORT']}
+  if File.file? '.ngrok'
+    options[:config] = '.ngrok'
+  elsif File.file? ENV['HOME'] + '/.ngrok'
+    options[:config] = ENV['HOME'] + '/.ngrok'
+  end
+  if ENV['NGROK_INSPECT']
+    options[:inspect] = ENV['NGROK_INSPECT']
+  end
+  puts "[NGROK] tunneling at " + Ngrok::Tunnel.start(options)
+  unless ENV['NGROK_INSPECT'] == 'false'
+    puts "[NGROK] inspector web interface listening at http://127.0.0.1:4040"
+  end
+end

data/lib/ngrok/tunnel.rb

@@ -81,6 +81,8 @@ module Ngrok
 
       def ngrok_exec_params
         exec_params = "-log=stdout -log-level=debug "
+        exec_params << "-region=#{@params[:region]} " if @params[:region]
+        exec_params << "-host-header=#{@params[:host_header]} " if @params[:host_header]
         exec_params << "-authtoken=#{@params[:authtoken]} " if @params[:authtoken]
         exec_params << "-subdomain=#{@params[:subdomain]} " if @params[:subdomain]
         exec_params << "-hostname=#{@params[:hostname]} " if @params[:hostname]

data/lib/ngrok/tunnel/version.rb

@@ -1,5 +1,5 @@
 module Ngrok
   class Tunnel
-    VERSION = "2.1.0"
+    VERSION = "2.1.1"
   end
 end

data/spec/tunnel/tunnel_spec.rb

@@ -2,64 +2,61 @@ describe Ngrok::Tunnel do
 
   describe "Before start" do
 
-    it "should not be running" do
+    it "is not running" do
       expect(Ngrok::Tunnel.running?).to be false
     end
 
-    it "should be stopped" do
+    it "is stopped" do
       expect(Ngrok::Tunnel.stopped?).to be true
     end
 
-    it "should have status = :stopped" do
+    it "has :stopped status" do
       expect(Ngrok::Tunnel.status).to eq :stopped
     end
 
   end
 
-  describe "Run process" do
+  describe "After start" do
 
-    before(:all) do
-      Ngrok::Tunnel.start
-    end
-
-    after(:all) { Ngrok::Tunnel.stop }
+    before(:all) { Ngrok::Tunnel.start }
+    after(:all)  { Ngrok::Tunnel.stop }
 
-    it "should be running" do
+    it "is running" do
       expect(Ngrok::Tunnel.running?).to be true
     end
 
-    it "should not be stopped" do
+    it "is not stopped" do
       expect(Ngrok::Tunnel.stopped?).to be false
     end
 
-    it "should have status = :running" do
+    it "has :running status" do
       expect(Ngrok::Tunnel.status).to eq :running
     end
 
-    it "should still support port" do
+    it "has correct port property" do
       expect(Ngrok::Tunnel.port).to eq(3001)
     end
 
-    it "should match local_addr" do
+    it "has correct addr property" do
       expect(Ngrok::Tunnel.addr).to eq(3001)
     end
 
-    it "should have valid ngrok_url" do
+    it "has valid ngrok_url" do
       expect(Ngrok::Tunnel.ngrok_url).to be =~ /http:\/\/.*ngrok\.io$/
     end
 
-    it "should have valid ngrok_url_https" do
+    it "has valid ngrok_url_https" do
       expect(Ngrok::Tunnel.ngrok_url_https).to be =~ /https:\/\/.*ngrok\.io$/
     end
 
-    it "should have pid > 0" do
+    it "has correct pid property" do
       expect(Ngrok::Tunnel.pid).to be > 0
     end
 
   end
 
   describe "Custom log file" do
-    it "should be able to use custom log file" do
+    it "uses custom log file" do
       Ngrok::Tunnel.start(log: 'test.log')
       expect(Ngrok::Tunnel.running?).to eq true
       expect(Ngrok::Tunnel.log.path).to eq 'test.log'
@@ -69,41 +66,41 @@ describe Ngrok::Tunnel do
   end
 
   describe "Custom subdomain" do
-    it "should fail without authtoken" do
+    it "fails without authtoken" do
       expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain')}.to raise_error Ngrok::Error
     end
 
-    it "should fail with incorrect authtoken" do
+    it "fails with incorrect authtoken" do
       expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain', authtoken: 'incorrect_token')}.to raise_error Ngrok::Error
     end
   end
 
   describe "Custom hostname" do
-    it "should fail without authtoken" do
+    it "fails without authtoken" do
       expect {Ngrok::Tunnel.start(hostname: 'example.com')}.to raise_error Ngrok::Error
     end
 
-    it "should fail with incorrect authtoken" do
+    it "fails with incorrect authtoken" do
       expect {Ngrok::Tunnel.start(hostname: 'example.com', authtoken: 'incorrect_token')}.to raise_error Ngrok::Error
     end
   end
 
   describe "Custom addr" do
-    it "should map port param to addr" do
+    it "maps port param to addr" do
       port = 10010
       Ngrok::Tunnel.start(port: port)
       expect(Ngrok::Tunnel.addr).to eq port
       Ngrok::Tunnel.stop
     end
 
-    it "should return just the port when the address contains a host" do
+    it "returns just the port when the address contains a host" do
       addr = '192.168.0.5:10010'
       Ngrok::Tunnel.start(addr: addr)
       expect(Ngrok::Tunnel.port).to eq 10010
       Ngrok::Tunnel.stop
     end
 
-    it "should support remote addresses" do
+    it "supports remote addresses" do
       addr = '192.168.0.5:10010'
       Ngrok::Tunnel.start(addr: addr)
       expect(Ngrok::Tunnel.addr).to eq addr
@@ -111,22 +108,51 @@ describe Ngrok::Tunnel do
     end
   end
 
+  describe "Custom region" do
+    it "doesn't include the -region parameter when it is not provided" do
+      Ngrok::Tunnel.start()
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).not_to include("-region=")
+      Ngrok::Tunnel.stop
+    end
+
+    it "includes the -region parameter with the correct value when it is provided" do
+      region = 'eu'
+      Ngrok::Tunnel.start(region: region)
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).to include("-region=#{region}")
+      Ngrok::Tunnel.stop
+    end
+  end
+
+  describe "Custom host header" do
+    it "doesn't include the -host-header parameter when it is not provided" do
+      Ngrok::Tunnel.start()
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).not_to include("-host-header=")
+      Ngrok::Tunnel.stop
+    end
+
+    it "includes the -host-header parameter with the correct value when it is provided" do
+      host_header = 'foo.bar'
+      Ngrok::Tunnel.start(host_header: host_header)
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).to include("-host-header=#{host_header}")
+      Ngrok::Tunnel.stop
+    end
+  end
+
   describe "Custom parameters provided" do
-    it "should not include the -inspect parameter when it is not provided" do
+    it "doesn't include the -inspect parameter when it is not provided" do
       Ngrok::Tunnel.start()
-      expect(Ngrok::Tunnel.send(:ngrok_exec_params).include? "-inspect=").to be false
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).not_to include("-inspect=")
       Ngrok::Tunnel.stop
     end
 
-    it "should include the -inspect parameter with the correct value when it is provided" do
+    it "includes the -inspect parameter with the correct value when it is provided" do
       Ngrok::Tunnel.start(inspect: true)
-      expect(Ngrok::Tunnel.send(:ngrok_exec_params).include? "-inspect=true").to be true
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).to include("-inspect=true")
       Ngrok::Tunnel.stop
 
       Ngrok::Tunnel.start(inspect: false)
-      expect(Ngrok::Tunnel.send(:ngrok_exec_params).include? "-inspect=false").to be true
+      expect(Ngrok::Tunnel.send(:ngrok_exec_params)).to include("-inspect=false")
       Ngrok::Tunnel.stop
     end
   end
-
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-tunnel
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Anton Bogdanovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Ngrok-tunnel gem is a ruby wrapper for ngrok
@@ -87,13 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/rack-server.rb
 - lib/ngrok/tunnel.rb
 - lib/ngrok/tunnel/version.rb
 - ngrok-tunnel.gemspec
@@ -109,21 +110,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ngrok-tunnel gem is a ruby wrapper for ngrok
 test_files:
 - spec/spec_helper.rb
 - spec/tunnel/tunnel_spec.rb
-has_rdoc: