ngrok-api 0.18.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e381b8c6f77364976fd9c107c5cd435b8b72a74f9e01b84a990eba6eb61746f
-  data.tar.gz: 79d3fc87e66c4e04a482f5140cfed3f028fb4b3361955adc8b7ef7d925622070
+  metadata.gz: 5c92cbd041a51750e9d3929bb97e2e1a8c13edb2861bb444ead41b04e969e35d
+  data.tar.gz: 1f15164b9a45c7c99b6583ba9aa7fb38a17df07a788f32b3cdde829144c13972
 SHA512:
-  metadata.gz: d30a021657a83ed0bf7c85b6b193934f41f02b2d86f4cf1cc4fbc85ebb2c607a57493e968eeaacbc48e83de2a202d2f8e9b96069cbc45790ca57a810e6fa3174
-  data.tar.gz: ad67e28b618df654e5019bdb20b0c8c77ff5974a99f58f4bf7c93f317ef7154f88877190c5ea7eea3a6ce9bb2e318fbe4c31a0248c4c8d023348a6a0f6599567
+  metadata.gz: c1ad0751a9ffb00656b77c91d6b380dc71833e644cfad5e6a593e672f1c773231483d6581bb803bb0a5dba568719385a5f33b7af22eecafc9fc82edba2619e7a
+  data.tar.gz: 41af3d9a9bd87f244cb59b60ad77a1d4ea3ac2124b0037bd9991f9b49b6e2058591c4d6727b99ef24c2982726947edf395fa46b7a0eacb8560a19c2b2e433d1b

data/.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: CI
-on: [push]
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -9,13 +13,9 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install bundler
-        run: gem install bundler
-      - name: Run bundler
-        run: bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Run Rake
         run: bundle exec rake

data/.gitignore

@@ -1,13 +1,15 @@
-Gemfile.lock
-.DS_Store
-.yardoc/
-tmp/
-log/
-pkg/
-*.swp
-/.bundle
-.rvmrc
-coverage
-*.gem
-.idea
-.env
+# Code generated for API Clients. DO NOT EDIT.
+
+Gemfile.lock
+.DS_Store
+.yardoc/
+tmp/
+log/
+pkg/
+*.swp
+/.bundle
+.rvmrc
+coverage
+*.gem
+.idea
+.env

data/.rubocop.yml

@@ -1,28 +1,30 @@
-inherit_from:
-  - .rubocop_airbnb.yml
-
-AllCops:
-  TargetRubyVersion: 2.7
-
-Metrics/LineLength:
-  Enabled: false
-
-# Ignore Rails-y Airbnb recommendation
-Airbnb/ClassOrModuleDeclaredInWrongFile:
-  Enabled: false
-
-# Ignore Rails-y Airbnb recommendation
-Airbnb/ConstAssignedInWrongFile:
-  Enabled: false
-
-# Allow empty examples to stub out specs
-RSpec/EmptyExampleGroup:
-  Enabled: false
-
-# Allow fake tests to stub out specs
-RSpec/ExpectActual:
-  Enabled: false
-
-# It just looks nicer
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
+# Code generated for API Clients. DO NOT EDIT.
+
+inherit_from:
+  - .rubocop_airbnb.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/LineLength:
+  Enabled: false
+
+# Ignore Rails-y Airbnb recommendation
+Airbnb/ClassOrModuleDeclaredInWrongFile:
+  Enabled: false
+
+# Ignore Rails-y Airbnb recommendation
+Airbnb/ConstAssignedInWrongFile:
+  Enabled: false
+
+# Allow empty examples to stub out specs
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
+# Allow fake tests to stub out specs
+RSpec/ExpectActual:
+  Enabled: false
+
+# It just looks nicer
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation

data/.rubocop_airbnb.yml

@@ -1,2 +1,4 @@
-require:
-  - rubocop-airbnb
+# Code generated for API Clients. DO NOT EDIT.
+
+require:
+  - rubocop-airbnb

data/.simplecov

@@ -1 +1,3 @@
-SimpleCov.start "test_frameworks"
+# Code generated for API Clients. DO NOT EDIT.
+
+SimpleCov.start "test_frameworks"

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+<!-- Code generated for API Clients. DO NOT EDIT. -->
+
+## 0.15.0
+
+ENHANCEMENTS:
+
+* Added `owner_id` field to the `api_key`, `credential`, and `ssh_credential` resources. If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
+* Added `failover_backend`, `http_response_backend`, and `tunnel_group_backend` resources. A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# ngrok Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+The ngrok documentation team is responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+The ngrok documentation team has the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the ngrok docs project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [support@ngrok.com](mailto:support@ngrok.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,33 +1,35 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'rake'
-
-group :development do
-  # https://github.com/guard/guard
-  gem 'guard'
-  # https://github.com/guard/guard-rspec
-  gem 'guard-rspec'
-  # https://github.com/guard/guard-bundler
-  gem 'guard-bundler'
-end
-
-group :test do
-  # https://github.com/rspec/rspec
-  gem 'rspec'
-  # https://github.com/simplecov-ruby/simplecov
-  gem 'simplecov', require: false
-  # https://github.com/bblimke/webmock
-  gem 'webmock'
-end
-
-group :development, :test do
-  # https://github.com/pry/pry
-  gem 'pry'
-  # https://github.com/lsegal/yard
-  gem 'yard'
-  # https://github.com/airbnb/ruby/tree/master/rubocop
-  gem 'rubocop'
-  # https://github.com/airbnb/ruby/tree/master/rubocop-airbnb
-  gem 'rubocop-airbnb'
+# Code generated for API Clients. DO NOT EDIT.
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+
+group :development do
+  # https://github.com/guard/guard
+  gem 'guard'
+  # https://github.com/guard/guard-rspec
+  gem 'guard-rspec'
+  # https://github.com/guard/guard-bundler
+  gem 'guard-bundler'
+end
+
+group :test do
+  # https://github.com/rspec/rspec
+  gem 'rspec'
+  # https://github.com/simplecov-ruby/simplecov
+  gem 'simplecov', require: false
+  # https://github.com/bblimke/webmock
+  gem 'webmock'
+end
+
+group :development, :test do
+  # https://github.com/pry/pry
+  gem 'pry'
+  # https://github.com/lsegal/yard
+  gem 'yard'
+  # https://github.com/airbnb/ruby/tree/master/rubocop
+  gem 'rubocop'
+  # https://github.com/airbnb/ruby/tree/master/rubocop-airbnb
+  gem 'rubocop-airbnb'
 end

