ngrok-tunnel 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca6bf750325cd01425d06a581329da3c50e3f4a7
-  data.tar.gz: c3d1f8a5acc781598882792e5b99896295a485c4
+  metadata.gz: 4c864e0a2db71b2c84350df7daba7ef501c75a2d
+  data.tar.gz: adbc7d33d04e99d3e657f53ff4c203d93a323b0e
 SHA512:
-  metadata.gz: 911ba4c6d25a317b580eba31971b3c732782aad259d88778956f21cfed4dc6375c323dfe1b20473e2629a799e449725162e003bd0f3a4c828fa2ea400fc401bd
-  data.tar.gz: 13df49c97439971b80f307a101ef9da302c5bd31d3b369be7a64c69e7ab13763116c3287fbc743d30382ce57c89d0cf8aecb2dbfe6e71bec1f4aefca021dbe8b
+  metadata.gz: f97a3e3eb817a84c124029ab9e40ea3d6bbd81548a576ba6c454f261564d9aa7a1150496d0b47035010d93a699b39543b7706d3e9fec113247e3a9f67dc25709
+  data.tar.gz: 96dbd1d0a73e59675ffe02e386953383d202c258b386665de17a6f4965ee40461fe274d5eab3f75e36806b1ed81d33ae804d27ed1b4b8f0720f3e8538293ab2f

data/README.md

@@ -1,6 +1,8 @@
 # Ngrok::Tunnel
 
-ngrok-tunnel provides ruby wrapper for ngrok
+Ngrok-tunnel gem is a ruby wrapper for ngrok
+
+[![Gem Version](https://badge.fury.io/rb/ngrok-tunnel.svg)](http://badge.fury.io/rb/ngrok-tunnel)
 
 ## Installation
 
@@ -23,33 +25,54 @@ Or install it yourself as:
 ```ruby
 require 'ngrok/tunnel'
 
-# spawn ngrok
-Ngrok::Tunnel.start(3001)
+# spawn ngrok (default port 3001)
+Ngrok::Tunnel.start
 
 # ngrok local_port
-Ngrok::Tunnel.local_port
+Ngrok::Tunnel.port
+=> 3001
 
 # ngrok external url
 Ngrok::Tunnel.ngrok_url
+=> "http://aaa0e65.ngrok.com"
+
 Ngrok::Tunnel.ngrok_url_https
+=> "https://aaa0e65.ngrok.com"
 
 Ngrok::Tunnel.running?
+=> true
+
 Ngrok::Tunnel.stopped?
+=> false
 
 # ngrok process id
 Ngrok::Tunnel.pid
+=> 27384
 
 # ngrok log file descriptor
-Ngrok::Tunnel.log_file
+Ngrok::Tunnel.log
+=> #<File:/tmp/ngrok20141022-27376-cmmiq4>
 
 # kill ngrok
 Ngrok::Tunnel.stop
+=> :stopped
+
+```
+
+```ruby
+# ngrok custom parameters
+Ngrok::Tunnel.start(port: 3333, 
+                    subdomain: 'MY_SUBDOMAIN', 
+                    authtoken: 'MY_TOKEN', 
+                    log: 'ngrok.log', 
+                    config: '~/.ngrok')
 
 ```
 
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ngrok-tunnel/fork )
+1. Fork it ( https://github.com/bogdanovich/ngrok-tunnel/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/ngrok/tunnel.rb

@@ -5,29 +5,31 @@ module Ngrok
 
   class NotFound < StandardError; end
   class FetchUrlError < StandardError; end
+  class Error < StandardError; end
 
   class Tunnel
     
     class << self
-      attr_reader :pid, :local_port, :ngrok_url, :ngrok_url_https, :log_file, :status
+      attr_reader :pid, :ngrok_url, :ngrok_url_https, :status
 
-      def init
-        @status = :stopped
+      def init(params = {})
+        @params = {port: 3001, timeout: 10, config: '/dev/null'}.merge(params)
+        @status = :stopped unless @status
       end
 
-      def start(port, options = {})
-        options[:timeout] ||= 10
-        @options = options
-
+      def start(params = {})
         ensure_binary
-
-        @local_port = port.to_i
-        @log_file   = Tempfile.new('ngrok')
+        init(params)
+
+        if stopped?
+          @params[:log] = (@params[:log]) ? File.open(@params[:log], 'w+') : Tempfile.new('ngrok')
+          @pid = spawn("exec ngrok " + ngrok_exec_params)
+          at_exit { Ngrok::Tunnel.stop }      
+          @status = :running
+          fetch_urls
+        end
         
-        @pid = spawn("exec ngrok -log=stdout #{@local_port} > #{@log_file.path}")
-        at_exit { Ngrok::Tunnel.stop }      
-        @status = :running
-        fetch_urls
+        @ngrok_url
       end
 
       def stop
@@ -36,6 +38,7 @@ module Ngrok
           @ngrok_url = @ngrok_url_https = @pid = nil
           @status = :stopped
         end
+        @status
       end
 
       def running?
@@ -46,18 +49,49 @@ module Ngrok
         @status == :stopped
       end
 
+      def port
+        @params[:port]
+      end
+
+      def log
+        @params[:log]
+      end
+
+      def subdomain
+        @params[:subdomain]
+      end
+
+      def authtoken
+        @params[:authtoken]
+      end
+
       def inherited(subclass)
         init
       end
 
       private
 
+      def ngrok_exec_params
+        exec_params = "-log=stdout " 
+        exec_params << "-authtoken=#{@params[:authtoken]} " if @params[:authtoken]
+        exec_params << "-subdomain=#{@params[:subdomain]} " if @params[:subdomain]
+        exec_params << "-config=#{@params[:config]} #{@params[:port].to_i} > #{@params[:log].path}"
+      end
+
       def fetch_urls
-        @options[:timeout].times do
-          @ngrok_url, @ngrok_url_https = @log_file.read.scan(/"Url":"([^"]+)"/).flatten
+        @params[:timeout].times do
+          log_content = @params[:log].read
+          @ngrok_url, @ngrok_url_https = log_content.scan(/"Url":"([^"]+)"/).flatten
           return @ngrok_url if @ngrok_url
