ngrok-api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3daf4a45dac0de79d93aa36eb3d107352274a246566bb4bd3fccde49d6d83287
+  data.tar.gz: 24b4c876aefbddbdd9a8a15ed2e5fb9a1fad13e0965bdf6a85726c4a35cf2887
+SHA512:
+  metadata.gz: 9c67d35a0070b5f96e99e086ad35b211ba1c157088d5ddc9ecddcfd4a359b30153774a8bbaaaca6a7ecbcf2716df623476cbcbe1d02721f1b1b1e93f9501dade
+  data.tar.gz: 920d1394126e42e8ddaf73766059fc7ff68b7769c90e9877fb739fcc83132858fec5e8e7f5c40fc79bb214ff754ebc9e1637416116c4153b9cf1c4d7aa64372b

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.0']
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/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
+      - name: Run Rake
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+.DS_Store
+.yardoc/
+tmp/
+log/
+pkg/
+*.swp
+/.bundle
+.rvmrc
+coverage
+*.gem
+.idea
+.env

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_from:
+  - .rubocop_airbnb.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Metrics/LineLength:
+  Max: 120
+
+# 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

@@ -0,0 +1,2 @@
+require:
+  - rubocop-airbnb

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start "test_frameworks"

data/Gemfile

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,61 @@
+# 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
+```

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: [:spec]