data/Guardfile

@@ -1,16 +1,18 @@
-rspec_options = {
-  version:        1,
-  all_after_pass: false,
-  all_on_start:   false
-}
-
-guard 'rspec', rspec_options do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-
-guard 'bundler' do
-  watch('Gemfile')
-  watch(/^.+\.gemspec/)
-end
+# Code generated for API Clients. DO NOT EDIT.
+
+rspec_options = {
+  version:        1,
+  all_after_pass: false,
+  all_on_start:   false
+}
+
+guard 'rspec', rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -1,61 +1,94 @@
-# ngrok API client library for Ruby
-
-This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
-easier to consume in Ruby.
-
-## Installation
-
-This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
-
-```ruby
-gem install ngrok-api
-```
-
-## Documentation
-
-A quickstart guide and a full API reference are included in the [ngrok Ruby API documentation](https://ruby-api.docs.ngrok.com)
-
-## Quickstart
-
-Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
-
-```ruby
-require 'ngrokapi/client'
-client = NgrokAPI::Client.new(api_key: '<API KEY>')
-
-# Get an instance of the api_keys client and list all API keys
-keys_client = client.api_keys
-keys_client.list
-```
-
-## Local Documentation
-
-Documentation can be generated with the command:
-
-```ruby
-bundle exec yard doc 'lib/**/*.rb'
-```
-
-This will generate documentation which can be viewed within the doc folder.
-
-## Specs
-
-Specs can be run with the command:
-
-```ruby
-bundle exec rake
-```
-
-This will generate a coverage report which can be viewed within the coverage folder.
-
-## Rubocop
-
-Rubocop can be run with the command:
-
-```ruby
-# Run rubocop on lib folder
-bundle exec rubocop 'lib'
-
-# Run rubcop on all files
-bundle exec rubocop
-```
+<!-- Code generated for API Clients. DO NOT EDIT. -->
+
+# ngrok API client library for Ruby
+
+This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
+easier to consume in Ruby.
+
+## Installation
+
+This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
+
+```ruby
+gem install ngrok-api
+```
+
+## Support
+
+The best place to get support using this library is through the [ngrok Slack Community](https://ngrok.com/slack). If you find any bugs, please contribute by opening a [new GitHub issue](https://github.com/ngrok/ngrok-api-ruby/issues/new/choose).
+
+## Documentation
+
+A quickstart guide and a full API reference are included in the [ngrok Ruby API documentation](https://ruby-api.docs.ngrok.com)
+
+## Quickstart
+
+Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+# Get an instance of the api_keys client and list all API keys
+keys_client = client.api_keys
+keys_client.list
+
+# Or set up an edge and backend with the ability to change your configuration later
+edge = client.edges.https.create!(
+  description: "A Ruby Created Edge",
+  metadata: '{"client": "ruby"}',
+  hostports: ["your-subdomain.ngrok.io:443"]
+)
+
+backend = client.backends.tunnel_group.create!(
+  description: "A Ruby Created Backend",
+  labels: {"client_example": "ruby"}
+)
+
+route = client.edges.https_routes.create!(
+  edge_id: edge.id,
+  match_type: "path_prefix",
+  match: "/",
+  description: "Root",
+  backend: NgrokAPI::Models::EndpointBackendMutate.new(attrs: {"enabled": true, "backend_id": backend.id}),
+  compression: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": true})
+)
+
+client.edge_modules.https_edge_route_compression.replace!(
+  edge_id: edge.id,
+  id: route.id,
+  a_module: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": false})
+)
+```
+
+## Local Documentation
+
+Documentation can be generated with the command:
+
+```ruby
+bundle exec yard doc 'lib/**/*.rb'
+```
+
+This will generate documentation which can be viewed within the doc folder.
+
+## Specs
+
+Specs can be run with the command:
+
+```ruby
+bundle exec rake
+```
+
+This will generate a coverage report which can be viewed within the coverage folder.
+
+## Rubocop
+
+Rubocop can be run with the command:
+
+```ruby
+# Run rubocop on lib folder
+bundle exec rubocop 'lib'
+
+# Run rubcop on all files
+bundle exec rubocop
+```

data/Rakefile

@@ -1,7 +1,9 @@
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
-task default: [:spec]
+# Code generated for API Clients. DO NOT EDIT.
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: [:spec]