puma-ngrok-tunnel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3227a5d893088f72be76945ce1e5c421026e521fc46e5ff97cde4306a090eef2
-  data.tar.gz: 2326bb0ae39d5b07ce731ee326068c440dc739782a7fbd43a3996ac8429d32a1
+  metadata.gz: d029d8c4cf8dc072229ec171cc0efb786336832b35244c077706aab670297f5b
+  data.tar.gz: 2be2b3c9fb277c079d0f74183805703505fff780fc60b27fba90d0ac189f8f1c
 SHA512:
-  metadata.gz: dc740df330bb4896132983e8766888d274c0294873989c1f489e96c63892a5d2258d4dbc8d826b2c4ed4fdec7134a9e58b8da646ad2e043b0be8a948c6768fc1
-  data.tar.gz: d68ee5cf93fb39e49505d34772dd01af5f8cb86e89a868d36f5914eb537f36cf53a95d9b6939104337828243525423eb243d7d3fc5bac560af7927221b63c945
+  metadata.gz: ac0f89bbd524854feae311cac699a33d74e6e2459c88b9886afc786c069b0fe58efe322f86480efba2082bf5e6e0d6263ae6c04a6c1bf4372535d29b67f57d98
+  data.tar.gz: dad8c33285f788cf5d7745c25bce721b62665efadb704b1fb9bfa4d03064870776df087cb7ce23c94cc3d76c69a0e08d17ee208b6d6f9feaef62aa657bdab4dd

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.1
+
+*  Improving mechanism for the tunnel being closed when rails is restarted, namely when `touch tmp/restart.txt` is used. This is based on https://github.com/harmjanblok/puma-metrics/blob/master/lib/puma/plugin/metrics.rb 
+* Adding more examples to docs.
+
+## 0.1.0
+
+* Initial Release

data/README.md

@@ -1,7 +1,17 @@
 # puma-ngrok-tunnel
 
