ngrok-tunnel 2.0.21 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48b412799e8a113e374412c2a68da389ee04c49c
-  data.tar.gz: aeabe2d6f25eb6224646762dc478b29c0bfcbd34
+  metadata.gz: 4744a8f70e339c7390520de791b624d36c167b4f
+  data.tar.gz: 51739d7cdb5f89fd86d7cfb6376571d563b12cc9
 SHA512:
-  metadata.gz: cbb75e5b3c6eaa23504eebdba9d7498831bfac45ce3a1abc01c58c1ce7ac12ec5ce1fcc6a67cd94f22544df686f4d3b7a2701c1353e15a2d57f57dbe9371546f
-  data.tar.gz: 05901e60c7d2ab019c127b958f903385c6f9fed6a3ffe0c837def7f284b27b7b5d22a80702c600d6ae38e9a22d0295cc90df32e2815f2f9101aec69c4d154727
+  metadata.gz: 966afd8e4d1b6f87438ba320d5c06f4229b65981470f345245c0694b0028041e00da2a6de0a1f98079478b4f30f9dc2a5c6e729401c3b21bf5d790dcecfe5e24
+  data.tar.gz: 2ebf404553a5d007937b7bbf35e10f45e4d3932b8d8e09ffb18f4897ace33d7d485d8ec3f425ed9cffec0cde8919c40da62778c5a895f4e9ca966498ee9fcb0b

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+test.log

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0
+
+- Added support for non-local server using `addr` parameter
+
 ## 2.0.21
 
 - Added support for -inspect option

data/README.md

@@ -36,10 +36,10 @@ Ngrok::Tunnel.port
 
 # ngrok external url
 Ngrok::Tunnel.ngrok_url
-=> "http://aaa0e65.ngrok.com"
+=> "http://aaa0e65.ngrok.io"
 
 Ngrok::Tunnel.ngrok_url_https
-=> "https://aaa0e65.ngrok.com"
+=> "https://aaa0e65.ngrok.io"
 
 Ngrok::Tunnel.running?
 => true
@@ -63,7 +63,7 @@ Ngrok::Tunnel.stop
 
 ```ruby
 # ngrok custom parameters
-Ngrok::Tunnel.start(port: 3333,
+Ngrok::Tunnel.start(addr: 'foo.dev:80',
                     subdomain: 'MY_SUBDOMAIN',
                     hostname: 'MY_HOSTNAME',
                     authtoken: 'MY_TOKEN',

data/lib/ngrok/tunnel.rb

@@ -13,7 +13,10 @@ module Ngrok
       attr_reader :pid, :ngrok_url, :ngrok_url_https, :status
 
       def init(params = {})
-        @params = {port: 3001, timeout: 10, config: '/dev/null'}.merge(params)
+        # map old key 'port' to 'addr' to maintain backwards compatibility with versions 2.0.21 and earlier
+        params[:addr] = params.delete(:port) if params.key?(:port)
+
+        @params = {addr: 3001, timeout: 10, config: '/dev/null'}.merge(params)
         @status = :stopped unless @status
       end
 
@@ -49,8 +52,13 @@ module Ngrok
         @status == :stopped
       end
 
+      def addr
+        @params[:addr]
+      end
+
       def port
-        @params[:port]
+        return addr if addr.is_a?(Numeric)
+        addr.split(":").last.to_i
       end
 
       def log
@@ -77,7 +85,7 @@ module Ngrok
         exec_params << "-subdomain=#{@params[:subdomain]} " if @params[:subdomain]
         exec_params << "-hostname=#{@params[:hostname]} " if @params[:hostname]
         exec_params << "-inspect=#{@params[:inspect]} " if @params.has_key? :inspect
-        exec_params << "-config=#{@params[:config]} #{@params[:port].to_i} > #{@params[:log].path}"
+        exec_params << "-config=#{@params[:config]} #{@params[:addr]} > #{@params[:log].path}"
       end
 
       def fetch_urls

data/lib/ngrok/tunnel/version.rb

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

data/spec/tunnel/tunnel_spec.rb

@@ -1,4 +1,3 @@
-
 describe Ngrok::Tunnel do
 
   describe "Before start" do
@@ -37,10 +36,14 @@ describe Ngrok::Tunnel do
       expect(Ngrok::Tunnel.status).to eq :running
     end
 
-    it "should match local_port" do
+    it "should still support port" do
       expect(Ngrok::Tunnel.port).to eq(3001)
     end
 
+    it "should match local_addr" do
+      expect(Ngrok::Tunnel.addr).to eq(3001)
+    end
+
     it "should have valid ngrok_url" do
       expect(Ngrok::Tunnel.ngrok_url).to be =~ /http:\/\/.*ngrok\.io$/
     end
@@ -67,21 +70,44 @@ describe Ngrok::Tunnel do
 
   describe "Custom subdomain" do
     it "should fail without authtoken" do
-      expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain')}.to raise_error
+      expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain')}.to raise_error Ngrok::Error
     end
 
     it "should fail with incorrect authtoken" do
-      expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain', authtoken: 'incorrect_token')}.to raise_error
+      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
-      expect {Ngrok::Tunnel.start(hostname: 'example.com')}.to raise_error
+      expect {Ngrok::Tunnel.start(hostname: 'example.com')}.to raise_error Ngrok::Error
     end
 
     it "should fail with incorrect authtoken" do
-      expect {Ngrok::Tunnel.start(hostname: 'example.com', authtoken: 'incorrect_token')}.to raise_error
+      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
+      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
+      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
+      addr = '192.168.0.5:10010'
+      Ngrok::Tunnel.start(addr: addr)
+      expect(Ngrok::Tunnel.addr).to eq addr
+      Ngrok::Tunnel.stop
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-tunnel
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.1.0
 platform: ruby
 authors:
 - Anton Bogdanovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry