ngrok-tunnel 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca6bf750325cd01425d06a581329da3c50e3f4a7
+  data.tar.gz: c3d1f8a5acc781598882792e5b99896295a485c4
+SHA512:
+  metadata.gz: 911ba4c6d25a317b580eba31971b3c732782aad259d88778956f21cfed4dc6375c323dfe1b20473e2629a799e449725162e003bd0f3a4c828fa2ea400fc401bd
+  data.tar.gz: 13df49c97439971b80f307a101ef9da302c5bd31d3b369be7a64c69e7ab13763116c3287fbc743d30382ce57c89d0cf8aecb2dbfe6e71bec1f4aefca021dbe8b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ngrok-tunnel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anton Bogdanovich
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Ngrok::Tunnel
+
+ngrok-tunnel provides ruby wrapper for ngrok
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ngrok-tunnel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ngrok-tunnel
+
+## Usage
+
+```ruby
+require 'ngrok/tunnel'
+
+# spawn ngrok
+Ngrok::Tunnel.start(3001)
+
+# ngrok local_port
+Ngrok::Tunnel.local_port
+
+# ngrok external url
+Ngrok::Tunnel.ngrok_url
+Ngrok::Tunnel.ngrok_url_https
+
+Ngrok::Tunnel.running?
+Ngrok::Tunnel.stopped?
+
+# ngrok process id
+Ngrok::Tunnel.pid
+
+# ngrok log file descriptor
+Ngrok::Tunnel.log_file
+
+# kill ngrok
+Ngrok::Tunnel.stop
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ngrok/tunnel.rb

@@ -0,0 +1,76 @@
+require "ngrok/tunnel/version"
+require "tempfile"
+
+module Ngrok
+
+  class NotFound < StandardError; end
+  class FetchUrlError < StandardError; end
+
+  class Tunnel
+    
+    class << self
+      attr_reader :pid, :local_port, :ngrok_url, :ngrok_url_https, :log_file, :status
+
+      def init
+        @status = :stopped
+      end
+
+      def start(port, options = {})
+        options[:timeout] ||= 10
+        @options = options
+
+        ensure_binary
+
+        @local_port = port.to_i
+        @log_file   = Tempfile.new('ngrok')
+        
+        @pid = spawn("exec ngrok -log=stdout #{@local_port} > #{@log_file.path}")
+        at_exit { Ngrok::Tunnel.stop }      
+        @status = :running
+        fetch_urls
+      end
+
+      def stop
+        if running?
+          Process.kill(9, @pid)
+          @ngrok_url = @ngrok_url_https = @pid = nil
+          @status = :stopped
+        end
+      end
+
+      def running?
+        @status == :running
+      end
+
+      def stopped?
+        @status == :stopped
+      end
+
+      def inherited(subclass)
+        init
+      end
+
+      private
+
+      def fetch_urls
+        @options[:timeout].times do
+          @ngrok_url, @ngrok_url_https = @log_file.read.scan(/"Url":"([^"]+)"/).flatten
+          return @ngrok_url if @ngrok_url
+          sleep 1
+          @log_file.rewind
+        end
+        raise FetchUrlError, "Unable to fetch external url"
+        @ngrok_url
+      end
+
+      def ensure_binary
+        `ngrok version`
+      rescue Errno::ENOENT
+        raise Ngrok::NotFound, "Ngrok binary not found"
+      end
+    end
+
+    init
+
+  end
+end

data/lib/ngrok/tunnel/version.rb

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

data/ngrok-tunnel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ngrok/tunnel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ngrok-tunnel"
+  spec.version       = Ngrok::Tunnel::VERSION
+  spec.authors       = ["Anton Bogdanovich"]
+  spec.email         = ["27bogdanovich@gmail.com"]
+  spec.summary       = %q{Ngrok-tunnel gem is a ruby wrapper for ngrok}
+  spec.description   = %q{Ngrok-tunnel gem is a ruby wrapper for ngrok}
+  spec.homepage      = "https://github.com/bogdanovich/ngrok-tunnel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("pry", "~> 0.10")
+  spec.add_development_dependency("pry-byebug", "~> 2.0")
+  spec.add_development_dependency("rspec", "~> 3.1")
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'ngrok/tunnel'
+require 'pry'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/tunnel/tunnel_spec.rb

@@ -0,0 +1,63 @@
+
+describe Ngrok::Tunnel do
+
+  describe "Before start" do
+    
+    it "should not be running" do
+      expect(Ngrok::Tunnel.running?).to be false
+    end
+
+    it "should be stopped" do
+      expect(Ngrok::Tunnel.stopped?).to be true
+    end
+
+    it "should have status = :stopped" do
+      expect(Ngrok::Tunnel.status).to eq :stopped
+    end
+
+  end
+
+  describe "Run process" do
+
+    before(:all) do
+      @local_port = 3001
+      Ngrok::Tunnel.start(3001)
+    end
+
+    after(:all) { Ngrok::Tunnel.stop }
+
+    it "should be running" do
+      expect(Ngrok::Tunnel.running?).to be true
+    end
+
+    it "should not be stopped" do
+      expect(Ngrok::Tunnel.stopped?).to be false
+    end
+
+    it "should have status = :running" do
+      expect(Ngrok::Tunnel.status).to eq :running
+    end
+
+    it "should match local_port" do
+      expect(Ngrok::Tunnel.local_port).to eq(@local_port)
+    end
+
+    it "should have valid ngrok_url" do
+      expect(Ngrok::Tunnel.ngrok_url).to be =~ /http:\/\/.*ngrok.com$/
+    end
+
+    it "should have valid ngrok_url_https" do
+      expect(Ngrok::Tunnel.ngrok_url_https).to be =~ /https:\/\/.*ngrok.com$/
+    end
+
+    it "should have pid > 0" do
+      expect(Ngrok::Tunnel.pid).to be > 0
+    end
+
+    it "should present in process list" do
+      expect(Ngrok::Tunnel.pid.to_s).to eq `pidof ngrok`.strip
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ngrok-tunnel
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Anton Bogdanovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 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
+email:
+- 27bogdanovich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ngrok/tunnel.rb
+- lib/ngrok/tunnel/version.rb
+- ngrok-tunnel.gemspec
+- spec/spec_helper.rb
+- spec/tunnel/tunnel_spec.rb
+homepage: https://github.com/bogdanovich/ngrok-tunnel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+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