ensure_ngrok_tunnel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2931e7c38d85022b0b5815e48da8d78c97fc224f5ebe849d5fbe13d6948c104
+  data.tar.gz: 4ce0716280a2584eb065aa79b11def5612107d948b7a684a887ac657bc4e0b31
+SHA512:
+  metadata.gz: 79b4fe7d512dd8361afbcf93e43aff0f64ed0d73315d402c52dd94154a499dd6e7d04094278cf651f6adc63bda88305fc04b37af61d2cca3f33e8eb2e256dca2
+  data.tar.gz: 370c80d3e42c43913acd13abf1022c04638a583e8728bad90525ab779c85299e60e04d6b81cac272e3327e7a35c58e5b475c6b43e64a4f0e7ee1a194ce962c97

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ensure_ngrok_tunnel.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ensure_ngrok_tunnel (0.1.0)
+      json
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rake (10.4.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ensure_ngrok_tunnel!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Johnston
+
+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,61 @@
+# EnsureNgrokTunnel
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ensure_ngrok_tunnel`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ensure_ngrok_tunnel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ensure_ngrok_tunnel
+
+## Usage
+
+In your development.rb, call `EnsureNgrokTunnel.start` with a [valid ngrok config](https://ngrok.com/docs#config). If you have tunnels defined in your global ngrok config, this could just be `{name: 'name-of-my-tunnel'}`.
+
+To determine whether the tunnel already exists, `EnsureNgrokTunnel` just looks for any tunnel bound to the port specified by `addr` in the config, or if not set, in `ENV['PORT']`. If you are using a config that just specifies a tunnel by name, you can optionally pass the port  as `port: XXXX`.
+
+`EnsureNgrokTunnel` returns the tunnel url.
+
+Example:
+```ruby
+  server_port = ENV.fetch('PORT')
+  ngrok_url = EnsureNgrokTunnel.start(
+    config: {
+      name: Rails.application.class.parent.name.underscore,
+      addr: server_port,
+      proto: 'tls',
+      hostname: ENV.fetch('API_DOMAIN'),
+      key: Rails.root.join('certificates', 'development-key.pem').to_s,
+      crt: Rails.root.join('certificates', 'development-cert.pem').to_s
+    },
+    port: server_port
+  )
+
+  puts "[NGROK] tunneling at " + ngrok_url
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lastobelus/ensure_ngrok_tunnel.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ensure_ngrok_tunnel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ensure_ngrok_tunnel.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ensure_ngrok_tunnel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ensure_ngrok_tunnel"
+  spec.version       = EnsureNgrokTunnel::VERSION
+  spec.authors       = ["Michael Johnston"]
+  spec.email         = ["lastobelus@mac.com"]
+
+  spec.summary       = %q{Ensure an ngrok tunnel is started}
+  spec.description   = %q{This tiny gem has a singular tunnel: ensure there is an ngrok tunnel running for the specified port.}
+  spec.homepage      = "https://github.com/lastobelus/ensure_ngrok_tunnel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "json"
+end

data/lib/ensure_ngrok_tunnel/version.rb

@@ -0,0 +1,3 @@
+module EnsureNgrokTunnel
+  VERSION = "0.1.0"
+end

data/lib/ensure_ngrok_tunnel.rb

@@ -0,0 +1,58 @@
+require "ensure_ngrok_tunnel/version"
+
+module EnsureNgrokTunnel
+  def self.start(config:, port: nil)
+    require 'json'
+    require 'open-uri'
+
+    port ||= config['addr'] || config[:addr] || ENV.fetch("PORT")
+
+    puts "setting up ngrok"
+    ngrok_url = false
+    ngrok_process = nil
+    ngrok = nil
+    ngrok_url = 'http://localhost:4040/api/tunnels'
+
+    begin
+      puts "checking ngrok for tunnels"
+      ngrok = open(ngrok_url).read
+    rescue
+      if ngrok_process
+        puts "waiting for ngrok..."
+        sleep 0.5
+      else
+        puts "starting ngrok..."
+        ngrok_process = spawn('ngrok start --none')
+        Process.detach(ngrok_process)
+      end
+      retry
+    end
+
+    retries = 0
+    begin
+      ngrok = JSON.parse(ngrok)
+      tunnel = ngrok['tunnels'].detect{|t| t['config']['addr'].split(':').last.to_s == port.to_s}
+      if tunnel
+        ngrok_url = tunnel.fetch('public_url')
+      else
+        puts "could not find tunnel..."
+        raise "not found"
+      end
+    rescue
+      retries += 1
+      name = config['name'] || config['hostname'] || config['subdomain'] || ENV.fetch('DOMAIN', '????')
+      puts "starting ngrok tunnel for #{name}"
+      begin
+        response = RestClient.post ngrok_url, config.to_json, {content_type: :json, accept: :json}
+      rescue => e
+        puts "error starting tunnel: #{e.inspect}\n#{e.response.body.inspect}"
+      end
+      sleep 0.5
+      puts "retrying"
+      ngrok = open(ngrok_url).read
+      retry unless retries > 5
+    end
+
+    ngrok_url
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ensure_ngrok_tunnel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Johnston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This tiny gem has a singular tunnel: ensure there is an ngrok tunnel
+  running for the specified port.'
+email:
+- lastobelus@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ensure_ngrok_tunnel.gemspec
+- lib/ensure_ngrok_tunnel.rb
+- lib/ensure_ngrok_tunnel/version.rb
+homepage: https://github.com/lastobelus/ensure_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.7.6
+signing_key: 
+specification_version: 4
+summary: Ensure an ngrok tunnel is started
+test_files: []