puma-ngrok-tunnel 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.dockerignore +58 -0
- data/.env +3 -0
- data/.github/workflows/changelog.yml +38 -0
- data/.github/workflows/gempush.yml +2 -3
- data/.github/workflows/linters.yml +58 -0
- data/.github/workflows/rspec.yml +40 -0
- data/.rubocop.yml +10 -3
- data/.ruby-version +1 -1
- data/.travis.yml +1 -1
- data/Aptfile +0 -0
- data/CHANGELOG.md +51 -23
- data/Dockerfile +45 -0
- data/Gemfile +2 -0
- data/README.md +6 -6
- data/docker-compose.yml +20 -0
- data/lib/puma-ngrok-tunnel/version.rb +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9441eab1703e011567c51b87e31928c49b4148852efcd072567bccec0ab1b531
|
|
4
|
+
data.tar.gz: abb76df3833f5a05fed45bb942c08c35794030bbaaea9acc61b4f4b56cfd2829
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e825ac406b5d1fbc7f4a5380844630de08dedc39ff5cc9291d6e873a826ec9e39e81c691b6a1dba704423bb6a77a69b5669150a7da195cbf0dad4d079019b046
|
|
7
|
+
data.tar.gz: 2ad9c8421435c66dd5140edf45818e4a9b8a0d3df6aa1fb341510fa4498032b6c66db7b1d72c0630031b36b84aa7279bceaabb72e2ae9bfbe5b9af5c986f2944
|
data/.dockerignore
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
.git
|
|
2
|
+
.gitignore
|
|
3
|
+
README.md
|
|
4
|
+
|
|
5
|
+
#
|
|
6
|
+
# OS X
|
|
7
|
+
#
|
|
8
|
+
.DS_Store
|
|
9
|
+
.AppleDouble
|
|
10
|
+
.LSOverride
|
|
11
|
+
# Icon must end with two \r
|
|
12
|
+
Icon
|
|
13
|
+
# Thumbnails
|
|
14
|
+
._*
|
|
15
|
+
# Files that might appear on external disk
|
|
16
|
+
.Spotlight-V100
|
|
17
|
+
.Trashes
|
|
18
|
+
# Directories potentially created on remote AFP share
|
|
19
|
+
.AppleDB
|
|
20
|
+
.AppleDesktop
|
|
21
|
+
Network Trash Folder
|
|
22
|
+
Temporary Items
|
|
23
|
+
.apdisk
|
|
24
|
+
|
|
25
|
+
#
|
|
26
|
+
# Rails
|
|
27
|
+
#
|
|
28
|
+
.env.sample
|
|
29
|
+
*.rbc
|
|
30
|
+
capybara-*.html
|
|
31
|
+
log
|
|
32
|
+
tmp
|
|
33
|
+
db/*.sqlite3
|
|
34
|
+
db/*.sqlite3-journal
|
|
35
|
+
public/system
|
|
36
|
+
public/assets
|
|
37
|
+
public/packs
|
|
38
|
+
public/packs-test
|
|
39
|
+
node_modules
|
|
40
|
+
yarn-error.log
|
|
41
|
+
yarn-debug.log*
|
|
42
|
+
.yarn-integrity
|
|
43
|
+
external_dns.log
|
|
44
|
+
|
|
45
|
+
coverage/
|
|
46
|
+
spec/tmp
|
|
47
|
+
**.orig
|
|
48
|
+
|
|
49
|
+
.bundle
|
|
50
|
+
|
|
51
|
+
.ruby-gemset
|
|
52
|
+
|
|
53
|
+
.rvmrc
|
|
54
|
+
|
|
55
|
+
# if using bower-rails ignore default bower_components path bower.json files
|
|
56
|
+
vendor/assets/bower_components
|
|
57
|
+
*.bowerrc
|
|
58
|
+
bower.json
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Changelog
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- master
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
timeout-minutes: 4
|
|
12
|
+
if: "!contains(github.event.head_commit.message, '[nodoc]')"
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@master
|
|
15
|
+
- name: Set up Ruby 2.6
|
|
16
|
+
uses: actions/setup-ruby@v1
|
|
17
|
+
with:
|
|
18
|
+
ruby-version: 2.6.x
|
|
19
|
+
- uses: actions/cache@v1.1.2
|
|
20
|
+
with:
|
|
21
|
+
path: vendor/bundle
|
|
22
|
+
key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
|
|
23
|
+
restore-keys: |
|
|
24
|
+
${{ runner.os }}-gem-
|
|
25
|
+
- name: Create local changes
|
|
26
|
+
run: |
|
|
27
|
+
gem install github_changelog_generator
|
|
28
|
+
github_changelog_generator -u MikeRogers0 -p puma-ngrok-tunnel --token ${{ secrets.GITHUB_TOKEN }} --exclude-labels duplicate,question,invalid,wontfix,nodoc
|
|
29
|
+
- name: Commit files
|
|
30
|
+
run: |
|
|
31
|
+
git config --local user.email "github-actions@example.com"
|
|
32
|
+
git config --local user.name "GitHub Actions"
|
|
33
|
+
git commit -m "[nodoc] update changelog" -a
|
|
34
|
+
- name: Push changes
|
|
35
|
+
uses: ad-m/github-push-action@master
|
|
36
|
+
with:
|
|
37
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
38
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Linters
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
pull_request:
|
|
6
|
+
branches: [ master ]
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
dotenv:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
steps:
|
|
12
|
+
- uses: actions/checkout@v1
|
|
13
|
+
- name: dotenv-linter
|
|
14
|
+
uses: wemake-services/dotenv-linter@0.1.5
|
|
15
|
+
with:
|
|
16
|
+
reporter: 'github-pr-review'
|
|
17
|
+
options: '.env'
|
|
18
|
+
env:
|
|
19
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
20
|
+
rubocop:
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
steps:
|
|
23
|
+
- uses: actions/checkout@v1
|
|
24
|
+
- name: Rubocop Linter Action
|
|
25
|
+
uses: andrewmcodes/rubocop-linter-action@v3.1.0
|
|
26
|
+
env:
|
|
27
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
28
|
+
languagetool:
|
|
29
|
+
runs-on: ubuntu-latest
|
|
30
|
+
steps:
|
|
31
|
+
- uses: actions/checkout@v2
|
|
32
|
+
- uses: reviewdog/action-languagetool@v1
|
|
33
|
+
with:
|
|
34
|
+
github_token: ${{ secrets.github_token }}
|
|
35
|
+
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
|
|
36
|
+
reporter: github-pr-review
|
|
37
|
+
# Change reporter level if you need.
|
|
38
|
+
level: info
|
|
39
|
+
hadolint:
|
|
40
|
+
runs-on: ubuntu-latest
|
|
41
|
+
steps:
|
|
42
|
+
- name: Check out code
|
|
43
|
+
uses: actions/checkout@v1
|
|
44
|
+
- name: hadolint
|
|
45
|
+
uses: reviewdog/action-hadolint@v1
|
|
46
|
+
with:
|
|
47
|
+
github_token: ${{ secrets.github_token }}
|
|
48
|
+
reporter: github-pr-review
|
|
49
|
+
fasterer:
|
|
50
|
+
runs-on: ubuntu-latest
|
|
51
|
+
steps:
|
|
52
|
+
- name: Check out code
|
|
53
|
+
uses: actions/checkout@v1
|
|
54
|
+
- name: fasterer
|
|
55
|
+
uses: vk26/action-fasterer@v1
|
|
56
|
+
with:
|
|
57
|
+
github_token: ${{ secrets.github_token }}
|
|
58
|
+
reporter: github-pr-review
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: RSpec
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches: [ master ]
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [ master ]
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v1
|
|
16
|
+
|
|
17
|
+
- name: Set up Ruby 2.6
|
|
18
|
+
uses: ruby/setup-ruby@v1
|
|
19
|
+
with:
|
|
20
|
+
ruby-version: 2.6.6
|
|
21
|
+
|
|
22
|
+
- uses: actions/cache@v1
|
|
23
|
+
with:
|
|
24
|
+
path: vendor/bundle
|
|
25
|
+
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
|
|
26
|
+
restore-keys: |
|
|
27
|
+
${{ runner.os }}-gems-
|
|
28
|
+
|
|
29
|
+
- name: Build
|
|
30
|
+
env:
|
|
31
|
+
RAILS_ENV: test
|
|
32
|
+
run: |
|
|
33
|
+
gem install bundler
|
|
34
|
+
bundle config path vendor/bundle
|
|
35
|
+
bundle install --jobs 4 --retry 3
|
|
36
|
+
- name: Run tests
|
|
37
|
+
env:
|
|
38
|
+
RAILS_ENV: test
|
|
39
|
+
run: |
|
|
40
|
+
bundle exec rake test
|
data/.rubocop.yml
CHANGED
|
@@ -1,10 +1,17 @@
|
|
|
1
|
+
---
|
|
1
2
|
AllCops:
|
|
2
3
|
Exclude:
|
|
4
|
+
- db/schema.rb
|
|
5
|
+
- 'node_modules/**/*'
|
|
6
|
+
- 'vendor/**/*'
|
|
3
7
|
- '.git/**/*'
|
|
4
8
|
- 'bin/*'
|
|
5
9
|
|
|
6
|
-
Style/
|
|
7
|
-
EnforcedStyle:
|
|
10
|
+
Style/FrozenStringLiteralComment:
|
|
11
|
+
EnforcedStyle: never
|
|
8
12
|
|
|
9
|
-
|
|
13
|
+
Layout/LineLength:
|
|
10
14
|
Max: 120
|
|
15
|
+
|
|
16
|
+
Style/ClassAndModuleChildren:
|
|
17
|
+
EnforcedStyle: compact
|
data/.ruby-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
2.6.
|
|
1
|
+
2.6.6
|
data/.travis.yml
CHANGED
data/Aptfile
ADDED
|
File without changes
|
data/CHANGELOG.md
CHANGED
|
@@ -1,40 +1,68 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## [Unreleased](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/HEAD)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/v1.0.0...HEAD)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**Merged pull requests:**
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
- Tidying up english a little [\#20](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/20) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
10
|
+
- Adding a few quality control linters in [\#19](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/19) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
11
|
+
- Adding docker setup [\#18](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/18) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
12
|
+
- Adding autogenerating changelog [\#17](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/17) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
10
13
|
|
|
11
|
-
## 0.
|
|
14
|
+
## [v1.0.0](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/v1.0.0) (2020-03-19)
|
|
12
15
|
|
|
13
|
-
|
|
14
|
-
* [Adding ngrok error exception handler](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/9)
|
|
15
|
-
* [Adding boilerplate gem files](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/10)
|
|
16
|
-
* [Updating CI to test against latest patch versions of Ruby](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/11)
|
|
16
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/v0.1.5...v1.0.0)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
**Merged pull requests:**
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
- Preparing for 1.0.0 [\#16](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/16) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
21
|
+
- Adding GitHub actions & Sponsor stuff in [\#15](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/15) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
22
|
+
- Indenting lists with two spaces [\#14](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/14) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
23
|
+
- Handling offline exception when connecting to Ngrok [\#13](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/13) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
24
|
+
- Adjusting formatting to not indent lists [\#12](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/12) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
21
25
|
|
|
22
|
-
##
|
|
26
|
+
## [v0.1.5](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/v0.1.5) (2019-10-02)
|
|
23
27
|
|
|
24
|
-
|
|
25
|
-
* [Update simplecov requirement from ~> 0.16.1 to ~> 0.17.0](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/4)
|
|
28
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/v0.1.3...v0.1.5)
|
|
26
29
|
|
|
27
|
-
|
|
30
|
+
**Merged pull requests:**
|
|
28
31
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
+
- Updating CI to test against latest patch versions of Ruby [\#11](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/11) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
33
|
+
- Adding boilerplate gem files [\#10](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/10) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
34
|
+
- Adding ngrok error exception handler [\#9](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/9) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
35
|
+
- Update rake requirement from ~\> 12.3 to ~\> 13.0 [\#8](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/8) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
|
|
36
|
+
- Adding more ruby versions into travis CI [\#7](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/7) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
32
37
|
|
|
33
|
-
##
|
|
38
|
+
## [v0.1.3](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/v0.1.3) (2019-07-04)
|
|
34
39
|
|
|
35
|
-
|
|
36
|
-
* Adding more examples to docs.
|
|
40
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/0.1.2...v0.1.3)
|
|
37
41
|
|
|
38
|
-
|
|
42
|
+
**Merged pull requests:**
|
|
39
43
|
|
|
40
|
-
|
|
44
|
+
- Sorting code fences, dollar sign bash code samples & quotes [\#6](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/6) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
45
|
+
- Updating changelog & fixing inconsistent code samples [\#5](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/5) ([MikeRogers0](https://github.com/MikeRogers0))
|
|
46
|
+
- Update simplecov requirement from ~\> 0.16.1 to ~\> 0.17.0 [\#4](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/4) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
|
|
47
|
+
- Update puma requirement from ~\> 3.0 to \>= 3, \< 5 [\#3](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/3) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
|
|
48
|
+
|
|
49
|
+
## [0.1.2](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/0.1.2) (2019-06-11)
|
|
50
|
+
|
|
51
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/0.1.1...0.1.2)
|
|
52
|
+
|
|
53
|
+
**Merged pull requests:**
|
|
54
|
+
|
|
55
|
+
- Update rake requirement from ~\> 10.0 to ~\> 12.3 [\#2](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/2) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
|
|
56
|
+
- Update ngrok installation instructions [\#1](https://github.com/MikeRogers0/puma-ngrok-tunnel/pull/1) ([andrewmcodes](https://github.com/andrewmcodes))
|
|
57
|
+
|
|
58
|
+
## [0.1.1](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/0.1.1) (2019-05-05)
|
|
59
|
+
|
|
60
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/0.1.0...0.1.1)
|
|
61
|
+
|
|
62
|
+
## [0.1.0](https://github.com/MikeRogers0/puma-ngrok-tunnel/tree/0.1.0) (2019-05-04)
|
|
63
|
+
|
|
64
|
+
[Full Changelog](https://github.com/MikeRogers0/puma-ngrok-tunnel/compare/6973163ea4462763b1becfa47c497265629b1190...0.1.0)
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
data/Dockerfile
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
FROM ruby:2.6.6-alpine AS development
|
|
2
|
+
|
|
3
|
+
LABEL maintainer="Mike Rogers <me@mikerogers.io>"
|
|
4
|
+
|
|
5
|
+
# Install the Essentials
|
|
6
|
+
ENV BUILD_DEPS="curl tar wget linux-headers bash" \
|
|
7
|
+
DEV_DEPS="ruby-dev build-base postgresql-dev zlib-dev libxml2-dev libxslt-dev readline-dev tzdata git nodejs vim sqlite-dev"
|
|
8
|
+
|
|
9
|
+
RUN apk add --update --upgrade $BUILD_DEPS $DEV_DEPS
|
|
10
|
+
|
|
11
|
+
# Add the current apps files into docker image
|
|
12
|
+
RUN mkdir -p /usr/src/app
|
|
13
|
+
WORKDIR /usr/src/app
|
|
14
|
+
|
|
15
|
+
# Install any extra dependencies via Aptfile
|
|
16
|
+
COPY Aptfile /usr/src/app/Aptfile
|
|
17
|
+
RUN apk add --update $(cat /usr/src/app/Aptfile | xargs)
|
|
18
|
+
|
|
19
|
+
# Set up environment
|
|
20
|
+
ENV PATH /usr/src/app/bin:$PATH
|
|
21
|
+
|
|
22
|
+
# Add some helpers to reduce typing when inside the containers
|
|
23
|
+
RUN echo 'alias bx="bundle exec"' >> ~/.bashrc
|
|
24
|
+
|
|
25
|
+
# Set ruby version
|
|
26
|
+
COPY .ruby-version /usr/src/app
|
|
27
|
+
|
|
28
|
+
# Install latest bundler
|
|
29
|
+
RUN gem update --system && gem install bundler:2.0.2
|
|
30
|
+
RUN bundle config --global silence_root_warning 1 && echo -e 'gem: --no-document' >> /etc/gemrc
|
|
31
|
+
|
|
32
|
+
RUN mkdir -p /usr/src/bundler
|
|
33
|
+
RUN bundle config path /usr/src/bundler
|
|
34
|
+
|
|
35
|
+
CMD ["bundle", "exec", "rake", "spec"]
|
|
36
|
+
|
|
37
|
+
FROM development AS production
|
|
38
|
+
|
|
39
|
+
# Install Ruby Gems
|
|
40
|
+
COPY Gemfile /usr/src/app
|
|
41
|
+
COPY Gemfile.lock /usr/src/app
|
|
42
|
+
RUN bundle check || bundle install --jobs=$(nproc)
|
|
43
|
+
|
|
44
|
+
# Copy the rest of the app
|
|
45
|
+
COPY . /usr/src/app
|
data/Gemfile
CHANGED
data/README.md
CHANGED
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
|
|
10
|
-
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
|
|
10
|
+
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 easier:
|
|
11
11
|
|
|
12
12
|
* Working with apps that require Webhooks to be received by the app to work correctly
|
|
13
|
-
* Demoing your local rails app to someone else
|
|
14
|
-
* Working with [Puma-dev](https://github.com/puma/puma-dev/) so your apps feels as production-like as possible
|
|
13
|
+
* Demoing your local rails app to someone else
|
|
14
|
+
* Working with [Puma-dev](https://github.com/puma/puma-dev/) so your apps feels as production-like as possible
|
|
15
15
|
* Testing on mobile.
|
|
16
16
|
|
|
17
|
-
I've setup a [sample Rails 6 app](https://github.com/MikeRogers0/puma-ngrok-tunnel-SampleRails6App)
|
|
17
|
+
I've setup a [sample Rails 6 app](https://github.com/MikeRogers0/puma-ngrok-tunnel-SampleRails6App) which demos an implementation of this gem.
|
|
18
18
|
|
|
19
19
|
## Installation
|
|
20
20
|
|
|
@@ -57,7 +57,7 @@ There are a few variables this plugin reads from the environment which control i
|
|
|
57
57
|
* `NGROK_HOST_HEADER` - Optional, if you're using Puma-dev you should set this to your virtual host e.g. `my-app-name.test`.
|
|
58
58
|
* `NGROK_CONFIG` - Optional, your ngrok configuration file location, defaults to `~/.ngrok2/ngrok.yml`.
|
|
59
59
|
* `NGROK_SUBDOMAIN` - Optional, ngrok will assign you a random subdomain unless this is set.
|
|
60
|
-
* `NGROK_REGION` - Optional, the region of your ngrok tunnel.
|
|
60
|
+
* `NGROK_REGION` - Optional, the region of your ngrok tunnel. The default is `us`.
|
|
61
61
|
* `NGROK_HOSTNAME` - Optional, full ngrok hostname, shouldn't be set if `NGROK_SUBDOMAIN` is set.
|
|
62
62
|
|
|
63
63
|
### Sample .env for use with `rails s`
|
|
@@ -87,7 +87,7 @@ export NGROK_HOST_HEADER=my-app-name.test
|
|
|
87
87
|
|
|
88
88
|
## Pitfalls & solutions
|
|
89
89
|
|
|
90
|
-
### ngrok tunnel not always stopping when puma-dev stops
|
|
90
|
+
### The ngrok tunnel not always stopping when puma-dev stops
|
|
91
91
|
|
|
92
92
|
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:
|
|
93
93
|
|
data/docker-compose.yml
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
# Docker Compose 2.4 is for local development
|
|
3
|
+
# https://www.heroku.com/podcasts/codeish/57-discussing-docker-containers-and-kubernetes-with-a-docker-captain - Source on that.
|
|
4
|
+
version: '2.4'
|
|
5
|
+
|
|
6
|
+
services:
|
|
7
|
+
web:
|
|
8
|
+
image: puma-ngrok-tunnel:latest
|
|
9
|
+
build:
|
|
10
|
+
context: .
|
|
11
|
+
dockerfile: Dockerfile
|
|
12
|
+
target: development
|
|
13
|
+
env_file:
|
|
14
|
+
- .env
|
|
15
|
+
command: >
|
|
16
|
+
bash -c "bundle check || bundle install &&
|
|
17
|
+
bundle exec rake spec"
|
|
18
|
+
volumes:
|
|
19
|
+
- .:/usr/src/app
|
|
20
|
+
- ~/.docker-data/ruby/2.6.6/bundler:/usr/src/bundler:delegated
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: puma-ngrok-tunnel
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Mike Rogers
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-
|
|
11
|
+
date: 2020-05-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: ngrok-tunnel
|
|
@@ -127,20 +127,28 @@ executables: []
|
|
|
127
127
|
extensions: []
|
|
128
128
|
extra_rdoc_files: []
|
|
129
129
|
files:
|
|
130
|
+
- ".dockerignore"
|
|
131
|
+
- ".env"
|
|
130
132
|
- ".github/FUNDING.yml"
|
|
133
|
+
- ".github/workflows/changelog.yml"
|
|
131
134
|
- ".github/workflows/gempush.yml"
|
|
135
|
+
- ".github/workflows/linters.yml"
|
|
136
|
+
- ".github/workflows/rspec.yml"
|
|
132
137
|
- ".gitignore"
|
|
133
138
|
- ".rubocop.yml"
|
|
134
139
|
- ".ruby-version"
|
|
135
140
|
- ".travis.yml"
|
|
141
|
+
- Aptfile
|
|
136
142
|
- CHANGELOG.md
|
|
137
143
|
- CODE_OF_CONDUCT.md
|
|
144
|
+
- Dockerfile
|
|
138
145
|
- Gemfile
|
|
139
146
|
- LICENSE
|
|
140
147
|
- README.md
|
|
141
148
|
- Rakefile
|
|
142
149
|
- bin/console
|
|
143
150
|
- bin/setup
|
|
151
|
+
- docker-compose.yml
|
|
144
152
|
- lib/puma-ngrok-tunnel/version.rb
|
|
145
153
|
- lib/puma/plugin/ngrok_tunnel.rb
|
|
146
154
|
- puma-ngrok-tunnel.gemspec
|