puma-ngrok-tunnel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3227a5d893088f72be76945ce1e5c421026e521fc46e5ff97cde4306a090eef2
+  data.tar.gz: 2326bb0ae39d5b07ce731ee326068c440dc739782a7fbd43a3996ac8429d32a1
+SHA512:
+  metadata.gz: dc740df330bb4896132983e8766888d274c0294873989c1f489e96c63892a5d2258d4dbc8d826b2c4ed4fdec7134a9e58b8da646ad2e043b0be8a948c6768fc1
+  data.tar.gz: d68ee5cf93fb39e49505d34772dd01af5f8cb86e89a868d36f5914eb537f36cf53a95d9b6939104337828243525423eb243d7d3fc5bac560af7927221b63c945

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Evan Phoenix
+
+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,74 @@
+# 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.
+
+
+## Installation
+
+Make sure you have installed ngrok on your machine:
+
+    $ brew install ngrok
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'puma-ngrok-tunnel'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+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
+```
+
+## Usage
+
+Read about how to configure puma to use this plugin here: https://github.com/puma/puma#plugins
+
+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.
+
+### Sample .env
+
+```
+# Puma-dev: You need to define this otherwise it uses it's own puma.rb file.
+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
+export NGROK_ADDR=my-app-name.test:443
+export NGROK_HOST_HEADER=my-app-name.test
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/puma/plugin/ngrok_tunnel.rb

@@ -0,0 +1,27 @@
+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)
+    end
+  end
+
+  def options
+    @options ||= {
+      addr: ENV.fetch('NGROK_ADDR') { nil } || ENV.fetch('PORT') { 3000 },
+      authtoken: ENV.fetch('NGROK_AUTHTOKEN') { nil },
+      host_header: ENV.fetch('NGROK_HOST_HEADER') { nil },
+      config: ENV.fetch('NGROK_CONFIG') { File.join(ENV['HOME'], '.ngrok2', 'ngrok.yml') },
+      subdomain: ENV.fetch('NGROK_SUBDOMAIN') { nil },
+      region: ENV.fetch('NGROK_REGION') { nil },
+      hostname: ENV.fetch('NGROK_HOSTNAME') { nil }
+    }.reject { |_, value| value.nil? }
+  end
+end
+
+at_exit do
+  puts '[puma-ngrok-tunnel] Stopping'
+  Ngrok::Tunnel.stop
+end

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

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

data/puma-ngrok-tunnel.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "puma-ngrok-tunnel/version"
+
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puma-ngrok-tunnel'
+  spec.version       = PumaNgrokTunnel::VERSION
+  spec.authors       = ['Mike Rogers']
+  spec.email         = ['me@mikerogers.io']
+
+  spec.summary       = 'Puma integration for starting a Ngrok Tunnel'
+  spec.description   = 'A Puma plugin that opens a ngrok tunnel after the rails server starts'
+  spec.homepage      = 'https://github.com/mikerogers0/puma-ngrok-tunnel'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ngrok-tunnel', '~> 2.1', '>= 2.1.1'
+  spec.add_runtime_dependency 'puma', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: puma-ngrok-tunnel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ngrok-tunnel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: A Puma plugin that opens a ngrok tunnel after the rails server starts
+email:
+- me@mikerogers.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puma-ngrok-tunnel/version.rb
+- lib/puma/plugin/ngrok_tunnel.rb
+- puma-ngrok-tunnel.gemspec
+homepage: https://github.com/mikerogers0/puma-ngrok-tunnel
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Puma integration for starting a Ngrok Tunnel
+test_files: []