+
+          error = log_content.scan(/"Error":"([^"]+)"/).flatten
+          unless error.empty?
+            self.stop
+            raise Ngrok::Error, error.first
+          end
+          
           sleep 1
-          @log_file.rewind
+          @params[:log].rewind
         end
         raise FetchUrlError, "Unable to fetch external url"
         @ngrok_url

data/lib/ngrok/tunnel/version.rb

@@ -1,5 +1,5 @@
 module Ngrok
   class Tunnel
-    VERSION = "1.0.1"
+    VERSION = "2.0.1"
   end
 end

data/spec/tunnel/tunnel_spec.rb

@@ -20,8 +20,7 @@ describe Ngrok::Tunnel do
   describe "Run process" do
 
     before(:all) do
-      @local_port = 3001
-      Ngrok::Tunnel.start(3001)
+      Ngrok::Tunnel.start
     end
 
     after(:all) { Ngrok::Tunnel.stop }
@@ -39,7 +38,7 @@ describe Ngrok::Tunnel do
     end
 
     it "should match local_port" do
-      expect(Ngrok::Tunnel.local_port).to eq(@local_port)
+      expect(Ngrok::Tunnel.port).to eq(3001)
     end
 
     it "should have valid ngrok_url" do
@@ -60,4 +59,24 @@ describe Ngrok::Tunnel do
 
   end
 
+  describe "Custom log file" do
+    it "should be able to use 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'
+      Ngrok::Tunnel.stop
+      expect(Ngrok::Tunnel.stopped?).to eq true
+    end
+  end
+
+  describe "Custom subdomain" do
+    it "should fail without authtoken" do
+      expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain')}.to raise_error
+    end
+
+    it "should fail with incorrect authtoken" do
+      expect {Ngrok::Tunnel.start(subdomain: 'test-subdomain', authtoken: 'incorrect_token')}.to raise_error
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-tunnel
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Anton Bogdanovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry