ensure_ngrok_tunnel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2931e7c38d85022b0b5815e48da8d78c97fc224f5ebe849d5fbe13d6948c104
-  data.tar.gz: 4ce0716280a2584eb065aa79b11def5612107d948b7a684a887ac657bc4e0b31
+  metadata.gz: 3893dd2afbe621460feb6d745c2988f557ca53eff7a406cb16b7b4fc08b79ae6
+  data.tar.gz: 4c93098adf79cf001339f82c497d0d75658fb83fb07923a8d3626e56566238a3
 SHA512:
-  metadata.gz: 79b4fe7d512dd8361afbcf93e43aff0f64ed0d73315d402c52dd94154a499dd6e7d04094278cf651f6adc63bda88305fc04b37af61d2cca3f33e8eb2e256dca2
-  data.tar.gz: 370c80d3e42c43913acd13abf1022c04638a583e8728bad90525ab779c85299e60e04d6b81cac272e3327e7a35c58e5b475c6b43e64a4f0e7ee1a194ce962c97
+  metadata.gz: cf912fec2740449d78c69f94ea1f078215e0330d77749e59e73d490b688d692f5a14092113f5f4ad989a90c31d6123dddf92bbc2597cf36716a2e96772d50919
+  data.tar.gz: 72f4bd7ba897074779707ed3398fee445cd09acec9407128aa65f15c3b7314491d83e3f8b9b0d5cc5abaedd2328d90d8a00b212ccceb3d4ab3e100a14b9b0956

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    ensure_ngrok_tunnel (0.1.0)
+    ensure_ngrok_tunnel (0.1.1)
       json
       rest-client
 
 GEM
   remote: https://rubygems.org/
   specs:
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       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 (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mime-types-data (3.2018.0812)
     netrc (0.11.0)
     rake (10.4.2)
     rest-client (2.0.2)
@@ -35,4 +35,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -1,9 +1,4 @@
 # 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:
@@ -26,11 +21,13 @@ In your development.rb, call `EnsureNgrokTunnel.start` with a [valid ngrok confi
 
 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`.
 
+If an instance of ngrok is already running on the standard port (4040), `EnsureNgrokTunnel` will talk to it, otherwise it spawns one with `ngrok start --none` (this instance should die when the parent process does, though with rails development the usual spring/fs-watch shenanigans will probably occasionally result in zombied ngroks).
+
 `EnsureNgrokTunnel` returns the tunnel url.
 
 Example:
 ```ruby
-  server_port = ENV.fetch('PORT')
+  server_port = ENV.fetch('TUNNEL_PORT')
   ngrok_url = EnsureNgrokTunnel.start(
     config: {
       name: Rails.application.class.parent.name.underscore,
@@ -46,6 +43,8 @@ Example:
   puts "[NGROK] tunneling at " + ngrok_url
 ```
 
+**NOTE:** be careful about using the standard PORT env var in Rails with sidekiq. When using heroku local & a Procfile with web & worker processes, the PORT variable seems to get incremented by 100 in the worker process, which will cause `EnsureNgrokTunnel` not to find the tunnel in whichever is the second process to launch.
+
 ## 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.

data/ensure_ngrok_tunnel.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{This tiny gem has a singular purpose: ensure there is an ngrok tunnel running for the specified port.}
   spec.homepage      = "https://github.com/lastobelus/ensure_ngrok_tunnel"
   spec.license       = "MIT"
 

data/lib/ensure_ngrok_tunnel.rb

@@ -5,9 +5,8 @@ module EnsureNgrokTunnel
     require 'json'
     require 'open-uri'
 
-    port ||= config['addr'] || config[:addr] || ENV.fetch("PORT")
+    port ||= config[:addr] || ENV.fetch("PORT")
 
-    puts "setting up ngrok"
     ngrok_url = false
     ngrok_process = nil
     ngrok = nil
@@ -29,6 +28,7 @@ module EnsureNgrokTunnel
     end
 
     retries = 0
+
     begin
       ngrok = JSON.parse(ngrok)
       tunnel = ngrok['tunnels'].detect{|t| t['config']['addr'].split(':').last.to_s == port.to_s}
@@ -40,8 +40,7 @@ module EnsureNgrokTunnel
       end
     rescue
       retries += 1
-      name = config['name'] || config['hostname'] || config['subdomain'] || ENV.fetch('DOMAIN', '????')
-      puts "starting ngrok tunnel for #{name}"
+      name = config[:name] || config[:hostname] || config[:subdomain] || ENV.fetch('DOMAIN', '????')
       begin
         response = RestClient.post ngrok_url, config.to_json, {content_type: :json, accept: :json}
       rescue => e

data/lib/ensure_ngrok_tunnel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ensure_ngrok_tunnel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-22 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'This tiny gem has a singular tunnel: ensure there is an ngrok tunnel
+description: 'This tiny gem has a singular purpose: ensure there is an ngrok tunnel
   running for the specified port.'
 email:
 - lastobelus@mac.com
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ensure an ngrok tunnel is started