puma-ngrok-tunnel 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d029d8c4cf8dc072229ec171cc0efb786336832b35244c077706aab670297f5b
-  data.tar.gz: 2be2b3c9fb277c079d0f74183805703505fff780fc60b27fba90d0ac189f8f1c
+  metadata.gz: 65b1ce3120be08b61f95a94b6ffc3487022f20cdb2627f3a926d088c1623e99b
+  data.tar.gz: e23605a56aff5a764b6121b4c65f679ed874e3de223dc02488b8e44dcab525bb
 SHA512:
-  metadata.gz: ac0f89bbd524854feae311cac699a33d74e6e2459c88b9886afc786c069b0fe58efe322f86480efba2082bf5e6e0d6263ae6c04a6c1bf4372535d29b67f57d98
-  data.tar.gz: dad8c33285f788cf5d7745c25bce721b62665efadb704b1fb9bfa4d03064870776df087cb7ce23c94cc3d76c69a0e08d17ee208b6d6f9feaef62aa657bdab4dd
+  metadata.gz: f5440af3101fd81aec45f3690ebf57e3a49f7d0bffa09877cdcc3c8cb37fc1fddf288ea19ad3b08a14690306f68c5bc4331b7c7d20bbcd982b02251700e0812c
+  data.tar.gz: 480f373d71ff8e79687fbdecac7f7ea95b6149d13822a922f89baae0ed072c34ced8738c98e4e7f8daa9ef13c665fef8952ac2c0e997a415db95752f4bffc83d

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - '.git/**/*'
+    - 'bin/*'
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -1,4 +1,7 @@
+---
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.6.2
+  - 2.6.3
 before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
+## 0.1.2
+
+  * Setting minimum ruby version to be 2.3
+  * Tided up the code with Robocop
+  * Added various to the repo.
+
 ## 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.
+  * Improving mechanism for the tunnel being closed when rails is restarted, namely when `touch tmp/restart.txt` is used. This is based on [puma-metrics](https://github.com/harmjanblok/puma-metrics/blob/master/lib/puma/plugin/metrics.rb)
+  * Adding more examples to docs.
 
 ## 0.1.0
 
-* Initial Release
+  * Initial Release

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in puma-heroku.gemspec

data/README.md

@@ -1,15 +1,18 @@
-# puma-ngrok-tunnel
-
 [![Gem Version](https://badge.fury.io/rb/puma-ngrok-tunnel.svg)](https://badge.fury.io/rb/puma-ngrok-tunnel)
+[![Build Status](https://travis-ci.org/MikeRogers0/puma-ngrok-tunnel.svg?branch=master)](https://travis-ci.org/MikeRogers0/puma-ngrok-tunnel)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/90680257c9dd4613a36ec3ac890e3559)](https://www.codacy.com/app/MikeRogers0/puma-ngrok-tunnel?utm_source=github.com&utm_medium=referral&utm_content=MikeRogers0/puma-ngrok-tunnel&utm_campaign=Badge_Grade)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c5710efd4dc1f90c7487/maintainability)](https://codeclimate.com/github/MikeRogers0/puma-ngrok-tunnel/maintainability)
+
+# 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.
+  * 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.
 
@@ -17,7 +20,8 @@ I've setup a [sample Rails 6 app](https://github.com/MikeRogers0/puma-ngrok-tunn
 
 Make sure you have installed ngrok on your machine:
 
-    $ brew install ngrok
+    $ brew tap caskroom/cask
+    $ brew cask install ngrok 
 
 Add this line to your application's Gemfile:
 
@@ -33,29 +37,28 @@ And then execute:
 
 Lastly in your `config/puma.rb` file, append the line:
 
-
 ```ruby
 plugin :ngrok_tunnel if ENV.fetch('RAILS_ENV') { 'development' } == 'development'
 ```
 
 ## Usage
 
-Read about how to configure puma to use this plugin here: https://github.com/puma/puma#plugins
+Read about how to configure puma to use this in [the Puma documentation](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` - 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.
+  * `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`
 
-```
+```bash
 # puma-ngrok-tunnel setup
 # You need https://github.com/bkeepers/dotenv setup to make sure Puma can use these.
 export NGROK_TUNNEL_ENABLED=true
@@ -65,7 +68,7 @@ export NGROK_REGION=eu
 
 ### Sample .env for use with Puma-dev
 
-```
+```bash
 # Puma-dev: You need to define this otherwise it uses it's own puma.rb file.
 CONFIG=config/puma.rb
 
@@ -92,7 +95,7 @@ in your terminal.
 
 If you seeing an error like:
 
-```
+```ruby
 Blocked host: a620ba29.ngrok.io
 To allow requests to a620ba29.ngrok.io, add the following to your environment configuration:
 config.hosts << "a620ba29.ngrok.io"
@@ -113,4 +116,3 @@ This will whitelist the ngrok subdomain to access your rails host.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PumaNgrokTunnel
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/puma/plugin/ngrok_tunnel.rb

@@ -1,22 +1,30 @@
+# frozen_string_literal: true
+require 'ngrok/tunnel'
 
 Puma::Plugin.create do
   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
+      ngrok_stop! if %i[halt restart stop].include?(state)
     end
 
+    ngrok_start!
+  end
+
+  private
+
+  def ngrok_start!
     puts '[puma-ngrok-tunnel] Tunneling at: ' + Ngrok::Tunnel.start(options)
   end
 
+  def ngrok_stop!
+    return unless Ngrok::Tunnel.running?
+
+    puts '[puma-ngrok-tunnel] Stopping'
+    Ngrok::Tunnel.stop
+  end
+
   def options
     @options ||= {
       addr: ENV.fetch('NGROK_ADDR') { nil } || ENV.fetch('PORT') { 3000 },

data/puma-ngrok-tunnel.gemspec

@@ -1,7 +1,8 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "puma-ngrok-tunnel/version"
+# frozen_string_literal: true
 
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma-ngrok-tunnel/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'puma-ngrok-tunnel'
@@ -17,22 +18,25 @@ Gem::Specification.new do |spec|
   # 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'
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
 
   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'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma-ngrok-tunnel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-05 00:00:00.000000000 Z
+date: 2019-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ngrok-tunnel
@@ -50,28 +50,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 description: A Puma plugin that opens a ngrok tunnel after the rails server starts
 email:
 - me@mikerogers.io
@@ -80,6 +108,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -102,15 +131,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Puma integration for starting a Ngrok Tunnel