-A plugin for puma that'll start a ngrok tunnel to your rails server. Built to make it easier to build apps that require webhooks to work as expected.
+[![Gem Version](https://badge.fury.io/rb/puma-ngrok-tunnel.svg)](https://badge.fury.io/rb/puma-ngrok-tunnel)
 
+![image](https://user-images.githubusercontent.com/325384/57193363-1d2c4800-6f32-11e9-82a4-1efc54fac0ad.png)
+
+A plugin for puma that'll start a [ngrok tunnel](https://ngrok.com/) to your rails server when puma starts. Primary I built this to make the following a little easier:
+
+* Working with apps that require Webhooks to be received by the app to work correctly
+* Demoing your local rails app to someone else without have to share IPs
+* Working with [Puma-dev](https://github.com/puma/puma-dev/) so your apps feels as production-like as possible.
+* Testing on mobile.
+
+I've setup a [sample Rails 6 app](https://github.com/MikeRogers0/puma-ngrok-tunnel-SampleRails6App) that demos an implementation of this gem.
 
 ## Installation
 
@@ -25,15 +35,7 @@ Lastly in your `config/puma.rb` file, append the line:
 
 
 ```ruby
-plugin :ngrok_tunnel if ENV['NGROK_TUNNEL_ENABLED']
-```
-
-## Installation with puma-dev
-
-Add the environmental variable (in a .env file for example):
-
-```
-CONFIG=config/puma.rb
+plugin :ngrok_tunnel if ENV.fetch('RAILS_ENV') { 'development' } == 'development'
 ```
 
 ## Usage
@@ -42,16 +44,26 @@ Read about how to configure puma to use this plugin here: https://github.com/pum
 
 There are a few variables this plugin reads from the environment which control its behavior. These are based on the arguments you'd pass to the [ngrok terminal command](https://ngrok.com/docs#http-subdomain).
 
-* `PORT` - defaults to 3000
-* `NGROK_ADDR`
-* `NGROK_AUTHTOKEN`
-* `NGROK_HOST_HEADER`
-* `NGROK_CONFIG`
-* `NGROK_SUBDOMAIN`
-* `NGROK_REGION`
-* `NGROK_HOSTNAME` - Full ngrok hostname, shouldn't be set if `NGROK_SUBDOMAIN` is set.
+* `PORT` - Optional, your rails port, defaults to `3000`. If `NGROK_ADDR` is set, this is ignored.
+* `NGROK_ADDR` - Optional, if you're using Puma-dev set this to be your hostname & port, e.g. `my-app-name.test:443`.
+* `NGROK_AUTHTOKEN` - Optional, your ngrok authtoken. If you have ngrok configured on your local machine you don't need this.
+* `NGROK_HOST_HEADER` - Optional, if you're using Puma-dev you should set this to your virtual host e.g. `my-app-name.test`.
+* `NGROK_CONFIG` - Optional, your ngrok configuration file location, defaults to `~/.ngrok2/ngrok.yml`.
+* `NGROK_SUBDOMAIN` - Optional, ngrok will assign you a random subdomain unless this is set.
+* `NGROK_REGION` - Optional, the region of your ngrok tunnel. defaults to `us`.
+* `NGROK_HOSTNAME` - Optional, full ngrok hostname, shouldn't be set if `NGROK_SUBDOMAIN` is set.
+
+### Sample .env for use with `rails s`
+
+```
+# puma-ngrok-tunnel setup
+# You need https://github.com/bkeepers/dotenv setup to make sure Puma can use these.
+export NGROK_TUNNEL_ENABLED=true
+export NGROK_SUBDOMAIN=my-app-name
+export NGROK_REGION=eu
+```
 
-### Sample .env
+### Sample .env for use with Puma-dev
 
 ```
 # Puma-dev: You need to define this otherwise it uses it's own puma.rb file.
@@ -59,7 +71,6 @@ CONFIG=config/puma.rb
 
 # puma-ngrok-tunnel setup
 # These should start with 'export' otherwise puma-dev won't use them.
-export NGROK_TUNNEL_ENABLED=true
 export NGROK_SUBDOMAIN=my-app-name
 export NGROK_REGION=eu
 # The URL (and HTTPS Port) you might use to access this under Puma-dev
@@ -67,6 +78,37 @@ export NGROK_ADDR=my-app-name.test:443
 export NGROK_HOST_HEADER=my-app-name.test
 ```
 
+## Pitfalls & solutions
+
+### ngrok tunnel not always stopping when puma-dev stops
+
+If you see an error saying `http: proxy error: dial unix`, it means ngrok was able to stop when puma was stopped. Right now the solution is to run:
+
+    $ pkill ngrok
+
+in your terminal.
+
+### Rails 6 "Blocked host" error
+
+If you seeing an error like:
+
+```
+Blocked host: a620ba29.ngrok.io
+To allow requests to a620ba29.ngrok.io, add the following to your environment configuration:
+config.hosts << "a620ba29.ngrok.io"
+```
+
+Open your `config/environments/development.rb` file add add:
+
+```ruby
+# Whitelist ngrok connections to development enviroment.
+config.hosts << /[a-z0-9]+\.ngrok\.io/
+# Whitelist Puma-Dev hostname.
+config.hosts << 'samplerailsapp.test'
+config.hosts << /[a-z0-9]+\.samplerailsapp.test/
+```
+
+This will whitelist the ngrok subdomain to access your rails host.
 
 ## License
 

data/lib/puma-ngrok-tunnel/version.rb

@@ -1,3 +1,3 @@
 module PumaNgrokTunnel
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/puma/plugin/ngrok_tunnel.rb

@@ -1,11 +1,20 @@
-require 'ngrok/tunnel'
 
 Puma::Plugin.create do
-  def start(_dsl)
-    in_background do
-      puts '[puma-ngrok-tunnel] Starting'
-      puts '[puma-ngrok-tunnel] Tunneling at: ' + Ngrok::Tunnel.start(options)
+  def start(launcher)
+    puts '[puma-ngrok-tunnel] Starting'
+
+    require 'ngrok/tunnel'
+
+    launcher.events.register(:state) do |state|
+      if %i[halt restart stop].include?(state)
+        if Ngrok::Tunnel.running?
+          puts '[puma-ngrok-tunnel] Stopping'
+          Ngrok::Tunnel.stop
+        end
+      end
     end
+
+    puts '[puma-ngrok-tunnel] Tunneling at: ' + Ngrok::Tunnel.start(options)
   end
 
   def options
@@ -20,8 +29,3 @@ Puma::Plugin.create do
     }.reject { |_, value| value.nil? }
   end
 end
-
-at_exit do
-  puts '[puma-ngrok-tunnel] Stopping'
-  Ngrok::Tunnel.stop
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-ngrok-tunnel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-04 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ngrok-tunnel
@@ -81,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md