ngrok-wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 270d9efa417c5821721519760816d3febbf085d183680ad0268a244eaec4a753
+  data.tar.gz: dd477aa0effed04807720dd6e22a3f607b79f88b343318c7d1674c18e573b056
+SHA512:
+  metadata.gz: e8d752ee9ee727a5e54705e1c7d361b6babd13415a68173325df4cf4a2c7158fa37cc60920b8023e9b57b45c1ce1450325bcc17949885045ff1f1d3b9bebcb7a
+  data.tar.gz: 7f3e3c5404e138e6f4a01ed06c77d13f746bc977057b91494a26f98f80fa59fa2c55b992cf6bf015142e6bc38ff4fc1fcd73e5537e77018801a8b945e9b33623

data/.codeclimate.yml

@@ -0,0 +1,39 @@
+version: "2"
+exclude_patterns:
+  - "sig/**/*"
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 300
+  method-complexity:
+    config:
+      threshold: 9
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+plugins:
+  rubocop:
+    enabled: true
+    channel: 'beta'
+  fixme:
+    enabled: true
+    config:
+      strings:
+        - FIXME
+        - BUG
+        - CUSTOM

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 2.6
+
+          - ruby: 2.7
+
+          - ruby: 3.0
+
+          - ruby: 3.1
+
+    name: ruby ${{ matrix.ruby }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: false
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Code Climate
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: d1116c05a48e27785cb11369bde3a5e7f9d9e5a114d294bcbefa19cd193b029c

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '22 0 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+test.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,72 @@
+# This is the default configuration file. Enabling and disabling is configured
+# in separate files. This file adds all other parameters apart from Enabled.
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_from:
+  - enabled.yml
+  - disabled.yml
+
+AllCops:
+  # Default formatter will be used if no -f/--format option is given.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Change
+  # behavior by overriding DisplayStyleGuide, or by giving the
+  # -S/--display-style-guide option.
+  DisplayStyleGuide: true
+  # Extra details are not displayed in offense messages by default. Change
+  # behavior by overriding ExtraDetails, or by giving the
+  # -E/--extra-details option.
+  ExtraDetails: true
+  NewCops: enable
+  # Additional cops that do not reference a style guide rule may be enabled by
+  # default. Change behavior by overriding StyleGuideCopsOnly, or by giving
+  # the --only-guide-cops option.
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 30
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 25
+
+Metrics/PerceivedComplexity:
+  Max: 11
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 100
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'db/**/*.rb'
+
+RSpec/MultipleExpectations:
+  Max: 13
+
+RSpec/NestedGroups:
+  Max: 7
+
+Style/StringLiterals:
+  ConsistentQuotesInMultiline: true

data/.ruby-version

@@ -0,0 +1 @@
+2.6.9

data/.simplecov

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  require 'simplecov_json_formatter'
+
+  formatter SimpleCov::Formatter::JSONFormatter
+  enable_coverage :branch
+  primary_coverage :branch
+  add_filter '/spec/'
+end

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.9

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [v0.1.0](https://github.com/texpert/ngrok-wrapper/tree/v0.1.0) (2022-01-09)
+
+[Full Changelog](https://github.com/texpert/ngrok-wrapper/compare/3e032fa019c91ee7338a7ad3a3335e6c5597b394...v0.1.0)
+
+**Merged pull requests:**
+
+- Added `github_changelog_generator` to the gemspec [\#14](https://github.com/texpert/ngrok-wrapper/pull/14) ([texpert](https://github.com/texpert))
+- Described gem's usage in Rails, move the description from `examples` folder into README.md [\#13](https://github.com/texpert/ngrok-wrapper/pull/13) ([texpert](https://github.com/texpert))
+- Fix Codeclimate rubocop channel to beta to enable latest 1-24-1 [\#11](https://github.com/texpert/ngrok-wrapper/pull/11) ([texpert](https://github.com/texpert))
+- Add codeclimate fixme and rubocop plugins [\#10](https://github.com/texpert/ngrok-wrapper/pull/10) ([texpert](https://github.com/texpert))
+- Decompose `fetch_urls` for maintainability [\#9](https://github.com/texpert/ngrok-wrapper/pull/9) ([texpert](https://github.com/texpert))
+- Refactor `ngrok_running?` to re-use `ngrok_process_status_lines` instead of a shell process [\#8](https://github.com/texpert/ngrok-wrapper/pull/8) ([texpert](https://github.com/texpert))
+- Raise if Ngrok with the pid from persistence file is running on other port [\#7](https://github.com/texpert/ngrok-wrapper/pull/7) ([texpert](https://github.com/texpert))
+- Refactor DRYing `ngrok_exec_params` method [\#6](https://github.com/texpert/ngrok-wrapper/pull/6) ([texpert](https://github.com/texpert))
+- Remove redundant methods and introduce `:params` read accessor [\#5](https://github.com/texpert/ngrok-wrapper/pull/5) ([texpert](https://github.com/texpert))
+- Don't forget to close the log file and don't use returns in a block [\#4](https://github.com/texpert/ngrok-wrapper/pull/4) ([texpert](https://github.com/texpert))
+- Fix CI setup-ruby action to use Ruby version from strategy matrix [\#3](https://github.com/texpert/ngrok-wrapper/pull/3) ([texpert](https://github.com/texpert))
+- Fix CodeClimate issue Class Wrapper has 22 methods \(exceeds 20 allowed\) [\#2](https://github.com/texpert/ngrok-wrapper/pull/2) ([texpert](https://github.com/texpert))
+- Fix the specs to avoid trying to run real Ngrok when testing using fixture log files [\#1](https://github.com/texpert/ngrok-wrapper/pull/1) ([texpert](https://github.com/texpert))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ngrok-wrapper.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Portions Copyright (c) 2022 Aureliu Brinzeanu
+Portions Copyright (c) 2014-2019 Anton Bogdanovich
+
+MIT License
+
+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,258 @@
+# Ngrok::Wrapper
+
+Ngrok-wrapper gem is a ruby wrapper for ngrok v2.
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/d978e217a8219326e325/maintainability)](https://codeclimate.com/github/texpert/ngrok-wrapper/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d978e217a8219326e325/test_coverage)](https://codeclimate.com/github/texpert/ngrok-wrapper/test_coverage)
+
+## History
+
+Ngrok-wrapper is renamed from my fork of the initial awesome [Ngrok-tunnel](https://github.com/bogdanovich/ngrok-tunnel) gem by [Anton Bogdanovich](https://github.com/bogdanovich)
+
+I was dealing with debugging work on some webhooks at my current project. Using Ngrok on a free plan, I quickly got tired of Ngrok generating a new endpoint URL every time on restarting the process. 
+
+There was a pull request [Add support for leaving an ngrok process open and reusing an existing ngrok process 
+instead of starting a new one on every process](https://github.com/bogdanovich/ngrok-tunnel/pull/11), but it wasn't 
+quite working. 
+
+So, I have created [a working one](https://github.com/bogdanovich/ngrok-tunnel/pull/20), but neither 
+of these PRs got any reaction from the author.
+
+So, excuse me, [Anton Bogdanovich](https://github.com/bogdanovich), but I've decided to craft another gem, based on your awesome work, thank you!
+
+## Installation
+
+*Note:* You must have ngrok v2+ installed available in your `PATH`.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ngrok-wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ngrok-wrapper
+
+## Usage
+
+```ruby
+require 'ngrok/wrapper'
+
+# spawn ngrok (default port 3001)
+Ngrok::Wrapper.start
+
+# ngrok local_port
+Ngrok::Wrapper.port
+=> 3001
+
+# ngrok external url
+Ngrok::Wrapper.ngrok_url
+=> "http://aaa0e65.ngrok.io"
+
+Ngrok::Wrapper.ngrok_url_https
+=> "https://aaa0e65.ngrok.io"
+
+Ngrok::Wrapper.running?
+=> true
+
+Ngrok::Wrapper.stopped?
+=> false
+
+# ngrok process id
+Ngrok::Wrapper.pid
+=> 27384
+
+# ngrok log file descriptor
+Ngrok::Wrapper.log
+=> #<File:/tmp/ngrok20141022-27376-cmmiq4>
+
+# kill ngrok
+Ngrok::Wrapper.stop
+=> :stopped
+
+```
+
+```ruby
+# ngrok custom parameters
+Ngrok::Wrapper.start(addr: 'foo.dev:80',
+                    subdomain: 'MY_SUBDOMAIN',
+                    hostname: 'MY_HOSTNAME',
+                    authtoken: 'MY_TOKEN',
+                    inspect: false,
+                    log: 'ngrok.log',
+                    config: '~/.ngrok2/ngrok.yml',
+                    persistence: true,
+                    persistence_file: '/Users/user/.ngrok2/ngrok-process.json') # optional parameter
+```
+
+- If `persistence: true` is specified, on the 1st server start, an Ngrok process will get invoked, and the attributes of this Ngrok process, like `pid`, URLs and `port` will be stored in the `persistence_file`. 
+- On server stop, the Ngrok process will not be killed. 
+- On the subsequent server start, Ngrok::Wrapper will read the process attributes from the `persistence_file` and will try to re-use the running Ngrok process, if it hadn't been killed.
+  - The `persistence_file` parameter is optional when invoking `Ngrok::Wrapper.start`, by default the '/Users/user/.ngrok2/ngrok-process.json' will be created and used
+  - The `authtoken` parameter is also optional, as long as the `config` parameter is specified (usually Ngrok config 
+    is the `~/.ngrok2/ngrok.yml` file)
+
+### With Rails
+
+- Use ~/.ngrok2/ngrok.yml as a config file
+- Set NGROK_INSPECT=false if you want to disable the inspector web-server
+- Add this code at the end of `config/application.rb` in a Rails project
+
+```ruby
+NGROK_ENABLED = Rails.env.development? &&
+                  (Rails.const_defined?(:Server) || ($PROGRAM_NAME.include?('puma') && Puma.const_defined?(:Server))) &&
+                  ENV['NGROK_TUNNEL'] == 'true'
+```
+
+- Add the following code at the start of `config/environments/development.rb`
+
+```ruby
+if NGROK_ENABLED
+  require 'ngrok/wrapper'
+
+  options = { addr: 'https://localhost:3000', persistence: true }
+  options[:config] = ENV.fetch('NGROK_CONFIG', "#{ENV['HOME']}/.ngrok2/ngrok.yml")
+  options[:inspect] = ENV['NGROK_INSPECT'] if ENV['NGROK_INSPECT']
+
+  puts "[NGROK] tunneling at #{Ngrok::Wrapper.start(options)}"
+  puts '[NGROK] inspector web interface listening at http://127.0.0.1:4040' if ENV['NGROK_INSPECT'] == 'true'
+
+  NGROK_URL = Ngrok::Wrapper.ngrok_url_https
+end
+```
+
+- If you need SSL (`https`) webhooks, you can use the `localhost` gem and then, in `config/puma.rb`:
+
+```ruby
+if self.class.const_defined?(:NGROK_ENABLED)
+  bind 'ssl://localhost:3000'
+else
+  port ENV.fetch('PORT', 3000)
+end
+```
+
+- And in `config/environments/development.rb`:
+
+```ruby
+config.force_ssl = true if NGROK_ENABLED
+
+config.action_mailer.default_url_options = {
+  host: NGROK_ENABLED ? NGROK_URL.delete_prefix('https://') : 'myapp.local',
+  port: 3000
+}
+```
+
+- To make the sessions bound to the Ngrok domain, in `config/initializers/session_store.rb`:
+
+```ruby
+Rails.application.config.session_store :cookie_store,
+  key: "_#{Rails.env}_my_app_secure_session_3",
+  domain: NGROK_ENABLED ? NGROK_URL.delete_prefix('https://') : :all,
+  tld_length: 2
+```
+
+- To use the webhooks when sending to, for example, Slack API, you can define the redirect URL in controller as follows:
+
+```ruby
+redirect_uri = NGROK_ENABLED ? "#{NGROK_URL}/slack/oauth/#{organization.id}" : slack_oauth_url(organization.id)
+```
+
+### With Rack server
+
+- Use ~/.ngrok2/ngrok.yml as a config file.
+- Set NGROK_INSPECT=false if you want to disable the inspector web-server.
+- Add the following code to the end of a configuration file of your preferred web-server, e.g. config/puma.rb, 
+config/unicorn.rb, or config/thin.rb
+
+```ruby
+require 'ngrok/wrapper'
+
+options = { addr: 'https://localhost:3000', persistence: true }
+options[:config] = ENV.fetch('NGROK_CONFIG', "#{ENV['HOME']}/.ngrok2/ngrok.yml")
+options[:inspect] = ENV['NGROK_INSPECT'] if ENV['NGROK_INSPECT']
+
+puts "[NGROK] tunneling at #{Ngrok::Wrapper.start(options)}"
+puts '[NGROK] inspector web interface listening at http://127.0.0.1:4040' if ENV['NGROK_INSPECT'] == 'true'
+
+NGROK_URL = Ngrok::Wrapper.ngrok_url_https
+```
+
+## Gem Maintenance
+
+### Preparing a release
+
+Merge all the pull requests that should make it into the new release into the `main` branch, then checkout and pull the
+branch and run the `github_changelog_generator`, specifying the new version as a `--future-release` cli parameter:
+
+```
+git checkout main
+git pull
+
+github_changelog_generator -u texpert -p ngrok-wrapper --future-release v0.1.0
+```
+
+Then add the changes to `git`, commit and push the `Preparing the new release` commit directly into the `main` branch:
+
+```
+git add .
+git commit -m 'Preparing the new v0.1.0 release'
+git push
+```
+
+### RubyGems credentials
+
+Ensure you have the RubyGems credentials located in the `~/.gem/credentials` file.
+
+### Adding a gem owner
+
+```
+gem owner ngrok-wrapper -a branzeanu.aurel@gmail.com
+```
+
+### Building a new gem version
+
+Adjust the new gem version number in the `lib/ngrok/wrapper/version.rb` file. It is used when building the gem by the following command:
+
+```
+gem build ngrok-wrapper.gemspec
+```
+
+Assuming the version was set to `0.1.0`,
+a `ngrok-wrapper-0.1.0.gem` binary file will be generated at the root of the app (repo).
+
+- The binary file shouldn't be added into the `git` tree, it will be pushed into the RubyGems and to the GitHub releases
+
+### Pushing a new gem release to RubyGems
+
+```
+gem push ngrok-wrapper-0.1.0.gem # don't forget to specify the correct version number
+```
+
+### Crafting the new release on GitHub
+
+On the [Releases page](https://github.com/texpert/ngrok-wrapper/releases) push the `Draft a new release` button.
+
+The new release editing page opens, on which the following actions could be taken:
+
+- Choose the repo branch (default is `main`)
+- Insert a tag version (usually, the tag should correspond to the gem's new version, v0.1.0, for example)
+  - the tag will be created by GitHub on the last commit into the chosen branch
+- Fill the release Title and Description
+- Attach the binary file with the generated gem version
+- If the release is not yet ready for production, mark the `This is a pre-release` checkbox
+- Press either the `Publish release`, or the `Save draft button` if you want to publish it later
+  - After publishing the release, the the binary gem file will be available on GitHub and could be removed locally
+
+
+## Contributing
+
+1. Fork it ( https://github.com/texpert/ngrok-wrapper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/disabled.yml

@@ -0,0 +1,26 @@
+# These are all the cops that are disabled in the default configuration.
+
+# By default, the rails cops are not run. Override in project or home
+# directory .rubocop.yml files, or by giving the -R/--rails option.
+
+Naming/InclusiveLanguage:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/BeEql:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false